Package org.languagetool.rules
Class AbstractSimpleReplaceRule2
java.lang.Object
org.languagetool.rules.Rule
org.languagetool.rules.AbstractSimpleReplaceRule2
A rule that matches words which should not be used and suggests correct ones instead.
Unlike AbstractSimpleReplaceRule, it supports phrases (Ex: "aqua forte" -> "acvaforte").
Note: Merge this into AbstractSimpleReplaceRule
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) static class
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate void
addToQueue
(AnalyzedTokenReadings token, Queue<AnalyzedTokenReadings> prevTokens) abstract String
A short description of the error this rule can detect, usually in the language of the text that is checked.abstract String
abstract String
getId()
A string used to identify the rule in e.g.abstract Locale
locale used on case-conversionabstract String
getShort()
abstract String
abstract String
boolean
use case-sensitive matching.protected boolean
isException
(String matchedText) Load the list of words.match
(AnalyzedSentence sentence) Check whether the given sentence matches this error rule, i.e.Methods inherited from class org.languagetool.rules.Rule
addExamplePair, estimateContextForSureMatch, getAntiPatterns, getCategory, getConfigureText, getCorrectExamples, getDefaultValue, getErrorTriggeringExamples, getIncorrectExamples, getLocQualityIssueType, getMaxConfigurableValue, getMinConfigurableValue, getSentenceWithImmunization, getUrl, hasConfigurableValue, isDefaultOff, isDefaultTempOff, isDictionaryBasedSpellingRule, isOfficeDefaultOff, isOfficeDefaultOn, makeAntiPatterns, setCategory, setCorrectExamples, setDefaultOff, setDefaultOn, setDefaultTempOff, setErrorTriggeringExamples, setIncorrectExamples, setLocQualityIssueType, setOfficeDefaultOff, setOfficeDefaultOn, setUrl, supportsLanguage, toRuleMatchArray, useInOffice
-
Field Details
-
language
-
cache
private static final com.google.common.cache.LoadingCache<AbstractSimpleReplaceRule2.PathAndLanguage,List<Map<String, cacheString>>>
-
-
Constructor Details
-
AbstractSimpleReplaceRule2
-
-
Method Details
-
getFileName
-
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 charactersA-Z
and the underscore. -
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 classRule
-
getShort
-
getSuggestion
- Returns:
- A string where
$match
will be replaced with the matching word and$suggestions
will be replaced with the alternatives. This is the string shown to the user.
-
getSuggestionsSeparator
- Returns:
- the word used to separate multiple suggestions; used only before last suggestion, the rest are comma-separated.
-
getLocale
locale used on case-conversion -
isCaseSensitive
public boolean isCaseSensitive()use case-sensitive matching. -
getWrongWords
- Returns:
- the list of wrong words for which this rule can suggest correction. The list cannot be modified.
-
loadWords
private static List<Map<String,String>> loadWords(String filename, Language lang, boolean caseSensitive) throws IOException Load the list of words. Same asAbstractSimpleReplaceRule.loadFromPath(java.lang.String)
but allows multiple words.- Parameters:
filename
- the file from classpath to load- Returns:
- the list of maps containing the error-corrections pairs. The n-th map contains key strings of (n+1) words.
- Throws:
IOException
-
addToQueue
-
match
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). -
isException
-