Class TextDocumentStatistics

java.lang.Object

com.kohlschutter.boilerpipe.document.TextDocumentStatistics

public final class TextDocumentStatistics
extends Object

Provides shallow statistics on a given TextDocument

Field Summary

Fields

Modifier and Type	Field	Description
private int	numBlocks
private int	numWords

Constructor Summary

Constructors

Constructor	Description
TextDocumentStatistics(TextDocument doc, boolean contentOnly)	Computes statistics on a given TextDocument.

Method Summary

Modifier and Type	Method	Description
float	avgNumWords()	Returns the average number of words at block-level (= overall number of words divided by the number of blocks).
int	getNumWords()	Returns the overall number of words in all blocks.

Methods inherited from class Object

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

Field Details

numWords

private int numWords

numBlocks

private int numBlocks

Constructor Details

TextDocumentStatistics

public TextDocumentStatistics(TextDocument doc,
 boolean contentOnly)

Computes statistics on a given TextDocument.

Parameters:

doc - The TextDocument.

contentOnly - if true then o

Method Details

avgNumWords

public float avgNumWords()

Returns the average number of words at block-level (= overall number of words divided by the number of blocks).

Returns:

Average

getNumWords

public int getNumWords()

Returns the overall number of words in all blocks.

Returns:

Sum