Lucene++ - a full-featured, c++ search engine
API Documentation


Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Static Public Attributes
Lucene::DocIdSetIterator Class Referenceabstract

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 INT_MAX as an invalid value. More...

#include <DocIdSetIterator.h>

+ Inheritance diagram for Lucene::DocIdSetIterator:

Public Member Functions

virtual ~DocIdSetIterator ()
 
virtual String getClassName ()
 
boost::shared_ptr< DocIdSetIteratorshared_from_this ()
 
virtual int32_t docID ()=0
 Returns the following:
 
virtual int32_t nextDoc ()=0
 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.
 
virtual int32_t advance (int32_t target)=0
 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.
 
- Public Member Functions inherited from Lucene::LuceneObject
virtual ~LuceneObject ()
 
virtual void initialize ()
 Called directly after instantiation to create objects that depend on this object being fully constructed.
 
virtual LuceneObjectPtr clone (const LuceneObjectPtr &other=LuceneObjectPtr())
 Return clone of this object.
 
virtual int32_t hashCode ()
 Return hash code for this object.
 
virtual bool equals (const LuceneObjectPtr &other)
 Return whether two objects are equal.
 
virtual int32_t compareTo (const LuceneObjectPtr &other)
 Compare two objects.
 
virtual String toString ()
 Returns a string representation of the object.
 
- Public Member Functions inherited from Lucene::LuceneSync
virtual ~LuceneSync ()
 
virtual SynchronizePtr getSync ()
 Return this object synchronize lock.
 
virtual LuceneSignalPtr getSignal ()
 Return this object signal.
 
virtual void lock (int32_t timeout=0)
 Lock this object using an optional timeout.
 
virtual void unlock ()
 Unlock this object.
 
virtual bool holdsLock ()
 Returns true if this object is currently locked by current thread.
 
virtual void wait (int32_t timeout=0)
 Wait for signal using an optional timeout.
 
virtual void notifyAll ()
 Notify all threads waiting for signal.
 

Static Public Member Functions

static String _getClassName ()
 

Static Public Attributes

static const int32_t NO_MORE_DOCS
 When returned by nextDoc(), advance(int) and docID() it means there are no more docs in the iterator.
 

Additional Inherited Members

- Protected Member Functions inherited from Lucene::LuceneObject
 LuceneObject ()
 
- Protected Attributes inherited from Lucene::LuceneSync
SynchronizePtr objectLock
 
LuceneSignalPtr objectSignal
 

Detailed Description

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 INT_MAX as an invalid value.

Constructor & Destructor Documentation

◆ ~DocIdSetIterator()

virtual Lucene::DocIdSetIterator::~DocIdSetIterator ( )
virtual

Member Function Documentation

◆ _getClassName()

static String Lucene::DocIdSetIterator::_getClassName ( )
inlinestatic

◆ advance()

virtual int32_t Lucene::DocIdSetIterator::advance ( int32_t  target)
pure 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.

Implemented in Lucene::BooleanScorer, Lucene::BucketScorer, Lucene::BooleanScorer2, Lucene::SingleMatchScorer, Lucene::ConjunctionScorer, Lucene::DisjunctionMaxScorer, Lucene::DisjunctionSumScorer, Lucene::FilteredDocIdSetIterator, Lucene::OpenBitSetIterator, Lucene::PhraseScorer, Lucene::ReqExclScorer, Lucene::ReqOptSumScorer, Lucene::ScoreCachingWrappingScorer, Lucene::SpanScorer, and Lucene::TermScorer.

◆ docID()

virtual int32_t Lucene::DocIdSetIterator::docID ( )
pure virtual

◆ getClassName()

virtual String Lucene::DocIdSetIterator::getClassName ( )
inlinevirtual

◆ nextDoc()

virtual int32_t Lucene::DocIdSetIterator::nextDoc ( )
pure 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.

Implemented in Lucene::BooleanScorer, Lucene::BucketScorer, Lucene::BooleanScorer2, Lucene::SingleMatchScorer, Lucene::ConjunctionScorer, Lucene::DisjunctionMaxScorer, Lucene::DisjunctionSumScorer, Lucene::FilteredDocIdSetIterator, Lucene::OpenBitSetIterator, Lucene::PhraseScorer, Lucene::ReqExclScorer, Lucene::ReqOptSumScorer, Lucene::ScoreCachingWrappingScorer, Lucene::SpanScorer, and Lucene::TermScorer.

◆ shared_from_this()

boost::shared_ptr< DocIdSetIterator > Lucene::DocIdSetIterator::shared_from_this ( )
inline

Field Documentation

◆ NO_MORE_DOCS

const int32_t Lucene::DocIdSetIterator::NO_MORE_DOCS
static

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


The documentation for this class was generated from the following file:

clucene.sourceforge.net