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


 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | Static Public Member Functions | Data Fields
Lucene::OneMerge Class Reference

OneMerge provides the information necessary to perform an individual primitive merge operation, resulting in a single new segment. The merge spec includes the subset of segments to be merged as well as whether the new segment should use the compound file format. More...

#include <MergePolicy.h>

+ Inheritance diagram for Lucene::OneMerge:

Public Member Functions

 OneMerge (SegmentInfosPtr segments, bool useCompoundFile)
 
virtual ~OneMerge ()
 
virtual String getClassName ()
 
boost::shared_ptr< OneMergeshared_from_this ()
 
void setException (const LuceneException &error)
 Record that an exception occurred while executing this merge. More...
 
LuceneException getException ()
 Retrieve previous exception set by setException. More...
 
void abort ()
 Mark this merge as aborted. If this is called before the merge is committed then the merge will not be committed. More...
 
bool isAborted ()
 Returns true if this merge was aborted. More...
 
void checkAborted (DirectoryPtr dir)
 
String segString (DirectoryPtr dir)
 
- 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 LuceneObjectPtr clone (LuceneObjectPtr other=LuceneObjectPtr())
 Return clone of this object. More...
 
virtual int32_t hashCode ()
 Return hash code for this object. More...
 
virtual bool equals (LuceneObjectPtr other)
 Return whether two objects are equal. More...
 
virtual int32_t compareTo (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 ()
 

Data Fields

SegmentInfoPtr info
 
bool mergeDocStores
 
bool optimize
 
bool registerDone
 
int64_t mergeGen
 
bool isExternal
 
int32_t maxNumSegmentsOptimize
 
Collection< SegmentReaderPtrreaders
 
Collection< SegmentReaderPtrreadersClone
 
SegmentInfosPtr segments
 
bool useCompoundFile
 
bool aborted
 
LuceneException error
 

Additional Inherited Members

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

Detailed Description

OneMerge provides the information necessary to perform an individual primitive merge operation, resulting in a single new segment. The merge spec includes the subset of segments to be merged as well as whether the new segment should use the compound file format.

Constructor & Destructor Documentation

Lucene::OneMerge::OneMerge ( SegmentInfosPtr  segments,
bool  useCompoundFile 
)
virtual Lucene::OneMerge::~OneMerge ( )
virtual

Member Function Documentation

static String Lucene::OneMerge::_getClassName ( )
inlinestatic
void Lucene::OneMerge::abort ( )

Mark this merge as aborted. If this is called before the merge is committed then the merge will not be committed.

void Lucene::OneMerge::checkAborted ( DirectoryPtr  dir)
virtual String Lucene::OneMerge::getClassName ( )
inlinevirtual
LuceneException Lucene::OneMerge::getException ( )

Retrieve previous exception set by setException.

bool Lucene::OneMerge::isAborted ( )

Returns true if this merge was aborted.

String Lucene::OneMerge::segString ( DirectoryPtr  dir)
void Lucene::OneMerge::setException ( const LuceneException error)

Record that an exception occurred while executing this merge.

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

Field Documentation

bool Lucene::OneMerge::aborted
LuceneException Lucene::OneMerge::error
SegmentInfoPtr Lucene::OneMerge::info
bool Lucene::OneMerge::isExternal
int32_t Lucene::OneMerge::maxNumSegmentsOptimize
bool Lucene::OneMerge::mergeDocStores
int64_t Lucene::OneMerge::mergeGen
bool Lucene::OneMerge::optimize
Collection<SegmentReaderPtr> Lucene::OneMerge::readers
Collection<SegmentReaderPtr> Lucene::OneMerge::readersClone
bool Lucene::OneMerge::registerDone
SegmentInfosPtr Lucene::OneMerge::segments
bool Lucene::OneMerge::useCompoundFile

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

clucene.sourceforge.net