Package 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	Description
static class	ProhibitedCompoundRule.Pair
(package private) static class	ProhibitedCompoundRule.WeightedRuleMatch

Field Summary

Fields

Modifier and Type	Field	Description
protected com.hankcs.algorithm.AhoCorasickDoubleArrayTrie<String>	ahoCorasickDoubleArrayTrie
private static final List<String>	blacklistRegex
private static final com.google.common.cache.LoadingCache<String,Set<String>>	cache
private ProhibitedCompoundRule.Pair	confusionPair
private static final Pattern	HERRN_FRAU
private static final List<String>	ignoreWords
private final Language	language
private static LinguServices	linguServices
private final BaseLanguageModel	lm
private static final List<ProhibitedCompoundRule.Pair>	lowercasePairs
protected Map<String,List<ProhibitedCompoundRule.Pair>>	pairMap
private static final Map<String,List<ProhibitedCompoundRule.Pair>>	prohibitedCompoundRulePairMap
private static final com.hankcs.algorithm.AhoCorasickDoubleArrayTrie<String>	prohibitedCompoundRuleSearcher
static final 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	Description
ProhibitedCompoundRule(ResourceBundle messages, LanguageModel lm, UserConfig userConfig, Language language)

Method Summary

Modifier and Type	Method	Description
private static void	addAllCaseVariants(List<ProhibitedCompoundRule.Pair> candidatePairs, ProhibitedCompoundRule.Pair lcPair)
protected static void	addItemsFromConfusionSets(List<ProhibitedCompoundRule.Pair> pairs, String confusionSetsFile, boolean isUpperCase)
private static void	addUpperCaseVariants(List<ProhibitedCompoundRule.Pair> pairs)
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.
private int	getMatches(AnalyzedSentence sentence, List<RuleMatch> ruleMatches, AnalyzedTokenReadings readings, int partsStartPos, String wordPart, int toPosCorrection)
(package private) int	getThreshold()
private static boolean	isMisspelled(String word)
RuleMatch[]	match(AnalyzedSentence sentence)	Check whether the given sentence matches this error rule, i.e.
(package private) String	removeHyphensAndAdaptCase(String word)
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, 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

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

lowercasePairs

private static final List<ProhibitedCompoundRule.Pair> lowercasePairs

HERRN_FRAU

private static final Pattern HERRN_FRAU

ignoreWords

private static final List<String> ignoreWords

blacklistRegex

private static final List<String> blacklistRegex

linguServices

private static LinguServices linguServices

cache

private static final com.google.common.cache.LoadingCache<String,Set<String>> cache

ahoCorasickDoubleArrayTrie

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

pairMap

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

prohibitedCompoundRuleSearcher

private static final com.hankcs.algorithm.AhoCorasickDoubleArrayTrie<String> prohibitedCompoundRuleSearcher

prohibitedCompoundRulePairMap

private static final Map<String,List<ProhibitedCompoundRule.Pair>> prohibitedCompoundRulePairMap

lm

private final BaseLanguageModel lm

language

private final Language language

confusionPair

private ProhibitedCompoundRule.Pair confusionPair

Constructor Details

ProhibitedCompoundRule

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

Method Details

addAllCaseVariants

private static void addAllCaseVariants(List<ProhibitedCompoundRule.Pair> candidatePairs,
 ProhibitedCompoundRule.Pair lcPair)

addUpperCaseVariants

private static void addUpperCaseVariants(List<ProhibitedCompoundRule.Pair> pairs)

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

isMisspelled

private static boolean isMisspelled(String word)

getMatches

private int getMatches(AnalyzedSentence sentence,
 List<RuleMatch> ruleMatches,
 AnalyzedTokenReadings readings,
 int partsStartPos,
 String wordPart,
 int toPosCorrection)

getThreshold

int getThreshold()

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

removeHyphensAndAdaptCase

@Nullable
String removeHyphensAndAdaptCase(String word)