Package org.apache.lucene.document

Class BinaryRangeDocValues

  • public class BinaryRangeDocValues
extends BinaryDocValues
    A binary representation of a range that wraps a BinaryDocValues field

    • Constructor Detail

      • BinaryRangeDocValues

        public BinaryRangeDocValues​(BinaryDocValues in,
                            int numDims,
                            int numBytesPerDimension)
        Constructor for BinaryRangeDocValues
        Parameters:
        in - the binary doc values source field
        numDims - the number of dimensions in each doc values field
        numBytesPerDimension - size of each dimension (2 * encoded value size)

    • Method Detail

      • cost

        public long cost()
        Description copied from class: DocIdSetIterator
        Returns the estimated cost of this DocIdSetIterator.

        This is generally an upper bound of the number of documents this iterator might match, but may be a rough heuristic, hardcoded value, or otherwise completely inaccurate.

        Specified by:
        cost in class DocIdSetIterator

      • advance

        public int advance​(int target)
            throws 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.

        Specified by:
        advance in class DocIdSetIterator
        Throws:
        IOException

      • advanceExact

        public 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

      • getPackedValue

        public byte[] getPackedValue()
        Gets the packed value that represents this range
        Returns:
        the packed value that represents this range