File Doc Category Size Date Package
IndexCommitPoint.java API Doc Apache Lucene 2.2.0 2089 Sat Jun 16 22:20:36 BST 2007 org.apache.lucene.index

IndexCommitPoint

public interface IndexCommitPoint

Expert: represents a single commit into an index as seen by the {@link IndexDeletionPolicy}.

Changes to the content of an index are made visible only after the writer who made that change had written to the directory a new segments file (segments_N). This point in time, when the action of writing of a new segments file to the directory is completed, is therefore an index commit point.

Each index commit point has a unique segments file associated with it. The segments file associated with a later index commit point would have a larger N.

Fields Summary
Constructors Summary
Methods Summary
public void delete()
Delete this commit point.
Upon calling this, the writer is notified that this commit point should be deleted.
Decision that a commit-point should be deleted is taken by the {@link IndexDeletionPolicy} in effect and therefore this should only be called by its {@link IndexDeletionPolicy#onInit onInit()} or {@link IndexDeletionPolicy#onCommit onCommit()} methods.
public java.lang.String getSegmentsFileName()
Get the segments file (segments_N) associated with this commit point.