Package org.languagetool.rules.spelling.morfologik

Class MorfologikSpellerRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.spelling.SpellingCheckRule

org.languagetool.rules.spelling.morfologik.MorfologikSpellerRule

Direct Known Subclasses:

AbstractEnglishSpellerRule, MorfologikAsturianSpellerRule, MorfologikBelarusianSpellerRule, MorfologikBretonSpellerRule, MorfologikCatalanSpellerRule, MorfologikCrimeanTatarSpellerRule, MorfologikDutchSpellerRule, MorfologikFrenchSpellerRule, MorfologikGermanyGermanSpellerRule, MorfologikGreekSpellerRule, MorfologikIrishSpellerRule, MorfologikItalianSpellerRule, MorfologikPolishSpellerRule, MorfologikPortugueseSpellerRule, MorfologikRomanianSpellerRule, MorfologikRussianSpellerRule, MorfologikRussianYOSpellerRule, MorfologikSlovakSpellerRule, MorfologikSlovenianSpellerRule, MorfologikSpanishSpellerRule, MorfologikTagalogSpellerRule, MorfologikUkrainianSpellerRule

public abstract class MorfologikSpellerRule
extends SpellingCheckRule

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	MorfologikSpellerRule.PhraseToTranslate

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	checkCompound
private Pattern	compoundRegex
protected Locale	conversionLocale
protected final GlobalConfig	globalConfig
private boolean	ignoreTaggedWords
private static final org.slf4j.Logger	logger
(package private) static final int	MAX_FREQUENCY_FOR_SPLITTING
protected final Language	motherTongue
private static final Pattern	pStartsWithNumbersBullets
private static final Pattern	pStartsWithNumbersBulletsExceptions
protected MorfologikMultiSpeller	speller1
protected MorfologikMultiSpeller	speller2
protected MorfologikMultiSpeller	speller3
private final UserConfig	userConfig

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	Description
MorfologikSpellerRule(ResourceBundle messages, Language language)
MorfologikSpellerRule(ResourceBundle messages, Language language, GlobalConfig globalConfig, UserConfig userConfig, List<Language> altLanguages, LanguageModel languageModel, Language motherTongue)
MorfologikSpellerRule(ResourceBundle messages, Language language, UserConfig userConfig)
MorfologikSpellerRule(ResourceBundle messages, Language language, UserConfig userConfig, List<Language> altLanguages)

Method Summary

Modifier and Type	Method	Description
protected void	addHyphenSuggestions(String[] split, List<SuggestedReplacement> topSuggestions)
private Supplier<List<SuggestedReplacement>>	appendLazySuggestions(String word, String beforeSuggestionStr, String afterSuggestionStr, boolean fullResults, List<SuggestedReplacement> prev)
private List<SuggestedReplacement>	calcSpellerSuggestions(String word, boolean fullResults)
private boolean	canBeIgnored(AnalyzedTokenReadings[] tokens, int idx, AnalyzedTokenReadings token)
String	getDescription()	A short description of the error this rule can detect, usually in the language of the text that is checked.
abstract String	getFileName()	Get the filename, e.g., /resource/pl/spelling.dict.
private static int	getFrequency(MorfologikMultiSpeller speller, String word)
abstract String	getId()	A string used to identify the rule in e.g.
protected List<RuleMatch>	getRuleMatches(String word, int startPos, AnalyzedSentence sentence, List<RuleMatch> ruleMatchesSoFar, int idx, AnalyzedTokenReadings[] tokens)
List<String>	getSpellingSuggestions(String w)
protected Translator	getTranslator(GlobalConfig globalConfig)
protected boolean	ignoreWord(String word)	Ignore surrogate pairs (emojis)
private void	initSpeller(String binaryDict)
private boolean	initSpellers()
boolean	isMisspelled(String word)
protected boolean	isMisspelled(MorfologikMultiSpeller speller, String word)
private static List<SuggestedReplacement>	joinBeforeAfterSuggestions(List<SuggestedReplacement> suggestionsList, String beforeSuggestionStr, String afterSuggestionStr)	Join strings before and after a suggestion.
RuleMatch[]	match(AnalyzedSentence sentence)	Check whether the given sentence matches this error rule, i.e.
private static List<SuggestedReplacement>	mergeSuggestionsWithSameTranslation(List<SuggestedReplacement> l)
protected List<SuggestedReplacement>	orderSuggestions(List<SuggestedReplacement> suggestions, String word)
protected void	setCheckCompound(boolean checkCompound)
protected void	setCompoundRegex(String compoundRegex)
void	setIgnoreTaggedWords()	Skip words that are known in the POS tagging dictionary, assuming they cannot be incorrect.
void	setLocale(Locale locale)
Pattern	tokenizingPattern()	Get the regular expression pattern used to tokenize the words as in the source dictionary.

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

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

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

speller1

protected MorfologikMultiSpeller speller1

speller2

protected MorfologikMultiSpeller speller2

speller3

protected MorfologikMultiSpeller speller3

conversionLocale

protected Locale conversionLocale

motherTongue

protected final Language motherTongue

globalConfig

protected final GlobalConfig globalConfig

ignoreTaggedWords

private boolean ignoreTaggedWords

checkCompound

private boolean checkCompound

compoundRegex

private Pattern compoundRegex

userConfig

private final UserConfig userConfig

MAX_FREQUENCY_FOR_SPLITTING

static final int MAX_FREQUENCY_FOR_SPLITTING

See Also:

• Constant Field Values

pStartsWithNumbersBullets

private static final Pattern pStartsWithNumbersBullets

pStartsWithNumbersBulletsExceptions

private static final Pattern pStartsWithNumbersBulletsExceptions

Constructor Details

MorfologikSpellerRule

public MorfologikSpellerRule(ResourceBundle messages,
 Language language)
                      throws IOException

Throws:

IOException

MorfologikSpellerRule

public MorfologikSpellerRule(ResourceBundle messages,
 Language language,
 UserConfig userConfig)
                      throws IOException

Throws:

IOException

MorfologikSpellerRule

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

Throws:

IOException

MorfologikSpellerRule

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

Throws:

IOException

Method Details

getFileName

public abstract String getFileName()

Get the filename, e.g., /resource/pl/spelling.dict.

getId

public abstract 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

setLocale

public void setLocale(Locale locale)

setIgnoreTaggedWords

public void setIgnoreTaggedWords()

Skip words that are known in the POS tagging dictionary, assuming they cannot be incorrect.

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.

Specified by:

match in class SpellingCheckRule

Parameters:

sentence - a pre-analyzed sentence

Returns:

an array of RuleMatch objects

Throws:

IOException

getTranslator

@Nullable
protected Translator getTranslator(GlobalConfig globalConfig)

initSpellers

private boolean initSpellers()
                      throws IOException

Throws:

IOException

initSpeller

private void initSpeller(String binaryDict)
                  throws IOException

Throws:

IOException

canBeIgnored

private boolean canBeIgnored(AnalyzedTokenReadings[] tokens,
 int idx,
 AnalyzedTokenReadings token)
                      throws IOException

Throws:

IOException

isMisspelled

@Experimental
public boolean isMisspelled(String word)
                     throws IOException

Specified by:

isMisspelled in class SpellingCheckRule

Throws:

IOException

Since:

4.8

isMisspelled

protected boolean isMisspelled(MorfologikMultiSpeller speller,
 String word)

Returns:

true if the word is misspelled

Since:

2.4

getFrequency

private static int getFrequency(MorfologikMultiSpeller speller,
 String word)

getRuleMatches

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

Throws:

IOException

appendLazySuggestions

private Supplier<List<SuggestedReplacement>> appendLazySuggestions(String word,
 String beforeSuggestionStr,
 String afterSuggestionStr,
 boolean fullResults,
 List<SuggestedReplacement> prev)

calcSpellerSuggestions

private List<SuggestedReplacement> calcSpellerSuggestions(String word,
 boolean fullResults)
                                                   throws IOException

Throws:

IOException

addHyphenSuggestions

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

Throws:

IOException

mergeSuggestionsWithSameTranslation

@NotNull
private static List<SuggestedReplacement> mergeSuggestionsWithSameTranslation(List<SuggestedReplacement> l)

tokenizingPattern

@Nullable
public Pattern tokenizingPattern()

Get the regular expression pattern used to tokenize the words as in the source dictionary. For example, it may contain a hyphen, if the words with hyphens are not included in the dictionary

Returns:

A compiled Pattern that is used to tokenize words or null.

orderSuggestions

protected List<SuggestedReplacement> orderSuggestions(List<SuggestedReplacement> suggestions,
 String word)

setCheckCompound

protected void setCheckCompound(boolean checkCompound)

Parameters:

checkCompound - If true and the word is not in the dictionary it will be split (see setCompoundRegex(String)) and each component will be checked separately

Since:

2.4

setCompoundRegex

protected void setCompoundRegex(String compoundRegex)

Parameters:

compoundRegex - see setCheckCompound(boolean)

Since:

2.4

ignoreWord

protected boolean ignoreWord(String word)
                      throws IOException

Ignore surrogate pairs (emojis)

Overrides:

ignoreWord in class SpellingCheckRule

Throws:

IOException

Since:

4.3

See Also:

• SpellingCheckRule.ignoreWord(java.lang.String)

joinBeforeAfterSuggestions

private static List<SuggestedReplacement> joinBeforeAfterSuggestions(List<SuggestedReplacement> suggestionsList,
 String beforeSuggestionStr,
 String afterSuggestionStr)

Join strings before and after a suggestion. Used when there is also suggestion for split words Ex. to thow > tot how | to throw

getSpellingSuggestions

public List<String> getSpellingSuggestions(String w)
                                    throws IOException

Throws:

IOException