public class IndexRevision extends Object implements Revision
Revision of a single index files which comprises the list of files
that are part of the current IndexCommit. To ensure the files are not
deleted by IndexWriter for as long as this revision stays alive (i.e.
until release()), the current commit point is snapshotted, using
SnapshotDeletionPolicy (this means that the given writer's
config should return
SnapshotDeletionPolicy).
When this revision is released, it releases the obtained
snapshot as well as calls IndexWriter.deleteUnusedFiles() so that the
snapshotted files are deleted (if they are no longer needed).
| Constructor and Description |
|---|
IndexRevision(IndexWriter writer)
Constructor over the given
IndexWriter. |
| Modifier and Type | Method and Description |
|---|---|
int |
compareTo(Revision o) |
int |
compareTo(String version)
Compares the revision to the given version string.
|
Map<String,List<RevisionFile>> |
getSourceFiles()
Returns the files that comprise this revision, as a mapping from a source
to a list of files.
|
String |
getVersion()
Returns a string representation of the version of this revision.
|
InputStream |
open(String source,
String fileName)
Returns an
IndexInput for the given fileName and source. |
void |
release()
Called when this revision can be safely released, i.e.
|
static Map<String,List<RevisionFile>> |
revisionFiles(IndexCommit commit)
Returns a singleton map of the revision files from the given
IndexCommit. |
static String |
revisionVersion(IndexCommit commit)
Returns a String representation of a revision's version from the given
IndexCommit. |
String |
toString() |
public IndexRevision(IndexWriter writer) throws IOException
IndexWriter. Uses the last
IndexCommit found in the Directory managed by the given
writer.IOExceptionpublic static Map<String,List<RevisionFile>> revisionFiles(IndexCommit commit) throws IOException
IndexCommit.IOExceptionpublic static String revisionVersion(IndexCommit commit)
IndexCommit.public int compareTo(String version)
RevisionComparable.compareTo(Object).public int compareTo(Revision o)
compareTo in interface Comparable<Revision>public String getVersion()
RevisionRevision.compareTo(String) as well as to
serialize/deserialize revision information. Therefore it must be self
descriptive as well as be able to identify one revision from another.getVersion in interface Revisionpublic Map<String,List<RevisionFile>> getSourceFiles()
RevisiongetSourceFiles in interface Revisionpublic InputStream open(String source, String fileName) throws IOException
RevisionIndexInput for the given fileName and source. It is the
caller's responsibility to close the IndexInput when it has been
consumed.open in interface RevisionIOExceptionpublic void release()
throws IOException
Revisionrelease in interface RevisionIOExceptionCopyright © 2000-2024 Apache Software Foundation. All Rights Reserved.