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>
Inheritance diagram for Lucene::DocIdSet: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. More... | |
| 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. More... | |
| 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. More... | |
| virtual LuceneObjectPtr | clone (LuceneObjectPtr other=LuceneObjectPtr()) |
| Return clone of this object. More... | |
| virtual int32_t | hashCode () |
| Return hash code for this object. More... | |
| virtual bool | equals (LuceneObjectPtr other) |
| Return whether two objects are equal. More... | |
| virtual int32_t | compareTo (LuceneObjectPtr other) |
| Compare two objects. More... | |
| virtual String | toString () |
| Returns a string representation of the object. More... | |
| Public Member Functions inherited from Lucene::LuceneSync | |
| virtual | ~LuceneSync () |
| virtual SynchronizePtr | getSync () |
| Return this object synchronize lock. More... | |
| virtual LuceneSignalPtr | getSignal () |
| Return this object signal. More... | |
| virtual void | lock (int32_t timeout=0) |
| Lock this object using an optional timeout. More... | |
| virtual void | unlock () |
| Unlock this object. More... | |
| virtual bool | holdsLock () |
| Returns true if this object is currently locked by current thread. More... | |
| virtual void | wait (int32_t timeout=0) |
| Wait for signal using an optional timeout. More... | |
| virtual void | notifyAll () |
| Notify all threads waiting for signal. More... | |
Static Public Member Functions | |
| static String | _getClassName () |
| static DocIdSetPtr | EMPTY_DOCIDSET () |
| An empty {. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from Lucene::LuceneObject | |
| LuceneObject () | |
| Protected Attributes inherited from Lucene::LuceneSync | |
| 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::SortedVIntList, Lucene::OpenBitSet, Lucene::FilteredDocIdSet, Lucene::OpenBitSetDISI, and Lucene::DocIdBitSet.
|
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::SortedVIntList, Lucene::OpenBitSet, Lucene::FilteredDocIdSet, and Lucene::DocIdBitSet.
|
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::SortedVIntList, Lucene::OpenBitSet, Lucene::FilteredDocIdSet, and Lucene::DocIdBitSet.
|
inline |
