org.languagetool.rules

Class AbstractWordCoherencyRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.AbstractWordCoherencyRule

public abstract class AbstractWordCoherencyRule
extends Rule

A rule that matches words for which two different spellings are used throughout the document.

Note that this should not be used for language variations like American English vs. British English or German "alte Rechtschreibung" vs. "neue Rechtschreibung" -- that's the task of a spell checker.

Since:

2.7

Author:

Daniel Naber

Field Summary

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor and Description
AbstractWordCoherencyRule(ResourceBundle messages)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract String	getMessage(String word1, String word2) Get the message shown to the user if the rule matches.
protected abstract Map<String,String>	getWordMap() Maps words in both directions, e.g.
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, getDescription, getId, 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

AbstractWordCoherencyRule

public AbstractWordCoherencyRule(ResourceBundle messages)
                          throws IOException

Throws:

IOException

Method Detail

getWordMap

protected abstract Map<String,String> getWordMap()

Maps words in both directions, e.g. "aufwendig -> aufwändig" and "aufwändig -> aufwendig".

Since:

3.0

getMessage

protected abstract String getMessage(String word1,
                String word2)

Get the message shown to the user if the rule matches.

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