org.languagetool.rules.uk

Class SimpleReplaceSoftRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.AbstractSimpleReplaceRule

org.languagetool.rules.uk.SimpleReplaceSoftRule

public class SimpleReplaceSoftRule
extends AbstractSimpleReplaceRule

A rule that matches words for which better alternatives exist and suggests them instead. On top of generic replacement list supports allowed word contexts, e.g. спасіння=ctx: релігія,поезія|рятування|... Loads the relevant words from rules/uk/replace_soft.txt. TODO: AbstractSimpleReplaceRule loads context as part of suggestion list and to be able to merge contexts for different lemmas we need to extract context out of suggestions list on every match. We may need to write our own replacement loader to make it right.

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
SimpleReplaceSoftRule(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.
protected boolean	isTokenException(AnalyzedTokenReadings atr)

Methods inherited from class org.languagetool.rules.AbstractSimpleReplaceRule

createRuleMatch, findMatches, getLocale, getSynthesizer, isCheckLemmas, isTagged, loadFromPath, loadFromPath, match, 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

SimpleReplaceSoftRule

public SimpleReplaceSoftRule(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

getMessage

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

Overrides:

getMessage in class AbstractSimpleReplaceRule

isTokenException

protected boolean isTokenException(AnalyzedTokenReadings atr)

Overrides:

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