Package org.languagetool.rules.en

Class AbstractEnglishSpellerRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.spelling.SpellingCheckRule

org.languagetool.rules.spelling.morfologik.MorfologikSpellerRule

org.languagetool.rules.en.AbstractEnglishSpellerRule

Direct Known Subclasses:

MorfologikAmericanSpellerRule, MorfologikAustralianSpellerRule, MorfologikBritishSpellerRule, MorfologikCanadianSpellerRule, MorfologikNewZealandSpellerRule, MorfologikSouthAfricanSpellerRule

public abstract class AbstractEnglishSpellerRule
extends MorfologikSpellerRule

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<String,List<String>>	topSuggestions
protected final Map<String,List<String>>	topSuggestionsIgnoreCase

Fields inherited from class org.languagetool.rules.spelling.morfologik.MorfologikSpellerRule

conversionLocale, globalConfig, motherTongue, speller1, speller2, speller3

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

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

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor	Description
AbstractEnglishSpellerRule(ResourceBundle messages, Language language)
AbstractEnglishSpellerRule(ResourceBundle messages, Language language, GlobalConfig globalConfig, UserConfig userConfig, List<Language> altLanguages, LanguageModel languageModel, Language motherTongue)
AbstractEnglishSpellerRule(ResourceBundle messages, Language language, UserConfig userConfig, List<Language> altLanguages)

Method Summary

Modifier and Type	Method	Description
protected void	addHyphenSuggestions(String[] parts, List<SuggestedReplacement> topSuggestions)
protected List<SuggestedReplacement>	filterNoSuggestWords(List<SuggestedReplacement> l)
protected List<SuggestedReplacement>	filterSuggestions(List<SuggestedReplacement> suggestions)
List<String>	getAdditionalSpellingFileNames()
protected List<SuggestedReplacement>	getAdditionalTopSuggestions(List<SuggestedReplacement> suggestions, String word)
protected List<SuggestedReplacement>	getOnlySuggestions(String word)
protected List<RuleMatch>	getRuleMatches(String word, int startPos, AnalyzedSentence sentence, List<RuleMatch> ruleMatchesSoFar, int idx, AnalyzedTokenReadings[] tokens)
protected static Map<String,List<String>>	getTopSuggestions()
protected static Map<String,List<String>>	getTopSuggestionsIgnoreCase()
protected Translator	getTranslator(GlobalConfig globalConfig)
protected org.languagetool.rules.en.VariantInfo	isValidInOtherVariant(String word)
protected static Map<String,String>	loadWordlist(String path, int column)
RuleMatch[]	match(AnalyzedSentence sentence)
protected boolean	tokenizeNewWords()

Methods inherited from class org.languagetool.rules.spelling.morfologik.MorfologikSpellerRule

getDescription, getFileName, getId, getSpellingSuggestions, ignoreWord, isMisspelled, isMisspelled, orderSuggestions, setCheckCompound, setCompoundRegex, setIgnoreTaggedWords, setLocale, tokenizingPattern

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

acceptPhrases, addIgnoreTokens, addIgnoreWords, addProhibitedWords, addSuggestionsToRuleMatch, createWrongSplitMatch, expandLine, filterDupes, getAdditionalProhibitFileNames, getAdditionalSuggestions, getAntiPatterns, getIgnoreFileName, getLanguageVariantSpellingFileName, getProhibitFileName, getSpellingFileName, ignorePotentiallyMisspelledWord, ignoreToken, ignoreWord, init, isDictionaryBasedSpellingRule, isEMail, isIgnoredNoCase, isInIgnoredSet, isLatinScript, isProhibited, isUrl, setConsiderIgnoreWords, setConvertsCase, startsWithIgnoredWord

Methods inherited from class org.languagetool.rules.Rule

addExamplePair, addTags, addToneTags, cacheAntiPatterns, estimateContextForSureMatch, getCategory, getCorrectExamples, getDistanceTokens, getErrorTriggeringExamples, getFullId, getIncorrectExamples, getLocQualityIssueType, getMinPrevMatches, getPriority, getRuleOptions, getSentenceWithImmunization, getSourceFile, getSubId, getTags, getToneTags, getUrl, hasTag, hasToneTag, isDefaultOff, isDefaultTempOff, isGoalSpecific, isIncludedInErrorsCorrectedAllAtOnce, isIncludedInHiddenMatches, isOfficeDefaultOff, isOfficeDefaultOn, isPremium, makeAntiPatterns, setCategory, setCorrectExamples, setDefaultOff, setDefaultOn, setDefaultTempOff, setDistanceTokens, setErrorTriggeringExamples, setExamplePair, setGoalSpecific, setIncludedInHiddenMatches, setIncorrectExamples, setLocQualityIssueType, setMinPrevMatches, setOfficeDefaultOff, setOfficeDefaultOn, setPremium, setPriority, setTags, setToneTags, setUrl, supportsLanguage, toRuleMatchArray, useDictionaryBasedFilterForMatches, useInOffice

Methods inherited from class java.lang.Object

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

Field Details

topSuggestions

protected final Map<String,List<String>> topSuggestions

topSuggestionsIgnoreCase

protected final Map<String,List<String>> topSuggestionsIgnoreCase

Constructor Details

AbstractEnglishSpellerRule

public AbstractEnglishSpellerRule(ResourceBundle messages,
 Language language)
                           throws IOException

Throws:

IOException

AbstractEnglishSpellerRule

public AbstractEnglishSpellerRule(ResourceBundle messages,
 Language language,
 UserConfig userConfig,
 List<Language> altLanguages)
                           throws IOException

Throws:

IOException

Since:

4.4

AbstractEnglishSpellerRule

public AbstractEnglishSpellerRule(ResourceBundle messages,
 Language language,
 GlobalConfig globalConfig,
 UserConfig userConfig,
 List<Language> altLanguages,
 LanguageModel languageModel,
 Language motherTongue)
                           throws IOException

Throws:

IOException

Since:

4.5 optional: language model for better suggestions

Method Details

getAdditionalSpellingFileNames

public List<String> getAdditionalSpellingFileNames()

Overrides:

getAdditionalSpellingFileNames in class SpellingCheckRule

match

public RuleMatch[] match(AnalyzedSentence sentence)
                  throws IOException

Overrides:

match in class MorfologikSpellerRule

Throws:

IOException

filterNoSuggestWords

protected List<SuggestedReplacement> filterNoSuggestWords(List<SuggestedReplacement> l)

Overrides:

filterNoSuggestWords in class SpellingCheckRule

loadWordlist

protected static Map<String,String> loadWordlist(String path,
 int column)

filterSuggestions

protected List<SuggestedReplacement> filterSuggestions(List<SuggestedReplacement> suggestions)

Overrides:

filterSuggestions in class SpellingCheckRule

getRuleMatches

protected List<RuleMatch> getRuleMatches(String word,
 int startPos,
 AnalyzedSentence sentence,
 List<RuleMatch> ruleMatchesSoFar,
 int idx,
 AnalyzedTokenReadings[] tokens)
                                  throws IOException

Overrides:

getRuleMatches in class MorfologikSpellerRule

Throws:

IOException

isValidInOtherVariant

@Nullable
protected org.languagetool.rules.en.VariantInfo isValidInOtherVariant(String word)

Since:

4.5

getTopSuggestionsIgnoreCase

protected static Map<String,List<String>> getTopSuggestionsIgnoreCase()

getTopSuggestions

protected static Map<String,List<String>> getTopSuggestions()

getAdditionalTopSuggestions

protected List<SuggestedReplacement> getAdditionalTopSuggestions(List<SuggestedReplacement> suggestions,
 String word)
                                                          throws IOException

Overrides:

getAdditionalTopSuggestions in class SpellingCheckRule

Throws:

IOException

Since:

2.7

addHyphenSuggestions

protected void addHyphenSuggestions(String[] parts,
 List<SuggestedReplacement> topSuggestions)
                             throws IOException

Overrides:

addHyphenSuggestions in class MorfologikSpellerRule

Throws:

IOException

getTranslator

protected Translator getTranslator(GlobalConfig globalConfig)

Overrides:

getTranslator in class MorfologikSpellerRule

tokenizeNewWords

protected boolean tokenizeNewWords()

Overrides:

tokenizeNewWords in class SpellingCheckRule

getOnlySuggestions

protected List<SuggestedReplacement> getOnlySuggestions(String word)

Overrides:

getOnlySuggestions in class SpellingCheckRule