Lucene++ - a full-featured, c++ search engine
API Documentation
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>
Public Member Functions | |
CommitPoint (Collection< CommitPointPtr > commitsToDelete, const DirectoryPtr &directory, const SegmentInfosPtr &segmentInfos) | |
virtual | ~CommitPoint () |
virtual String | getClassName () |
boost::shared_ptr< CommitPoint > | shared_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. | |
![]() | |
virtual | ~IndexCommit () |
boost::shared_ptr< IndexCommit > | shared_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()). | |
![]() | |
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 | ~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 String | _getClassName () |
Data Fields | |
int64_t | gen |
HashSet< String > | files |
String | segmentsFileName |
bool | deleted |
DirectoryPtr | directory |
Collection< CommitPointPtr > | commitsToDelete |
int64_t | version |
int64_t | generation |
bool | _isOptimized |
MapStringString | userData |
Additional Inherited Members | |
![]() | |
LuceneObject () | |
![]() | |
SynchronizePtr | objectLock |
LuceneSignalPtr | objectSignal |
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.
Lucene::CommitPoint::CommitPoint | ( | Collection< CommitPointPtr > | commitsToDelete, |
const DirectoryPtr & | directory, | ||
const SegmentInfosPtr & | segmentInfos | ||
) |
|
virtual |
|
inlinestatic |
|
virtual |
Compare two objects.
Reimplemented from Lucene::LuceneObject.
|
virtual |
Called only be the deletion policy, to remove this commit point from the index.
Implements Lucene::IndexCommit.
|
inlinevirtual |
Reimplemented from Lucene::IndexCommit.
|
virtual |
Returns the Directory
for the index.
Implements Lucene::IndexCommit.
|
virtual |
Returns all index files referenced by this commit point.
Implements Lucene::IndexCommit.
|
virtual |
Returns the generation (the _N in segments_N) for this IndexCommit.
Implements Lucene::IndexCommit.
|
virtual |
Get the segments file (segments_N) associated with this commit point.
Implements Lucene::IndexCommit.
|
virtual |
Returns userData, previously passed to IndexWriter#commit(Map)
for this commit.
Implements Lucene::IndexCommit.
|
virtual |
Returns the version for this IndexCommit.
Implements Lucene::IndexCommit.
|
virtual |
Implements Lucene::IndexCommit.
|
virtual |
Returns true if this commit is an optimized index.
Implements Lucene::IndexCommit.
|
inline |
|
virtual |
Returns a string representation of the object.
Reimplemented from Lucene::LuceneObject.
bool Lucene::CommitPoint::_isOptimized |
Collection<CommitPointPtr> Lucene::CommitPoint::commitsToDelete |
bool Lucene::CommitPoint::deleted |
DirectoryPtr Lucene::CommitPoint::directory |
HashSet<String> Lucene::CommitPoint::files |
int64_t Lucene::CommitPoint::gen |
int64_t Lucene::CommitPoint::generation |
String Lucene::CommitPoint::segmentsFileName |
MapStringString Lucene::CommitPoint::userData |
int64_t Lucene::CommitPoint::version |