Package org.apache.lucene.search

Class CollectionStatistics

java.lang.Object

org.apache.lucene.search.CollectionStatistics

public class CollectionStatistics
extends Object

Contains statistics for a collection (field)

Constructor Summary

Constructors

Constructor	Description
CollectionStatistics(String field, long maxDoc, long docCount, long sumTotalTermFreq, long sumDocFreq)

Method Summary

Modifier and Type	Method	Description
final long	docCount()	returns the total number of documents that have at least one term for this field.
final String	field()	returns the field name
final long	maxDoc()	returns the total number of documents, regardless of whether they all contain values for this field.
final long	sumDocFreq()	returns the total number of postings for this field
final long	sumTotalTermFreq()	returns the total number of tokens for this field

Methods inherited from class java.lang.Object

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

Constructor Details

CollectionStatistics

public CollectionStatistics(String field,
 long maxDoc,
 long docCount,
 long sumTotalTermFreq,
 long sumDocFreq)

Method Details

field

public final String field()

returns the field name

maxDoc

public final long maxDoc()

returns the total number of documents, regardless of whether they all contain values for this field.

See Also:

• IndexReader.maxDoc()

docCount

public final long docCount()

returns the total number of documents that have at least one term for this field.

See Also:

• Terms.getDocCount()

sumTotalTermFreq

public final long sumTotalTermFreq()

returns the total number of tokens for this field

See Also:

• Terms.getSumTotalTermFreq()

sumDocFreq

public final long sumDocFreq()

returns the total number of postings for this field

See Also:

• Terms.getSumDocFreq()