Abstract decorator class of a DocIdSetIterator implementation that provides on-demand filter/validation mechanism on an underlying DocIdSetIterator. See FilteredDocIdSet
.
More...
#include <FilteredDocIdSetIterator.h>
|
virtual bool | match (int32_t docid)=0 |
| Validation method to determine whether a docid should be in the result set.
|
|
| LuceneObject () |
|
Abstract decorator class of a DocIdSetIterator implementation that provides on-demand filter/validation mechanism on an underlying DocIdSetIterator. See FilteredDocIdSet
.
◆ FilteredDocIdSetIterator()
Lucene::FilteredDocIdSetIterator::FilteredDocIdSetIterator |
( |
const DocIdSetIteratorPtr & |
innerIter | ) |
|
◆ ~FilteredDocIdSetIterator()
virtual Lucene::FilteredDocIdSetIterator::~FilteredDocIdSetIterator |
( |
| ) |
|
|
virtual |
◆ _getClassName()
static String Lucene::FilteredDocIdSetIterator::_getClassName |
( |
| ) |
|
|
inlinestatic |
◆ advance()
virtual int32_t Lucene::FilteredDocIdSetIterator::advance |
( |
int32_t |
target | ) |
|
|
virtual |
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:
int32_t advance(int32_t target)
{
int32_t 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 behaviour.
Implements Lucene::DocIdSetIterator.
◆ docID()
virtual int32_t Lucene::FilteredDocIdSetIterator::docID |
( |
| ) |
|
|
virtual |
◆ getClassName()
virtual String Lucene::FilteredDocIdSetIterator::getClassName |
( |
| ) |
|
|
inlinevirtual |
◆ match()
virtual bool Lucene::FilteredDocIdSetIterator::match |
( |
int32_t |
docid | ) |
|
|
protectedpure virtual |
Validation method to determine whether a docid should be in the result set.
- Parameters
-
- Returns
- true if input docid should be in the result set, false otherwise.
- See also
- #FilteredDocIdSetIterator(DocIdSetIterator).
◆ nextDoc()
virtual int32_t Lucene::FilteredDocIdSetIterator::nextDoc |
( |
| ) |
|
|
virtual |
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 behaviour.
Implements Lucene::DocIdSetIterator.
◆ shared_from_this()
◆ doc
int32_t Lucene::FilteredDocIdSetIterator::doc |
|
protected |
◆ innerIter
The documentation for this class was generated from the following file: