Package org.languagetool.rules.de

Class GermanFillerWordsRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.TextLevelRule

org.languagetool.rules.AbstractStatisticStyleRule

org.languagetool.rules.de.GermanFillerWordsRule

public class GermanFillerWordsRule
extends AbstractStatisticStyleRule

A rule that gives Hints about the use of German filler words. The Hints are only given when the percentage of filler words 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:

4.2

Field Summary

Fields

Modifier and Type	Field	Description
private static final boolean	DEFAULT_MANY_IN_SENTENCE
private static final int	DEFAULT_MIN_PERCENT
private static final String	DEFAULT_SENTENCE_MSG1
private static final String	DEFAULT_SENTENCE_MSG2
private static final boolean	DEFAULT_TWO_FOLLOWING
private static final Set<String>	fillerWords
(package private) String	sentenceMessage
private final Boolean	TestManyInSentence
private final Boolean	testTwoFollowing

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor	Description
GermanFillerWordsRule(ResourceBundle messages, Language lang, UserConfig userConfig)

Method Summary

Modifier and Type	Method	Description
protected int	conditionFulfilled(AnalyzedTokenReadings[] tokens, int nToken)	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
protected boolean	excludeDirectSpeech()	Condition to generate a hint related to the sentence (possibly including all exceptions)
String	getConfigurePercentText()
String	getConfigureWithoutDirectSpeachText()
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.
protected String	getLimitMessage(int limit, double percent)	Defines the message for hints which exceed the limit
private boolean	getManyInSentence(UserConfig userConfig)
RuleOption[]	getRuleOptions()	give the user the possibility to configure the function
protected String	getSentenceMessage()	Defines the message for sentence related hints
private boolean	getTwoFollowing(UserConfig userConfig)
private static boolean	isException(AnalyzedTokenReadings[] tokens, int num)
private static boolean	isTwoWordException(String first, String second)
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

denominator, getNumberOfMatches, getWordCount, 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, getPriority, getSentenceWithImmunization, getSourceFile, getSubId, getTags, getToneTags, getUrl, hasTag, hasToneTag, isDefaultOff, isDefaultTempOff, isDictionaryBasedSpellingRule, isGoalSpecific, isIncludedInHiddenMatches, isOfficeDefaultOff, isOfficeDefaultOn, isPremium, makeAntiPatterns, setCategory, setCorrectExamples, setDefaultOff, setDefaultOn, setDefaultTempOff, setDistanceTokens, setErrorTriggeringExamples, setExamplePair, setGoalSpecific, setIncludedInHiddenMatches, setIncorrectExamples, setLocQualityIssueType, setMinPrevMatches, setOfficeDefaultOff, setOfficeDefaultOn, setPremium, setPriority, setTags, setToneTags, setUrl, supportsLanguage, toRuleMatchArray, useInOffice

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_MIN_PERCENT

private static final int DEFAULT_MIN_PERCENT

See Also:

• Constant Field Values

DEFAULT_TWO_FOLLOWING

private static final boolean DEFAULT_TWO_FOLLOWING

See Also:

• Constant Field Values

DEFAULT_MANY_IN_SENTENCE

private static final boolean DEFAULT_MANY_IN_SENTENCE

See Also:

• Constant Field Values

DEFAULT_SENTENCE_MSG1

private static final String DEFAULT_SENTENCE_MSG1

See Also:

• Constant Field Values

DEFAULT_SENTENCE_MSG2

private static final String DEFAULT_SENTENCE_MSG2

See Also:

• Constant Field Values

fillerWords

private static final Set<String> fillerWords

testTwoFollowing

private final Boolean testTwoFollowing

TestManyInSentence

private final Boolean TestManyInSentence

sentenceMessage

String sentenceMessage

Constructor Details

GermanFillerWordsRule

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

Method Details

getTwoFollowing

private boolean getTwoFollowing(UserConfig userConfig)

getManyInSentence

private boolean getManyInSentence(UserConfig userConfig)

isException

private static boolean isException(AnalyzedTokenReadings[] tokens,
 int num)

conditionFulfilled

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

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

isTwoWordException

private static boolean isTwoWordException(String first,
 String second)

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

getConfigurePercentText

public String getConfigurePercentText()

Specified by:

getConfigurePercentText in class AbstractStatisticStyleRule

getConfigureWithoutDirectSpeachText

public String getConfigureWithoutDirectSpeachText()

Specified by:

getConfigureWithoutDirectSpeachText in class AbstractStatisticStyleRule

getRuleOptions

public RuleOption[] getRuleOptions()

Description copied from class: AbstractStatisticStyleRule

give the user the possibility to configure the function

Overrides:

getRuleOptions in class AbstractStatisticStyleRule