Package org.apache.lucene.index
Class SnapshotDeletionPolicy.SnapshotCommitPoint
- java.lang.Object
-
- org.apache.lucene.index.IndexCommit
-
- org.apache.lucene.index.SnapshotDeletionPolicy.SnapshotCommitPoint
-
- All Implemented Interfaces:
Comparable<IndexCommit>
- Enclosing class:
- SnapshotDeletionPolicy
protected class SnapshotDeletionPolicy.SnapshotCommitPoint extends IndexCommit
-
-
Field Summary
Fields Modifier and Type Field Description protected IndexCommitcp
-
Constructor Summary
Constructors Modifier Constructor Description protectedSnapshotCommitPoint(IndexCommit cp)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voiddelete()Delete this commit point.DirectorygetDirectory()Returns theDirectoryfor the index.Collection<String>getFileNames()Returns all index files referenced by this commit point.longgetGeneration()Returns the generation (the _N in segments_N) for this IndexCommitintgetSegmentCount()Returns number of segments referenced by this commit.StringgetSegmentsFileName()Get the segments file (segments_N) associated with this commit point.Map<String,String>getUserData()Returns userData, previously passed toIndexWriter.commit(Map)for this commit.longgetVersion()Returns the version for this IndexCommit.booleanisDeleted()protected booleanshouldDelete(String segmentsFileName)Returns true if this segment can be deleted.StringtoString()-
Methods inherited from class org.apache.lucene.index.IndexCommit
compareTo, equals, getTimestamp, hashCode
-
-
-
-
Field Detail
-
cp
protected IndexCommit cp
-
-
Constructor Detail
-
SnapshotCommitPoint
protected SnapshotCommitPoint(IndexCommit cp)
-
-
Method Detail
-
shouldDelete
protected boolean shouldDelete(String segmentsFileName)
Returns true if this segment can be deleted. The default implementation returns false if this segment is currently held as snapshot.
-
delete
public void delete()
Description copied from class:IndexCommitDelete 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
IndexDeletionPolicyin effect and therefore this should only be called by itsonInit()oronCommit()methods.- Specified by:
deletein classIndexCommit
-
getDirectory
public Directory getDirectory()
Description copied from class:IndexCommitReturns theDirectoryfor the index.- Specified by:
getDirectoryin classIndexCommit
-
getFileNames
public Collection<String> getFileNames() throws IOException
Description copied from class:IndexCommitReturns all index files referenced by this commit point.- Specified by:
getFileNamesin classIndexCommit- Throws:
IOException
-
getGeneration
public long getGeneration()
Description copied from class:IndexCommitReturns the generation (the _N in segments_N) for this IndexCommit- Specified by:
getGenerationin classIndexCommit
-
getSegmentsFileName
public String getSegmentsFileName()
Description copied from class:IndexCommitGet the segments file (segments_N) associated with this commit point.- Specified by:
getSegmentsFileNamein classIndexCommit
-
getUserData
public Map<String,String> getUserData() throws IOException
Description copied from class:IndexCommitReturns userData, previously passed toIndexWriter.commit(Map)for this commit. Map is String -> String.- Specified by:
getUserDatain classIndexCommit- Throws:
IOException
-
getVersion
public long getVersion()
Description copied from class:IndexCommitReturns the version for this IndexCommit. This is the same value thatIndexReader.getVersion()would return if it were opened on this commit.- Specified by:
getVersionin classIndexCommit
-
isDeleted
public boolean isDeleted()
- Specified by:
isDeletedin classIndexCommit
-
getSegmentCount
public int getSegmentCount()
Description copied from class:IndexCommitReturns number of segments referenced by this commit.- Specified by:
getSegmentCountin classIndexCommit
-
-