org.languagetool.rules
Class WordRepeatRule

Object
  Rule
      WordRepeatRule

Direct Known Subclasses:

GermanWordRepeatRule

public class WordRepeatRule
extends Rule

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

Author:

Daniel Naber

Constructor Summary

WordRepeatRule(ResourceBundle messages, Language language)

Method Summary

String	getDescription()
String	getId() An ASCII-only 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 should be ignored, i.e. if no error should be created.
RuleMatch[]	match(AnalyzedSentence text) Check whether the given text matches this error rule, i.e. whether the text contains this error.
void	reset() If a rule keeps its state over more than the check of one sentence, this must be implemented so the internal state is reset.

Methods inherited from class Rule

addRuleMatch, clearMatches, getCategory, getCorrectExamples, getIncorrectExamples, getMatches, getMatchesIndex, isDefaultOff, isInMatches, isInRemoved, isParagraphBackTrack, setAsDeleted, setCategory, setCorrectExamples, setDefaultOff, setIncorrectExamples, setParagraphBackTrack, supportsLanguage

Methods inherited from class Object

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

An ASCII-only 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.

Specified by:

getId in class Rule

getDescription

public String getDescription()

Specified by:

getDescription in class Rule

match

public RuleMatch[] match(AnalyzedSentence text)

Description copied from class: Rule

Check whether the given text matches this error rule, i.e. whether the text contains this error.

Specified by:

match in class Rule

Parameters:

text - a pre-analyzed sentence

Returns:

an array of RuleMatch object for each match.

reset

public void reset()

Description copied from class: Rule

If a rule keeps its state over more than the check of one sentence, this must be implemented so the internal state is reset. It will be called before a new text is going to be checked.

Specified by:

reset in class Rule