org.languagetool.rules.de

Class ProhibitedCompoundRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.de.ProhibitedCompoundRule

public class ProhibitedCompoundRule
extends Rule

Find compounds that might be morphologically correct but are still probably wrong, like 'Lehrzeile'.

Since:

4.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProhibitedCompoundRule.Pair

Field Summary

Fields

Modifier and Type	Field and Description
protected com.hankcs.algorithm.AhoCorasickDoubleArrayTrie<String>	ahoCorasickDoubleArrayTrie
protected Map<String,List<ProhibitedCompoundRule.Pair>>	pairMap
static String	RULE_ID Deprecated. each pair has its own id since LT 5.1

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor and Description
ProhibitedCompoundRule(ResourceBundle messages, LanguageModel lm, UserConfig userConfig, Language language)

Method Summary

Modifier and Type	Method and Description
protected static void	addItemsFromConfusionSets(List<ProhibitedCompoundRule.Pair> pairs, String confusionSetsFile, boolean isUpperCase)
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. configuration files.
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	setConfusionPair(ProhibitedCompoundRule.Pair confusionPair) ignore automatically loaded pairs and only match using given confusionPair used for evaluation by ProhibitedCompoundRuleEvaluator
protected static com.hankcs.algorithm.AhoCorasickDoubleArrayTrie<String>	setupAhoCorasickSearch(List<ProhibitedCompoundRule.Pair> pairs, Map<String,List<ProhibitedCompoundRule.Pair>> pairMap)

Methods inherited from class org.languagetool.rules.Rule

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

RULE_ID

public static final String RULE_ID

Deprecated. each pair has its own id since LT 5.1

Since:

4.3

See Also:

Constant Field Values

ahoCorasickDoubleArrayTrie

protected com.hankcs.algorithm.AhoCorasickDoubleArrayTrie<String> ahoCorasickDoubleArrayTrie

pairMap

protected Map<String,List<ProhibitedCompoundRule.Pair>> pairMap

Constructor Detail

ProhibitedCompoundRule

public ProhibitedCompoundRule(ResourceBundle messages,
                              LanguageModel lm,
                              UserConfig userConfig,
                              Language language)

Method Detail

addItemsFromConfusionSets

protected static void addItemsFromConfusionSets(List<ProhibitedCompoundRule.Pair> pairs,
                                                String confusionSetsFile,
                                                boolean isUpperCase)

setupAhoCorasickSearch

protected static com.hankcs.algorithm.AhoCorasickDoubleArrayTrie<String> setupAhoCorasickSearch(List<ProhibitedCompoundRule.Pair> pairs,
                                                                                                Map<String,List<ProhibitedCompoundRule.Pair>> pairMap)

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)
                  throws IOException

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 from 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). In other words, implementations must be stateless, so that a previous call to this method has no influence on later calls.

Specified by:

match in class Rule

Parameters:

sentence - a pre-analyzed sentence

Returns:

an array of RuleMatch objects

Throws:

IOException

setConfusionPair

public void setConfusionPair(ProhibitedCompoundRule.Pair confusionPair)

ignore automatically loaded pairs and only match using given confusionPair used for evaluation by ProhibitedCompoundRuleEvaluator

Parameters:

confusionPair - pair to evaluate, parts are assumed to be lowercase / null to reset