com.sun.labs.minion
Interface TermStats

All Known Implementing Classes:

TermStatsImpl

public interface TermStats

An interface to some standard term statistics.

See Also:

SearchEngine.getTermStats(java.lang.String)

Method Summary

int	getDocFreq() Gets the number of documents in which the term occurs.
int	getMaxFDT() Gets the maximum term frequency for the term in this collection.
java.lang.String	getName() Gets the name of the term whose stats we're holding.
int	getTotalOccurrences() Gets the total number of occurrences of the term in the collection.

Method Detail

getDocFreq

int getDocFreq()

Gets the number of documents in which the term occurs.

Returns:

the number of documents in the collection that contain the term.

getMaxFDT

int getMaxFDT()

Gets the maximum term frequency for the term in this collection.

Returns:

the maximum term frequency.

getName

java.lang.String getName()

Gets the name of the term whose stats we're holding.

getTotalOccurrences

int getTotalOccurrences()

Gets the total number of occurrences of the term in the collection.

Returns:

the total number of occurrences of the term in all documents in the collection.