Class BasicStats
- java.lang.Object
-
- org.apache.lucene.search.similarities.BasicStats
-
- Direct Known Subclasses:
LMSimilarity.LMStats
public class BasicStats extends Object
Stores all statistics commonly used ranking methods.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Field Summary
Fields Modifier and Type Field Description protected double
avgFieldLength
The average field length.protected double
boost
A query boost.protected long
docFreq
The document frequency.protected long
numberOfDocuments
The number of documents.protected long
numberOfFieldTokens
The total number of tokens in the field.protected long
totalTermFreq
The total number of occurrences of this term across all documents.
-
Constructor Summary
Constructors Constructor Description BasicStats(String field, double boost)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description double
getAvgFieldLength()
Returns the average field length.double
getBoost()
Returns the total boost.long
getDocFreq()
Returns the document frequency.long
getNumberOfDocuments()
Returns the number of documents.long
getNumberOfFieldTokens()
Returns the total number of tokens in the field.long
getTotalTermFreq()
Returns the total number of occurrences of this term across all documents.void
setAvgFieldLength(double avgFieldLength)
Sets the average field length.void
setDocFreq(long docFreq)
Sets the document frequency.void
setNumberOfDocuments(long numberOfDocuments)
Sets the number of documents.void
setNumberOfFieldTokens(long numberOfFieldTokens)
Sets the total number of tokens in the field.void
setTotalTermFreq(long totalTermFreq)
Sets the total number of occurrences of this term across all documents.
-
-
-
Field Detail
-
numberOfDocuments
protected long numberOfDocuments
The number of documents.
-
numberOfFieldTokens
protected long numberOfFieldTokens
The total number of tokens in the field.
-
avgFieldLength
protected double avgFieldLength
The average field length.
-
docFreq
protected long docFreq
The document frequency.
-
totalTermFreq
protected long totalTermFreq
The total number of occurrences of this term across all documents.
-
boost
protected final double boost
A query boost. Should be applied as a multiplicative factor to the score.
-
-
Constructor Detail
-
BasicStats
public BasicStats(String field, double boost)
Constructor.
-
-
Method Detail
-
getNumberOfDocuments
public long getNumberOfDocuments()
Returns the number of documents.
-
setNumberOfDocuments
public void setNumberOfDocuments(long numberOfDocuments)
Sets the number of documents.
-
getNumberOfFieldTokens
public long getNumberOfFieldTokens()
Returns the total number of tokens in the field.- See Also:
Terms.getSumTotalTermFreq()
-
setNumberOfFieldTokens
public void setNumberOfFieldTokens(long numberOfFieldTokens)
Sets the total number of tokens in the field.- See Also:
Terms.getSumTotalTermFreq()
-
getAvgFieldLength
public double getAvgFieldLength()
Returns the average field length.
-
setAvgFieldLength
public void setAvgFieldLength(double avgFieldLength)
Sets the average field length.
-
getDocFreq
public long getDocFreq()
Returns the document frequency.
-
setDocFreq
public void setDocFreq(long docFreq)
Sets the document frequency.
-
getTotalTermFreq
public long getTotalTermFreq()
Returns the total number of occurrences of this term across all documents.
-
setTotalTermFreq
public void setTotalTermFreq(long totalTermFreq)
Sets the total number of occurrences of this term across all documents.
-
getBoost
public double getBoost()
Returns the total boost.
-
-