Class DocValuesStats<T>

java.lang.Object
org.apache.lucene.misc.search.DocValuesStats<T>
Direct Known Subclasses:
DocValuesStats.NumericDocValuesStats, DocValuesStats.SortedDocValuesStats, DocValuesStats.SortedNumericDocValuesStats, DocValuesStats.SortedSetDocValuesStats

public abstract class DocValuesStats<T> extends Object
Holds statistics for a DocValues field.
  • Field Details

    • field

      protected final String field
    • min

      protected T min
    • max

      protected T max
  • Constructor Details

    • DocValuesStats

      protected DocValuesStats(String field, T initialMin, T initialMax)
  • Method Details

    • doAccumulate

      protected abstract void doAccumulate(int count) throws IOException
      Called after accumulate(int) was processed and verified that the document has a value for the field. Implementations should update the statistics based on the value of the current document.
      Parameters:
      count - the updated number of documents with value for this field.
      Throws:
      IOException
    • init

      protected abstract boolean init(LeafReaderContext context) throws IOException
      Initializes this object with the given reader context. Returns whether stats can be computed for this segment (i.e. it does have the requested DocValues field).
      Throws:
      IOException
    • hasValue

      protected abstract boolean hasValue(int doc) throws IOException
      Returns whether the given document has a value for the requested DocValues field.
      Throws:
      IOException
    • field

      public final String field()
      The field for which these stats were computed.
    • count

      public final int count()
      The number of documents which have a value of the field.
    • missing

      public final int missing()
      The number of documents which do not have a value of the field.
    • min

      public final T min()
      The minimum value of the field. Undefined when count() is zero.
    • max

      public final T max()
      The maximum value of the field. Undefined when count() is zero.