org.languagetool.rules

Class AbstractSimpleReplaceRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.AbstractSimpleReplaceRule

public abstract class AbstractSimpleReplaceRule
extends Rule

A rule that matches words which should not be used and suggests correct ones instead. Loads the relevant words from rules/XX/replace.txt, where XX is a code of the language.

Author:

Andriy Rysin

Field Summary

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor and Description
AbstractSimpleReplaceRule(ResourceBundle messages)

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	getEncoding() Deprecated. will be removed, it was always "utf-8" anyway (deprecated since 3.0)
String	getId() A string used to identify the rule in e.g. configuration files.
Locale	getLocale()
String	getMessage(String tokenStr, List<String> replacements)
String	getShort()
protected abstract Map<String,List<String>>	getWrongWords()
boolean	isCaseSensitive() Indicates if the rule is case-sensitive.
boolean	isCheckLemmas()
protected boolean	isTagged(AnalyzedTokenReadings tokenReadings) This method allows to override which tags will mark token as tagged
protected static Map<String,List<String>>	load(String path)
RuleMatch[]	match(AnalyzedSentence sentence) Check whether the given sentence matches this error rule, i.e. whether it contains the error detected by this rule.
void	reset() If a rule keeps its state over more than the check of one sentence, this must be implemented so the internal state is reset.
void	setCheckLemmas(boolean checkLemmas) Used to disable matching lemmas.
void	setIgnoreTaggedWords() Skip words that are known in the POS tagging dictionary, assuming they cannot be incorrect.

Methods inherited from class org.languagetool.rules.Rule

addExamplePair, getCategory, getCorrectExamples, getIncorrectExamples, getLocQualityIssueType, getUrl, isDefaultOff, isDictionaryBasedSpellingRule, 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

Constructor Detail

AbstractSimpleReplaceRule

public AbstractSimpleReplaceRule(ResourceBundle messages)
                          throws IOException

Throws:

IOException

Method Detail

getWrongWords

protected abstract Map<String,List<String>> getWrongWords()

load

protected static Map<String,List<String>> load(String path)

getEncoding

public String getEncoding()

Deprecated. will be removed, it was always "utf-8" anyway (deprecated since 3.0)

isCaseSensitive

public boolean isCaseSensitive()

Indicates if the rule is case-sensitive. Default value is true.

Returns:

true if the rule is case-sensitive, false otherwise.

getLocale

public Locale getLocale()

Returns:

the locale used for case conversion when isCaseSensitive() is set to false.

setIgnoreTaggedWords

public void setIgnoreTaggedWords()

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

Since:

2.3

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 Rule

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 Rule

getMessage

public String getMessage(String tokenStr,
                List<String> replacements)

getShort

public String getShort()

match

public final RuleMatch[] match(AnalyzedSentence sentence)

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 Rule

Parameters:

sentence - a pre-analyzed sentence

Returns:

an array of RuleMatch objects

isTagged

protected boolean isTagged(AnalyzedTokenReadings tokenReadings)

This method allows to override which tags will mark token as tagged

Returns:

returns true if token has valid tag

isCheckLemmas

public boolean isCheckLemmas()

Since:

2.5

setCheckLemmas

public void setCheckLemmas(boolean checkLemmas)

Used to disable matching lemmas.

Since:

2.5

reset

public void reset()

Description copied from class: Rule

If a rule keeps its state over more than the check of one sentence, this must be implemented so the internal state is reset. It will be called before a new text is going to be checked.

Specified by:

reset in class Rule