Module org.apache.lucene.core
Package org.apache.lucene.index
Class StandardDirectoryReader.ReaderCommit
- java.lang.Object
-
- org.apache.lucene.index.IndexCommit
-
- org.apache.lucene.index.StandardDirectoryReader.ReaderCommit
-
- All Implemented Interfaces:
java.lang.Comparable<IndexCommit>
- Enclosing class:
- StandardDirectoryReader
static final class StandardDirectoryReader.ReaderCommit extends IndexCommit
-
-
Field Summary
Fields Modifier and Type Field Description (package private) Directory
dir
(package private) java.util.Collection<java.lang.String>
files
(package private) long
generation
private StandardDirectoryReader
reader
private int
segmentCount
private java.lang.String
segmentsFileName
(package private) java.util.Map<java.lang.String,java.lang.String>
userData
-
Constructor Summary
Constructors Constructor Description ReaderCommit(StandardDirectoryReader reader, SegmentInfos infos, Directory dir)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
delete()
Delete this commit point.Directory
getDirectory()
Returns theDirectory
for the index.java.util.Collection<java.lang.String>
getFileNames()
Returns all index files referenced by this commit point.long
getGeneration()
Returns the generation (the _N in segments_N) for this IndexCommit(package private) StandardDirectoryReader
getReader()
Package-private API for IndexWriter to init from a commit-point pulled from an NRT or non-NRT reader.int
getSegmentCount()
Returns number of segments referenced by this commit.java.lang.String
getSegmentsFileName()
Get the segments file (segments_N
) associated with this commit point.java.util.Map<java.lang.String,java.lang.String>
getUserData()
Returns userData, previously passed toIndexWriter.setLiveCommitData(Iterable)
for this commit.boolean
isDeleted()
Returns true if this commit should be deleted; this is only used byIndexWriter
after invoking theIndexDeletionPolicy
.java.lang.String
toString()
-
Methods inherited from class org.apache.lucene.index.IndexCommit
compareTo, equals, hashCode
-
-
-
-
Field Detail
-
segmentsFileName
private java.lang.String segmentsFileName
-
files
java.util.Collection<java.lang.String> files
-
dir
Directory dir
-
generation
long generation
-
userData
final java.util.Map<java.lang.String,java.lang.String> userData
-
segmentCount
private final int segmentCount
-
reader
private final StandardDirectoryReader reader
-
-
Constructor Detail
-
ReaderCommit
ReaderCommit(StandardDirectoryReader reader, SegmentInfos infos, Directory dir) throws java.io.IOException
- Throws:
java.io.IOException
-
-
Method Detail
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
getSegmentCount
public int getSegmentCount()
Description copied from class:IndexCommit
Returns number of segments referenced by this commit.- Specified by:
getSegmentCount
in classIndexCommit
-
getSegmentsFileName
public java.lang.String getSegmentsFileName()
Description copied from class:IndexCommit
Get the segments file (segments_N
) associated with this commit point.- Specified by:
getSegmentsFileName
in classIndexCommit
-
getFileNames
public java.util.Collection<java.lang.String> getFileNames()
Description copied from class:IndexCommit
Returns all index files referenced by this commit point.- Specified by:
getFileNames
in classIndexCommit
-
getDirectory
public Directory getDirectory()
Description copied from class:IndexCommit
Returns theDirectory
for the index.- Specified by:
getDirectory
in classIndexCommit
-
getGeneration
public long getGeneration()
Description copied from class:IndexCommit
Returns the generation (the _N in segments_N) for this IndexCommit- Specified by:
getGeneration
in classIndexCommit
-
isDeleted
public boolean isDeleted()
Description copied from class:IndexCommit
Returns true if this commit should be deleted; this is only used byIndexWriter
after invoking theIndexDeletionPolicy
.- Specified by:
isDeleted
in classIndexCommit
-
getUserData
public java.util.Map<java.lang.String,java.lang.String> getUserData()
Description copied from class:IndexCommit
Returns userData, previously passed toIndexWriter.setLiveCommitData(Iterable)
for this commit. Map isString -> String
.- Specified by:
getUserData
in classIndexCommit
-
delete
public void delete()
Description copied from class:IndexCommit
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 itsonInit()
oronCommit()
methods.- Specified by:
delete
in classIndexCommit
-
getReader
StandardDirectoryReader getReader()
Description copied from class:IndexCommit
Package-private API for IndexWriter to init from a commit-point pulled from an NRT or non-NRT reader.- Overrides:
getReader
in classIndexCommit
-
-