org.languagetool.rules

Class Rule

java.lang.Object

org.languagetool.rules.Rule

Direct Known Subclasses:

AbstractCompoundRule, AbstractPatternRule, AbstractPunctuationCheckRule, AbstractSimpleReplaceRule, AbstractSimpleReplaceRule2, AbstractSpaceBeforeRule, AbstractWordCoherencyRule, AdvancedWordRepeatRule, BitextRule, CommaWhitespaceRule, ConfusionProbabilityRule, DoublePunctuationRule, LongSentenceRule, MultipleWhitespaceRule, SentenceWhitespaceRule, SpellingCheckRule, TextLevelRule, UppercaseSentenceStartRule, WhitespaceBeforePunctuationRule, WordRepeatBeginningRule, WordRepeatRule, WrongWordInContextRule

public abstract class Rule
extends Object

Abstract rule class. A Rule describes a language error and can test whether a given pre-analyzed text contains that error using the match(AnalyzedSentence) method.

Rules are created whenever a JLanguageTool or a MultiThreadedJLanguageTool object is created. As these objects are not thread-safe, this can happen often. Rules should thus make sure that their initialization works fast. For example, if a rule needs to load data from disk, it should store it in a static variable to make sure the loading happens only once.

Author:

Daniel Naber

Field Summary

Fields

Modifier and Type	Field and Description
protected ResourceBundle	messages

Constructor Summary

Constructors

Constructor and Description
Rule()
Rule(ResourceBundle messages) Called by rules that require a translation of their messages.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addExamplePair(IncorrectExample incorrectSentence, String correctSentence) Convenience method to add a pair of sentences: an incorrect sentence and the same sentence with the error corrected.
Category	getCategory()
List<String>	getCorrectExamples() Get example sentences that are correct and thus will not match this rule.
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	getId() A string used to identify the rule in e.g. configuration files.
List<IncorrectExample>	getIncorrectExamples() Get example sentences that are incorrect and thus will match this rule.
ITSIssueType	getLocQualityIssueType() Returns the Localization Quality Issue Type, as defined at http://www.w3.org/International/multilingualweb/lt/drafts/its20/its20.html#lqissue-typevalues.
URL	getUrl() An optional URL describing the rule match in more detail.
boolean	isDefaultOff() Checks whether the rule has been turned off by default by the rule author.
boolean	isDictionaryBasedSpellingRule() Whether this is a spelling rule that uses a dictionary.
abstract RuleMatch[]	match(AnalyzedSentence sentence) Check whether the given sentence matches this error rule, i.e. whether it contains the error detected by this rule.
abstract 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.
void	setCategory(Category category)
void	setCorrectExamples(List<String> correctExamples) Set the examples that are correct and thus do not trigger the rule.
void	setDefaultOff() Turns the rule off by default.
void	setDefaultOn() Turns the rule on by default.
void	setIncorrectExamples(List<IncorrectExample> incorrectExamples) Set the examples that are incorrect and thus do trigger the rule.
void	setLocQualityIssueType(ITSIssueType locQualityIssueType) Set the Localization Quality Issue Type.
void	setUrl(URL url)
boolean	supportsLanguage(Language language) Whether this rule can be used for text in the given language.
protected RuleMatch[]	toRuleMatchArray(List<RuleMatch> ruleMatches)
boolean	useInOffice() Whether this rule should be forced to be used in LO/OO extension.

Methods inherited from class java.lang.Object

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

Field Detail

messages

protected final ResourceBundle messages

Constructor Detail

Rule

public Rule()

Rule

public Rule(ResourceBundle messages)

Called by rules that require a translation of their messages.

Method Detail

getId

public abstract String getId()

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.

getDescription

public abstract String getDescription()

A short description of the error this rule can detect, usually in the language of the text that is checked.

match

public abstract RuleMatch[] match(AnalyzedSentence sentence)
                           throws IOException

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

Parameters:

sentence - a pre-analyzed sentence

Returns:

an array of RuleMatch objects

Throws:

IOException

reset

public abstract 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. It will be called before a new text is going to be checked.

supportsLanguage

public boolean supportsLanguage(Language language)

Whether this rule can be used for text in the given language. Since LanguageTool 2.6, this also works PatternRules (before, it used to always return false for those).

isDictionaryBasedSpellingRule

public boolean isDictionaryBasedSpellingRule()

Whether this is a spelling rule that uses a dictionary. Rules that return true here are basically rules that work like a simple hunspell-like spellchecker: they check words without considering the words' context.

Since:

2.5

useInOffice

public boolean useInOffice()

Whether this rule should be forced to be used in LO/OO extension. Rules that return true will be enabled always in LO/OO extension regardless of other options like isDictionaryBasedSpellingRule().

Since:

2.6

setCorrectExamples

public final void setCorrectExamples(List<String> correctExamples)

Set the examples that are correct and thus do not trigger the rule.

getCorrectExamples

public final List<String> getCorrectExamples()

Get example sentences that are correct and thus will not match this rule.

setIncorrectExamples

public final void setIncorrectExamples(List<IncorrectExample> incorrectExamples)

Set the examples that are incorrect and thus do trigger the rule.

getIncorrectExamples

public final List<IncorrectExample> getIncorrectExamples()

Get example sentences that are incorrect and thus will match this rule.

getCategory

public final Category getCategory()

setCategory

public final void setCategory(Category category)

toRuleMatchArray

protected final RuleMatch[] toRuleMatchArray(List<RuleMatch> ruleMatches)

isDefaultOff

public final boolean isDefaultOff()

Checks whether the rule has been turned off by default by the rule author.

Returns:

True if the rule is turned off by default.

setDefaultOff

public final void setDefaultOff()

Turns the rule off by default.

setDefaultOn

public final void setDefaultOn()

Turns the rule on by default.

getUrl

@Nullable
public URL getUrl()

An optional URL describing the rule match in more detail. Typically points to a dictionary or grammar website with explanations and examples. Will return null for rules that have no URL.

Since:

1.8

setUrl

public void setUrl(URL url)

Since:

1.8

See Also:

getUrl()

getLocQualityIssueType

public ITSIssueType getLocQualityIssueType()

Returns the Localization Quality Issue Type, as defined at http://www.w3.org/International/multilingualweb/lt/drafts/its20/its20.html#lqissue-typevalues.

Note that not all languages nor all rules actually map yet to a type yet. In those cases, uncategorized is returned.

Returns:

the Localization Quality Issue Type - uncategorized if no type has been assigned

Since:

2.5

setLocQualityIssueType

public void setLocQualityIssueType(ITSIssueType locQualityIssueType)

Set the Localization Quality Issue Type.

Since:

2.5

See Also:

getLocQualityIssueType()

addExamplePair

protected void addExamplePair(IncorrectExample incorrectSentence,
                  String correctSentence)

Convenience method to add a pair of sentences: an incorrect sentence and the same sentence with the error corrected.

Since:

2.5