Class HunspellRule
java.lang.Object
org.languagetool.rules.Rule
org.languagetool.rules.spelling.SpellingCheckRule
org.languagetool.rules.spelling.hunspell.HunspellRule
- Direct Known Subclasses:
CompoundAwareHunspellRule
,HunspellNoSuggestionRule
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!
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final ConcurrentLinkedQueue<String>
protected static final String
protected Hunspell.Dictionary
private final boolean
protected boolean
private static final String
protected Pattern
static final String
private final boolean
protected final SuggestionsOrderer
private final UserConfig
private static final String[]
Fields inherited from class org.languagetool.rules.spelling.SpellingCheckRule
ignoreWordsWithLength, language, languageModel, LANGUAGETOOL, LANGUAGETOOLER, wordListLoader
-
Constructor Summary
ConstructorsConstructorDescriptionHunspellRule
(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 TypeMethodDescriptionprivate void
private String
private void
fileCopy
(InputStream in, File targetFile) A short description of the error this rule can detect, usually in the language of the text that is checked.protected @NotNull String
getDictFilenameInResources
(String langCountry) private String
getDictionaryPath
(String dicName, String originalPath) getId()
A string used to identify the rule in e.g.protected String
getSuggestions
(String word) protected void
init()
protected boolean
isAcceptedWordFromLanguage
(Language language, String word) Used in combination withacceptedInAlternativeLanguage
to surpress spelling errors for words from a foreign languageboolean
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“)match
(AnalyzedSentence sentence) Check whether the given sentence matches this error rule, i.e.sortSuggestionByQuality
(String misspelling, List<String> suggestions) protected String[]
tokenizeText
(String sentence) Methods inherited from class org.languagetool.rules.spelling.SpellingCheckRule
acceptedInAlternativeLanguage, acceptPhrases, addIgnoreTokens, addIgnoreWords, addProhibitedWords, addSuggestionsToRuleMatch, createWrongSplitMatch, expandLine, filterDupes, filterSuggestions, getAdditionalProhibitFileNames, getAdditionalSpellingFileNames, getAdditionalSuggestions, getAdditionalTopSuggestions, getAlternativeLangSpellingRules, getAntiPatterns, getIgnoreFileName, getLanguageVariantSpellingFileName, getProhibitFileName, getSpellingFileName, ignoreToken, ignoreWord, ignoreWord, isDictionaryBasedSpellingRule, isEMail, isProhibited, isUrl, reorderSuggestions, setConsiderIgnoreWords, setConvertsCase, startsWithIgnoredWord
Methods inherited from class org.languagetool.rules.Rule
addExamplePair, estimateContextForSureMatch, getCategory, getConfigureText, getCorrectExamples, getDefaultValue, getErrorTriggeringExamples, getIncorrectExamples, getLocQualityIssueType, getMaxConfigurableValue, getMinConfigurableValue, getSentenceWithImmunization, getUrl, hasConfigurableValue, isDefaultOff, isDefaultTempOff, isOfficeDefaultOff, isOfficeDefaultOn, makeAntiPatterns, setCategory, setCorrectExamples, setDefaultOff, setDefaultOn, setDefaultTempOff, setErrorTriggeringExamples, setIncorrectExamples, setLocQualityIssueType, setOfficeDefaultOff, setOfficeDefaultOn, setUrl, supportsLanguage, toRuleMatchArray, useInOffice
-
Field Details
-
RULE_ID
- See Also:
-
FILE_EXTENSION
- See Also:
-
suggestionsOrderer
-
needsInit
protected boolean needsInit -
hunspellDict
-
activeChecks
-
NON_ALPHABETIC
- See Also:
-
monitorRules
private final boolean monitorRules -
runningExperiment
private final boolean runningExperiment -
WHITESPACE_ARRAY
-
nonWordPattern
-
userConfig
-
-
Constructor Details
-
HunspellRule
-
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 Details
-
getActiveChecks
-
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 charactersA-Z
and the underscore.- Specified by:
getId
in classSpellingCheckRule
-
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 classSpellingCheckRule
-
isQuotedCompound
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
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 than 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).- Specified by:
match
in classSpellingCheckRule
- Parameters:
sentence
- a pre-analyzed sentence- Returns:
- an array of
RuleMatch
objects - Throws:
IOException
-
cutOffDot
-
isMisspelled
- Specified by:
isMisspelled
in classSpellingCheckRule
- Since:
- public since 4.1
-
getSuggestions
- Throws:
IOException
-
sortSuggestionByQuality
-
tokenizeText
-
getSentenceTextWithoutUrlsAndImmunizedTokens
-
init
- Overrides:
init
in classSpellingCheckRule
- Throws:
IOException
-
getDictFilenameInResources
-
addIgnoreWords
- Throws:
IOException
-
getDictionaryPath
- Throws:
IOException
-
fileCopy
- Throws:
IOException
-
isAcceptedWordFromLanguage
Used in combination withacceptedInAlternativeLanguage
to surpress spelling errors for words from a foreign language- Parameters:
language
-word
-- Returns:
- true if the
word
fromlanguage
can be considered as correctly spelled - Since:
- 4.6
-