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


Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions
Lucene::FieldCacheEntry Class Referenceabstract

A unique Identifier/Description for each item in the FieldCache. Can be useful for logging/debugging. More...

#include <FieldCache.h>

+ Inheritance diagram for Lucene::FieldCacheEntry:

Public Member Functions

virtual ~FieldCacheEntry ()
 
virtual String getClassName ()
 
boost::shared_ptr< FieldCacheEntryshared_from_this ()
 
virtual LuceneObjectPtr getReaderKey ()=0
 
virtual String getFieldName ()=0
 
virtual int32_t getCacheType ()=0
 
virtual boost::any getCustom ()=0
 
virtual boost::any getValue ()=0
 
virtual String toString ()
 Returns a string representation of the object.
 
- 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.
 
- 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 ()
 

Additional Inherited Members

- Protected Member Functions inherited from Lucene::LuceneObject
 LuceneObject ()
 
- Protected Attributes inherited from Lucene::LuceneSync
SynchronizePtr objectLock
 
LuceneSignalPtr objectSignal
 

Detailed Description

A unique Identifier/Description for each item in the FieldCache. Can be useful for logging/debugging.

Constructor & Destructor Documentation

◆ ~FieldCacheEntry()

virtual Lucene::FieldCacheEntry::~FieldCacheEntry ( )
virtual

Member Function Documentation

◆ _getClassName()

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

◆ getCacheType()

virtual int32_t Lucene::FieldCacheEntry::getCacheType ( )
pure virtual

Implemented in Lucene::FieldCacheEntryImpl.

◆ getClassName()

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

Reimplemented in Lucene::FieldCacheEntryImpl.

◆ getCustom()

virtual boost::any Lucene::FieldCacheEntry::getCustom ( )
pure virtual

Implemented in Lucene::FieldCacheEntryImpl.

◆ getFieldName()

virtual String Lucene::FieldCacheEntry::getFieldName ( )
pure virtual

Implemented in Lucene::FieldCacheEntryImpl.

◆ getReaderKey()

virtual LuceneObjectPtr Lucene::FieldCacheEntry::getReaderKey ( )
pure virtual

Implemented in Lucene::FieldCacheEntryImpl.

◆ getValue()

virtual boost::any Lucene::FieldCacheEntry::getValue ( )
pure virtual

Implemented in Lucene::FieldCacheEntryImpl.

◆ shared_from_this()

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

◆ toString()

virtual String Lucene::FieldCacheEntry::toString ( )
virtual

Returns a string representation of the object.

Reimplemented from Lucene::LuceneObject.


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

clucene.sourceforge.net