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


Public Member Functions | Static Public Member Functions | Protected Attributes
Lucene::AttributeSourceState Class Reference

This class holds the state of an AttributeSource. More...

#include <AttributeSource.h>

+ Inheritance diagram for Lucene::AttributeSourceState:

Public Member Functions

virtual ~AttributeSourceState ()
 
virtual String getClassName ()
 
boost::shared_ptr< AttributeSourceStateshared_from_this ()
 
virtual LuceneObjectPtr clone (const LuceneObjectPtr &other=LuceneObjectPtr())
 Return clone of this object. More...
 
- 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. More...
 
virtual int32_t hashCode ()
 Return hash code for this object. More...
 
virtual bool equals (const LuceneObjectPtr &other)
 Return whether two objects are equal. More...
 
virtual int32_t compareTo (const LuceneObjectPtr &other)
 Compare two objects. More...
 
virtual String toString ()
 Returns a string representation of the object. More...
 
- Public Member Functions inherited from Lucene::LuceneSync
virtual ~LuceneSync ()
 
virtual SynchronizePtr getSync ()
 Return this object synchronize lock. More...
 
virtual LuceneSignalPtr getSignal ()
 Return this object signal. More...
 
virtual void lock (int32_t timeout=0)
 Lock this object using an optional timeout. More...
 
virtual void unlock ()
 Unlock this object. More...
 
virtual bool holdsLock ()
 Returns true if this object is currently locked by current thread. More...
 
virtual void wait (int32_t timeout=0)
 Wait for signal using an optional timeout. More...
 
virtual void notifyAll ()
 Notify all threads waiting for signal. More...
 

Static Public Member Functions

static String _getClassName ()
 

Protected Attributes

AttributePtr attribute
 
AttributeSourceStatePtr next
 
- Protected Attributes inherited from Lucene::LuceneSync
SynchronizePtr objectLock
 
LuceneSignalPtr objectSignal
 

Additional Inherited Members

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

Detailed Description

This class holds the state of an AttributeSource.

See also
#captureState
#restoreState

Constructor & Destructor Documentation

virtual Lucene::AttributeSourceState::~AttributeSourceState ( )
virtual

Member Function Documentation

static String Lucene::AttributeSourceState::_getClassName ( )
inlinestatic
virtual LuceneObjectPtr Lucene::AttributeSourceState::clone ( const LuceneObjectPtr other = LuceneObjectPtr())
virtual

Return clone of this object.

Parameters
otherclone reference - null when called initially, then set in top virtual override.

Reimplemented from Lucene::LuceneObject.

virtual String Lucene::AttributeSourceState::getClassName ( )
inlinevirtual
boost::shared_ptr< AttributeSourceState > Lucene::AttributeSourceState::shared_from_this ( )
inline

Field Documentation

AttributePtr Lucene::AttributeSourceState::attribute
protected
AttributeSourceStatePtr Lucene::AttributeSourceState::next
protected

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

clucene.sourceforge.net