Class CollectionStatistics

Contains statistics for a collection (field)

Note

This API is experimental and might change in incompatible ways in the next release.

Inheritance
object
CollectionStatistics
Inherited Members
Namespace: Lucene.Net.Search
Assembly: Lucene.Net.dll
Syntax
public class CollectionStatistics

Constructors

CollectionStatistics(string, long, long, long, long)

Sole constructor.

Declaration
public CollectionStatistics(string field, long maxDoc, long docCount, long sumTotalTermFreq, long sumDocFreq)
Parameters
Type Name Description
string field
long maxDoc
long docCount
long sumTotalTermFreq
long sumDocFreq

Properties

DocCount

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

Declaration
public long DocCount { get; }
Property Value
Type Description
long
See Also

Field

Returns the field name

Declaration
public string Field { get; }
Property Value
Type Description
string

MaxDoc

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

Declaration
public long MaxDoc { get; }
Property Value
Type Description
long
See Also

SumDocFreq

Returns the total number of postings for this field

Declaration
public long SumDocFreq { get; }
Property Value
Type Description
long
See Also

SumTotalTermFreq

Returns the total number of tokens for this field

Declaration
public long SumTotalTermFreq { get; }
Property Value
Type Description
long
See Also