Java org.apache.lucene.search DocIdSetIterator fields, constructors, methods, implement or subclass

Example usage for Java org.apache.lucene.search DocIdSetIterator fields, constructors, methods, implement or subclass

Introduction

In this page you can find the methods, fields and constructors for org.apache.lucene.search DocIdSetIterator.

The text is from its open source code.

Subclass

org.apache.lucene.search.DocIdSetIterator has subclasses.
Click this link to see all its subclasses.

Field

intNO_MORE_DOCS
When returned by #nextDoc() , #advance(int) and #docID() it means there are no more docs in the iterator.

Constructor

Method

intadvance(int target)
Advances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself.
DocIdSetIteratorall(int maxDoc)
A DocIdSetIterator that matches all documents up to maxDoc - 1 .
longcost()
Returns the estimated cost of this DocIdSetIterator .
intdocID()
Returns the following:
  • -1 if #nextDoc() or #advance(int) were not called yet.
DocIdSetIteratorempty()
An empty DocIdSetIterator instance
intnextDoc()
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.