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


Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Data Fields
Lucene::CommitPoint Class Reference

Holds details for each commit point. This class is also passed to the deletion policy. Note: this class has a natural ordering that is inconsistent with equals. More...

#include <IndexFileDeleter.h>

+ Inheritance diagram for Lucene::CommitPoint:

Public Member Functions

 CommitPoint (Collection< CommitPointPtr > commitsToDelete, const DirectoryPtr &directory, const SegmentInfosPtr &segmentInfos)
 
virtual ~CommitPoint ()
 
virtual String getClassName ()
 
boost::shared_ptr< CommitPointshared_from_this ()
 
virtual String toString ()
 Returns a string representation of the object.
 
virtual bool isOptimized ()
 Returns true if this commit is an optimized index.
 
virtual String getSegmentsFileName ()
 Get the segments file (segments_N) associated with this commit point.
 
virtual HashSet< String > getFileNames ()
 Returns all index files referenced by this commit point.
 
virtual DirectoryPtr getDirectory ()
 Returns the Directory for the index.
 
virtual int64_t getVersion ()
 Returns the version for this IndexCommit.
 
virtual int64_t getGeneration ()
 Returns the generation (the _N in segments_N) for this IndexCommit.
 
virtual MapStringString getUserData ()
 Returns userData, previously passed to IndexWriter#commit(Map) for this commit.
 
virtual void deleteCommit ()
 Called only be the deletion policy, to remove this commit point from the index.
 
virtual bool isDeleted ()
 
virtual int32_t compareTo (const LuceneObjectPtr &other)
 Compare two objects.
 
- Public Member Functions inherited from Lucene::IndexCommit
virtual ~IndexCommit ()
 
boost::shared_ptr< IndexCommitshared_from_this ()
 
virtual bool equals (const LuceneObjectPtr &other)
 Two IndexCommits are equal if both their Directory and versions are equal.
 
virtual int32_t hashCode ()
 Return hash code for this object.
 
virtual int64_t getTimestamp ()
 Convenience method that returns the last modified time of the segments_N file corresponding to this index commit, equivalent to getDirectory()->fileModified(getSegmentsFileName()).
 
- 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.
 
- 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 ()
 
- Static Public Member Functions inherited from Lucene::IndexCommit
static String _getClassName ()
 

Data Fields

int64_t gen
 
HashSet< String > files
 
String segmentsFileName
 
bool deleted
 
DirectoryPtr directory
 
Collection< CommitPointPtrcommitsToDelete
 
int64_t version
 
int64_t generation
 
bool _isOptimized
 
MapStringString userData
 

Additional Inherited Members

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

Detailed Description

Holds details for each commit point. This class is also passed to the deletion policy. Note: this class has a natural ordering that is inconsistent with equals.

Constructor & Destructor Documentation

◆ CommitPoint()

Lucene::CommitPoint::CommitPoint ( Collection< CommitPointPtr commitsToDelete,
const DirectoryPtr directory,
const SegmentInfosPtr segmentInfos 
)

◆ ~CommitPoint()

virtual Lucene::CommitPoint::~CommitPoint ( )
virtual

Member Function Documentation

◆ _getClassName()

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

◆ compareTo()

virtual int32_t Lucene::CommitPoint::compareTo ( const LuceneObjectPtr other)
virtual

Compare two objects.

Reimplemented from Lucene::LuceneObject.

◆ deleteCommit()

virtual void Lucene::CommitPoint::deleteCommit ( )
virtual

Called only be the deletion policy, to remove this commit point from the index.

Implements Lucene::IndexCommit.

◆ getClassName()

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

Reimplemented from Lucene::IndexCommit.

◆ getDirectory()

virtual DirectoryPtr Lucene::CommitPoint::getDirectory ( )
virtual

Returns the Directory for the index.

Implements Lucene::IndexCommit.

◆ getFileNames()

virtual HashSet< String > Lucene::CommitPoint::getFileNames ( )
virtual

Returns all index files referenced by this commit point.

Implements Lucene::IndexCommit.

◆ getGeneration()

virtual int64_t Lucene::CommitPoint::getGeneration ( )
virtual

Returns the generation (the _N in segments_N) for this IndexCommit.

Implements Lucene::IndexCommit.

◆ getSegmentsFileName()

virtual String Lucene::CommitPoint::getSegmentsFileName ( )
virtual

Get the segments file (segments_N) associated with this commit point.

Implements Lucene::IndexCommit.

◆ getUserData()

virtual MapStringString Lucene::CommitPoint::getUserData ( )
virtual

Returns userData, previously passed to IndexWriter#commit(Map) for this commit.

Implements Lucene::IndexCommit.

◆ getVersion()

virtual int64_t Lucene::CommitPoint::getVersion ( )
virtual

Returns the version for this IndexCommit.

Implements Lucene::IndexCommit.

◆ isDeleted()

virtual bool Lucene::CommitPoint::isDeleted ( )
virtual

Implements Lucene::IndexCommit.

◆ isOptimized()

virtual bool Lucene::CommitPoint::isOptimized ( )
virtual

Returns true if this commit is an optimized index.

Implements Lucene::IndexCommit.

◆ shared_from_this()

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

◆ toString()

virtual String Lucene::CommitPoint::toString ( )
virtual

Returns a string representation of the object.

Reimplemented from Lucene::LuceneObject.

Field Documentation

◆ _isOptimized

bool Lucene::CommitPoint::_isOptimized

◆ commitsToDelete

Collection<CommitPointPtr> Lucene::CommitPoint::commitsToDelete

◆ deleted

bool Lucene::CommitPoint::deleted

◆ directory

DirectoryPtr Lucene::CommitPoint::directory

◆ files

HashSet<String> Lucene::CommitPoint::files

◆ gen

int64_t Lucene::CommitPoint::gen

◆ generation

int64_t Lucene::CommitPoint::generation

◆ segmentsFileName

String Lucene::CommitPoint::segmentsFileName

◆ userData

MapStringString Lucene::CommitPoint::userData

◆ version

int64_t Lucene::CommitPoint::version

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

clucene.sourceforge.net