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:

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) Collection<String>	files
(package private) long	generation
private final StandardDirectoryReader	reader
private final int	segmentCount
private String	segmentsFileName
(package private) final Map<String,String>	userData

Constructor Summary

Constructors

Constructor	Description
ReaderCommit(StandardDirectoryReader reader, SegmentInfos infos, Directory dir)

Method Summary

Modifier and Type	Method	Description
void	delete()	Delete this commit point.
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
(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.
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, hashCode

Methods inherited from class java.lang.Object

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

Field Details

segmentsFileName

private String segmentsFileName

files

Collection<String> files

dir

Directory dir

generation

long generation

userData

final Map<String,String> userData

segmentCount

private final int segmentCount

reader

private final StandardDirectoryReader reader

Constructor Details

ReaderCommit

ReaderCommit(StandardDirectoryReader reader,
 SegmentInfos infos,
 Directory dir)
      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

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

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()

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 its onInit() or onCommit() methods.

Specified by:

delete in class IndexCommit

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 class IndexCommit