Class NumericDocValues

java.lang.Object
org.apache.lucene.search.DocIdSetIterator
org.apache.lucene.index.NumericDocValues
Direct Known Subclasses:
FilterNumericDocValues

public abstract class NumericDocValues extends DocIdSetIterator
A per-document numeric value.
  • Constructor Details

    • NumericDocValues

      protected NumericDocValues()
      Sole constructor. (For invocation by subclass constructors, typically implicit.)
  • Method Details

    • longValue

      public abstract long longValue() throws IOException
      Returns the numeric value for the current document ID. It is illegal to call this method after advanceExact(int) returned false.
      Returns:
      numeric value
      Throws:
      IOException
    • advanceExact

      public abstract boolean advanceExact(int target) throws IOException
      Advance the iterator to exactly target and return whether target has a value. target must be greater than or equal to the current doc ID and must be a valid doc ID, ie. ≥ 0 and < maxDoc. After this method returns, DocIdSetIterator.docID() returns target.
      Throws:
      IOException