org.languagetool.rules.uk

Class SimpleReplaceSpelling1992Rule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.AbstractSimpleReplaceRule

org.languagetool.rules.uk.SimpleReplaceSpelling1992Rule

public class SimpleReplaceSpelling1992Rule
extends AbstractSimpleReplaceRule

A rule that matches words that are written by 1992 spelling rules and suggests 2019 spelling instead. Loads the relevant words from rules/uk/replace_spelling_2019.txt.

Author:

Andriy Rysin

Field Summary

Fields inherited from class org.languagetool.rules.AbstractSimpleReplaceRule

ignoreTaggedWords, subRuleSpecificIds

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor and Description
SimpleReplaceSpelling1992Rule(ResourceBundle messages, Language language)

Method Summary

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.
String	getMessage(String tokenStr, List<String> replacements)
String	getShort()
Map<String,List<String>>	getWrongWords()
boolean	isCaseSensitive() Indicates if the rule is case-sensitive.
RuleMatch[]	match(AnalyzedSentence sentence) Check whether the given sentence matches this error rule, i.e. whether it contains the error detected by this rule.

Methods inherited from class org.languagetool.rules.AbstractSimpleReplaceRule

createRuleMatch, findMatches, getLocale, getSynthesizer, isCheckLemmas, isTagged, isTokenException, loadFromPath, loadFromPath, setCheckLemmas, setIgnoreTaggedWords, useSubRuleSpecificIds

Methods inherited from class org.languagetool.rules.Rule

addExamplePair, addTags, addToneTags, cacheAntiPatterns, estimateContextForSureMatch, getAntiPatterns, getCategory, getConfigureText, getCorrectExamples, getDefaultValue, getDistanceTokens, getErrorTriggeringExamples, getFullId, getIncorrectExamples, getLocQualityIssueType, getMaxConfigurableValue, getMinConfigurableValue, getMinPrevMatches, getSentenceWithImmunization, getSourceFile, getSubId, getTags, getToneTags, getUrl, hasConfigurableValue, hasTag, hasToneTag, isDefaultOff, isDefaultTempOff, isDictionaryBasedSpellingRule, isGoalSpecific, isOfficeDefaultOff, isOfficeDefaultOn, isPremium, makeAntiPatterns, setCategory, setCorrectExamples, setDefaultOff, setDefaultOn, setDefaultTempOff, setDistanceTokens, setErrorTriggeringExamples, setExamplePair, setGoalSpecific, setIncorrectExamples, setLocQualityIssueType, setMinPrevMatches, setOfficeDefaultOff, setOfficeDefaultOn, setPremium, setTags, setToneTags, setUrl, supportsLanguage, toRuleMatchArray, useInOffice

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleReplaceSpelling1992Rule

public SimpleReplaceSpelling1992Rule(ResourceBundle messages,
                                     Language language)
                              throws IOException

Throws:

IOException

Method Detail

getWrongWords

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

Specified by:

getWrongWords in class AbstractSimpleReplaceRule

getId

public final 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.

Overrides:

getId in class AbstractSimpleReplaceRule

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.

Overrides:

getDescription in class AbstractSimpleReplaceRule

getShort

public String getShort()

Overrides:

getShort in class AbstractSimpleReplaceRule

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.

Overrides:

match in class AbstractSimpleReplaceRule

Parameters:

sentence - a pre-analyzed sentence

Returns:

an array of RuleMatch objects

Throws:

IOException

getMessage

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

Overrides:

getMessage in class AbstractSimpleReplaceRule

isCaseSensitive

public boolean isCaseSensitive()

Description copied from class: AbstractSimpleReplaceRule

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

Overrides:

isCaseSensitive in class AbstractSimpleReplaceRule

Returns:

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