public class TermStatistics extends Object
This class holds statistics for this term across all documents for scoring purposes:
docFreq: number of documents this term occurs in.
totalTermFreq: number of tokens for this term.
The following conditions are always true:
sumDocFreqof the collection
sumTotalTermFreqof the collection
Values may include statistics on deleted documents that have not yet been merged away.
Be careful when performing calculations on these values because they are represented
as 64-bit integer values, you may need to cast to
double for your use.
|Constructor and Description|
Creates statistics instance for a term.
|Modifier and Type||Method and Description|
The number of documents this term occurs in.
The term text.
The total number of occurrences of this term.
public TermStatistics(BytesRef term, long docFreq, long totalTermFreq)
term- Term bytes
docFreq- number of documents containing the term in the collection.
totalTermFreq- number of occurrences of the term in the collection.
docFreqis negative or zero.
totalTermFreqis less than
public final BytesRef term()
This value is never
public final long docFreq()
This is the document-frequency for the term: the count of documents where the term appears at least one time.
This value is always a positive number, and never
totalTermFreq. It also cannot exceed
public final long totalTermFreq()
This is the token count for the term: the number of times it appears in the field across all documents.
This value is always a positive number, always at least
and never exceeds
Copyright © 2000-2020 Apache Software Foundation. All Rights Reserved.