Module org.apache.lucene.core

Package org.apache.lucene.codecs.lucene90

Class Lucene90CompoundReader

java.lang.Object

org.apache.lucene.store.Directory

org.apache.lucene.codecs.CompoundDirectory

org.apache.lucene.codecs.lucene90.Lucene90CompoundReader

All Implemented Interfaces:

Closeable, AutoCloseable

final class Lucene90CompoundReader
extends CompoundDirectory

Class for accessing a compound stream. This class implements a directory, but is limited to only read operations. Directory methods that would normally modify data throw an exception.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Lucene90CompoundReader.FileEntry	Offset/Length for a slice inside of a compound file

Field Summary

Fields

Modifier and Type	Field	Description
private final Directory	directory
private final Map<String,Lucene90CompoundReader.FileEntry>	entries
private final IndexInput	handle
private final String	segmentName
private int	version

Constructor Summary

Constructors

Constructor	Description
Lucene90CompoundReader(Directory directory, SegmentInfo si, IOContext context)	Create a new CompoundFileDirectory.

Method Summary

Modifier and Type	Method	Description
void	checkIntegrity()	Checks consistency of this directory.
void	close()	Closes the directory.
long	fileLength(String name)	Returns the length of a file in the directory.
Set<String>	getPendingDeletions()	Returns a set of files currently pending deletion in this directory.
String[]	listAll()	Returns an array of strings, one for each file in the directory.
IndexInput	openInput(String name, IOContext context)	Opens a stream for reading an existing file.
private Map<String,Lucene90CompoundReader.FileEntry>	readEntries(byte[] segmentID, Directory dir, String entriesFileName)	Helper method that reads CFS entries from an input stream
private Map<String,Lucene90CompoundReader.FileEntry>	readMapping(IndexInput entriesStream)
String	toString()

Methods inherited from class org.apache.lucene.codecs.CompoundDirectory

createOutput, createTempOutput, deleteFile, obtainLock, rename, sync, syncMetaData

Methods inherited from class org.apache.lucene.store.Directory

copyFrom, ensureOpen, getTempFileName, openChecksumInput

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

directory

private final Directory directory

segmentName

private final String segmentName

entries

private final Map<String,Lucene90CompoundReader.FileEntry> entries

handle

private final IndexInput handle

version

private int version

Constructor Details

Lucene90CompoundReader

public Lucene90CompoundReader(Directory directory,
 SegmentInfo si,
 IOContext context)
                       throws IOException

Create a new CompoundFileDirectory.

Throws:

IOException

Method Details

readEntries

private Map<String,Lucene90CompoundReader.FileEntry> readEntries(byte[] segmentID,
 Directory dir,
 String entriesFileName)
                                                          throws IOException

Helper method that reads CFS entries from an input stream

Throws:

IOException

readMapping

private Map<String,Lucene90CompoundReader.FileEntry> readMapping(IndexInput entriesStream)
                                                          throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Description copied from class: Directory

Closes the directory.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class Directory

Throws:

IOException

openInput

public IndexInput openInput(String name,
 IOContext context)
                     throws IOException

Description copied from class: Directory

Opens a stream for reading an existing file.

This method must throw either NoSuchFileException or FileNotFoundException if name points to a non-existing file.

Specified by:

openInput in class Directory

Parameters:

name - the name of an existing file.

Throws:

IOException - in case of I/O error

listAll

public String[] listAll()

Returns an array of strings, one for each file in the directory.

Specified by:

listAll in class Directory

fileLength

public long fileLength(String name)
                throws IOException

Returns the length of a file in the directory.

Specified by:

fileLength in class Directory

Parameters:

name - the name of an existing file.

Throws:

IOException - if the file does not exist

toString

public String toString()

Overrides:

toString in class Directory

getPendingDeletions

public Set<String> getPendingDeletions()

Description copied from class: Directory

Returns a set of files currently pending deletion in this directory.

Specified by:

getPendingDeletions in class Directory

checkIntegrity

public void checkIntegrity()
                    throws IOException

Description copied from class: CompoundDirectory

Checks consistency of this directory.

Note that this may be costly in terms of I/O, e.g. may involve computing a checksum value against large data files.

Specified by:

checkIntegrity in class CompoundDirectory

Throws:

IOException