org.languagetool.rules

Class TextLevelRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.TextLevelRule

Direct Known Subclasses:

AbstractFillerWordsRule, AbstractRepeatedWordsRule, AbstractStatisticSentenceStyleRule, AbstractStatisticStyleRule, AbstractStyleRepeatedWordRule, AbstractStyleTooOftenUsedWordRule, AbstractWordCoherencyRule, CatalanUnpairedQuestionMarksRule, CompoundCoherencyRule, ConsistencyPatternRuleTransformer.ConsistencyPatternRule, ConsistentApostrophesRule, DuUpperLowerCaseRule, EmptyLineRule, GenericUnpairedBracketsRule, LongParagraphRule, LongSentenceRule, MultipleWhitespaceRule, ParagraphRepeatBeginningRule, PunctuationMarkAtParagraphEnd, PunctuationMarkAtParagraphEnd2, QuestionMarkRule, ReadabilityRule, RepeatedPatternRuleTransformer.RepeatedPatternRule, SentenceWhitespaceRule, SimilarNameRule, StyleRepeatedSentenceBeginning, StyleRepeatedVeryShortSentences, UppercaseSentenceStartRule, VerbAgreementRule, WhiteSpaceBeforeParagraphEnd, WordRepeatBeginningRule

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()
TextLevelRule(ResourceBundle messages) Called by rules that require a translation of their messages.

Method Summary

Modifier and Type	Method and Description
int	estimateContextForSureMatch() A number that estimates how many words there must be after a match before we can be (relatively) sure the match is valid.
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 RuleMatch[]	match(List<AnalyzedSentence> sentences) Deprecated. use match(List, AnnotatedText) instead
RuleMatch[]	match(List<AnalyzedSentence> sentences, AnnotatedText annotatedText)
abstract int	minToCheckParagraph() Gives back the minimum number of paragraphs to check to give back a correct result.

Methods inherited from class org.languagetool.rules.Rule

addExamplePair, addTags, addToneTags, cacheAntiPatterns, getAntiPatterns, getCategory, getConfigureText, getCorrectExamples, getDefaultValue, getDescription, getDistanceTokens, getErrorTriggeringExamples, getFullId, getId, 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

TextLevelRule

public TextLevelRule()

Since:

3.7

TextLevelRule

public TextLevelRule(ResourceBundle messages)

Called by rules that require a translation of their messages.

Method Detail

match

public RuleMatch[] match(List<AnalyzedSentence> sentences,
                         AnnotatedText annotatedText)
                  throws IOException

Throws:

IOException

Since:

3.9

match

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

Deprecated. use match(List, AnnotatedText) instead

Throws:

IOException

estimateContextForSureMatch

public int estimateContextForSureMatch()

Description copied from class: Rule

A number that estimates how many words there must be after a match before we can be (relatively) sure the match is valid. This is useful for check-as-you-type, where a match might occur and the word that gets typed next makes the match disappear (something one would obviously like to avoid). Note: this may over-estimate the real context size. Returns -1 when the sentence needs to end to be sure there's a match.

Overrides:

estimateContextForSureMatch in class Rule

match

public final 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 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

Throws:

IOException

minToCheckParagraph

public abstract int minToCheckParagraph()

Gives back the minimum number of paragraphs to check to give back a correct result. Only used by LO office extension.

• n == -1 --> need to check full text (use only if really needed / bad performance) examples: AbstractWordCoherencyRule, GenericUnpairedBracketsRule, ...
• n == 0 --> need only to check the current paragraph examples: MultipleWhitespaceRule, LongParagraphRule, ...
• n >= 1 --> need only to check n paragraphs around the current paragraph examples: ParagraphRepeatBeginningRule (n == 1), WordRepeatBeginningRule (n == 2), ...