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 and Description
protected Map<String,List<String>>	topSuggestions
protected 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, LANGUAGETOOL, LANGUAGETOOLER, MAX_TOKEN_LENGTH, wordListLoader, wordsToBeIgnored

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor and 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 and Description
protected List<SuggestedReplacement>	filterNoSuggestWords(List<SuggestedReplacement> l)
protected List<SuggestedReplacement>	filterSuggestions(List<SuggestedReplacement> suggestions) Remove prohibited words from suggestions.
protected List<SuggestedReplacement>	getAdditionalTopSuggestions(List<SuggestedReplacement> suggestions, String word) Get additional suggestions added before other suggestions (note the rule may choose to re-order the suggestions anyway).
protected List<SuggestedReplacement>	getOnlySuggestions(String word) Get suggestions that will replace all other suggestions.
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) Check whether the given sentence matches this error rule, i.e. whether it contains the error detected by this rule.
protected boolean	tokenizeNewWords()

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

getDescription, getFileName, getId, getSpellingSuggestions, ignoreWord, isEmoji, 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, getAdditionalSpellingFileNames, 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, 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

topSuggestions

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

topSuggestionsIgnoreCase

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

Constructor Detail

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 Detail

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.

Overrides:

match in class MorfologikSpellerRule

Parameters:

sentence - a pre-analyzed sentence

Returns:

an array of RuleMatch objects

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)

Description copied from class: SpellingCheckRule

Remove prohibited words from 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

Description copied from class: SpellingCheckRule

Get additional suggestions added before other suggestions (note the rule may choose to re-order the suggestions anyway). Only add suggestions here that you know are spelled correctly, they will not be checked again before being shown to the user.

Overrides:

getAdditionalTopSuggestions in class SpellingCheckRule

Throws:

IOException

Since:

2.7

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)

Description copied from class: SpellingCheckRule

Get suggestions that will replace all other suggestions. Only add suggestions here that you know are spelled correctly, they will not be checked again before being shown to the user.

Overrides:

getOnlySuggestions in class SpellingCheckRule