org.languagetool.rules.de

Class PassiveSentenceRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.TextLevelRule

org.languagetool.rules.AbstractStatisticSentenceStyleRule

org.languagetool.rules.de.PassiveSentenceRule

public class PassiveSentenceRule
extends AbstractStatisticSentenceStyleRule

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

Author:

Fred Kruse

Field Summary

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected AnalyzedTokenReadings	conditionFulfilled(List<AnalyzedTokenReadings> sentence) Is passive sentence
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

Methods inherited from class org.languagetool.rules.AbstractStatisticSentenceStyleRule

denominator, getDefaultValue, getMaxConfigurableValue, getMinConfigurableValue, getNumberOfMatches, getSentenceCount, hasConfigurableValue, isMark, isOpeningQuote, 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

PassiveSentenceRule

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

Method Detail

conditionFulfilled

protected AnalyzedTokenReadings conditionFulfilled(List<AnalyzedTokenReadings> sentence)

Is passive sentence

Specified by:

conditionFulfilled in class AbstractStatisticSentenceStyleRule

excludeDirectSpeech

protected boolean excludeDirectSpeech()

Description copied from class: AbstractStatisticSentenceStyleRule

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

Specified by:

excludeDirectSpeech in class AbstractStatisticSentenceStyleRule

getLimitMessage

protected String getLimitMessage(int limit,
                                 double percent)

Description copied from class: AbstractStatisticSentenceStyleRule

Defines the message for hints which exceed the limit

Specified by:

getLimitMessage in class AbstractStatisticSentenceStyleRule

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 AbstractStatisticSentenceStyleRule