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


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

Convenience class for storing collate objects. More...

#include <Collator.h>

+ Inheritance diagram for Lucene::Collator:

Public Member Functions

 Collator (std::locale locale)
 Creates a new Collator, given the file to read from.
 
virtual ~Collator ()
 
virtual String getClassName ()
 
boost::shared_ptr< Collatorshared_from_this ()
 
int32_t compare (const String &first, const String &second)
 
- 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 ()
 

Protected Attributes

const std::collate< wchar_t > & collate
 
- Protected Attributes inherited from Lucene::LuceneSync
SynchronizePtr objectLock
 
LuceneSignalPtr objectSignal
 

Additional Inherited Members

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

Detailed Description

Convenience class for storing collate objects.

Constructor & Destructor Documentation

◆ Collator()

Lucene::Collator::Collator ( std::locale  locale)

Creates a new Collator, given the file to read from.

◆ ~Collator()

virtual Lucene::Collator::~Collator ( )
virtual

Member Function Documentation

◆ _getClassName()

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

◆ compare()

int32_t Lucene::Collator::compare ( const String &  first,
const String &  second 
)

◆ getClassName()

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

◆ shared_from_this()

boost::shared_ptr< Collator > Lucene::Collator::shared_from_this ( )
inline

Field Documentation

◆ collate

const std::collate<wchar_t>& Lucene::Collator::collate
protected

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

clucene.sourceforge.net