Package org.languagetool.rules.ngrams
Class ConfusionProbabilityRule
- java.lang.Object
-
- org.languagetool.rules.Rule
-
- org.languagetool.rules.ngrams.ConfusionProbabilityRule
-
public abstract class ConfusionProbabilityRule extends Rule
LanguageTool's homophone confusion check that uses ngram lookups to decide which word in a confusion set (fromconfusion_sets.txt
) suits best. Also see http://wiki.languagetool.org/finding-errors-using-n-gram-data.- Since:
- 2.7
-
-
Field Summary
Fields Modifier and Type Field Description static float
MIN_COVERAGE
static String
RULE_ID
-
Constructor Summary
Constructors Constructor Description ConfusionProbabilityRule(ResourceBundle messages, LanguageModel languageModel, Language language)
ConfusionProbabilityRule(ResourceBundle messages, LanguageModel languageModel, Language language, int grams)
ConfusionProbabilityRule(ResourceBundle messages, LanguageModel languageModel, Language language, int grams, List<String> exceptions)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description int
estimateContextForSureMatch()
A number that estimates how many words there must be after a match before we can be (relatively) sure the match is valid.String
getDescription()
A short description of the error this rule can detect, usually in the language of the text that is checked.protected @NotNull List<String>
getFilenames()
String
getId()
A string used to identify the rule in e.g.protected String
getMessage(ConfusionString textString, ConfusionString suggestion)
int
getNGrams()
Returns the ngram level used, typically 3.protected boolean
isException(String sentenceText)
Return true to prevent a match.RuleMatch[]
match(AnalyzedSentence sentence)
Check whether the given sentence matches this error rule, i.e.void
setConfusionPair(ConfusionPair pair)
Deprecated.used only for tests-
Methods inherited from class org.languagetool.rules.Rule
addExamplePair, 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 Detail
-
RULE_ID
public static final String RULE_ID
- Since:
- 3.1
- See Also:
- Constant Field Values
-
MIN_COVERAGE
public static final float MIN_COVERAGE
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ConfusionProbabilityRule
public ConfusionProbabilityRule(ResourceBundle messages, LanguageModel languageModel, Language language)
-
ConfusionProbabilityRule
public ConfusionProbabilityRule(ResourceBundle messages, LanguageModel languageModel, Language language, int grams)
-
ConfusionProbabilityRule
public ConfusionProbabilityRule(ResourceBundle messages, LanguageModel languageModel, Language language, int grams, List<String> exceptions)
- Since:
- 4.7
-
-
Method Detail
-
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 charactersA-Z
and the underscore.
-
estimateContextForSureMatch
public int estimateContextForSureMatch()
Description copied from class:Rule
A number that estimates how many words there must be after a match before we can be (relatively) sure the match is valid. This is useful for check-as-you-type, where a match might occur and the word that gets typed next makes the match disappear (something one would obviously like to avoid). Note: this may over-estimate the real context size. Returns-1
when the sentence needs to end to be sure there's a match.- Overrides:
estimateContextForSureMatch
in classRule
-
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 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).
-
isException
protected boolean isException(String sentenceText)
Return true to prevent a match.
-
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 classRule
-
getMessage
protected String getMessage(ConfusionString textString, ConfusionString suggestion)
-
setConfusionPair
public void setConfusionPair(ConfusionPair pair)
Deprecated.used only for tests
-
getNGrams
public int getNGrams()
Returns the ngram level used, typically 3.- Since:
- 3.1
-
-