Package org.languagetool.rules

Class AbstractFillerWordsRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.TextLevelRule

org.languagetool.rules.AbstractStatisticStyleRule

org.languagetool.rules.AbstractFillerWordsRule

Direct Known Subclasses:

PortugueseFillerWordsRule, RussianFillerWordsRule

public abstract class AbstractFillerWordsRule
extends AbstractStatisticStyleRule

A rule that gives hints about the use of filler words. The hints are only given when the percentage of filler words per paragraph exceeds the given limit. A limit of 0 shows all used filler words. Direct speech or citation is excluded otherwise. This rule detects no grammar error but gives stylistic hints (default off).

Since:

4.2

Field Summary

Fields

Modifier and Type	Field	Description
private static final boolean	DEFAULT_ACTIVATION
private static final int	DEFAULT_MIN_PERCENT
private int	minPercent
static final String	RULE_ID

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor	Description
AbstractFillerWordsRule(ResourceBundle messages, Language lang, UserConfig userConfig)
AbstractFillerWordsRule(ResourceBundle messages, Language lang, UserConfig userConfig, boolean defaultActive)

Method Summary

Modifier and Type	Method	Description
protected 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
protected boolean	excludeDirectSpeech()	Condition to generate a hint related to the sentence (possibly including all exceptions)
String	getConfigurePercentText()
String	getConfigureWithoutDirectSpeachText()
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.
protected String	getLimitMessage(int limit, double percent)	Defines the message for hints which exceed the limit
String	getMessage()
RuleOption[]	getRuleOptions()	give the user the possibility to configure the function
protected String	getSentenceMessage()	Defines the message for sentence related hints
protected boolean	isException(AnalyzedTokenReadings[] tokens, int num)
protected abstract boolean	isFillerWord(String token)
int	minToCheckParagraph()	Gives back the minimum number of paragraphs to check to give back a correct result.
protected boolean	sentenceConditionFulfilled(AnalyzedTokenReadings[] tokens, int nAnalysedToken)	Condition to generate a hint related to the sentence (possibly including all exceptions)

Methods inherited from class org.languagetool.rules.AbstractStatisticStyleRule

denominator, getNumberOfMatches, getWordCount, match, setWithoutDirectSpeech

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

DEFAULT_MIN_PERCENT

private static final int DEFAULT_MIN_PERCENT

See Also:

• Constant Field Values

DEFAULT_ACTIVATION

private static final boolean DEFAULT_ACTIVATION

See Also:

• Constant Field Values

minPercent

private int minPercent

Constructor Details

AbstractFillerWordsRule

public AbstractFillerWordsRule(ResourceBundle messages,
 Language lang,
 UserConfig userConfig,
 boolean defaultActive)

AbstractFillerWordsRule

public AbstractFillerWordsRule(ResourceBundle messages,
 Language lang,
 UserConfig userConfig)

Method Details

isFillerWord

protected abstract boolean isFillerWord(String token)

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

getRuleOptions

public RuleOption[] getRuleOptions()

give the user the possibility to configure the function

Overrides:

getRuleOptions in class AbstractStatisticStyleRule

getMessage

public String getMessage()

isException

protected boolean isException(AnalyzedTokenReadings[] tokens,
 int num)

conditionFulfilled

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

Description copied from class: AbstractStatisticStyleRule

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

Specified by:

conditionFulfilled in class AbstractStatisticStyleRule

sentenceConditionFulfilled

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

Description copied from class: AbstractStatisticStyleRule

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

Specified by:

sentenceConditionFulfilled in class AbstractStatisticStyleRule

excludeDirectSpeech

protected boolean excludeDirectSpeech()

Description copied from class: AbstractStatisticStyleRule

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

Specified by:

excludeDirectSpeech in class AbstractStatisticStyleRule

getLimitMessage

protected String getLimitMessage(int limit,
 double percent)

Description copied from class: AbstractStatisticStyleRule

Defines the message for hints which exceed the limit

Specified by:

getLimitMessage in class AbstractStatisticStyleRule

getSentenceMessage

protected String getSentenceMessage()

Description copied from class: AbstractStatisticStyleRule

Defines the message for sentence related hints

Specified by:

getSentenceMessage in class AbstractStatisticStyleRule

getConfigurePercentText

public String getConfigurePercentText()

Specified by:

getConfigurePercentText in class AbstractStatisticStyleRule

getConfigureWithoutDirectSpeachText

public String getConfigureWithoutDirectSpeachText()

Specified by:

getConfigureWithoutDirectSpeachText in class AbstractStatisticStyleRule

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

Overrides:

minToCheckParagraph in class AbstractStatisticStyleRule