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


Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
Lucene::SnapshotDeletionPolicy Class Reference

#include <SnapshotDeletionPolicy.h>

+ Inheritance diagram for Lucene::SnapshotDeletionPolicy:

Public Member Functions

 SnapshotDeletionPolicy (const IndexDeletionPolicyPtr &primary)
 
virtual ~SnapshotDeletionPolicy ()
 
virtual String getClassName ()
 
boost::shared_ptr< SnapshotDeletionPolicyshared_from_this ()
 
virtual void onInit (Collection< IndexCommitPtr > commits)
 This is called once when a writer is first instantiated to give the policy a chance to remove old commit points.
 
virtual void onCommit (Collection< IndexCommitPtr > commits)
 This is called each time the writer completed a commit. This gives the policy a chance to remove old commit points with each commit.
 
virtual IndexCommitPtr snapshot ()
 Take a snapshot of the most recent commit to the index. You must call release() to free this snapshot. Note that while the snapshot is held, the files it references will not be deleted, which will consume additional disk space in your index. If you take a snapshot at a particularly bad time (say just before you call optimize()) then in the worst case this could consume an extra 1X of your total index size, until you release the snapshot.
 
virtual void release ()
 Release the currently held snapshot.
 
- Public Member Functions inherited from Lucene::IndexDeletionPolicy
virtual ~IndexDeletionPolicy ()
 
boost::shared_ptr< IndexDeletionPolicyshared_from_this ()
 
- 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 ()
 
- Static Public Member Functions inherited from Lucene::IndexDeletionPolicy
static String _getClassName ()
 

Protected Member Functions

Collection< IndexCommitPtrwrapCommits (Collection< IndexCommitPtr > commits)
 
- Protected Member Functions inherited from Lucene::IndexDeletionPolicy
 IndexDeletionPolicy ()
 
- Protected Member Functions inherited from Lucene::LuceneObject
 LuceneObject ()
 

Protected Attributes

IndexCommitPtr lastCommit
 
IndexDeletionPolicyPtr primary
 
String _snapshot
 
- Protected Attributes inherited from Lucene::LuceneSync
SynchronizePtr objectLock
 
LuceneSignalPtr objectSignal
 

Constructor & Destructor Documentation

◆ SnapshotDeletionPolicy()

Lucene::SnapshotDeletionPolicy::SnapshotDeletionPolicy ( const IndexDeletionPolicyPtr primary)

◆ ~SnapshotDeletionPolicy()

virtual Lucene::SnapshotDeletionPolicy::~SnapshotDeletionPolicy ( )
virtual

Member Function Documentation

◆ _getClassName()

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

◆ getClassName()

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

Reimplemented from Lucene::IndexDeletionPolicy.

◆ onCommit()

virtual void Lucene::SnapshotDeletionPolicy::onCommit ( Collection< IndexCommitPtr commits)
virtual

This is called each time the writer completed a commit. This gives the policy a chance to remove old commit points with each commit.

Implements Lucene::IndexDeletionPolicy.

◆ onInit()

virtual void Lucene::SnapshotDeletionPolicy::onInit ( Collection< IndexCommitPtr commits)
virtual

This is called once when a writer is first instantiated to give the policy a chance to remove old commit points.

Implements Lucene::IndexDeletionPolicy.

◆ release()

virtual void Lucene::SnapshotDeletionPolicy::release ( )
virtual

Release the currently held snapshot.

◆ shared_from_this()

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

◆ snapshot()

virtual IndexCommitPtr Lucene::SnapshotDeletionPolicy::snapshot ( )
virtual

Take a snapshot of the most recent commit to the index. You must call release() to free this snapshot. Note that while the snapshot is held, the files it references will not be deleted, which will consume additional disk space in your index. If you take a snapshot at a particularly bad time (say just before you call optimize()) then in the worst case this could consume an extra 1X of your total index size, until you release the snapshot.

◆ wrapCommits()

Collection< IndexCommitPtr > Lucene::SnapshotDeletionPolicy::wrapCommits ( Collection< IndexCommitPtr commits)
protected

Field Documentation

◆ _snapshot

String Lucene::SnapshotDeletionPolicy::_snapshot
protected

◆ lastCommit

IndexCommitPtr Lucene::SnapshotDeletionPolicy::lastCommit
protected

◆ primary

IndexDeletionPolicyPtr Lucene::SnapshotDeletionPolicy::primary
protected

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

clucene.sourceforge.net