org.languagetool.rules

Class AbstractStatisticStyleRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.TextLevelRule

org.languagetool.rules.AbstractStatisticStyleRule

public abstract class AbstractStatisticStyleRule
extends TextLevelRule

A rule that gives hints when a defined condition is fulfilled and the percentage of hints in the text exceeds the given limit. (For office extension: Works on the level of chapters) A limit of 0 shows all hints. Direct speech or citation can be excluded. A second condition per sentences can be defined. The rule detects no grammar error but gives stylistic hints in a statistic way (default off).

Since:

5.3

Author:

Fred Kruse

Field Summary

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor and Description
AbstractStatisticStyleRule(ResourceBundle messages, Language lang, UserConfig userConfig, int minPercent)
AbstractStatisticStyleRule(ResourceBundle messages, Language lang, UserConfig userConfig, int minPercent, boolean defaultActive)

Method Summary

Modifier and Type	Method and Description
protected abstract int	conditionFulfilled(AnalyzedTokenReadings[] tokens, int nAnalysedToken) Condition to generate a hint (possibly including all exceptions) Returns: < nAnalysedToken, if condition is not fulfilled >= nAnalysedToken, if condition is not fulfilled; integer is number of token which is the end hint
double	denominator() Override, if value should be given in an other unity than percent
protected abstract boolean	excludeDirectSpeech() Condition to generate a hint related to the sentence (possibly including all exceptions)
abstract String	getConfigurePercentText()
abstract String	getConfigureWithoutDirectSpeachText()
protected abstract String	getLimitMessage(int limit, double percent) Defines the message for hints which exceed the limit
int	getNumberOfMatches()
RuleOption[]	getRuleOptions() give the user the possibility to configure the function
protected abstract String	getSentenceMessage() Defines the message for sentence related hints
int	getWordCount()
RuleMatch[]	match(List<AnalyzedSentence> sentences)
int	minToCheckParagraph() Gives back the minimum number of paragraphs to check to give back a correct result.
protected abstract boolean	sentenceConditionFulfilled(AnalyzedTokenReadings[] tokens, int nAnalysedToken) Condition to generate a hint related to the sentence (possibly including all exceptions)
void	setWithoutDirectSpeech(boolean withoutDirectSpeech)

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, getDescription, getDistanceTokens, getErrorTriggeringExamples, getFullId, getId, 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

Constructor Detail

AbstractStatisticStyleRule

public AbstractStatisticStyleRule(ResourceBundle messages,
                                  Language lang,
                                  UserConfig userConfig,
                                  int minPercent,
                                  boolean defaultActive)

AbstractStatisticStyleRule

public AbstractStatisticStyleRule(ResourceBundle messages,
                                  Language lang,
                                  UserConfig userConfig,
                                  int minPercent)

Method Detail

conditionFulfilled

protected abstract int conditionFulfilled(AnalyzedTokenReadings[] tokens,
                                          int nAnalysedToken)

Condition to generate a hint (possibly including all exceptions) Returns: < nAnalysedToken, if condition is not fulfilled >= nAnalysedToken, if condition is not fulfilled; integer is number of token which is the end hint

sentenceConditionFulfilled

protected abstract boolean sentenceConditionFulfilled(AnalyzedTokenReadings[] tokens,
                                                      int nAnalysedToken)

Condition to generate a hint related to the sentence (possibly including all exceptions)

excludeDirectSpeech

protected abstract boolean excludeDirectSpeech()

Condition to generate a hint related to the sentence (possibly including all exceptions)

getLimitMessage

protected abstract String getLimitMessage(int limit,
                                          double percent)

Defines the message for hints which exceed the limit

getSentenceMessage

protected abstract String getSentenceMessage()

Defines the message for sentence related hints

getConfigurePercentText

public abstract String getConfigurePercentText()

getConfigureWithoutDirectSpeachText

public abstract String getConfigureWithoutDirectSpeachText()

denominator

public double denominator()

Override, if value should be given in an other unity than percent

getRuleOptions

public RuleOption[] getRuleOptions()

give the user the possibility to configure the function

Overrides:

getRuleOptions in class Rule

getWordCount

public int getWordCount()

getNumberOfMatches

public int getNumberOfMatches()

setWithoutDirectSpeech

public void setWithoutDirectSpeech(boolean withoutDirectSpeech)

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