org.languagetool.rules

Class WrongWordInContextRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.WrongWordInContextRule

public abstract class WrongWordInContextRule
extends Rule

Check if there is a confusion of two words (which might have a similar spelling) depending on the context. This rule loads the words and their respective context from an external file with the following format (tab-separated):

word1 word2 match1 match2 context1 context2 explanation1 explanation2

• word1 and word2 are regular expressions of the words that can easily be confused
• match1 is the substring of word1 that will be replaced with match2 when word1 occurs in a context where it is probably wrong (and vice versa)
• context1 is the context in which word1 typically occurs (but which is wrong for word2), given as a regular expression
• context2 is the context in which word2 typically occurs (but which is wrong for word1), given as a regular expression
• explanation1 is a short description of word1 (optional)
• explanation2 is a short description of word2 (optional)

Author:

Markus Brenneis

Field Summary

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor and Description
WrongWordInContextRule(ResourceBundle messages)

Method Summary

Methods

Modifier and Type	Method and Description
protected String	getCategoryString()
String	getDescription() A short description of the error this rule can detect, usually in the language of the text that is checked.
protected abstract String	getFilename()
String	getId() A string used to identify the rule in e.g. configuration files.
protected abstract String	getLongMessageString()
protected abstract String	getMessageString()
protected abstract String	getShortMessageString()
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.

Methods inherited from class org.languagetool.rules.Rule

addExamplePair, getCategory, getCorrectExamples, 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

Constructor Detail

WrongWordInContextRule

public WrongWordInContextRule(ResourceBundle messages)

Method Detail

getFilename

protected abstract String getFilename()

getCategoryString

protected String getCategoryString()

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

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

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

getMessageString

protected abstract String getMessageString()

Returns:

a string like "Possible confusion of words: Did you mean $SUGGESTION instead of '$WRONGWORD'?"

getShortMessageString

protected abstract String getShortMessageString()

Returns:

a string like "Possible confusion of words"

getLongMessageString

protected abstract String getLongMessageString()

Returns:

a string like "Possible confusion of words: Did you mean $SUGGESTION (= $EXPLANATION_SUGGESTION) instead of '$WRONGWORD' (= $EXPLANATION_WRONGWORD)?"

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