de.tudarmstadt.ukp.dkpro.core.readability.measure

Class ReadabilityMeasures

java.lang.Object

de.tudarmstadt.ukp.dkpro.core.readability.measure.ReadabilityMeasures

public class ReadabilityMeasures
extends Object

Java port of readability measures from the Linux 'style' command ('diction' package).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReadabilityMeasures.Measures

Constructor Summary

Constructors

Constructor and Description
ReadabilityMeasures()
ReadabilityMeasures(String language)

Method Summary

Modifier and Type	Method and Description
double	ari(List<String> words, int nrofSentences) Calculate Automated Readability Index (reading grade).
double	coleman_liau(List<String> words, int nrofSentences) Calculate Coleman-Liau formula.
double	flesch(List<String> words, int nrofSentences) Calculate Flesch reading ease score.
double	fog(List<String> words, int nrofSentences) Calculate FOG index.
String	getLanguage()
double	getReadabilityScore(ReadabilityMeasures.Measures measure, List<String> words, int nrofSentences)
double	kincaid(List<String> words, int nrofSentences) Calculate Kincaid Formula (reading grade).
double	lix(List<String> words, int nrofSentences) Calculate Björnsson's Lix formula.
void	setLanguage(String language)
double	smog(List<String> words, int nrofSentences) Calculate SMOG-Grading.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReadabilityMeasures

public ReadabilityMeasures()

ReadabilityMeasures

public ReadabilityMeasures(String language)

Method Detail

getReadabilityScore

public double getReadabilityScore(ReadabilityMeasures.Measures measure,
                                  List<String> words,
                                  int nrofSentences)

kincaid

public double kincaid(List<String> words,
                      int nrofSentences)

Calculate Kincaid Formula (reading grade).

Parameters:

words - words

nrofSentences - number of sentences.

Returns:

score.

ari

public double ari(List<String> words,
                  int nrofSentences)

Calculate Automated Readability Index (reading grade).

Parameters:

words - words.

nrofSentences - number of sentences.

Returns:

score.

coleman_liau

public double coleman_liau(List<String> words,
                           int nrofSentences)

Calculate Coleman-Liau formula.

Parameters:

words - words.

nrofSentences - number of sentences.

Returns:

score.

flesch

public double flesch(List<String> words,
                     int nrofSentences)

Calculate Flesch reading ease score.

Parameters:

words - words.

nrofSentences - number of sentences.

Returns:

score.

fog

public double fog(List<String> words,
                  int nrofSentences)

Calculate FOG index.

Parameters:

words - words.

nrofSentences - number of sentences.

Returns:

score.

lix

public double lix(List<String> words,
                  int nrofSentences)

Calculate Björnsson's Lix formula.

Parameters:

words - words.

nrofSentences - number of sentences.

Returns:

the wheeler smith index as result and the grade level in grade. If grade is 0, the index is lower than any grade, if the index is 99, it is higher than any grade.

smog

public double smog(List<String> words,
                   int nrofSentences)

Calculate SMOG-Grading.

Parameters:

words - words.

nrofSentences - number of sentences.

Returns:

score.

getLanguage

public String getLanguage()

setLanguage

public void setLanguage(String language)