Lucene++ - a full-featured, c++ search engine
API Documentation
A DocIdSet contains a set of doc ids. Implementing classes must only implement iterator
to provide access to the set.
More...
#include <DocIdSet.h>
Public Member Functions | |
virtual | ~DocIdSet () |
virtual String | getClassName () |
boost::shared_ptr< DocIdSet > | shared_from_this () |
virtual DocIdSetIteratorPtr | iterator ()=0 |
Provides a DocIdSetIterator to access the set. This implementation can return null or EmptyDocIdSet .iterator() if there are no docs that match. | |
virtual bool | isCacheable () |
This method is a hint for CachingWrapperFilter , if this DocIdSet should be cached without copying it into a BitSet. The default is to return false. If you have an own DocIdSet implementation that does its iteration very effective and fast without doing disk I/O, override this method and return true. | |
![]() | |
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. | |
![]() | |
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 DocIdSetPtr | EMPTY_DOCIDSET () |
An empty {. | |
Additional Inherited Members | |
![]() | |
LuceneObject () | |
![]() | |
SynchronizePtr | objectLock |
LuceneSignalPtr | objectSignal |
A DocIdSet contains a set of doc ids. Implementing classes must only implement iterator
to provide access to the set.
|
virtual |
|
inlinestatic |
|
static |
An empty {.
|
inlinevirtual |
Reimplemented in Lucene::DocIdBitSet, Lucene::FilteredDocIdSet, Lucene::OpenBitSet, Lucene::OpenBitSetDISI, and Lucene::SortedVIntList.
|
virtual |
This method is a hint for CachingWrapperFilter
, if this DocIdSet should be cached without copying it into a BitSet. The default is to return false. If you have an own DocIdSet implementation that does its iteration very effective and fast without doing disk I/O, override this method and return true.
Reimplemented in Lucene::DocIdBitSet, Lucene::FilteredDocIdSet, Lucene::OpenBitSet, and Lucene::SortedVIntList.
|
pure virtual |
Provides a DocIdSetIterator
to access the set. This implementation can return null or EmptyDocIdSet
.iterator() if there are no docs that match.
Implemented in Lucene::DocIdBitSet, Lucene::FilteredDocIdSet, Lucene::OpenBitSet, and Lucene::SortedVIntList.
|
inline |