Package org.apache.lucene.index

Class ExitableDirectoryReader.ExitableFilterAtomicReader.ExitableVectorValues

    • Field Detail

      • docToCheck

        private int docToCheck

    • Constructor Detail

      • ExitableVectorValues

        public ExitableVectorValues​(VectorValues vectorValues)

    • Method Detail

      • advance

        public int advance​(int target)
            throws java.io.IOException
        Description copied from class: DocIdSetIterator
        Advances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself. Exhausts the iterator and returns DocIdSetIterator.NO_MORE_DOCS if target is greater than the highest document number in the set.

        The behavior of this method is undefined when called with target ≤ current , or after the iterator has exhausted. Both cases may result in unpredicted behavior.

        When target > current it behaves as if written: 

         int advance(int target) {
   int doc;
   while ((doc = nextDoc()) < target) {
   }
   return doc;
 }
        Some implementations are considerably more efficient than that.

        NOTE: this method may be called with DocIdSetIterator.NO_MORE_DOCS for efficiency by some Scorers. If your implementation cannot efficiently determine that it should exhaust, it is recommended that you check for that value in each call to this method.

        Overrides:
        advance in class FilterVectorValues
        Throws:
        java.io.IOException

      • nextDoc

        public int nextDoc()
            throws java.io.IOException
        Description copied from class: DocIdSetIterator
        Advances to the next document in the set and returns the doc it is currently on, or DocIdSetIterator.NO_MORE_DOCS if there are no more docs in the set.
        NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.
        Overrides:
        nextDoc in class FilterVectorValues
        Throws:
        java.io.IOException

      • vectorValue

        public float[] vectorValue()
                    throws java.io.IOException
        Description copied from class: VectorValues
        Return the vector value for the current document ID. It is illegal to call this method when the iterator is not positioned: before advancing, or after failing to advance. The returned array may be shared across calls, re-used, and modified as the iterator advances.
        Overrides:
        vectorValue in class FilterVectorValues
        Returns:
        the vector value
        Throws:
        java.io.IOException

      • binaryValue

        public BytesRef binaryValue()
                     throws java.io.IOException
        Description copied from class: VectorValues
        Return the binary encoded vector value for the current document ID. These are the bytes corresponding to the float array return by VectorValues.vectorValue(). It is illegal to call this method when the iterator is not positioned: before advancing, or after failing to advance. The returned storage may be shared across calls, re-used and modified as the iterator advances.
        Overrides:
        binaryValue in class FilterVectorValues
        Returns:
        the binary value
        Throws:
        java.io.IOException