org.languagetool.rules.de

Class GermanReadabilityRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.TextLevelRule

org.languagetool.rules.ReadabilityRule

org.languagetool.rules.de.GermanReadabilityRule

public class GermanReadabilityRule
extends ReadabilityRule

A rule that checks the readability of German text (using the Flesch-Reading-Ease Formula) If tooEasyTest == true, the rule tests if paragraph level > level (readability is too easy) If tooEasyTest == false, the rule tests if paragraph level < level (readability is too difficult)

Since:

4.4

Author:

Fred Kruse

Field Summary

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor and Description
GermanReadabilityRule(ResourceBundle messages, Language lang, UserConfig userConfig, boolean tooEasyTest)
GermanReadabilityRule(ResourceBundle messages, Language lang, UserConfig userConfig, boolean tooEasyTest, boolean defaultOn)
GermanReadabilityRule(ResourceBundle messages, Language lang, UserConfig userConfig, boolean tooEasyTest, int level)
GermanReadabilityRule(ResourceBundle messages, Language lang, UserConfig userConfig, boolean tooEasyTest, int level, boolean defaultOn)

Method Summary

Modifier and Type	Method and Description
String	getConfigureText()
String	getDescription()
double	getFleschReadingEase(double asl, double asw)
String	getId()
String	getId(boolean tooEasyTest)
protected String	getMessage(int level, int fre, int als, int asw)
String	printMessageLevel(int level)
protected int	simpleSyllablesCount(String word)

Methods inherited from class org.languagetool.rules.ReadabilityRule

getAllSentences, getAllSyllables, getAllWords, getDefaultValue, getMaxConfigurableValue, getMinConfigurableValue, hasConfigurableValue, match, minToCheckParagraph

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

GermanReadabilityRule

public GermanReadabilityRule(ResourceBundle messages,
                             Language lang,
                             UserConfig userConfig,
                             boolean tooEasyTest)

GermanReadabilityRule

public GermanReadabilityRule(ResourceBundle messages,
                             Language lang,
                             UserConfig userConfig,
                             boolean tooEasyTest,
                             int level)

GermanReadabilityRule

public GermanReadabilityRule(ResourceBundle messages,
                             Language lang,
                             UserConfig userConfig,
                             boolean tooEasyTest,
                             boolean defaultOn)

GermanReadabilityRule

public GermanReadabilityRule(ResourceBundle messages,
                             Language lang,
                             UserConfig userConfig,
                             boolean tooEasyTest,
                             int level,
                             boolean defaultOn)

Method Detail

getId

public String getId()

Overrides:

getId in class ReadabilityRule

getId

public String getId(boolean tooEasyTest)

Overrides:

getId in class ReadabilityRule

getDescription

public String getDescription()

Overrides:

getDescription in class ReadabilityRule

printMessageLevel

public String printMessageLevel(int level)

Overrides:

printMessageLevel in class ReadabilityRule

getMessage

protected String getMessage(int level,
                            int fre,
                            int als,
                            int asw)

Overrides:

getMessage in class ReadabilityRule

getConfigureText

public String getConfigureText()

Overrides:

getConfigureText in class ReadabilityRule

getFleschReadingEase

public double getFleschReadingEase(double asl,
                                   double asw)

Overrides:

getFleschReadingEase in class ReadabilityRule

simpleSyllablesCount

protected int simpleSyllablesCount(String word)

Overrides:

simpleSyllablesCount in class ReadabilityRule