org.languagetool.rules

Class AbstractSpecificCaseRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.AbstractSpecificCaseRule

Direct Known Subclasses:

BelarusianSpecificCaseRule, EnglishSpecificCaseRule, GreekSpecificCaseRule

public abstract class AbstractSpecificCaseRule
extends Rule

A rule that matches words which need a specific upper/lowercase spelling.

Author:

Nikos-Antonopoulos, giorgossideris

Field Summary

Fields

Modifier and Type	Field and Description
protected CachingWordListLoader	phrasesListLoader

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor and Description
AbstractSpecificCaseRule(ResourceBundle messages) The constructor of the abstract class AbstractSpecificCaseRule

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	getInitialCapitalMessage()
String	getOtherCapitalizationMessage()
abstract String	getPhrasesPath()
String	getShortMessage()
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.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

Field Detail

phrasesListLoader

protected final CachingWordListLoader phrasesListLoader

Constructor Detail

AbstractSpecificCaseRule

public AbstractSpecificCaseRule(ResourceBundle messages)

The constructor of the abstract class AbstractSpecificCaseRule

Parameters:

messages - the messages to apply the rule

Method Detail

getPhrasesPath

public abstract String getPhrasesPath()

Returns:

the path to the txt file that contains the phrases for the rule

getInitialCapitalMessage

public String getInitialCapitalMessage()

Returns:

the message that will be shown if the words of the wrongly capitalized phrase must begin with capital

getOtherCapitalizationMessage

public String getOtherCapitalizationMessage()

Returns:

the message that will be shown if the wrongly capitalized phrase must not be written with capital initials (another special kind of capitalization)

getShortMessage

public String getShortMessage()

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

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

Specified by:

match in class Rule

Parameters:

sentence - a pre-analyzed sentence

Returns:

an array of RuleMatch objects