org.languagetool.rules

Class WordRepeatBeginningRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.TextLevelRule

org.languagetool.rules.WordRepeatBeginningRule

Direct Known Subclasses:

CatalanWordRepeatBeginningRule, EnglishWordRepeatBeginningRule, GermanWordRepeatBeginningRule, GreekWordRepeatBeginningRule, PersianWordRepeatBeginningRule, PortugueseWordRepeatBeginningRule, RomanianWordRepeatBeginningRule, SpanishWordRepeatBeginningRule

public class WordRepeatBeginningRule
extends TextLevelRule

Check if three successive sentences begin with the same word, e.g. "I am Max. I am living in Germany. I like ice cream.", and if two successive sentences begin with the same adverb, e.g. "Furthermore, he is ill. Furthermore, he likes her."

Author:

Markus Brenneis

Field Summary

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor and Description
WordRepeatBeginningRule(ResourceBundle messages, Language language)

Method Summary

Modifier and Type	Method and Description
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.
protected List<String>	getSuggestions(AnalyzedTokenReadings analyzedToken)
protected boolean	isAdverb(AnalyzedTokenReadings token)
boolean	isException(String token)
boolean	isSentenceException(AnalyzedSentence sentence)
RuleMatch[]	match(List<AnalyzedSentence> sentences)
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, 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

WordRepeatBeginningRule

public WordRepeatBeginningRule(ResourceBundle messages,
                               Language language)

Method Detail

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

isAdverb

protected boolean isAdverb(AnalyzedTokenReadings token)

isException

public boolean isException(String token)

isSentenceException

public boolean isSentenceException(AnalyzedSentence sentence)

match

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

Specified by:

match in class TextLevelRule

Throws:

IOException

getSuggestions

protected List<String> getSuggestions(AnalyzedTokenReadings analyzedToken)

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