Module org.apache.lucene.core

Package org.apache.lucene.index

Class IndexFileDeleter.CommitPoint

java.lang.Object

org.apache.lucene.index.IndexCommit

org.apache.lucene.index.IndexFileDeleter.CommitPoint

All Implemented Interfaces:

Comparable<IndexCommit>

Enclosing class:

IndexFileDeleter

private static final class IndexFileDeleter.CommitPoint
extends IndexCommit

Holds details for each commit point. This class is also passed to the deletion policy. Note: this class has a natural ordering that is inconsistent with equals.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) Collection<IndexFileDeleter.CommitPoint>	commitsToDelete
(package private) boolean	deleted
(package private) Directory	directoryOrig
(package private) Collection<String>	files
(package private) long	generation
private final int	segmentCount
(package private) String	segmentsFileName
(package private) final Map<String,String>	userData

Constructor Summary

Constructors

Constructor	Description
CommitPoint(Collection<IndexFileDeleter.CommitPoint> commitsToDelete, Directory directoryOrig, SegmentInfos segmentInfos)

Method Summary

Modifier and Type	Method	Description
void	delete()	Called only be the deletion policy, to remove this commit point from the index.
Directory	getDirectory()	Returns the Directory for the index.
Collection<String>	getFileNames()	Returns all index files referenced by this commit point.
long	getGeneration()	Returns the generation (the _N in segments_N) for this IndexCommit
int	getSegmentCount()	Returns number of segments referenced by this commit.
String	getSegmentsFileName()	Get the segments file (segments_N) associated with this commit point.
Map<String,String>	getUserData()	Returns userData, previously passed to IndexWriter.setLiveCommitData(Iterable) for this commit.
boolean	isDeleted()	Returns true if this commit should be deleted; this is only used by IndexWriter after invoking the IndexDeletionPolicy.
String	toString()

Methods inherited from class org.apache.lucene.index.IndexCommit

compareTo, equals, getReader, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

files

Collection<String> files

segmentsFileName

String segmentsFileName

deleted

boolean deleted

directoryOrig

Directory directoryOrig

commitsToDelete

Collection<IndexFileDeleter.CommitPoint> commitsToDelete

generation

long generation

userData

final Map<String,String> userData

segmentCount

private final int segmentCount

Constructor Details

CommitPoint

public CommitPoint(Collection<IndexFileDeleter.CommitPoint> commitsToDelete,
 Directory directoryOrig,
 SegmentInfos segmentInfos)
            throws IOException

Throws:

IOException

Method Details

toString

public String toString()

Overrides:

toString in class Object

getSegmentCount

public int getSegmentCount()

Description copied from class: IndexCommit

Returns number of segments referenced by this commit.

Specified by:

getSegmentCount in class IndexCommit

getSegmentsFileName

public String getSegmentsFileName()

Description copied from class: IndexCommit

Get the segments file (segments_N) associated with this commit point.

Specified by:

getSegmentsFileName in class IndexCommit

getFileNames

public Collection<String> getFileNames()

Description copied from class: IndexCommit

Returns all index files referenced by this commit point.

Specified by:

getFileNames in class IndexCommit

getDirectory

public Directory getDirectory()

Description copied from class: IndexCommit

Returns the Directory for the index.

Specified by:

getDirectory in class IndexCommit

getGeneration

public long getGeneration()

Description copied from class: IndexCommit

Returns the generation (the _N in segments_N) for this IndexCommit

Specified by:

getGeneration in class IndexCommit

getUserData

public Map<String,String> getUserData()

Description copied from class: IndexCommit

Returns userData, previously passed to IndexWriter.setLiveCommitData(Iterable) for this commit. Map is String -> String.

Specified by:

getUserData in class IndexCommit

delete

public void delete()

Called only be the deletion policy, to remove this commit point from the index.

Specified by:

delete in class IndexCommit

isDeleted

public boolean isDeleted()

Description copied from class: IndexCommit

Returns true if this commit should be deleted; this is only used by IndexWriter after invoking the IndexDeletionPolicy.

Specified by:

isDeleted in class IndexCommit