Class CollectionStatistics

Contains statistics for a collection (field)

This is a Lucene.NET EXPERIMENTAL API, use at your own risk
Inheritance
System.Object
CollectionStatistics
Namespace: Lucene.Net.Search
Assembly: Lucene.Net.dll
Syntax
public class CollectionStatistics : object

Constructors

| Improve this Doc View Source

CollectionStatistics(String, Int64, Int64, Int64, Int64)

Sole constructor.

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

Properties

| Improve this Doc View Source

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
System.Int64
See Also
| Improve this Doc View Source

Field

Returns the field name

Declaration
public string Field { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

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
System.Int64
See Also
| Improve this Doc View Source

SumDocFreq

Returns the total number of postings for this field

Declaration
public long SumDocFreq { get; }
Property Value
Type Description
System.Int64
See Also
| Improve this Doc View Source

SumTotalTermFreq

Returns the total number of tokens for this field

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