Lucene++ - a full-featured, c++ search engine
API Documentation
A hit queue for sorting by hits by terms in more than one field. Uses FieldCache::DEFAULT for maintaining internal term lookup tables. More...
#include <FieldValueHitQueue.h>
Public Member Functions | |
virtual | ~FieldValueHitQueue () |
virtual String | getClassName () |
boost::shared_ptr< FieldValueHitQueue > | shared_from_this () |
Collection< FieldComparatorPtr > | getComparators () |
Collection< int32_t > | getReverseMul () |
FieldDocPtr | fillFields (const FieldValueHitQueueEntryPtr &entry) |
Given a queue Entry, creates a corresponding FieldDoc that contains the values used to sort the given document. These values are not the raw values out of the index, but the internal representation of them. This is so the given search hit can be collated by a MultiSearcher with other search hits. | |
Collection< SortFieldPtr > | getFields () |
Returns the SortFields being used by this hit queue. | |
![]() | |
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. | |
![]() | |
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. | |
![]() | |
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 FieldValueHitQueuePtr | create (Collection< SortFieldPtr > fields, int32_t size) |
Creates a hit queue sorted by the given list of fields. | |
![]() | |
static String | _getClassName () |
Protected Member Functions | |
FieldValueHitQueue (Collection< SortFieldPtr > fields, int32_t size) | |
![]() | |
virtual bool | lessThan (const ScoreDocPtr &first, const ScoreDocPtr &second)=0 |
virtual ScoreDocPtr | getSentinelObject () |
![]() | |
LuceneObject () | |
Protected Attributes | |
Collection< SortFieldPtr > | fields |
Stores the sort criteria being used. | |
Collection< FieldComparatorPtr > | comparators |
Collection< int32_t > | reverseMul |
![]() | |
PriorityQueueScoreDocsPtr | queue |
int32_t | queueSize |
![]() | |
SynchronizePtr | objectLock |
LuceneSignalPtr | objectSignal |
A hit queue for sorting by hits by terms in more than one field. Uses FieldCache::DEFAULT for maintaining internal term lookup tables.
|
protected |
|
virtual |
|
inlinestatic |
|
static |
Creates a hit queue sorted by the given list of fields.
fields | SortField array we are sorting by in priority order (highest priority first); cannot be null or empty. |
size | The number of hits to retain. Must be greater than zero. |
FieldDocPtr Lucene::FieldValueHitQueue::fillFields | ( | const FieldValueHitQueueEntryPtr & | entry | ) |
Given a queue Entry, creates a corresponding FieldDoc that contains the values used to sort the given document. These values are not the raw values out of the index, but the internal representation of them. This is so the given search hit can be collated by a MultiSearcher with other search hits.
|
inlinevirtual |
Reimplemented from Lucene::HitQueueBase.
Collection< FieldComparatorPtr > Lucene::FieldValueHitQueue::getComparators | ( | ) |
Collection< SortFieldPtr > Lucene::FieldValueHitQueue::getFields | ( | ) |
Returns the SortFields being used by this hit queue.
Collection< int32_t > Lucene::FieldValueHitQueue::getReverseMul | ( | ) |
|
inline |
|
protected |
|
protected |
Stores the sort criteria being used.
|
protected |