Package org.languagetool.rules.spelling
Class SymSpellRule
java.lang.Object
org.languagetool.rules.Rule
org.languagetool.rules.spelling.SpellingCheckRule
org.languagetool.rules.spelling.SymSpellRule
spell checking using SymSpell algorithm, implementation from
https://github.com/Lundez/JavaSymSpell in org.languagetool.rules.spelling.symspell.implementation
potential faster alternative to Morfologik, especially in generating suggestions
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final SymSpell
private int
static final int
private SuggestionsOrderer
protected final SymSpell
private SymSpell.Verbosity
Fields inherited from class org.languagetool.rules.spelling.SpellingCheckRule
ignoreWordsWithLength, language, languageModel, LANGUAGETOOL, LANGUAGETOOLER, wordListLoader
-
Constructor Summary
ConstructorsConstructorDescriptionSymSpellRule
(ResourceBundle messages, Language language, UserConfig userConfig) SymSpellRule
(ResourceBundle messages, Language language, UserConfig userConfig, List<Language> altLanguages) SymSpellRule
(ResourceBundle messages, Language language, UserConfig userConfig, List<Language> altLanguages, @Nullable LanguageModel languageModel) -
Method Summary
Modifier and TypeMethodDescriptionfilterCandidates
(List<String> candidates) private static void
forEachLineInResources
(List<String> resources, Consumer<String> function) A short description of the error this rule can detect, usually in the language of the text that is checked.getId()
A string used to identify the rule in e.g.getSpellerMatches
(String word, SymSpell speller) protected static String
getWordList
(Language lang, String file) protected static SymSpell
private void
protected static @Nullable SymSpell
initUserDictSpeller
(UserConfig config) boolean
isMisspelled
(String word) static void
match
(AnalyzedSentence sentence) Check whether the given sentence matches this error rule, i.e.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, init, 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
-
spellerCache
-
ignoredWordsCache
-
INITIAL_CAPACITY
public static final int INITIAL_CAPACITY- See Also:
-
prohibitedWordsCache
-
defaultDictSpeller
-
userDictSpeller
-
editDistance
private int editDistance -
verbosity
-
orderer
-
-
Constructor Details
-
SymSpellRule
-
SymSpellRule
public SymSpellRule(ResourceBundle messages, Language language, UserConfig userConfig, List<Language> altLanguages) -
SymSpellRule
public SymSpellRule(ResourceBundle messages, Language language, UserConfig userConfig, List<Language> altLanguages, @Nullable @Nullable LanguageModel languageModel)
-
-
Method Details
-
getWordList
-
getSpellingDictBaseDir
-
forEachLineInResources
-
initUserDictSpeller
- Parameters:
config
-- Returns:
- Spell checker using users personal dictionary, or null if no custom speller is needed
-
initDefaultDictSpeller
-
initParameters
private void initParameters() -
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
-
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
-
isMisspelled
- Specified by:
isMisspelled
in classSpellingCheckRule
-
filterCandidates
-
getSpellerMatches
-
main
- Throws:
IOException
ClassNotFoundException
-