Package 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

Field Summary

Fields

Modifier and Type	Field	Description
private static final boolean	DEFAULT_ACTIVATION
private final int	defaultMinPercent
private static final Pattern	ENDING_QUOTES
private static final int	MIN_WORD_COUNT
private final int	minPercent
private static final Pattern	OPENING_QUOTES
private boolean	withoutDirectSpeech
private final Map<String,Integer>	wordMap

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor	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	Description
private void	FillWordMap(List<AnalyzedSentence> sentences)	fill the map with all words and the number of occurrence
abstract String	getConfigureText()
protected String	getLemmaForPosTagStartsWith(String startPos, AnalyzedTokenReadings token)
protected abstract String	getLimitMessage(int minPercent)	Defines the message for hints which exceed the limit
private int	getMinPercent(UserConfig userConfig, int minPercentDefault)
RuleOption[]	getRuleOptions()	give the user the possibility to configure the function
private List<String>	getTooOftenUsedWords()	get all words that are used more often than minPercent
Map<String,Integer>	getWordMap()
protected abstract boolean	isException(AnalyzedTokenReadings[] tokens, int n)	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, 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

OPENING_QUOTES

private static final Pattern OPENING_QUOTES

ENDING_QUOTES

private static final Pattern ENDING_QUOTES

DEFAULT_ACTIVATION

private static final boolean DEFAULT_ACTIVATION

See Also:

• Constant Field Values

MIN_WORD_COUNT

private static final int MIN_WORD_COUNT

See Also:

• Constant Field Values

minPercent

private final int minPercent

defaultMinPercent

private final int defaultMinPercent

wordMap

private final Map<String,Integer> wordMap

withoutDirectSpeech

private boolean withoutDirectSpeech

Constructor Details

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 Details

isToCountedWord

protected abstract boolean isToCountedWord(AnalyzedTokenReadings token)

A token that has to be counted

isException

protected abstract boolean isException(AnalyzedTokenReadings[] tokens,
 int n)

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()

getMinPercent

private int getMinPercent(UserConfig userConfig,
 int minPercentDefault)

getRuleOptions

public RuleOption[] getRuleOptions()

give the user the possibility to configure the function

Overrides:

getRuleOptions in class Rule

getWordMap

public Map<String,Integer> getWordMap()

setWithoutDirectSpeech

public void setWithoutDirectSpeech(boolean withoutDirectSpeech)

FillWordMap

private void FillWordMap(List<AnalyzedSentence> sentences)

fill the map with all words and the number of occurrence

getTooOftenUsedWords

private List<String> getTooOftenUsedWords()

get all words that are used more often than minPercent

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

getLemmaForPosTagStartsWith

protected String getLemmaForPosTagStartsWith(String startPos,
 AnalyzedTokenReadings token)