org.languagetool.rules

Class AbstractSimpleReplaceRule2

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.AbstractSimpleReplaceRule2

public abstract class AbstractSimpleReplaceRule2
extends Rule

A rule that matches words which should not be used and suggests correct ones instead.
Romanian implementations. Loads the list of words from /ro/replace.txt.

Unlike AbstractSimpleReplaceRule, supports multiple words (Ex: "aqua forte" => "acvaforte").

Note: Merge this into AbstractSimpleReplaceRule

Author:

Ionuț Păduraru

Field Summary

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor and Description
AbstractSimpleReplaceRule2(ResourceBundle messages, Language language)

Method Summary

Methods

Modifier and Type	Method and Description
abstract 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()
abstract String	getId() A string used to identify the rule in e.g. configuration files.
abstract Locale	getLocale() locale used on case-conversion
abstract String	getShort()
abstract String	getSuggestion()
abstract String	getSuggestionsSeparator()
List<Map<String,String>>	getWrongWords()
boolean	isCaseSensitive() use case-insensitive matching.
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.

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

AbstractSimpleReplaceRule2

public AbstractSimpleReplaceRule2(ResourceBundle messages,
                          Language language)
                           throws IOException

Throws:

IOException

Method Detail

getFileName

public abstract String getFileName()

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 Rule

getDescription

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

getShort

public abstract String getShort()

getSuggestion

public abstract String getSuggestion()

getSuggestionsSeparator

public abstract String getSuggestionsSeparator()

Returns:

the word used to separate multiple suggestions; used only before last suggestion, the rest are comma-separated.

getLocale

public abstract Locale getLocale()

locale used on case-conversion

isCaseSensitive

public boolean isCaseSensitive()

use case-insensitive matching.

getWrongWords

public List<Map<String,String>> getWrongWords()

Returns:

the list of wrong words for which this rule can suggest correction. The list cannot be modified.

match

public 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

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