Package org.apache.lucene.index

Class MultiDocValues.MultiSortedSetDocValues

  • Enclosing class:
    MultiDocValues
    public static class MultiDocValues.MultiSortedSetDocValues
extends SortedSetDocValues
    Implements MultiSortedSetDocValues over n subs, using an OrdinalMap
    NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

    • Field Detail

      • docStarts

        public final int[] docStarts
        docbase for each leaf: parallel with values

      • mapping

        public final OrdinalMap mapping
        ordinal map mapping ords from values to global ord space

    • Constructor Detail

      • MultiSortedSetDocValues

        public MultiSortedSetDocValues​(SortedSetDocValues[] values,
                               int[] docStarts,
                               OrdinalMap mapping,
                               long totalCost)
        Creates a new MultiSortedSetDocValues over values

    • Method Detail

      • advance

        public int advance​(int targetDocID)
            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 targetDocID)
                     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

      • getValueCount

        public long getValueCount()
        Description copied from class: SortedSetDocValues
        Returns the number of unique values.
        Specified by:
        getValueCount in class SortedSetDocValues
        Returns:
        number of unique values in this SortedDocValues. This is also equivalent to one plus the maximum ordinal.

      • 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