Package org.languagetool.rules

Class ParagraphRepeatBeginningRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.TextLevelRule

org.languagetool.rules.ParagraphRepeatBeginningRule

public class ParagraphRepeatBeginningRule
extends TextLevelRule

Check if to paragraphs begin with the same word. If the first word is an article it checks if the first two words are identical

Since:

4.1

Field Summary

Fields

Modifier and Type	Field	Description
private Language	lang
private static java.util.regex.Pattern	QUOTES_REGEX

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor	Description
ParagraphRepeatBeginningRule(java.util.ResourceBundle messages, Language lang)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescription()	A short description of the error this rule can detect, usually in the language of the text that is checked.
java.lang.String	getId()	A string used to identify the rule in e.g.
boolean	isArticle(AnalyzedTokenReadings token)
RuleMatch[]	match(java.util.List<AnalyzedSentence> sentences)
int	minToCheckParagraph()	Gives back the minimum number of paragraphs to check to give back a correct result.
private int	numCharEqualBeginning(AnalyzedTokenReadings[] lastTokens, AnalyzedTokenReadings[] nextTokens)

Methods inherited from class org.languagetool.rules.TextLevelRule

estimateContextForSureMatch, match, match

Methods inherited from class org.languagetool.rules.Rule

addExamplePair, getAntiPatterns, getCategory, getConfigureText, getCorrectExamples, getDefaultValue, getErrorTriggeringExamples, getIncorrectExamples, getLocQualityIssueType, getMaxConfigurableValue, getMinConfigurableValue, getSentenceWithImmunization, getUrl, hasConfigurableValue, isDefaultOff, isDefaultTempOff, isDictionaryBasedSpellingRule, isOfficeDefaultOff, isOfficeDefaultOn, makeAntiPatterns, setCategory, setCorrectExamples, setDefaultOff, setDefaultOn, setDefaultTempOff, setErrorTriggeringExamples, setIncorrectExamples, setLocQualityIssueType, setOfficeDefaultOff, setOfficeDefaultOn, setUrl, supportsLanguage, toRuleMatchArray, useInOffice

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

lang

private final Language lang

QUOTES_REGEX

private static final java.util.regex.Pattern QUOTES_REGEX

Constructor Detail

ParagraphRepeatBeginningRule

public ParagraphRepeatBeginningRule(java.util.ResourceBundle messages,
                                    Language lang)

Method Detail

getId

public java.lang.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 java.lang.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

isArticle

public boolean isArticle(AnalyzedTokenReadings token)

numCharEqualBeginning

private int numCharEqualBeginning(AnalyzedTokenReadings[] lastTokens,
                                  AnalyzedTokenReadings[] nextTokens)
                           throws java.io.IOException

Throws:

java.io.IOException

match

public RuleMatch[] match(java.util.List<AnalyzedSentence> sentences)
                  throws java.io.IOException

Specified by:

match in class TextLevelRule

Throws:

java.io.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