Package org.languagetool.rules.en

Class WordCoherencyRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.TextLevelRule

org.languagetool.rules.AbstractWordCoherencyRule

org.languagetool.rules.en.WordCoherencyRule

public class WordCoherencyRule
extends AbstractWordCoherencyRule

English version of AbstractWordCoherencyRule

Field Summary

Fields

Modifier and Type	Field	Description
private static final Map<String,Set<String>>	wordMap

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor	Description
WordCoherencyRule(ResourceBundle messages)

Method Summary

Modifier and Type	Method	Description
String	getDescription()	A short description of the error this rule can detect, usually in the language of the text that is checked.
String	getId()	A string used to identify the rule in e.g.
protected String	getMessage(String word1, String word2)	Get the message shown to the user if the rule matches.
protected Map<String,Set<String>>	getWordMap()	Maps words in both directions, e.g.

Methods inherited from class org.languagetool.rules.AbstractWordCoherencyRule

createReplacement, getShortMessage, match, minToCheckParagraph

Methods inherited from class org.languagetool.rules.TextLevelRule

estimateContextForSureMatch, match, match

Methods inherited from class org.languagetool.rules.Rule

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

wordMap

private static final Map<String,Set<String>> wordMap

Constructor Details

WordCoherencyRule

public WordCoherencyRule(ResourceBundle messages)
                  throws IOException

Throws:

IOException

Method Details

getWordMap

protected Map<String,Set<String>> getWordMap()

Description copied from class: AbstractWordCoherencyRule

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

Specified by:

getWordMap in class AbstractWordCoherencyRule

getMessage

protected String getMessage(String word1,
 String word2)

Description copied from class: AbstractWordCoherencyRule

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

Specified by:

getMessage in class AbstractWordCoherencyRule

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