Package org.languagetool.rules.en

Class CompoundRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.AbstractCompoundRule

org.languagetool.rules.en.CompoundRule

public class CompoundRule
extends AbstractCompoundRule

Checks that compounds (if in the list) are not written as separate words.

Field Summary

Fields

Modifier and Type	Field	Description
private static final Language	AMERICAN_ENGLISH
private static final List<DisambiguationPatternRule>	ANTI_PATTERNS
private static CompoundRuleData	compoundData
private final Language	english

Fields inherited from class org.languagetool.rules.AbstractCompoundRule

lang, linguServices, sentenceStartsWithUpperCase, subRuleSpecificIds

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor	Description
CompoundRule(ResourceBundle messages, Language english, UserConfig userConfig)

Method Summary

Modifier and Type	Method	Description
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()
CompoundRuleData	getCompoundRuleData()
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.
boolean	isMisspelled(String word)

Methods inherited from class org.languagetool.rules.AbstractCompoundRule

estimateContextForSureMatch, filterReplacements, match, mergeCompound, useSubRuleSpecificIds

Methods inherited from class org.languagetool.rules.Rule

addExamplePair, addTags, addToneTags, cacheAntiPatterns, 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

compoundData

private static volatile CompoundRuleData compoundData

AMERICAN_ENGLISH

private static final Language AMERICAN_ENGLISH

ANTI_PATTERNS

private static final List<DisambiguationPatternRule> ANTI_PATTERNS

english

private final Language english

Constructor Details

CompoundRule

public CompoundRule(ResourceBundle messages,
 Language english,
 UserConfig userConfig)
             throws IOException

Throws:

IOException

Method Details

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 AbstractCompoundRule

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 AbstractCompoundRule

getCompoundRuleData

public CompoundRuleData getCompoundRuleData()

Specified by:

getCompoundRuleData in class AbstractCompoundRule

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

isMisspelled

public boolean isMisspelled(String word)
                     throws IOException

Overrides:

isMisspelled in class AbstractCompoundRule

Throws:

IOException