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() 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.
double	getFleschReadingEase(double asl, double asw) get Flesch-Reading-Ease (Formula for readability) for English the formula dependence on the language and has to be overridden for every supported language
String	getId() A string used to identify the rule in e.g. configuration files.
String	getId(boolean tooEasyTest)
protected String	getMessage(int level, int fre, int als, int asw)
String	printMessageLevel(int level)
protected int	simpleSyllablesCount(String word) A simple method to count the Syllables of a word TODO: further improvement of the method A hyphenation service should be used if available (e.g. from LO extension) Has to be overridden for every language

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()

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.

Overrides:

getId in class ReadabilityRule

getId

public String getId(boolean tooEasyTest)

Overrides:

getId in class ReadabilityRule

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.

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()

Description copied from class: Rule

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

Overrides:

getConfigureText in class ReadabilityRule

getFleschReadingEase

public double getFleschReadingEase(double asl,
                                   double asw)

Description copied from class: ReadabilityRule

get Flesch-Reading-Ease (Formula for readability) for English the formula dependence on the language and has to be overridden for every supported language

Overrides:

getFleschReadingEase in class ReadabilityRule

simpleSyllablesCount

protected int simpleSyllablesCount(String word)

Description copied from class: ReadabilityRule

A simple method to count the Syllables of a word TODO: further improvement of the method A hyphenation service should be used if available (e.g. from LO extension) Has to be overridden for every language

Overrides:

simpleSyllablesCount in class ReadabilityRule