org.languagetool.rules

Class WordRepeatRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.WordRepeatRule

Direct Known Subclasses:

ArabicWordRepeatRule, CatalanWordRepeatRule, EnglishWordRepeatRule, GermanWordRepeatRule, ItalianWordRepeatRule, PersianWordRepeatRule, PortugueseWordRepeatRule, RussianSimpleWordRepeatRule, SpanishWordRepeatRule, UkrainianWordRepeatRule

public class WordRepeatRule
extends Rule

Check if a word is repeated, e.g. "the the".

Author:

Daniel Naber

Field Summary

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor and Description
WordRepeatRule(ResourceBundle messages, Language language)

Method Summary

Modifier and Type	Method and Description
protected RuleMatch	createRuleMatch(String prevToken, String token, int prevPos, int pos, String msg, AnalyzedSentence sentence)
int	estimateContextForSureMatch() A number that estimates how many words there must be after a match before we can be (relatively) sure the match is valid.
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. configuration files.
boolean	ignore(AnalyzedTokenReadings[] tokens, int position) Implement this method to return true if there's a potential word repetition at the current position that should be ignored, i.e. if no error should be created.
RuleMatch[]	match(AnalyzedSentence sentence) Check whether the given sentence matches this error rule, i.e. whether it contains the error detected by this rule.
protected boolean	wordRepetitionOf(String word, AnalyzedTokenReadings[] tokens, int position)

Methods inherited from class org.languagetool.rules.Rule

addExamplePair, addTags, addToneTags, cacheAntiPatterns, getAntiPatterns, getCategory, getConfigureText, getCorrectExamples, getDefaultValue, getDistanceTokens, getErrorTriggeringExamples, getFullId, getIncorrectExamples, getLocQualityIssueType, getMaxConfigurableValue, getMinConfigurableValue, getMinPrevMatches, getSentenceWithImmunization, getSourceFile, getSubId, getTags, getToneTags, getUrl, hasConfigurableValue, 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

WordRepeatRule

public WordRepeatRule(ResourceBundle messages,
                      Language language)

Method Detail

ignore

public boolean ignore(AnalyzedTokenReadings[] tokens,
                      int position)

Implement this method to return true if there's a potential word repetition at the current position that should be ignored, i.e. if no error should be created.

Parameters:

tokens - the tokens of the sentence currently being checked

position - the current position in the tokens

Returns:

this implementation always returns false

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

estimateContextForSureMatch

public int estimateContextForSureMatch()

Description copied from class: Rule

A number that estimates how many words there must be after a match before we can be (relatively) sure the match is valid. This is useful for check-as-you-type, where a match might occur and the word that gets typed next makes the match disappear (something one would obviously like to avoid). Note: this may over-estimate the real context size. Returns -1 when the sentence needs to end to be sure there's a match.

Overrides:

estimateContextForSureMatch in class Rule

match

public RuleMatch[] match(AnalyzedSentence sentence)

Description copied from class: Rule

Check whether the given sentence matches this error rule, i.e. whether it contains the error detected by this rule. Note that the order in which this method is called is not always guaranteed, i.e. the sentence order in the text may be different from the order in which you get the sentences (this may be the case when LanguageTool is used as a LibreOffice/OpenOffice add-on, for example). In other words, implementations must be stateless, so that a previous call to this method has no influence on later calls.

Specified by:

match in class Rule

Parameters:

sentence - a pre-analyzed sentence

Returns:

an array of RuleMatch objects

createRuleMatch

protected RuleMatch createRuleMatch(String prevToken,
                                    String token,
                                    int prevPos,
                                    int pos,
                                    String msg,
                                    AnalyzedSentence sentence)

wordRepetitionOf

protected boolean wordRepetitionOf(String word,
                                   AnalyzedTokenReadings[] tokens,
                                   int position)