Package org.apache.lucene.search

Class TermStatistics

  • public class TermStatistics
extends java.lang.Object
    Contains statistics for a specific term

    • Constructor Summary

      Constructors 
      Constructor Description
      TermStatistics​(BytesRef term, long docFreq, long totalTermFreq)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      long docFreq()
      returns the number of documents this term occurs in
      BytesRef term()
      returns the term text
      long totalTermFreq()
      returns the total number of occurrences of this term

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • TermStatistics

        public TermStatistics​(BytesRef term,
                      long docFreq,
                      long totalTermFreq)

    • Method Detail

      • term

        public final BytesRef term()
        returns the term text

      • docFreq

        public final long docFreq()
        returns the number of documents this term occurs in
        See Also:
        TermsEnum.docFreq()

      • totalTermFreq

        public final long totalTermFreq()
        returns the total number of occurrences of this term
        See Also:
        TermsEnum.totalTermFreq()