org.languagetool.rules.spelling.hunspell

Class CompoundAwareHunspellRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.spelling.SpellingCheckRule

org.languagetool.rules.spelling.hunspell.HunspellRule

org.languagetool.rules.spelling.hunspell.CompoundAwareHunspellRule

Direct Known Subclasses:

GermanSpellerRule

public abstract class CompoundAwareHunspellRule
extends HunspellRule

A spell checker that combines Hunspell und Morfologik spell checking to support compound words and offer fast suggestions for some misspelled compound words.

Field Summary

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

FILE_EXTENSION, hunspell, nonWordPattern, RULE_ID

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

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

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor and Description
CompoundAwareHunspellRule(ResourceBundle messages, Language language, CompoundWordTokenizer compoundSplitter, MorfologikMultiSpeller morfoSpeller, UserConfig userConfig)
CompoundAwareHunspellRule(ResourceBundle messages, Language language, CompoundWordTokenizer compoundSplitter, MorfologikMultiSpeller morfoSpeller, UserConfig userConfig, List<Language> altLanguages)
CompoundAwareHunspellRule(ResourceBundle messages, Language language, CompoundWordTokenizer compoundSplitter, MorfologikMultiSpeller morfoSpeller, UserConfig userConfig, List<Language> altLanguages, LanguageModel languageModel)

Method Summary

Modifier and Type	Method and Description
protected abstract void	filterForLanguage(List<String> suggestions)
protected List<String>	getCandidates(List<String> parts)
protected 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)
protected static List<String>	getSpellingFilePaths(String langCode)
protected static List<InputStream>	getStreams(List<String> paths)
List<String>	getSuggestions(String word) As a hunspell-based approach is too slow, we use Morfologik to create suggestions.
protected List<String>	sortSuggestionByQuality(String misspelling, List<String> suggestions)

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

acceptSuggestion, ensureInitialized, getActiveChecks, getDescription, getDictFilenameInResources, getId, getSentenceTextWithoutUrlsAndImmunizedTokens, init, isInIgnoredSet, isMisspelled, isQuotedCompound, match, tokenizeText

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

acceptPhrases, addIgnoreTokens, addIgnoreWords, addProhibitedWords, addSuggestionsToRuleMatch, createWrongSplitMatch, expandLine, filterDupes, filterNoSuggestWords, filterSuggestions, getAdditionalProhibitFileNames, getAdditionalSpellingFileNames, getAdditionalSuggestions, getAdditionalTopSuggestions, getAntiPatterns, getIgnoreFileName, getLanguageVariantSpellingFileName, getOnlySuggestions, getProhibitFileName, getSpellingFileName, ignorePotentiallyMisspelledWord, ignoreToken, ignoreWord, ignoreWord, isDictionaryBasedSpellingRule, isEMail, isIgnoredNoCase, isLatinScript, isProhibited, 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

Constructor Detail

CompoundAwareHunspellRule

public CompoundAwareHunspellRule(ResourceBundle messages,
                                 Language language,
                                 CompoundWordTokenizer compoundSplitter,
                                 MorfologikMultiSpeller morfoSpeller,
                                 UserConfig userConfig)

CompoundAwareHunspellRule

public CompoundAwareHunspellRule(ResourceBundle messages,
                                 Language language,
                                 CompoundWordTokenizer compoundSplitter,
                                 MorfologikMultiSpeller morfoSpeller,
                                 UserConfig userConfig,
                                 List<Language> altLanguages)

Since:

4.3

CompoundAwareHunspellRule

public CompoundAwareHunspellRule(ResourceBundle messages,
                                 Language language,
                                 CompoundWordTokenizer compoundSplitter,
                                 MorfologikMultiSpeller morfoSpeller,
                                 UserConfig userConfig,
                                 List<Language> altLanguages,
                                 LanguageModel languageModel)

Method Detail

filterForLanguage

protected abstract void filterForLanguage(List<String> suggestions)

getSpellingFilePaths

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

getStreams

@NotNull
protected static List<InputStream> getStreams(List<String> paths)

getSuggestions

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

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 HunspellRule

Throws:

IOException

getCandidates

protected 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.

getCandidates

protected List<String> getCandidates(List<String> parts)

sortSuggestionByQuality

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

Overrides:

sortSuggestionByQuality in class HunspellRule

getFilteredSuggestions

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

Since:

4.7