Package org.apache.lucene.index

Class MultiDocsAndPositionsEnum

  • public final class MultiDocsAndPositionsEnum
extends DocsAndPositionsEnum
    Exposes flex API, merged from flex API of sub-segments.

    • Constructor Detail

      • MultiDocsAndPositionsEnum

        public MultiDocsAndPositionsEnum​(MultiTermsEnum parent,
                                 int subReaderCount)
        Sole constructor.

    • Method Detail

      • getNumSubs

        public int getNumSubs()
        How many sub-readers we are merging.
        See Also:
        getSubs()

      • 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.

        Specified by:
        advance in class DocIdSetIterator
        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.
        Specified by:
        nextDoc in class DocIdSetIterator
        Throws:
        java.io.IOException

      • nextPosition

        public int nextPosition()
                 throws java.io.IOException
        Description copied from class: DocsAndPositionsEnum
        Returns the next position. You should only call this up to DocsEnum.freq() times else the behavior is not defined. If positions were not indexed this will return -1; this only happens if offsets were indexed and you passed needsOffset=true when pulling the enum.
        Specified by:
        nextPosition in class DocsAndPositionsEnum
        Throws:
        java.io.IOException

      • startOffset

        public int startOffset()
                throws java.io.IOException
        Description copied from class: DocsAndPositionsEnum
        Returns start offset for the current position, or -1 if offsets were not indexed.
        Specified by:
        startOffset in class DocsAndPositionsEnum
        Throws:
        java.io.IOException

      • endOffset

        public int endOffset()
              throws java.io.IOException
        Description copied from class: DocsAndPositionsEnum
        Returns end offset for the current position, or -1 if offsets were not indexed.
        Specified by:
        endOffset in class DocsAndPositionsEnum
        Throws:
        java.io.IOException

      • getPayload

        public BytesRef getPayload()
                    throws java.io.IOException
        Description copied from class: DocsAndPositionsEnum
        Returns the payload at this position, or null if no payload was indexed. You should not modify anything (neither members of the returned BytesRef nor bytes in the byte[]).
        Specified by:
        getPayload in class DocsAndPositionsEnum
        Throws:
        java.io.IOException

      • 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

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object