Package org.apache.lucene.search
Class AbstractDocIdSetIterator
java.lang.Object
org.apache.lucene.search.DocIdSetIterator
org.apache.lucene.search.AbstractDocIdSetIterator
- Direct Known Subclasses:
BitSetIterator,DisjunctionDISIApproximation,DocBaseBitSetIterator,FilteredDocIdSetIterator,IndexedDISI
Abstract implementation of a
DocIdSetIterator that tracks the current doc ID.
Implementing DocIdSetIterator by extending either this class or FilterDocIdSetIterator is a good idea in order to reduce polymorphism of call sites to DocIdSetIterator.docID().-
Field Summary
FieldsFields inherited from class org.apache.lucene.search.DocIdSetIterator
NO_MORE_DOCS -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedSole constructor, invoked by sub-classes. -
Method Summary
Modifier and TypeMethodDescriptionfinal intdocID()Returns the following:-1ifDocIdSetIterator.nextDoc()orDocIdSetIterator.advance(int)were not called yet.Methods inherited from class org.apache.lucene.search.DocIdSetIterator
advance, all, cost, docIDRunEnd, empty, intoBitSet, nextDoc, range, slowAdvance
-
Field Details
-
doc
protected int docThe current doc ID, initialized at -1.
-
-
Constructor Details
-
AbstractDocIdSetIterator
protected AbstractDocIdSetIterator()Sole constructor, invoked by sub-classes.
-
-
Method Details
-
docID
public final int docID()Description copied from class:DocIdSetIteratorReturns the following:-1ifDocIdSetIterator.nextDoc()orDocIdSetIterator.advance(int)were not called yet.DocIdSetIterator.NO_MORE_DOCSif the iterator has exhausted.- Otherwise it should return the doc ID it is currently on.
- Specified by:
docIDin classDocIdSetIterator
-