org.languagetool.rules

Class AbstractStyleTooOftenUsedWordRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.TextLevelRule

org.languagetool.rules.AbstractStyleTooOftenUsedWordRule

Direct Known Subclasses:

StyleTooOftenUsedAdjectiveRule, StyleTooOftenUsedAdjectiveRule, StyleTooOftenUsedNounRule, StyleTooOftenUsedNounRule, StyleTooOftenUsedVerbRule, StyleTooOftenUsedVerbRule

public abstract class AbstractStyleTooOftenUsedWordRule
extends TextLevelRule

The method gives stylistic hints that a word is being used too often when the set percentage has been exceeded.(default off).

Since:

6.2.3

Author:

Fred Kruse

Field Summary

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
abstract 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
protected abstract String	getLimitMessage(int minPercent) Defines the message for hints which exceed the limit
int	getMaxConfigurableValue() Overwrite this to define the maximum of a configurable value
int	getMinConfigurableValue() Overwrite this to define the minimum of a configurable value
Map<String,Integer>	getWordMap()
boolean	hasConfigurableValue() Overwrite this to return true, if a value may be configured by option panel
protected abstract boolean	isException(AnalyzedTokenReadings token) An exception is defined for the token
protected abstract boolean	isToCountedWord(AnalyzedTokenReadings token) A token that has to be counted
RuleMatch[]	match(List<AnalyzedSentence> sentences)
int	minToCheckParagraph() Gives back the minimum number of paragraphs to check to give back a correct result.
void	setWithoutDirectSpeech(boolean withoutDirectSpeech)
protected abstract String	toAddedLemma(AnalyzedTokenReadings token) Gives back the lemma that should be added to the word map

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, getSentenceWithImmunization, getSourceFile, getSubId, getTags, getToneTags, getUrl, hasTag, hasToneTag, isDefaultOff, isDefaultTempOff, isDictionaryBasedSpellingRule, isGoalSpecific, isOfficeDefaultOff, isOfficeDefaultOn, isPremium, makeAntiPatterns, setCategory, setCorrectExamples, setDefaultOff, setDefaultOn, setDefaultTempOff, setDistanceTokens, setErrorTriggeringExamples, setExamplePair, setGoalSpecific, setIncorrectExamples, setLocQualityIssueType, setMinPrevMatches, setOfficeDefaultOff, setOfficeDefaultOn, setPremium, 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

AbstractStyleTooOftenUsedWordRule

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

AbstractStyleTooOftenUsedWordRule

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

Method Detail

isToCountedWord

protected abstract boolean isToCountedWord(AnalyzedTokenReadings token)

A token that has to be counted

isException

protected abstract boolean isException(AnalyzedTokenReadings token)

An exception is defined for the token

toAddedLemma

protected abstract String toAddedLemma(AnalyzedTokenReadings token)

Gives back the lemma that should be added to the word map

getLimitMessage

protected abstract String getLimitMessage(int minPercent)

Defines the message for hints which exceed the limit

getConfigureText

public abstract 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

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

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

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

getWordMap

public Map<String,Integer> getWordMap()

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