Package org.languagetool.rules
Class AbstractSimpleReplaceRule
java.lang.Object
org.languagetool.rules.Rule
org.languagetool.rules.AbstractSimpleReplaceRule
A rule that matches words which should not be used and suggests
correct ones instead. Loads the relevant words from
rules/XX/replace.txt
, where XX is a code of the language.-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate String
protected RuleMatch
createRuleMatch
(AnalyzedTokenReadings tokenReadings, List<String> replacements, AnalyzedSentence sentence) findMatches
(AnalyzedTokenReadings tokenReadings, AnalyzedSentence sentence) A short description of the error this rule can detect, usually in the language of the text that is checked.getId()
A string used to identify the rule in e.g.getMessage
(String tokenStr, List<String> replacements) getShort()
boolean
Indicates if the rule is case-sensitive.boolean
protected boolean
isTagged
(AnalyzedTokenReadings tokenReadings) This method allows to override which tags will mark token as taggedloadFromPath
(String path) match
(AnalyzedSentence sentence) Check whether the given sentence matches this error rule, i.e.void
setCheckLemmas
(boolean checkLemmas) Used to disable matching lemmas.void
Skip words that are known in the POS tagging dictionary, assuming they cannot be incorrect.Methods inherited from class org.languagetool.rules.Rule
addExamplePair, estimateContextForSureMatch, getAntiPatterns, getCategory, getConfigureText, getCorrectExamples, getDefaultValue, getErrorTriggeringExamples, getIncorrectExamples, getLocQualityIssueType, getMaxConfigurableValue, getMinConfigurableValue, getSentenceWithImmunization, getUrl, hasConfigurableValue, isDefaultOff, isDefaultTempOff, isDictionaryBasedSpellingRule, isOfficeDefaultOff, isOfficeDefaultOn, makeAntiPatterns, setCategory, setCorrectExamples, setDefaultOff, setDefaultOn, setDefaultTempOff, setErrorTriggeringExamples, setIncorrectExamples, setLocQualityIssueType, setOfficeDefaultOff, setOfficeDefaultOn, setUrl, supportsLanguage, toRuleMatchArray, useInOffice
-
Field Details
-
ignoreTaggedWords
protected boolean ignoreTaggedWords -
checkLemmas
private boolean checkLemmas
-
-
Constructor Details
-
AbstractSimpleReplaceRule
-
-
Method Details
-
getWrongWords
-
loadFromPath
-
isCaseSensitive
public boolean isCaseSensitive()Indicates if the rule is case-sensitive. Default value istrue
.- Returns:
- true if the rule is case-sensitive, false otherwise.
-
getLocale
- Returns:
- the locale used for case conversion when
isCaseSensitive()
is set tofalse
.
-
setIgnoreTaggedWords
public void setIgnoreTaggedWords()Skip words that are known in the POS tagging dictionary, assuming they cannot be incorrect.- Since:
- 2.3
-
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 charactersA-Z
and the underscore. -
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 classRule
-
getMessage
-
getShort
-
cleanup
-
match
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 than 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). -
findMatches
protected List<RuleMatch> findMatches(AnalyzedTokenReadings tokenReadings, AnalyzedSentence sentence) -
isTagged
This method allows to override which tags will mark token as tagged- Returns:
- returns true if token has valid tag
-
createRuleMatch
protected RuleMatch createRuleMatch(AnalyzedTokenReadings tokenReadings, List<String> replacements, AnalyzedSentence sentence) -
isCheckLemmas
public boolean isCheckLemmas()- Since:
- 2.5
-
setCheckLemmas
public void setCheckLemmas(boolean checkLemmas) Used to disable matching lemmas.- Since:
- 2.5
-