org.languagetool.rules.spelling.hunspell

Class HunspellRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.spelling.SpellingCheckRule

org.languagetool.rules.spelling.hunspell.HunspellRule

Direct Known Subclasses:

CompoundAwareHunspellRule, HunspellNoSuggestionRule

public class HunspellRule
extends SpellingCheckRule

A hunspell-based spellchecking-rule. The default dictionary is set to the first country variant on the list - so the order in the Language class declaration is important!

Author:

Marcin Miłkowski

Field Summary

Fields

Modifier and Type	Field and Description
protected Hunspell.Dictionary	hunspellDict
protected boolean	needsInit
static String	RULE_ID

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
HunspellRule(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.
String	getId() A string used to identify the rule in e.g. configuration files.
List<String>	getSuggestions(String word)
protected void	init()
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 String[]	tokenizeText(String sentence)

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

addIgnoreTokens, addIgnoreWords, expandLine, filterSuggestions, getAdditionalSuggestions, getAdditionalTopSuggestions, getIgnoreFileName, getProhibitFileName, getSpellingFileName, ignoreToken, ignoreWord, ignoreWord, 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

RULE_ID

public static final String RULE_ID

See Also:

Constant Field Values

needsInit

protected boolean needsInit

hunspellDict

protected Hunspell.Dictionary hunspellDict

Constructor Detail

HunspellRule

public HunspellRule(ResourceBundle messages,
            Language language)

Method Detail

getId

public 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

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

getSuggestions

public List<String> getSuggestions(String word)
                            throws IOException

Throws:

IOException

tokenizeText

protected String[] tokenizeText(String sentence)

init

protected void init()
             throws IOException

Overrides:

init in class SpellingCheckRule

Throws:

IOException