Class BinaryDocValues

java.lang.Object
org.apache.lucene.search.DocIdSetIterator
org.apache.lucene.index.BinaryDocValues
Direct Known Subclasses:
FilterBinaryDocValues

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

    • BinaryDocValues

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

    • binaryValue

      public abstract BytesRef binaryValue() throws IOException
      Returns the binary value for the current document ID. It is illegal to call this method after advanceExact(int) returned false.
      Returns:
      binary 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