Class SortedBinaryDocValues

  • Direct Known Subclasses:
    SortingBinaryDocValues

    public abstract class SortedBinaryDocValues
    extends java.lang.Object
    A list of per-document binary values, sorted according to BytesRef.compareTo(BytesRef). There might be dups however.
    • Method Summary

      Modifier and Type Method Description
      abstract boolean advanceExact​(int doc)
      Advance this instance to the given document id
      abstract int docValueCount()
      Retrieves the number of values for the current document.
      abstract org.apache.lucene.util.BytesRef nextValue()
      Iterates to the next value in the current document.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • SortedBinaryDocValues

        public SortedBinaryDocValues()
    • Method Detail

      • advanceExact

        public abstract boolean advanceExact​(int doc)
                                      throws java.io.IOException
        Advance this instance to the given document id
        Returns:
        true if there is a value for this document
        Throws:
        java.io.IOException
      • docValueCount

        public abstract int docValueCount()
        Retrieves the number of values for the current document. This must always be greater than zero. It is illegal to call this method after advanceExact(int) returned false.
      • nextValue

        public abstract org.apache.lucene.util.BytesRef nextValue()
                                                           throws java.io.IOException
        Iterates to the next value in the current document. Do not call this more than docValueCount() times for the document. Note that the returned BytesRef might be reused across invocations.
        Throws:
        java.io.IOException