Lucene++ - a full-featured, c++ search engine
API Documentation


Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Attributes
Lucene::StringValComparator Class Reference

Sorts by field's natural String sort order. All comparisons are done using String.compare, which is slow for medium to large result sets but possibly very fast for very small results sets. More...

#include <FieldComparator.h>

+ Inheritance diagram for Lucene::StringValComparator:

Public Member Functions

 StringValComparator (int32_t numHits, const String &field)
 
virtual ~StringValComparator ()
 
virtual String getClassName ()
 
boost::shared_ptr< StringOrdValComparatorshared_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.
 
- Public Member Functions inherited from Lucene::FieldComparator
virtual ~FieldComparator ()
 
boost::shared_ptr< FieldComparatorshared_from_this ()
 
virtual void setScorer (const ScorerPtr &scorer)
 Sets the Scorer to use in case a document's score is needed.
 
- 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.
 
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::FieldComparator
static String _getClassName ()
 

Protected Attributes

Collection< String > values
 
Collection< String > currentReaderValues
 
String field
 
String bottom
 
- Protected Attributes inherited from Lucene::LuceneSync
SynchronizePtr objectLock
 
LuceneSignalPtr objectSignal
 

Additional Inherited Members

- Protected Member Functions inherited from Lucene::LuceneObject
 LuceneObject ()
 

Detailed Description

Sorts by field's natural String sort order. All comparisons are done using String.compare, which is slow for medium to large result sets but possibly very fast for very small results sets.

Constructor & Destructor Documentation

◆ StringValComparator()

Lucene::StringValComparator::StringValComparator ( int32_t  numHits,
const String &  field 
)

◆ ~StringValComparator()

virtual Lucene::StringValComparator::~StringValComparator ( )
virtual

Member Function Documentation

◆ _getClassName()

static String Lucene::StringValComparator::_getClassName ( )
inlinestatic

◆ compare()

virtual int32_t Lucene::StringValComparator::compare ( int32_t  slot1,
int32_t  slot2 
)
virtual

Compare hit at slot1 with hit at slot2.

Parameters
slot1first slot to compare
slot2second slot to compare
Returns
any N < 0 if slot2's value is sorted after slot1, any N > 0 if the slot2's value is sorted before slot1 and 0 if they are equal

Implements Lucene::FieldComparator.

◆ compareBottom()

virtual int32_t Lucene::StringValComparator::compareBottom ( int32_t  doc)
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).

Parameters
docthat was hit
Returns
any N < 0 if the doc's value is sorted after the bottom entry (not competitive), any N > 0 if the doc's value is sorted before the bottom entry and 0 if they are equal.

Implements Lucene::FieldComparator.

◆ copy()

virtual void Lucene::StringValComparator::copy ( int32_t  slot,
int32_t  doc 
)
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.

Parameters
slotwhich slot to copy the hit to
docdocID relative to current reader

Implements Lucene::FieldComparator.

◆ getClassName()

virtual String Lucene::StringValComparator::getClassName ( )
inlinevirtual

Reimplemented from Lucene::FieldComparator.

◆ setBottom()

virtual void Lucene::StringValComparator::setBottom ( int32_t  slot)
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.

Parameters
slotthe currently weakest (sorted last) slot in the queue

Implements Lucene::FieldComparator.

◆ setNextReader()

virtual void Lucene::StringValComparator::setNextReader ( const IndexReaderPtr reader,
int32_t  docBase 
)
virtual

Set a new Reader. All doc correspond to the current Reader.

Parameters
readercurrent reader
docBasedocBase of this reader

Implements Lucene::FieldComparator.

◆ shared_from_this()

boost::shared_ptr< StringOrdValComparator > Lucene::StringValComparator::shared_from_this ( )
inline

◆ value()

virtual ComparableValue Lucene::StringValComparator::value ( int32_t  slot)
virtual

Return the actual value in the slot.

Parameters
slotthe value
Returns
value in this slot upgraded to ComparableValue

Implements Lucene::FieldComparator.

Field Documentation

◆ bottom

String Lucene::StringValComparator::bottom
protected

◆ currentReaderValues

Collection<String> Lucene::StringValComparator::currentReaderValues
protected

◆ field

String Lucene::StringValComparator::field
protected

◆ values

Collection<String> Lucene::StringValComparator::values
protected

The documentation for this class was generated from the following file:

clucene.sourceforge.net