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

public abstract class MorfologikSpellerRule
extends SpellingCheckRule

Field Summary

Fields

Modifier and Type	Field and Description
protected Locale	conversionLocale
protected MorfologikMultiSpeller	speller1
protected MorfologikMultiSpeller	speller2

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

language, LANGUAGETOOL, LANGUAGETOOL_FX

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor and Description
MorfologikSpellerRule(ResourceBundle messages, Language language)

Method Summary

Methods

Modifier and Type	Method and Description
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.
abstract String	getId() A string used to identify the rule in e.g. configuration files.
protected List<RuleMatch>	getRuleMatches(String word, int startPos)
protected boolean	isMisspelled(MorfologikMultiSpeller speller, String word)
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 List<String>	orderSuggestions(List<String> 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

addIgnoreTokens, addIgnoreWords, expandLine, filterSuggestions, getAdditionalSuggestions, getAdditionalTopSuggestions, getIgnoreFileName, getProhibitFileName, getSpellingFileName, ignoreToken, ignoreWord, ignoreWord, init, isConvertsCase, isDictionaryBasedSpellingRule, isProhibited, isUrl, reset, setConsiderIgnoreWords, setConvertsCase

Methods inherited from class org.languagetool.rules.Rule

addExamplePair, getCategory, getCorrectExamples, getIncorrectExamples, getLocQualityIssueType, getUrl, isDefaultOff, setCategory, setCorrectExamples, setDefaultOff, setDefaultOn, setIncorrectExamples, setLocQualityIssueType, setUrl, supportsLanguage, toRuleMatchArray, useInOffice

Methods inherited from class java.lang.Object

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

Field Detail

speller1

protected MorfologikMultiSpeller speller1

speller2

protected MorfologikMultiSpeller speller2

conversionLocale

protected Locale conversionLocale

Constructor Detail

MorfologikSpellerRule

public MorfologikSpellerRule(ResourceBundle messages,
                     Language language)
                      throws IOException

Throws:

IOException

Method Detail

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

protected boolean isMisspelled(MorfologikMultiSpeller speller,
                   String word)

Returns:

true if the word is misspelled

Since:

2.4

getRuleMatches

protected List<RuleMatch> getRuleMatches(String word,
                             int startPos)
                                  throws IOException

Throws:

IOException

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<String> orderSuggestions(List<String> 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