Package org.languagetool.rules.spelling

Class SymSpellRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.spelling.SpellingCheckRule

org.languagetool.rules.spelling.SymSpellRule

@Experimental
public class SymSpellRule
extends SpellingCheckRule

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

Fields

Modifier and Type	Field	Description
protected final SymSpell	defaultDictSpeller
private int	editDistance
private static final com.google.common.cache.LoadingCache<Language,Set<String>>	ignoredWordsCache
static final int	INITIAL_CAPACITY
private SuggestionsOrderer	orderer
private static final com.google.common.cache.LoadingCache<Language,Set<String>>	prohibitedWordsCache
private static final com.google.common.cache.LoadingCache<Language,SymSpell>	spellerCache
protected final SymSpell	userDictSpeller
private SymSpell.Verbosity	verbosity

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

ignoreWordsWithLength, language, languageModel, LANGUAGETOOL, LANGUAGETOOLER, wordListLoader

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor	Description
SymSpellRule(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 Type	Method	Description
private @NotNull List<String>	filterCandidates(List<String> candidates)
private static void	forEachLineInResources(List<String> resources, Consumer<String> function)
String	getDescription()	A short description of the error this rule can detect, usually in the language of the text that is checked.
String	getId()	A string used to identify the rule in e.g.
private @NotNull List<String>	getSpellerMatches(String word, SymSpell speller)
protected static String	getSpellingDictBaseDir(Language lang)
private static @NotNull Set<String>	getWordList(Language lang, String file)
protected static SymSpell	initDefaultDictSpeller(Language lang)
private void	initParameters()
protected static @Nullable SymSpell	initUserDictSpeller(UserConfig config)
boolean	isMisspelled(String word)
static void	main(String[] args)
RuleMatch[]	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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

spellerCache

private static final com.google.common.cache.LoadingCache<Language,SymSpell> spellerCache

ignoredWordsCache

private static final com.google.common.cache.LoadingCache<Language,Set<String>> ignoredWordsCache

INITIAL_CAPACITY

public static final int INITIAL_CAPACITY

See Also:

• Constant Field Values

prohibitedWordsCache

private static final com.google.common.cache.LoadingCache<Language,Set<String>> prohibitedWordsCache

defaultDictSpeller

protected final SymSpell defaultDictSpeller

userDictSpeller

protected final SymSpell userDictSpeller

editDistance

private int editDistance

verbosity

private SymSpell.Verbosity verbosity

orderer

private SuggestionsOrderer orderer

Constructor Details

SymSpellRule

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

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

@NotNull
private static @NotNull Set<String> getWordList(Language lang,
 String file)

getSpellingDictBaseDir

protected static String getSpellingDictBaseDir(Language lang)

forEachLineInResources

private static void forEachLineInResources(List<String> resources,
 Consumer<String> function)

initUserDictSpeller

@Nullable
protected static @Nullable SymSpell initUserDictSpeller(UserConfig config)

Parameters:

config -

Returns:

Spell checker using users personal dictionary, or null if no custom speller is needed

initDefaultDictSpeller

protected static SymSpell initDefaultDictSpeller(Language lang)

initParameters

private void initParameters()

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

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 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 class SpellingCheckRule

Parameters:

sentence - a pre-analyzed sentence

Returns:

an array of RuleMatch objects

Throws:

IOException

isMisspelled

public boolean isMisspelled(String word)

Specified by:

isMisspelled in class SpellingCheckRule

filterCandidates

@NotNull
private @NotNull List<String> filterCandidates(List<String> candidates)

getSpellerMatches

@NotNull
private @NotNull List<String> getSpellerMatches(String word,
 SymSpell speller)

main

public static void main(String[] args)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException