org.languagetool.rules.de

Class UnnecessaryPhraseRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.TextLevelRule

org.languagetool.rules.AbstractStatisticStyleRule

org.languagetool.rules.de.UnnecessaryPhraseRule

public class UnnecessaryPhraseRule
extends AbstractStatisticStyleRule

A rule that gives Hints about the use of German phrases. The Hints are only given when the percentage of phrases per chapter/text exceeds the given limit. A limit of 0 shows all used filler words. Direct speech or citation is excluded otherwise. This rule detects no grammar error but gives stylistic hints (default off).

Since:

5.3

Author:

Fred Kruse

Field Summary

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor and Description
UnnecessaryPhraseRule(ResourceBundle messages, Language lang, UserConfig userConfig)

Method Summary

Modifier and Type	Method and Description
protected int	conditionFulfilled(AnalyzedTokenReadings[] tokens, int nAnalysedToken) Condition to generate a hint (possibly including all exceptions) Returns: < nAnalysedToken, if condition is not fulfilled >= nAnalysedToken, if condition is not fulfilled; integer is number of token which is the end hint
double	denominator() Minimal value is given in per mil
protected boolean	excludeDirectSpeech() Condition to generate a hint related to the sentence (possibly including all exceptions)
String	getConfigureText() Overwrite this to define the Text in the option panel for the configurable value
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 String	getLimitMessage(int limit, double percent) Defines the message for hints which exceed the limit
protected String	getSentenceMessage() Defines the message for sentence related hints
protected boolean	sentenceConditionFulfilled(AnalyzedTokenReadings[] tokens, int nToken) Condition to generate a hint related to the sentence (possibly including all exceptions)

Methods inherited from class org.languagetool.rules.AbstractStatisticStyleRule

getDefaultValue, getMaxConfigurableValue, getMinConfigurableValue, getNumberOfMatches, getWordCount, hasConfigurableValue, match, minToCheckParagraph, setWithoutDirectSpeech

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, getSentenceWithImmunization, getSourceFile, getSubId, getTags, getToneTags, getUrl, 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

UnnecessaryPhraseRule

public UnnecessaryPhraseRule(ResourceBundle messages,
                             Language lang,
                             UserConfig userConfig)

Method Detail

denominator

public double denominator()

Minimal value is given in per mil

Overrides:

denominator in class AbstractStatisticStyleRule

conditionFulfilled

protected int conditionFulfilled(AnalyzedTokenReadings[] tokens,
                                 int nAnalysedToken)

Description copied from class: AbstractStatisticStyleRule

Condition to generate a hint (possibly including all exceptions) Returns: < nAnalysedToken, if condition is not fulfilled >= nAnalysedToken, if condition is not fulfilled; integer is number of token which is the end hint

Specified by:

conditionFulfilled in class AbstractStatisticStyleRule

sentenceConditionFulfilled

protected boolean sentenceConditionFulfilled(AnalyzedTokenReadings[] tokens,
                                             int nToken)

Description copied from class: AbstractStatisticStyleRule

Condition to generate a hint related to the sentence (possibly including all exceptions)

Specified by:

sentenceConditionFulfilled in class AbstractStatisticStyleRule

excludeDirectSpeech

protected boolean excludeDirectSpeech()

Description copied from class: AbstractStatisticStyleRule

Condition to generate a hint related to the sentence (possibly including all exceptions)

Specified by:

excludeDirectSpeech in class AbstractStatisticStyleRule

getLimitMessage

protected String getLimitMessage(int limit,
                                 double percent)

Description copied from class: AbstractStatisticStyleRule

Defines the message for hints which exceed the limit

Specified by:

getLimitMessage in class AbstractStatisticStyleRule

getSentenceMessage

protected String getSentenceMessage()

Description copied from class: AbstractStatisticStyleRule

Defines the message for sentence related hints

Specified by:

getSentenceMessage in class AbstractStatisticStyleRule

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

getConfigureText

public String getConfigureText()

Description copied from class: Rule

Overwrite this to define the Text in the option panel for the configurable value

Specified by:

getConfigureText in class AbstractStatisticStyleRule