org.languagetool.rules.spelling.hunspell

Class HunspellRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.spelling.SpellingCheckRule

org.languagetool.rules.spelling.hunspell.HunspellRule

Direct Known Subclasses:

ArabicHunspellSpellerRule, CompoundAwareHunspellRule, HunspellNoSuggestionRule, KhmerHunspellRule

public class HunspellRule
extends SpellingCheckRule

A hunspell-based spellchecking-rule. The default dictionary is set to the first country variant on the list - so the order in the Language class declaration is important!

Author:

Marcin Miłkowski

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	FILE_EXTENSION
protected HunspellDictionary	hunspell
protected Pattern	nonWordPattern
static String	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
HunspellRule(ResourceBundle messages, Language language, UserConfig userConfig)
HunspellRule(ResourceBundle messages, Language language, UserConfig userConfig, List<Language> altLanguages)
HunspellRule(ResourceBundle messages, Language language, UserConfig userConfig, List<Language> altLanguages, LanguageModel languageModel)

Method Summary

Modifier and Type	Method and Description
protected boolean	acceptSuggestion(String suggestion)
protected void	ensureInitialized()
static Queue<String>	getActiveChecks()
String	getDescription() A short description of the error this rule can detect, usually in the language of the text that is checked.
protected String	getDictFilenameInResources(String langCountry)
String	getId() A string used to identify the rule in e.g. configuration files.
protected String	getSentenceTextWithoutUrlsAndImmunizedTokens(AnalyzedSentence sentence)
List<String>	getSuggestions(String word)
protected void	init()
protected boolean	isInIgnoredSet(String word)
boolean	isMisspelled(String word)
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)
protected String[]	tokenizeText(String sentence)

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

Field Detail

RULE_ID

public static final String RULE_ID

See Also:

Constant Field Values

FILE_EXTENSION

protected static final String FILE_EXTENSION

See Also:

Constant Field Values

hunspell

protected volatile HunspellDictionary hunspell

nonWordPattern

protected Pattern nonWordPattern

Constructor Detail

HunspellRule

public HunspellRule(ResourceBundle messages,
                    Language language,
                    UserConfig userConfig)

HunspellRule

public HunspellRule(ResourceBundle messages,
                    Language language,
                    UserConfig userConfig,
                    List<Language> altLanguages)

Since:

4.3

HunspellRule

public HunspellRule(ResourceBundle messages,
                    Language language,
                    UserConfig userConfig,
                    List<Language> altLanguages,
                    LanguageModel languageModel)

Method Detail

getActiveChecks

public static Queue<String> getActiveChecks()

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 SpellingCheckRule

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 SpellingCheckRule

isQuotedCompound

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“)

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 SpellingCheckRule

Parameters:

sentence - a pre-analyzed sentence

Returns:

an array of RuleMatch objects

Throws:

IOException

acceptSuggestion

protected boolean acceptSuggestion(String suggestion)

isMisspelled

public boolean isMisspelled(String word)

Specified by:

isMisspelled in class SpellingCheckRule

Since:

public since 4.1

getSuggestions

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

Throws:

IOException

sortSuggestionByQuality

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

tokenizeText

protected String[] tokenizeText(String sentence)

getSentenceTextWithoutUrlsAndImmunizedTokens

protected String getSentenceTextWithoutUrlsAndImmunizedTokens(AnalyzedSentence sentence)

ensureInitialized

protected final void ensureInitialized()
                                throws IOException

Throws:

IOException

init

protected void init()
             throws IOException

Overrides:

init in class SpellingCheckRule

Throws:

IOException

getDictFilenameInResources

@NotNull
protected String getDictFilenameInResources(String langCountry)

isInIgnoredSet

protected boolean isInIgnoredSet(String word)

Overrides:

isInIgnoredSet in class SpellingCheckRule