Package org.languagetool.rules

Class AbstractFillerWordsRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.TextLevelRule

org.languagetool.rules.AbstractFillerWordsRule

public abstract class AbstractFillerWordsRule
extends TextLevelRule

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 boolean	DEFAULT_ACTIVATION
private static int	DEFAULT_MIN_PERCENT
private static java.util.regex.Pattern	ENDING_QUOTES
private Language	lang
private int	minPercent
private static java.util.regex.Pattern	OPENING_QUOTES
static java.lang.String	RULE_ID

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
java.lang.String	getConfigureText()	Overwrite this to define the Text in the option panel for the configurable value
int	getDefaultValue()	Overwrite this to get a default Integer value by option panel
java.lang.String	getDescription()	A short description of the error this rule can detect, usually in the language of the text that is checked.
java.lang.String	getId()	A string used to identify the rule in e.g.
int	getMaxConfigurableValue()	Overwrite this to define the maximum of a configurable value
java.lang.String	getMessage()
int	getMinConfigurableValue()	Overwrite this to define the minimum of a configurable value
boolean	hasConfigurableValue()	Overwrite this to return true, if a value may be configured by option panel
protected boolean	isException(AnalyzedTokenReadings[] tokens, int num)
protected abstract boolean	isFillerWord(java.lang.String token)
RuleMatch[]	match(java.util.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, getAntiPatterns, getCategory, getCorrectExamples, getErrorTriggeringExamples, getIncorrectExamples, getLocQualityIssueType, getSentenceWithImmunization, getUrl, isDefaultOff, isDefaultTempOff, isDictionaryBasedSpellingRule, isOfficeDefaultOff, isOfficeDefaultOn, makeAntiPatterns, setCategory, setCorrectExamples, setDefaultOff, setDefaultOn, setDefaultTempOff, setErrorTriggeringExamples, setIncorrectExamples, setLocQualityIssueType, setOfficeDefaultOff, setOfficeDefaultOn, setUrl, supportsLanguage, toRuleMatchArray, useInOffice

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RULE_ID

public static final java.lang.String RULE_ID

See Also:

Constant Field Values

DEFAULT_MIN_PERCENT

private static final int DEFAULT_MIN_PERCENT

See Also:

Constant Field Values

OPENING_QUOTES

private static final java.util.regex.Pattern OPENING_QUOTES

ENDING_QUOTES

private static final java.util.regex.Pattern ENDING_QUOTES

DEFAULT_ACTIVATION

private static final boolean DEFAULT_ACTIVATION

See Also:

Constant Field Values

minPercent

private int minPercent

lang

private final Language lang

Constructor Detail

AbstractFillerWordsRule

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

AbstractFillerWordsRule

public AbstractFillerWordsRule(java.util.ResourceBundle messages,
                               Language lang,
                               UserConfig userConfig)

Method Detail

isFillerWord

protected abstract boolean isFillerWord(java.lang.String token)

getDescription

public java.lang.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 java.lang.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

getDefaultValue

public int getDefaultValue()

Description copied from class: Rule

Overwrite this to get a default Integer value by option panel

Overrides:

getDefaultValue in class Rule

hasConfigurableValue

public boolean hasConfigurableValue()

Description copied from class: Rule

Overwrite this to return true, if a value may be configured by option panel

Overrides:

hasConfigurableValue in class Rule

getMinConfigurableValue

public int getMinConfigurableValue()

Description copied from class: Rule

Overwrite this to define the minimum of a configurable value

Overrides:

getMinConfigurableValue in class Rule

getMaxConfigurableValue

public int getMaxConfigurableValue()

Description copied from class: Rule

Overwrite this to define the maximum of a configurable value

Overrides:

getMaxConfigurableValue in class Rule

getConfigureText

public java.lang.String getConfigureText()

Description copied from class: Rule

Overwrite this to define the Text in the option panel for the configurable value

Overrides:

getConfigureText in class Rule

getMessage

public java.lang.String getMessage()

isException

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

match

public RuleMatch[] match(java.util.List<AnalyzedSentence> sentences)
                  throws java.io.IOException

Specified by:

match in class TextLevelRule

Throws:

java.io.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