Simple DocIdSet and DocIdSetIterator backed by a BitSet. More...
#include <DocIdBitSet.h>
Inheritance diagram for Lucene::DocIdBitSet:
Public Member Functions | |
| DocIdBitSet () | |
| DocIdBitSet (const BitSetPtr &bitSet) | |
| virtual | ~DocIdBitSet () |
| virtual String | getClassName () |
| boost::shared_ptr< DocIdBitSet > | shared_from_this () |
| virtual DocIdSetIteratorPtr | iterator () |
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 DocIdSet implementation is cacheable. More... | |
| BitSetPtr | getBitSet () |
| Returns the underlying BitSet. More... | |
| virtual bool | equals (const LuceneObjectPtr &other) |
| Return whether two objects are equal. More... | |
| virtual int32_t | hashCode () |
| Return hash code for this object. More... | |
| virtual LuceneObjectPtr | clone (const LuceneObjectPtr &other=LuceneObjectPtr()) |
| Return clone of this object. More... | |
| Public Member Functions inherited from Lucene::DocIdSet | |
| 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 (const LuceneObjectPtr &other=LuceneObjectPtr()) |
| Return clone of this object. More... | |
| virtual int32_t | hashCode () |
| Return hash code for this object. More... | |
| virtual bool | equals (const LuceneObjectPtr &other) |
| Return whether two objects are equal. More... | |
| virtual int32_t | compareTo (const 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 Public Member Functions inherited from Lucene::DocIdSet | |
| static String | _getClassName () |
| static DocIdSetPtr | EMPTY_DOCIDSET () |
| An empty {. More... | |
Protected Attributes | |
| BitSetPtr | bitSet |
| Protected Attributes inherited from Lucene::LuceneSync | |
| SynchronizePtr | objectLock |
| LuceneSignalPtr | objectSignal |
Additional Inherited Members | |
| Protected Member Functions inherited from Lucene::LuceneObject | |
| LuceneObject () | |
Detailed Description
Simple DocIdSet and DocIdSetIterator backed by a BitSet.
Constructor & Destructor Documentation
◆ DocIdBitSet() [1/2]
| Lucene::DocIdBitSet::DocIdBitSet | ( | ) |
◆ DocIdBitSet() [2/2]
| Lucene::DocIdBitSet::DocIdBitSet | ( | const BitSetPtr & | bitSet | ) |
◆ ~DocIdBitSet()
|
virtual |
Member Function Documentation
◆ _getClassName()
|
inlinestatic |
◆ clone()
|
virtual |
Return clone of this object.
- Parameters
-
other clone reference - null when called initially, then set in top virtual override.
Reimplemented from Lucene::LuceneObject.
◆ equals()
|
virtual |
Return whether two objects are equal.
Reimplemented from Lucene::LuceneObject.
◆ getBitSet()
◆ getClassName()
|
inlinevirtual |
Reimplemented from Lucene::DocIdSet.
◆ hashCode()
|
virtual |
Return hash code for this object.
Reimplemented from Lucene::LuceneObject.
◆ isCacheable()
|
virtual |
This DocIdSet implementation is cacheable.
Reimplemented from Lucene::DocIdSet.
◆ iterator()
|
virtual |
Provides a DocIdSetIterator to access the set. This implementation can return null or EmptyDocIdSet.iterator() if there are no docs that match.
Implements Lucene::DocIdSet.
◆ shared_from_this()
|
inline |
Field Documentation
◆ bitSet
|
protected |
The documentation for this class was generated from the following file: