java.lang.Object | |
↳ | org.apache.lucene.index.IndexCommit |
Known Direct Subclasses |
Expert: represents a single commit into an index as seen by the
IndexDeletionPolicy
or IndexReader
.
Changes to the content of an index are made visible
only after the writer who made that change commits by
writing 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 an index commit.
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.
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Delete this commit point.
| |||||||||||
Two IndexCommits are equal if both their Directory and versions are equal.
| |||||||||||
Returns the
Directory for the index. | |||||||||||
Returns all index files referenced by this commit point.
| |||||||||||
Returns the generation (the _N in segments_N) for this
IndexCommit
| |||||||||||
Get the segments file (
segments_N ) associated
with this commit point. | |||||||||||
Convenience method that returns the last modified time
of the segments_N file corresponding to this index
commit, equivalent to
getDirectory().fileModified(getSegmentsFileName()).
| |||||||||||
Returns userData, previously passed to
commit(Map) for this commit. | |||||||||||
Returns the version for this IndexCommit.
| |||||||||||
Returns true if this commit is an optimized index.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
java.lang.Comparable
|
Delete this commit point. This only applies when using the commit point in the context of IndexWriter's IndexDeletionPolicy.
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 IndexDeletionPolicy
in effect
and therefore this should only be called by its onInit()
or
onCommit()
methods.
Two IndexCommits are equal if both their Directory and versions are equal.
Returns all index files referenced by this commit point.
IOException |
---|
Returns the generation (the _N in segments_N) for this IndexCommit
Get the segments file (segments_N
) associated
with this commit point.
Convenience method that returns the last modified time of the segments_N file corresponding to this index commit, equivalent to getDirectory().fileModified(getSegmentsFileName()).
IOException |
---|
Returns userData, previously passed to commit(Map)
for this commit. Map is
String -> String.
IOException |
---|
Returns the version for this IndexCommit. This is the
same value that getVersion()
would
return if it were opened on this commit.
Returns true if this commit is an optimized index.