org.languagetool.rules

Class LongSentenceRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.LongSentenceRule

public class LongSentenceRule
extends Rule

A rule that warns on long sentences. Note that this rule is off by default.

Field Summary

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor and Description
LongSentenceRule(ResourceBundle messages) Creates a rule with the default maximum sentence length (40 words).
LongSentenceRule(ResourceBundle messages, int maxSentenceLength)

Method Summary

Methods

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

LongSentenceRule

public LongSentenceRule(ResourceBundle messages,
                int maxSentenceLength)

Parameters:

maxSentenceLength - the maximum sentence length that does not yet trigger a match

Since:

2.4

LongSentenceRule

public LongSentenceRule(ResourceBundle messages)

Creates a rule with the default maximum sentence length (40 words).

Method Detail

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

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

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

reset

public 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