Package org.languagetool.rules.ar

Class ArabicInflectedOneWordReplaceRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.AbstractSimpleReplaceRule2

org.languagetool.rules.ar.ArabicInflectedOneWordReplaceRule

public class ArabicInflectedOneWordReplaceRule
extends AbstractSimpleReplaceRule2

Since:

6.2

Nested Class Summary

Nested classes/interfaces inherited from class org.languagetool.rules.AbstractSimpleReplaceRule2

AbstractSimpleReplaceRule2.CaseSensitivy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AR_INFLECTED_ONE_WORD_REPLACE
private static final Locale	AR_LOCALE
private static final String	FILE_NAME
private final ArabicSynthesizer	synthesizer
private final ArabicTagger	tagger
private final List<Map<String,SuggestionWithMessage>>	wrongWords

Fields inherited from class org.languagetool.rules.AbstractSimpleReplaceRule2

language, subRuleSpecificIds

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor	Description
ArabicInflectedOneWordReplaceRule(ResourceBundle messages)

Method Summary

Modifier and Type	Method	Description
String	getDescription()	A short description of the error this rule can detect, usually in the language of the text that is checked.
final List<String>	getFileNames()
String	getId()	A string used to identify the rule in e.g.
Locale	getLocale()	locale used on case-conversion
String	getMessage()
String	getShort()
private SuggestionWithMessage	getSuggestedWords(AnalyzedToken mytoken)
String	getSuggestionsSeparator()
private List<String>	inflectSuggestedWords(String targetLemma, AnalyzedToken sourcetoken)
private boolean	isCandidateWord(AnalyzedToken mytoken)
RuleMatch[]	match(AnalyzedSentence sentence)	Check whether the given sentence matches this error rule, i.e.

Methods inherited from class org.languagetool.rules.AbstractSimpleReplaceRule2

checkKeyWordsAreKnownToSpeller, checkKeyWordsAreUnknownToSpeller, getCaseSensitivy, getDescription, getFilePaths, getWrongWords, isCheckingCase, isException, isIgnoreShortUppercaseWords, isPunctuationStart, isRuleMatchException, isTokenException, separateKeyWordsBySpeller, setIgnoreShortUppercaseWords, setRuleHasSuggestions, useSubRuleSpecificIds

Methods inherited from class org.languagetool.rules.Rule

addExamplePair, addTags, addToneTags, cacheAntiPatterns, estimateContextForSureMatch, getAntiPatterns, getCategory, getCorrectExamples, getDistanceTokens, getErrorTriggeringExamples, getFullId, getIncorrectExamples, getLocQualityIssueType, getMinPrevMatches, getPriority, getRuleOptions, getSentenceWithImmunization, getSourceFile, getSubId, getTags, getToneTags, getUrl, hasTag, hasToneTag, isDefaultOff, isDefaultTempOff, isDictionaryBasedSpellingRule, isGoalSpecific, isIncludedInHiddenMatches, isOfficeDefaultOff, isOfficeDefaultOn, isPremium, makeAntiPatterns, setCategory, setCorrectExamples, setDefaultOff, setDefaultOn, setDefaultTempOff, setDistanceTokens, setErrorTriggeringExamples, setExamplePair, setGoalSpecific, setIncludedInHiddenMatches, setIncorrectExamples, setLocQualityIssueType, setMinPrevMatches, setOfficeDefaultOff, setOfficeDefaultOn, setPremium, setPriority, setTags, setToneTags, setUrl, supportsLanguage, toRuleMatchArray, useInOffice

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

AR_INFLECTED_ONE_WORD_REPLACE

public static final String AR_INFLECTED_ONE_WORD_REPLACE

See Also:

• Constant Field Values

FILE_NAME

private static final String FILE_NAME

See Also:

• Constant Field Values

AR_LOCALE

private static final Locale AR_LOCALE

tagger

private final ArabicTagger tagger

synthesizer

private final ArabicSynthesizer synthesizer

wrongWords

private final List<Map<String,SuggestionWithMessage>> wrongWords

Constructor Details

ArabicInflectedOneWordReplaceRule

public ArabicInflectedOneWordReplaceRule(ResourceBundle messages)

Method Details

getId

public String getId()

Description copied from class: Rule

A string used to identify the rule in e.g. configuration files. This string is supposed to be unique and to stay the same in all upcoming versions of LanguageTool. It's supposed to contain only the characters A-Z and the underscore.

Specified by:

getId in class AbstractSimpleReplaceRule2

getFileNames

public final List<String> getFileNames()

Specified by:

getFileNames in class AbstractSimpleReplaceRule2

getDescription

public String getDescription()

Description copied from class: Rule

A short description of the error this rule can detect, usually in the language of the text that is checked.

Specified by:

getDescription in class AbstractSimpleReplaceRule2

Returns:

A string where $match will be replaced with the matching word.

getShort

public String getShort()

Specified by:

getShort in class AbstractSimpleReplaceRule2

getMessage

public String getMessage()

Specified by:

getMessage in class AbstractSimpleReplaceRule2

Returns:

A string where $match will be replaced with the matching word and $suggestions will be replaced with the alternatives. This is the string shown to the user.

getSuggestionsSeparator

public String getSuggestionsSeparator()

Overrides:

getSuggestionsSeparator in class AbstractSimpleReplaceRule2

Returns:

the word used to separate multiple suggestions; used only before last suggestion, the rest are comma-separated.

getLocale

public Locale getLocale()

Description copied from class: AbstractSimpleReplaceRule2

locale used on case-conversion

Specified by:

getLocale in class AbstractSimpleReplaceRule2

match

public RuleMatch[] match(AnalyzedSentence sentence)

Description copied from class: Rule

Check whether the given sentence matches this error rule, i.e. whether it contains the error detected by this rule. Note that the order in which this method is called is not always guaranteed, i.e. the sentence order in the text may be different from the order in which you get the sentences (this may be the case when LanguageTool is used as a LibreOffice/OpenOffice add-on, for example). In other words, implementations must be stateless, so that a previous call to this method has no influence on later calls.

Overrides:

match in class AbstractSimpleReplaceRule2

Parameters:

sentence - a pre-analyzed sentence

Returns:

an array of RuleMatch objects

isCandidateWord

private boolean isCandidateWord(AnalyzedToken mytoken)

getSuggestedWords

private SuggestionWithMessage getSuggestedWords(AnalyzedToken mytoken)

inflectSuggestedWords

private List<String> inflectSuggestedWords(String targetLemma,
 AnalyzedToken sourcetoken)