Package org.languagetool.rules

Class LongSentenceRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.TextLevelRule

org.languagetool.rules.LongSentenceRule

Direct Known Subclasses:

LongSentenceRule, LongSentenceRule

public class LongSentenceRule
extends TextLevelRule

A rule that warns on long sentences.

Since:

3.9

Field Summary

Fields

Modifier and Type	Field	Description
private static final List<String>	CLOSING_QUOTES
private final int	maxWords
private final ResourceBundle	messages
private static final List<String>	OPENING_QUOTES
private static final Pattern	QUOTED_SENT_END
static final String	RULE_ID
private static final Pattern	SENT_END

Constructor Summary

Constructors

Constructor	Description
LongSentenceRule(ResourceBundle messages, UserConfig userConfig, int maxWords)

Method Summary

Modifier and Type	Method	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.
String	getMessage()
RuleOption[]	getRuleOptions()	give the user the possibility to configure the function
private boolean	isWordCount(String tokenText)
RuleMatch[]	match(List<AnalyzedSentence> sentences)
int	minToCheckParagraph()	Gives back the minimum number of paragraphs to check to give back a correct result.

Methods inherited from class org.languagetool.rules.TextLevelRule

estimateContextForSureMatch, match, match

Methods inherited from class org.languagetool.rules.Rule

addExamplePair, addTags, addToneTags, cacheAntiPatterns, getAntiPatterns, getCategory, getCorrectExamples, getDistanceTokens, getErrorTriggeringExamples, getFullId, getIncorrectExamples, getLocQualityIssueType, getMinPrevMatches, getPriority, getSentenceWithImmunization, getSourceFile, getSubId, getTags, getToneTags, getUrl, hasTag, hasToneTag, isDefaultOff, isDefaultTempOff, isDictionaryBasedSpellingRule, isGoalSpecific, isIncludedInHiddenMatches, isOfficeDefaultOff, isOfficeDefaultOn, isPremium, makeAntiPatterns, setCategory, setCorrectExamples, setDefaultOff, setDefaultOn, setDefaultTempOff, setDistanceTokens, setErrorTriggeringExamples, setExamplePair, setGoalSpecific, setIncludedInHiddenMatches, setIncorrectExamples, setLocQualityIssueType, setMinPrevMatches, setOfficeDefaultOff, setOfficeDefaultOn, setPremium, setPriority, 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 Details

RULE_ID

public static final String RULE_ID

See Also:

• Constant Field Values

QUOTED_SENT_END

private static final Pattern QUOTED_SENT_END

SENT_END

private static final Pattern SENT_END

OPENING_QUOTES

private static final List<String> OPENING_QUOTES

CLOSING_QUOTES

private static final List<String> CLOSING_QUOTES

messages

private final ResourceBundle messages

maxWords

private final int maxWords

Constructor Details

LongSentenceRule

public LongSentenceRule(ResourceBundle messages,
 UserConfig userConfig,
 int maxWords)

Method Details

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

isWordCount

private boolean isWordCount(String tokenText)

getMessage

public String getMessage()

match

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

Specified by:

match in class TextLevelRule

Throws:

IOException

minToCheckParagraph

public int minToCheckParagraph()

Description copied from class: TextLevelRule

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

Specified by:

minToCheckParagraph in class TextLevelRule

getRuleOptions

public RuleOption[] getRuleOptions()

give the user the possibility to configure the function

Overrides:

getRuleOptions in class Rule