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


Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Attributes
Lucene::DocFieldConsumer Class Referenceabstract

#include <DocFieldConsumer.h>

+ Inheritance diagram for Lucene::DocFieldConsumer:

Public Member Functions

virtual ~DocFieldConsumer ()
 
virtual String getClassName ()
 
boost::shared_ptr< DocFieldConsumershared_from_this ()
 
virtual void flush (MapDocFieldConsumerPerThreadCollectionDocFieldConsumerPerField threadsAndFields, const SegmentWriteStatePtr &state)=0
 Called when DocumentsWriter decides to create a new segment.
 
virtual void closeDocStore (const SegmentWriteStatePtr &state)=0
 Called when DocumentsWriter decides to close the doc stores.
 
virtual void abort ()=0
 Called when an aborting exception is hit.
 
virtual DocFieldConsumerPerThreadPtr addThread (const DocFieldProcessorPerThreadPtr &docFieldProcessorPerThread)=0
 Add a new thread.
 
virtual bool freeRAM ()=0
 Called when DocumentsWriter is using too much RAM. The consumer should free RAM, if possible, returning true if any RAM was in fact freed.
 
virtual void setFieldInfos (const FieldInfosPtr &fieldInfos)
 
- 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

FieldInfosPtr fieldInfos
 
- Protected Attributes inherited from Lucene::LuceneSync
SynchronizePtr objectLock
 
LuceneSignalPtr objectSignal
 

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ ~DocFieldConsumer()

virtual Lucene::DocFieldConsumer::~DocFieldConsumer ( )
virtual

Member Function Documentation

◆ _getClassName()

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

◆ abort()

virtual void Lucene::DocFieldConsumer::abort ( )
pure virtual

Called when an aborting exception is hit.

Implemented in Lucene::DocInverter.

◆ addThread()

virtual DocFieldConsumerPerThreadPtr Lucene::DocFieldConsumer::addThread ( const DocFieldProcessorPerThreadPtr docFieldProcessorPerThread)
pure virtual

Add a new thread.

Implemented in Lucene::DocFieldConsumers, and Lucene::DocInverter.

◆ closeDocStore()

virtual void Lucene::DocFieldConsumer::closeDocStore ( const SegmentWriteStatePtr state)
pure virtual

Called when DocumentsWriter decides to close the doc stores.

Implemented in Lucene::DocFieldConsumers, and Lucene::DocInverter.

◆ flush()

virtual void Lucene::DocFieldConsumer::flush ( MapDocFieldConsumerPerThreadCollectionDocFieldConsumerPerField  threadsAndFields,
const SegmentWriteStatePtr state 
)
pure virtual

Called when DocumentsWriter decides to create a new segment.

Implemented in Lucene::DocFieldConsumers, and Lucene::DocInverter.

◆ freeRAM()

virtual bool Lucene::DocFieldConsumer::freeRAM ( )
pure virtual

Called when DocumentsWriter is using too much RAM. The consumer should free RAM, if possible, returning true if any RAM was in fact freed.

Implemented in Lucene::DocFieldConsumers, and Lucene::DocInverter.

◆ getClassName()

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

◆ setFieldInfos()

virtual void Lucene::DocFieldConsumer::setFieldInfos ( const FieldInfosPtr fieldInfos)
virtual

◆ shared_from_this()

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

Field Documentation

◆ fieldInfos

FieldInfosPtr Lucene::DocFieldConsumer::fieldInfos
protected

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

clucene.sourceforge.net