Package org.languagetool.rules

Class AbstractRepeatedWordsRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.TextLevelRule

org.languagetool.rules.AbstractRepeatedWordsRule

Direct Known Subclasses:

CatalanRepeatedWordsRule, EnglishRepeatedWordsRule, FrenchRepeatedWordsRule, GermanRepeatedWordsRule, SpanishRepeatedWordsRule

public abstract class AbstractRepeatedWordsRule
extends TextLevelRule

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	FILE_ENCODING
private static final Pattern	HASH_PATTERN
protected final Language	language
private static final Pattern	PUNCT_PATTERN
private final String	ruleId

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor	Description
AbstractRepeatedWordsRule(ResourceBundle messages, Language language)

Method Summary

Modifier and Type	Method	Description
protected String	adjustPostag(String postag)
abstract 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 abstract String	getMessage()
protected abstract String	getShortMessage()
protected abstract Synthesizer	getSynthesizer()
protected abstract Map<String,SynonymsData>	getWordsToCheck()
protected abstract boolean	isException(AnalyzedTokenReadings[] tokens, int i, boolean sentStart, boolean isCapitalized, boolean isAllUppercase)
protected static Map<String,SynonymsData>	loadWords(String path)
RuleMatch[]	match(List<AnalyzedSentence> sentences)
protected int	maxWordsDistance()
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, addTags, addToneTags, cacheAntiPatterns, getAntiPatterns, getCategory, getCorrectExamples, getDistanceTokens, getErrorTriggeringExamples, getFullId, getIncorrectExamples, getLocQualityIssueType, getMinPrevMatches, getPriority, getRuleOptions, 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

PUNCT_PATTERN

private static final Pattern PUNCT_PATTERN

HASH_PATTERN

private static final Pattern HASH_PATTERN

FILE_ENCODING

private static final String FILE_ENCODING

See Also:

• Constant Field Values

ruleId

private final String ruleId

language

protected final Language language

Constructor Details

AbstractRepeatedWordsRule

public AbstractRepeatedWordsRule(ResourceBundle messages,
 Language language)

Method Details

getWordsToCheck

protected abstract Map<String,SynonymsData> getWordsToCheck()

getSynthesizer

protected abstract Synthesizer getSynthesizer()

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

maxWordsDistance

protected int maxWordsDistance()

getMessage

protected abstract String getMessage()

getShortMessage

protected abstract String getShortMessage()

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

getDescription

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

adjustPostag

protected String adjustPostag(String postag)

isException

protected abstract boolean isException(AnalyzedTokenReadings[] tokens,
 int i,
 boolean sentStart,
 boolean isCapitalized,
 boolean isAllUppercase)

match

public RuleMatch[] match(List<AnalyzedSentence> sentences)
                  throws IOException

Specified by:

match in class TextLevelRule

Throws:

IOException

loadWords

protected static Map<String,SynonymsData> loadWords(String path)