Lucene++ - a full-featured, c++ search engine
API Documentation
Sorts by a field's value using the Collator for a given Locale. More...
#include <FieldComparator.h>
Public Member Functions | |
StringComparatorLocale (int32_t numHits, const String &field, const std::locale &locale) | |
virtual | ~StringComparatorLocale () |
virtual String | getClassName () |
boost::shared_ptr< StringComparatorLocale > | shared_from_this () |
virtual int32_t | compare (int32_t slot1, int32_t slot2) |
Compare hit at slot1 with hit at slot2. | |
virtual int32_t | compareBottom (int32_t doc) |
Compare the bottom of the queue with doc. This will only invoked after setBottom has been called. This should return the same result as compare(int,int) } as if bottom were slot1 and the new document were slot 2. | |
virtual void | copy (int32_t slot, int32_t doc) |
This method is called when a new hit is competitive. You should copy any state associated with this document that will be required for future comparisons, into the specified slot. | |
virtual void | setNextReader (const IndexReaderPtr &reader, int32_t docBase) |
Set a new Reader. All doc correspond to the current Reader. | |
virtual void | setBottom (int32_t slot) |
Set the bottom slot, ie the "weakest" (sorted last) entry in the queue. When compareBottom is called, you should compare against this slot. This will always be called before compareBottom . | |
virtual ComparableValue | value (int32_t slot) |
Return the actual value in the slot. | |
![]() | |
virtual | ~FieldComparator () |
boost::shared_ptr< FieldComparator > | shared_from_this () |
virtual void | setScorer (const ScorerPtr &scorer) |
Sets the Scorer to use in case a document's score is needed. | |
![]() | |
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 String | _getClassName () |
Protected Attributes | |
Collection< String > | values |
Collection< String > | currentReaderValues |
String | field |
CollatorPtr | collator |
String | bottom |
![]() | |
SynchronizePtr | objectLock |
LuceneSignalPtr | objectSignal |
Additional Inherited Members | |
![]() | |
LuceneObject () | |
Sorts by a field's value using the Collator for a given Locale.
Lucene::StringComparatorLocale::StringComparatorLocale | ( | int32_t | numHits, |
const String & | field, | ||
const std::locale & | locale | ||
) |
|
virtual |
|
inlinestatic |
|
virtual |
Compare hit at slot1 with hit at slot2.
slot1 | first slot to compare |
slot2 | second slot to compare |
Implements Lucene::FieldComparator.
|
virtual |
Compare the bottom of the queue with doc. This will only invoked after setBottom has been called. This should return the same result as compare(int,int)
} as if bottom were slot1 and the new document were slot 2.
For a search that hits many results, this method will be the hotspot (invoked by far the most frequently).
doc | that was hit |
Implements Lucene::FieldComparator.
|
virtual |
This method is called when a new hit is competitive. You should copy any state associated with this document that will be required for future comparisons, into the specified slot.
slot | which slot to copy the hit to |
doc | docID relative to current reader |
Implements Lucene::FieldComparator.
|
inlinevirtual |
Reimplemented from Lucene::FieldComparator.
|
virtual |
Set the bottom slot, ie the "weakest" (sorted last) entry in the queue. When compareBottom
is called, you should compare against this slot. This will always be called before compareBottom
.
slot | the currently weakest (sorted last) slot in the queue |
Implements Lucene::FieldComparator.
|
virtual |
Set a new Reader. All doc correspond to the current Reader.
reader | current reader |
docBase | docBase of this reader |
Implements Lucene::FieldComparator.
|
inline |
|
virtual |
Return the actual value in the slot.
slot | the value |
Implements Lucene::FieldComparator.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |