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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	AbstractEnglishSpellerRule.IrregularForms

Field Summary

Fields

Modifier and Type	Field	Description
private static final Pattern	ADDON
private static final Pattern	ADHOC
private static final Pattern	ADMITTINGLY
private static final Pattern	AFAIK
private static final Pattern	ALLRIGHT
private static final Pattern	APRIL
private static final Pattern	BASICLY
private static final Pattern	BELEIVES
private static final Pattern	BELIVES
private static final Pattern	BIZZARE
private static final String[]	blogLinks
private static final Pattern	BONAFIDE
private static final Pattern	CEMETARIES
private static final Pattern	CEMETARY
private static final Pattern	COMPLETLY
private static final Pattern	CONTAINS_TOKEN
private static final Pattern	DEACTIVE
private static final Pattern	DECEMBER
private static final Pattern	DEVOPS
private static final Pattern	DISSAPEARS
private static final Pattern	ENGLISH
private static final Pattern	EUROPEAN
private static final Pattern	EUROPEANS
private static final Pattern	FARENHEIT
private static final Pattern	FORSEEABLE
private static final Pattern	FORSEEABLY
private static final Pattern	FREINDS
private static final Pattern	FYI
private static final Pattern	GITLAB
private static final Pattern	HONGKONG
private static final Pattern	HTTP
private static final Pattern	HTTPS
private static final Pattern	HUBSPOT
private static final Pattern	INCIDENTLY
private static final Pattern	INTERUPTS
private static final Pattern	INTRANSPARENT
private static final Pattern	JANUARY
private static final Pattern	JETLAGGED
private static final Pattern	JIST
private static final Pattern	LANGUAGETOOL
private static final Set<String>	lcDoNotSuggestWords
private static final Pattern	LIKELYHOOD
private static final org.slf4j.Logger	logger
private static final Pattern	LOLLYPOPS
private static final Pattern	MACBOOK
private static final int	maxPatterns
private static final Pattern	MICROSOFT
private static final Pattern	MISSPELT
private static NERService	nerPipe
private static final Pattern	NOVEMBER
private static final Pattern	OCASSIONS
private static final Pattern	OCCURANCES
private static final Pattern	OCTOBER
private static final Pattern	PEICES
private static final Pattern	PERSISTANT
private static final Pattern	PROFILERATION
private static final Pattern	QUILLBOT_POS
private static final Pattern	QUILLBOT1
private static final Pattern	QUILLBOT1_POS
private static final Pattern	QUILLBOT2
private static final Pattern	QUILLBOT2_POS
private static final Pattern	SARGENT
private static final Pattern	SEIGES
private static final Pattern	SEPTEMBER
private static final Pattern	SPANISH
private static final Pattern	SUPERCEDES
private static final Pattern	SWIMMED
private static final Pattern	THRESHHOLDS
private static final Pattern	TOMMORROWS
protected final Map<String,List<String>>	topSuggestions
protected final Map<String,List<String>>	topSuggestionsIgnoreCase
private static final Pattern	TOUTES
private final BeoLingusTranslator	translator
private static final Pattern	TV
private static final Pattern	UNCOMPLIANT
private static final Pattern	UNDETERMINISTIC
private static final Pattern	UNECESSARY
private static final Pattern	UNFORSEEABLE
private static final Pattern	UNFORSEEABLY
private static final Pattern	URL
private static final Pattern	UX
private static final Pattern	WDYT
private static final Pattern	WHATSAPP
private static final Pattern	WHEREEVER
private static final Pattern	WIERD
private static final Pattern[]	wordPatterns

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
private void	addFormsToFirstMatch(String message, AnalyzedSentence sentence, List<RuleMatch> ruleMatches, List<String> forms)
protected void	addHyphenSuggestions(String[] parts, List<SuggestedReplacement> topSuggestions)
private static List<SuggestedReplacement>	cleanSuggestions(RuleMatch ruleMatch)
private List<RuleMatch>	filter(RuleMatch[] matches, String sentenceText, List<NERService.Span> namedEntities, LanguageModel languageModel)
protected List<SuggestedReplacement>	filterNoSuggestWords(List<SuggestedReplacement> l)
protected List<SuggestedReplacement>	filterSuggestions(List<SuggestedReplacement> suggestions)	Remove prohibited words from suggestions.
List<String>	getAdditionalSpellingFileNames()	Get the name of additional spelling file, which lists words to be accepted and used for suggestions, even when the spell checker would not accept them.
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).
private String	getHyphenatedWordSuggestion(String[] parts, int currentPos, String currentPostSuggestion)
private AbstractEnglishSpellerRule.IrregularForms	getIrregularFormsOrNull(String word)
private AbstractEnglishSpellerRule.IrregularForms	getIrregularFormsOrNull(String word, String wordSuffix, List<String> suffixes, String posTag, String posName, String formName)
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 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.
private void	replaceFormsOfFirstMatch(String message, AnalyzedSentence sentence, List<RuleMatch> ruleMatches, String suggestion)
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, 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, useInOffice

Methods inherited from class java.lang.Object

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

Field Details

logger

private static final org.slf4j.Logger logger

lcDoNotSuggestWords

private static final Set<String> lcDoNotSuggestWords

PROFILERATION

private static final Pattern PROFILERATION

CEMETARY

private static final Pattern CEMETARY

CEMETARIES

private static final Pattern CEMETARIES

BASICLY

private static final Pattern BASICLY

BELEIVES

private static final Pattern BELEIVES

BELIVES

private static final Pattern BELIVES

BIZZARE

private static final Pattern BIZZARE

COMPLETLY

private static final Pattern COMPLETLY

DISSAPEARS

private static final Pattern DISSAPEARS

FARENHEIT

private static final Pattern FARENHEIT

FREINDS

private static final Pattern FREINDS

INCIDENTLY

private static final Pattern INCIDENTLY

INTERUPTS

private static final Pattern INTERUPTS

LOLLYPOPS

private static final Pattern LOLLYPOPS

OCASSIONS

private static final Pattern OCASSIONS

OCCURANCES

private static final Pattern OCCURANCES

PERSISTANT

private static final Pattern PERSISTANT

PEICES

private static final Pattern PEICES

SEIGES

private static final Pattern SEIGES

SUPERCEDES

private static final Pattern SUPERCEDES

THRESHHOLDS

private static final Pattern THRESHHOLDS

TOMMORROWS

private static final Pattern TOMMORROWS

TOUTES

private static final Pattern TOUTES

WIERD

private static final Pattern WIERD

SARGENT

private static final Pattern SARGENT

SWIMMED

private static final Pattern SWIMMED

MISSPELT

private static final Pattern MISSPELT

JIST

private static final Pattern JIST

ADHOC

private static final Pattern ADHOC

DEACTIVE

private static final Pattern DEACTIVE

HONGKONG

private static final Pattern HONGKONG

AFAIK

private static final Pattern AFAIK

JANUARY

private static final Pattern JANUARY

ADMITTINGLY

private static final Pattern ADMITTINGLY

APRIL

private static final Pattern APRIL

SEPTEMBER

private static final Pattern SEPTEMBER

OCTOBER

private static final Pattern OCTOBER

NOVEMBER

private static final Pattern NOVEMBER

DECEMBER

private static final Pattern DECEMBER

ENGLISH

private static final Pattern ENGLISH

SPANISH

private static final Pattern SPANISH

GITLAB

private static final Pattern GITLAB

BONAFIDE

private static final Pattern BONAFIDE

WHEREEVER

private static final Pattern WHEREEVER

WHATSAPP

private static final Pattern WHATSAPP

JETLAGGED

private static final Pattern JETLAGGED

MACBOOK

private static final Pattern MACBOOK

LIKELYHOOD

private static final Pattern LIKELYHOOD

FORSEEABLE

private static final Pattern FORSEEABLE

UNFORSEEABLE

private static final Pattern UNFORSEEABLE

FORSEEABLY

private static final Pattern FORSEEABLY

UNFORSEEABLY

private static final Pattern UNFORSEEABLY

UNECESSARY

private static final Pattern UNECESSARY

HUBSPOT

private static final Pattern HUBSPOT

URL

private static final Pattern URL

TV

private static final Pattern TV

HTTP

private static final Pattern HTTP

HTTPS

private static final Pattern HTTPS

EUROPEAN

private static final Pattern EUROPEAN

EUROPEANS

private static final Pattern EUROPEANS

FYI

private static final Pattern FYI

MICROSOFT

private static final Pattern MICROSOFT

DEVOPS

private static final Pattern DEVOPS

ALLRIGHT

private static final Pattern ALLRIGHT

INTRANSPARENT

private static final Pattern INTRANSPARENT

ADDON

private static final Pattern ADDON

WDYT

private static final Pattern WDYT

UNCOMPLIANT

private static final Pattern UNCOMPLIANT

UX

private static final Pattern UX

LANGUAGETOOL

private static final Pattern LANGUAGETOOL

UNDETERMINISTIC

private static final Pattern UNDETERMINISTIC

QUILLBOT_POS

private static final Pattern QUILLBOT_POS

QUILLBOT1

private static final Pattern QUILLBOT1

QUILLBOT1_POS

private static final Pattern QUILLBOT1_POS

QUILLBOT2

private static final Pattern QUILLBOT2

QUILLBOT2_POS

private static final Pattern QUILLBOT2_POS

translator

private final BeoLingusTranslator translator

nerPipe

private static NERService nerPipe

maxPatterns

private static final int maxPatterns

See Also:

• Constant Field Values

wordPatterns

private static final Pattern[] wordPatterns

blogLinks

private static final String[] blogLinks

CONTAINS_TOKEN

private static final Pattern CONTAINS_TOKEN

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()

Description copied from class: SpellingCheckRule

Get the name of additional spelling file, which lists words to be accepted and used for suggestions, even when the spell checker would not accept them.

Overrides:

getAdditionalSpellingFileNames 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 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

filter

private List<RuleMatch> filter(RuleMatch[] matches,
 String sentenceText,
 List<NERService.Span> namedEntities,
 LanguageModel languageModel)

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

cleanSuggestions

private static List<SuggestedReplacement> cleanSuggestions(RuleMatch ruleMatch)

isValidInOtherVariant

@Nullable
protected VariantInfo isValidInOtherVariant(String word)

Since:

4.5

addFormsToFirstMatch

private void addFormsToFirstMatch(String message,
 AnalyzedSentence sentence,
 List<RuleMatch> ruleMatches,
 List<String> forms)

replaceFormsOfFirstMatch

private void replaceFormsOfFirstMatch(String message,
 AnalyzedSentence sentence,
 List<RuleMatch> ruleMatches,
 String suggestion)

getIrregularFormsOrNull

@Nullable
private AbstractEnglishSpellerRule.IrregularForms getIrregularFormsOrNull(String word)

getIrregularFormsOrNull

@Nullable
private AbstractEnglishSpellerRule.IrregularForms getIrregularFormsOrNull(String word,
 String wordSuffix,
 List<String> suffixes,
 String posTag,
 String posName,
 String formName)

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

addHyphenSuggestions

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

Overrides:

addHyphenSuggestions in class MorfologikSpellerRule

Throws:

IOException

getHyphenatedWordSuggestion

private String getHyphenatedWordSuggestion(String[] parts,
 int currentPos,
 String currentPostSuggestion)

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