Module org.apache.lucene.core
Package org.apache.lucene.index

Class DocValuesFieldUpdates.Iterator

java.lang.Object
org.apache.lucene.search.DocIdSetIterator
org.apache.lucene.index.DocValuesIterator
org.apache.lucene.index.DocValuesFieldUpdates.Iterator
Direct Known Subclasses:
DocValuesFieldUpdates.AbstractIterator
Enclosing class:
DocValuesFieldUpdates
abstract static class DocValuesFieldUpdates.Iterator extends DocValuesIterator
An iterator over documents and their updated values. Only documents with updates are returned by this iterator, and the documents are returned in increasing order.

  • Constructor Details

    • Iterator

      Iterator()

  • Method Details

    • advanceExact

      public final boolean advanceExact(int target)
      Description copied from class: DocValuesIterator
      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.
      Specified by:
      advanceExact in class DocValuesIterator

    • advance

      public final int advance(int target)
      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

    • cost

      public final 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

    • nextDoc

      public abstract int nextDoc()
      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

    • longValue

      abstract long longValue()
      Returns a long value for the current document if this iterator is a long iterator.

    • binaryValue

      abstract BytesRef binaryValue()
      Returns a binary value for the current document if this iterator is a binary value iterator.

    • delGen

      abstract long delGen()
      Returns delGen for this packet.

    • hasValue

      abstract boolean hasValue()
      Returns true if this doc has a value

    • asBinaryDocValues

      static BinaryDocValues asBinaryDocValues(DocValuesFieldUpdates.Iterator iterator)
      Wraps the given iterator as a BinaryDocValues instance.

    • asNumericDocValues

      static NumericDocValues asNumericDocValues(DocValuesFieldUpdates.Iterator iterator)
      Wraps the given iterator as a NumericDocValues instance.