org.languagetool.rules.ngrams

Class ConfusionProbabilityRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.ngrams.ConfusionProbabilityRule

Direct Known Subclasses:

ArabicConfusionProbabilityRule, ChineseConfusionProbabilityRule, DutchConfusionProbabilityRule, EnglishConfusionProbabilityRule, EnglishForL2SpeakersFalseFriendRule, FrenchConfusionProbabilityRule, GermanConfusionProbabilityRule, ItalianConfusionProbabilityRule, PortugueseConfusionProbabilityRule, RussianConfusionProbabilityRule, SpanishConfusionProbabilityRule

public abstract class ConfusionProbabilityRule
extends Rule

LanguageTool's homophone confusion check that uses ngram lookups to decide which word in a confusion set (from confusion_sets.txt) suits best. Also see https://dev.languagetool.org/finding-errors-using-n-gram-data.

Since:

2.7

Field Summary

Fields

Modifier and Type	Field and Description
static float	MIN_COVERAGE
static String	RULE_ID Deprecated. not used anymore, the id is now more specific (like CONFUSION_RULE_TERM1_TERM2)

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor and 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)
ConfusionProbabilityRule(ResourceBundle messages, LanguageModel languageModel, Language language, int grams, List<String> exceptions, List<List<PatternToken>> antiPatterns)

Method Summary

Modifier and Type	Method and 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.
List<DisambiguationPatternRule>	getAntiPatterns() Overwrite this to avoid false alarms by ignoring these patterns - note that your Rule.match(AnalyzedSentence) method needs to call Rule.getSentenceWithImmunization(org.languagetool.AnalyzedSentence) for this to be used and you need to check AnalyzedTokenReadings.isImmunized()
String	getDescription() A short description of the error this rule can detect, usually in the language of the text that is checked.
protected List<String>	getFilenames()
String	getId() A string used to identify the rule in e.g. configuration files.
protected String	getMessage(ConfusionString textString, ConfusionString suggestion)
int	getNGrams() Returns the ngram level used, typically 3.
protected boolean	isCommonWord(String token)
protected boolean	isException(String sentenceText, int startPos, int endPos) Return true to prevent a match.
RuleMatch[]	match(AnalyzedSentence sentence) Check whether the given sentence matches this error rule, i.e. whether it contains the error detected by this rule.
void	setConfusionPair(ConfusionPair pair) Deprecated. used only for tests

Methods inherited from class org.languagetool.rules.Rule

addExamplePair, addTags, addToneTags, cacheAntiPatterns, getCategory, getConfigureText, getCorrectExamples, getDefaultValue, getDistanceTokens, getErrorTriggeringExamples, getFullId, getIncorrectExamples, getLocQualityIssueType, getMaxConfigurableValue, getMinConfigurableValue, getMinPrevMatches, getSentenceWithImmunization, getSourceFile, getSubId, getTags, getToneTags, getUrl, hasConfigurableValue, hasTag, hasToneTag, isDefaultOff, isDefaultTempOff, isDictionaryBasedSpellingRule, isGoalSpecific, isOfficeDefaultOff, isOfficeDefaultOn, isPremium, makeAntiPatterns, setCategory, setCorrectExamples, setDefaultOff, setDefaultOn, setDefaultTempOff, setDistanceTokens, setErrorTriggeringExamples, setExamplePair, setGoalSpecific, setIncorrectExamples, setLocQualityIssueType, setMinPrevMatches, setOfficeDefaultOff, setOfficeDefaultOn, setPremium, 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 Detail

RULE_ID

public static final String RULE_ID

Deprecated. not used anymore, the id is now more specific (like CONFUSION_RULE_TERM1_TERM2)

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

ConfusionProbabilityRule

public ConfusionProbabilityRule(ResourceBundle messages,
                                LanguageModel languageModel,
                                Language language,
                                int grams,
                                List<String> exceptions,
                                List<List<PatternToken>> antiPatterns)

Method Detail

getFilenames

@NotNull
protected List<String> getFilenames()

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 Rule

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 class Rule

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.

Specified by:

match in class Rule

Parameters:

sentence - a pre-analyzed sentence

Returns:

an array of RuleMatch objects

isCommonWord

protected boolean isCommonWord(String token)

isException

protected boolean isException(String sentenceText,
                              int startPos,
                              int endPos)

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 class Rule

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

getAntiPatterns

public List<DisambiguationPatternRule> getAntiPatterns()

Description copied from class: Rule

Overwrite this to avoid false alarms by ignoring these patterns - note that your Rule.match(AnalyzedSentence) method needs to call Rule.getSentenceWithImmunization(org.languagetool.AnalyzedSentence) for this to be used and you need to check AnalyzedTokenReadings.isImmunized()

Overrides:

getAntiPatterns in class Rule