org.languagetool.rules

Class ConfusionProbabilityRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.ConfusionProbabilityRule

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.

Since:

2.7

Field Summary

Fields

Modifier and Type	Field and Description
static float	MIN_COVERAGE

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)

Method Summary

Methods

Modifier and Type	Method and Description
String	getId() A string used to identify the rule in e.g. configuration files.
abstract String	getMessage(String suggestion, String description)
protected abstract WordTokenizer	getTokenizer()
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	reset() If a rule keeps its state over more than the check of one sentence, this must be implemented so the internal state is reset.
void	setConfusionSet(ConfusionSet set) Deprecated. used only for tests

Methods inherited from class org.languagetool.rules.Rule

addExamplePair, getCategory, getCorrectExamples, getDescription, getIncorrectExamples, getLocQualityIssueType, getUrl, isDefaultOff, isDictionaryBasedSpellingRule, setCategory, setCorrectExamples, setDefaultOff, setDefaultOn, setIncorrectExamples, setLocQualityIssueType, setUrl, supportsLanguage, toRuleMatchArray, useInOffice

Methods inherited from class java.lang.Object

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

Field Detail

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)

Method Detail

getMessage

public abstract String getMessage(String suggestion,
                String description)

getTokenizer

protected abstract WordTokenizer getTokenizer()

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

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).

Specified by:

match in class Rule

Parameters:

sentence - a pre-analyzed sentence

Returns:

an array of RuleMatch objects

reset

public void reset()

Description copied from class: Rule

If a rule keeps its state over more than the check of one sentence, this must be implemented so the internal state is reset. It will be called before a new text is going to be checked.

Specified by:

reset in class Rule

setConfusionSet

public void setConfusionSet(ConfusionSet set)

Deprecated. used only for tests