Public Member Functions |
Static Public Member Functions |
Protected Member Functions |
Protected Attributes
Lucene::HitQueue Class Reference
#include <HitQueue.h>
Inheritance diagram for Lucene::HitQueue:
Public Member Functions | |
| HitQueue (int32_t size, bool prePopulate) | |
| Creates a new instance with size elements. | |
| virtual | ~HitQueue () |
| virtual String | getClassName () |
| boost::shared_ptr< HitQueue > | shared_from_this () |
| Public Member Functions inherited from Lucene::HitQueueBase | |
| HitQueueBase (int32_t size) | |
| virtual | ~HitQueueBase () |
| boost::shared_ptr< HitQueueBase > | shared_from_this () |
| virtual ScoreDocPtr | add (const ScoreDocPtr &scoreDoc) |
| virtual ScoreDocPtr | addOverflow (const ScoreDocPtr &scoreDoc) |
| virtual ScoreDocPtr | top () |
| virtual ScoreDocPtr | pop () |
| virtual ScoreDocPtr | updateTop () |
| virtual int32_t | size () |
| virtual bool | empty () |
| virtual void | clear () |
| virtual void | initialize () |
| Called directly after instantiation to create objects that depend on this object being fully constructed. | |
| Public Member Functions inherited from Lucene::LuceneObject | |
| virtual | ~LuceneObject () |
| 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 Member Functions inherited from Lucene::HitQueueBase | |
| static String | _getClassName () |
Protected Member Functions | |
| virtual bool | lessThan (const ScoreDocPtr &first, const ScoreDocPtr &second) |
| virtual ScoreDocPtr | getSentinelObject () |
| Returns null if prePopulate is false. | |
| Protected Member Functions inherited from Lucene::LuceneObject | |
| LuceneObject () | |
Protected Attributes | |
| bool | prePopulate |
| Protected Attributes inherited from Lucene::HitQueueBase | |
| PriorityQueueScoreDocsPtr | queue |
| int32_t | queueSize |
| Protected Attributes inherited from Lucene::LuceneSync | |
| SynchronizePtr | objectLock |
| LuceneSignalPtr | objectSignal |
Constructor & Destructor Documentation
◆ HitQueue()
| Lucene::HitQueue::HitQueue | ( | int32_t | size, |
| bool | prePopulate ) |
Creates a new instance with size elements.
References prePopulate, and Lucene::HitQueueBase::size().
Referenced by _getClassName().
◆ ~HitQueue()
|
virtual |
Member Function Documentation
◆ _getClassName()
|
inlinestatic |
References HitQueue().
◆ getClassName()
|
inlinevirtual |
Reimplemented from Lucene::HitQueueBase.
◆ getSentinelObject()
|
protectedvirtual |
Returns null if prePopulate is false.
Reimplemented from Lucene::HitQueueBase.
◆ lessThan()
|
protectedvirtual |
Implements Lucene::HitQueueBase.
◆ shared_from_this()
|
inline |
Field Documentation
◆ prePopulate
|
protected |
Referenced by HitQueue().
The documentation for this class was generated from the following file: