org.languagetool.rules

Class TextLevelRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.TextLevelRule

Direct Known Subclasses:

GenericUnpairedBracketsRule

@Experimental
public abstract class TextLevelRule
extends Rule

A rule that considers the complete text, not just one sentence after the other. Useful for rules that check coherency over sentence boundaries etc.

Since:

2.7

Field Summary

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
RuleMatch[]	match(AnalyzedSentence sentence) Check whether the given sentence matches this error rule, i.e. whether it contains the error detected by this rule.
RuleMatch[]	match(List<AnalyzedSentence> sentence)
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.

Methods inherited from class org.languagetool.rules.Rule

addExamplePair, getCategory, getCorrectExamples, getDescription, getId, getIncorrectExamples, getLocQualityIssueType, getUrl, isDefaultOff, isDictionaryBasedSpellingRule, setCategory, setCorrectExamples, setDefaultOff, setDefaultOn, setIncorrectExamples, setLocQualityIssueType, setUrl, supportsLanguage, toRuleMatchArray, useInOffice

Methods inherited from class java.lang.Object

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

Constructor Detail

TextLevelRule

public TextLevelRule(ResourceBundle messages)

Called by rules that require a translation of their messages.

Method Detail

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

Specified by:

match in class Rule

Parameters:

sentence - a pre-analyzed sentence

Returns:

an array of RuleMatch objects

Throws:

IOException

match

public RuleMatch[] match(List<AnalyzedSentence> sentence)
                  throws IOException

Throws:

IOException

reset

public final void reset()

Description copied from class: Rule

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.

Specified by:

reset in class Rule