org.languagetool.rules.de

Class GermanSpellerRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.spelling.SpellingCheckRule

org.languagetool.rules.spelling.hunspell.HunspellRule

org.languagetool.rules.spelling.hunspell.CompoundAwareHunspellRule

org.languagetool.rules.de.GermanSpellerRule

Direct Known Subclasses:

AustrianGermanSpellerRule, SwissGermanSpellerRule

public class GermanSpellerRule
extends CompoundAwareHunspellRule

Field Summary

Fields

Modifier and Type	Field and Description
static String	RULE_ID

Fields inherited from class org.languagetool.rules.spelling.hunspell.HunspellRule

FILE_EXTENSION, hunspell, nonWordPattern

Fields inherited from class org.languagetool.rules.spelling.SpellingCheckRule

CUSTOM_SPELLING_FILE, GLOBAL_SPELLING_FILE, HIGH_CONFIDENCE, ignoreWordsWithLength, language, languageModel, LANGUAGETOOL, LANGUAGETOOLER, wordListLoader, wordsToBeIgnored

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor and Description
GermanSpellerRule(ResourceBundle messages, German language)
GermanSpellerRule(ResourceBundle messages, German language, UserConfig userConfig, String languageVariantPlainTextDict)
GermanSpellerRule(ResourceBundle messages, German language, UserConfig userConfig, String languageVariantPlainTextDict, List<Language> altLanguages, LanguageModel languageModel)

Method Summary

Modifier and Type	Method and Description
protected boolean	acceptSuggestion(String s)
protected void	addIgnoreWords(String origLine)
protected void	addProhibitedWords(List<String> words)
protected RuleMatch	createWrongSplitMatch(AnalyzedSentence sentence, List<RuleMatch> ruleMatchesSoFar, int pos, String coveredWord, String suggestion1, String suggestion2, int prevPos)
protected List<String>	expandLine(String line) Expand suffixes in a line.
protected void	filterForLanguage(List<String> suggestions)
protected List<SuggestedReplacement>	filterNoSuggestWords(List<SuggestedReplacement> l)
protected List<SuggestedReplacement>	getAdditionalTopSuggestions(List<SuggestedReplacement> suggestions, String word) Get additional suggestions added before other suggestions (note the rule may choose to re-order the suggestions anyway).
List<String>	getCandidates(String word) Find potential corrections - it's okay if some of these are not valid words, this list will be filtered against the spellchecker before being returned to the user.
protected List<String>	getFilteredSuggestions(List<String> wordsOrPhrases)
String	getId() A string used to identify the rule in e.g. configuration files.
protected List<SuggestedReplacement>	getOnlySuggestions(String word) Get suggestions that will replace all other suggestions.
protected static MorfologikMultiSpeller	getSpeller(Language language, UserConfig userConfig, String languageVariantPlainTextDict)
protected static List<String>	getSpellingFilePaths(String langCode)
List<String>	getSuggestions(String word) As a hunspell-based approach is too slow, we use Morfologik to create suggestions.
protected boolean	ignorePotentiallyMisspelledWord(String word) Like SpellingCheckRule.ignoreWord(String), but will only be called after the standard spell check has run and considered this word to be incorrect.
protected boolean	ignoreWord(List<String> words, int idx) Returns true iff the word at the given position should be ignored by the spell checker.
protected void	init()
protected boolean	isIgnoredNoCase(String word)
boolean	isMisspelled(String word)
protected boolean	isProhibited(String word) Whether the word is prohibited, i.e. whether it should be marked as a spelling error even if the spell checker would accept it.
protected boolean	isQuotedCompound(AnalyzedSentence analyzedSentence, int idx, String token) Is the given token part of a hyphenated compound preceded by a quoted token (e.g., „Spiegel“-Magazin) and should be treated as an ordinary hyphenated compound (e.g., „Spiegel-Magazin“)
RuleMatch[]	match(AnalyzedSentence sentence) Check whether the given sentence matches this error rule, i.e. whether it contains the error detected by this rule.
protected List<String>	sortSuggestionByQuality(String misspelling, List<String> suggestions)

Methods inherited from class org.languagetool.rules.spelling.hunspell.CompoundAwareHunspellRule

getCandidates, getStreams

Methods inherited from class org.languagetool.rules.spelling.hunspell.HunspellRule

ensureInitialized, getActiveChecks, getDescription, getDictFilenameInResources, getSentenceTextWithoutUrlsAndImmunizedTokens, isInIgnoredSet, tokenizeText

Methods inherited from class org.languagetool.rules.spelling.SpellingCheckRule

acceptPhrases, addIgnoreTokens, addSuggestionsToRuleMatch, filterDupes, filterSuggestions, getAdditionalProhibitFileNames, getAdditionalSpellingFileNames, getAdditionalSuggestions, getAntiPatterns, getIgnoreFileName, getLanguageVariantSpellingFileName, getProhibitFileName, getSpellingFileName, ignoreToken, ignoreWord, isDictionaryBasedSpellingRule, isEMail, isLatinScript, isUrl, setConsiderIgnoreWords, setConvertsCase, startsWithIgnoredWord, tokenizeNewWords

Methods inherited from class org.languagetool.rules.Rule

addExamplePair, addTags, addToneTags, cacheAntiPatterns, estimateContextForSureMatch, getCategory, getConfigureText, getCorrectExamples, getDefaultValue, getDistanceTokens, getErrorTriggeringExamples, getFullId, getIncorrectExamples, getLocQualityIssueType, getMaxConfigurableValue, getMinConfigurableValue, getMinPrevMatches, getSentenceWithImmunization, getSourceFile, getSubId, getTags, getToneTags, getUrl, hasConfigurableValue, hasTag, hasToneTag, isDefaultOff, isDefaultTempOff, 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

See Also:

Constant Field Values

Constructor Detail

GermanSpellerRule

public GermanSpellerRule(ResourceBundle messages,
                         German language)

GermanSpellerRule

public GermanSpellerRule(ResourceBundle messages,
                         German language,
                         UserConfig userConfig,
                         String languageVariantPlainTextDict)

Since:

4.2

GermanSpellerRule

public GermanSpellerRule(ResourceBundle messages,
                         German language,
                         UserConfig userConfig,
                         String languageVariantPlainTextDict,
                         List<Language> altLanguages,
                         LanguageModel languageModel)

Since:

4.3

Method Detail

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.

Overrides:

match in class HunspellRule

Parameters:

sentence - a pre-analyzed sentence

Returns:

an array of RuleMatch objects

Throws:

IOException

init

protected void init()
             throws IOException

Overrides:

init in class HunspellRule

Throws:

IOException

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.

Overrides:

getId in class HunspellRule

isIgnoredNoCase

protected boolean isIgnoredNoCase(String word)

Overrides:

isIgnoredNoCase in class SpellingCheckRule

getCandidates

public List<String> getCandidates(String word)

Description copied from class: CompoundAwareHunspellRule

Find potential corrections - it's okay if some of these are not valid words, this list will be filtered against the spellchecker before being returned to the user.

Overrides:

getCandidates in class CompoundAwareHunspellRule

isProhibited

protected boolean isProhibited(String word)

Description copied from class: SpellingCheckRule

Whether the word is prohibited, i.e. whether it should be marked as a spelling error even if the spell checker would accept it. (This is useful to improve our spell checker without waiting for the upstream checker to be updated.)

Overrides:

isProhibited in class SpellingCheckRule

addIgnoreWords

protected void addIgnoreWords(String origLine)

Overrides:

addIgnoreWords in class SpellingCheckRule

Parameters:

origLine - the line as read from spelling.txt.

expandLine

protected List<String> expandLine(String line)

Description copied from class: SpellingCheckRule

Expand suffixes in a line. By default, the line is not expanded. Implementations might e.g. turn bicycle/S into [bicycle, bicycles].

Overrides:

expandLine in class SpellingCheckRule

createWrongSplitMatch

protected RuleMatch createWrongSplitMatch(AnalyzedSentence sentence,
                                          List<RuleMatch> ruleMatchesSoFar,
                                          int pos,
                                          String coveredWord,
                                          String suggestion1,
                                          String suggestion2,
                                          int prevPos)

Overrides:

createWrongSplitMatch in class SpellingCheckRule

getSuggestions

public List<String> getSuggestions(String word)
                            throws IOException

Description copied from class: CompoundAwareHunspellRule

As a hunspell-based approach is too slow, we use Morfologik to create suggestions. As this won't work for compounds not in the dictionary, we split the word and also get suggestions on the compound parts. In the end, all candidates are filtered against Hunspell again (which supports compounds).

Overrides:

getSuggestions in class CompoundAwareHunspellRule

Throws:

IOException

acceptSuggestion

protected boolean acceptSuggestion(String s)

Overrides:

acceptSuggestion in class HunspellRule

getSpellingFilePaths

@NotNull
protected static List<String> getSpellingFilePaths(String langCode)

getSpeller

@Nullable
protected static MorfologikMultiSpeller getSpeller(Language language,
                                                             UserConfig userConfig,
                                                             String languageVariantPlainTextDict)

filterForLanguage

protected void filterForLanguage(List<String> suggestions)

Specified by:

filterForLanguage in class CompoundAwareHunspellRule

sortSuggestionByQuality

protected List<String> sortSuggestionByQuality(String misspelling,
                                               List<String> suggestions)

Overrides:

sortSuggestionByQuality in class CompoundAwareHunspellRule

getFilteredSuggestions

protected List<String> getFilteredSuggestions(List<String> wordsOrPhrases)

Overrides:

getFilteredSuggestions in class CompoundAwareHunspellRule

isMisspelled

public boolean isMisspelled(String word)

Overrides:

isMisspelled in class HunspellRule

ignoreWord

protected boolean ignoreWord(List<String> words,
                             int idx)
                      throws IOException

Description copied from class: SpellingCheckRule

Returns true iff the word at the given position should be ignored by the spell checker. If possible, use SpellingCheckRule.ignoreToken(AnalyzedTokenReadings[], int) instead.

Overrides:

ignoreWord in class SpellingCheckRule

Throws:

IOException

ignorePotentiallyMisspelledWord

protected boolean ignorePotentiallyMisspelledWord(String word)
                                           throws IOException

Description copied from class: SpellingCheckRule

Like SpellingCheckRule.ignoreWord(String), but will only be called after the standard spell check has run and considered this word to be incorrect. This way, tests run here can be a bit more computationally expensive.

Overrides:

ignorePotentiallyMisspelledWord in class SpellingCheckRule

Throws:

IOException

getAdditionalTopSuggestions

protected List<SuggestedReplacement> getAdditionalTopSuggestions(List<SuggestedReplacement> suggestions,
                                                                 String word)
                                                          throws IOException

Description copied from class: SpellingCheckRule

Get additional suggestions added before other suggestions (note the rule may choose to re-order the suggestions anyway). Only add suggestions here that you know are spelled correctly, they will not be checked again before being shown to the user.

Overrides:

getAdditionalTopSuggestions in class SpellingCheckRule

Throws:

IOException

isQuotedCompound

protected boolean isQuotedCompound(AnalyzedSentence analyzedSentence,
                                   int idx,
                                   String token)

Description copied from class: HunspellRule

Is the given token part of a hyphenated compound preceded by a quoted token (e.g., „Spiegel“-Magazin) and should be treated as an ordinary hyphenated compound (e.g., „Spiegel-Magazin“)

Overrides:

isQuotedCompound in class HunspellRule

addProhibitedWords

protected void addProhibitedWords(List<String> words)

Overrides:

addProhibitedWords in class SpellingCheckRule

Parameters:

words - list of words to be prohibited.

filterNoSuggestWords

protected List<SuggestedReplacement> filterNoSuggestWords(List<SuggestedReplacement> l)

Overrides:

filterNoSuggestWords in class SpellingCheckRule

getOnlySuggestions

protected List<SuggestedReplacement> getOnlySuggestions(String word)

Description copied from class: SpellingCheckRule

Get suggestions that will replace all other suggestions. Only add suggestions here that you know are spelled correctly, they will not be checked again before being shown to the user.

Overrides:

getOnlySuggestions in class SpellingCheckRule