Home » lucene-3.0.1-src » org.apache » lucene » search » [javadoc | source]
org.apache.lucene.search
abstract public class: DocIdSetIterator [javadoc | source]
java.lang.Object
   org.apache.lucene.search.DocIdSetIterator
This abstract class defines methods to iterate over a set of non-decreasing doc ids. Note that this class assumes it iterates on doc Ids, and therefore #NO_MORE_DOCS is set to {@value #NO_MORE_DOCS} in order to be used as a sentinel object. Implementations of this class are expected to consider Integer#MAX_VALUE as an invalid value.
Field Summary
public static final  int NO_MORE_DOCS    When returned by #nextDoc() , #advance(int) and #docID() it means there are no more docs in the iterator. 
Method from org.apache.lucene.search.DocIdSetIterator Summary:
advance,   docID,   nextDoc
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.lucene.search.DocIdSetIterator Detail:
 abstract public int advance(int target) throws IOException
    Advances to the first beyond the current whose document number is greater than or equal to target. Returns the current document number or #NO_MORE_DOCS if there are no more docs in the set.

    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: certain implementations may return a different value (each time) if called several times in a row with the same target.

    NOTE: this method may be called with {@value #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.

    NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.

 abstract public int docID()
 abstract public int nextDoc() throws IOException
    Advances to the next document in the set and returns the doc it is currently on, or #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.