Package org.apache.lucene.search

Class CollectionStatistics

  • public class CollectionStatistics
extends java.lang.Object
    Contains statistics for a collection (field)

    • Constructor Summary

      Constructors 
      Constructor Description
      CollectionStatistics​(java.lang.String field, long maxDoc, long docCount, long sumTotalTermFreq, long sumDocFreq)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      long docCount()
      returns the total number of documents that have at least one term for this field.
      java.lang.String field()
      returns the field name
      long maxDoc()
      returns the total number of documents, regardless of whether they all contain values for this field.
      long sumDocFreq()
      returns the total number of postings for this field
      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 Detail

      • CollectionStatistics

        public CollectionStatistics​(java.lang.String field,
                            long maxDoc,
                            long docCount,
                            long sumTotalTermFreq,
                            long sumDocFreq)

    • Method Detail

      • field

        public final java.lang.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()