Package org.apache.lucene.codecs.compressing

Class CompressingStoredFieldsReader

java.lang.Object

org.apache.lucene.codecs.StoredFieldsReader

org.apache.lucene.codecs.compressing.CompressingStoredFieldsReader

All Implemented Interfaces:

Closeable, AutoCloseable, Cloneable, Accountable

public final class CompressingStoredFieldsReader
extends StoredFieldsReader

StoredFieldsReader impl for CompressingStoredFieldsFormat.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	CompressingStoredFieldsReader.BlockState	Keeps state about the current block of documents.
(package private) static class	CompressingStoredFieldsReader.SerializedDocument	A serialized document, you need to decode its input in order to get an actual Document.

Field Summary

Fields

Modifier and Type	Field	Description
private final int	chunkSize
private boolean	closed
private final CompressionMode	compressionMode
private final Decompressor	decompressor
private final FieldInfos	fieldInfos
private final IndexInput	fieldsStream
private final FieldsIndex	indexReader
private final long	maxPointer
private final boolean	merging
private final long	numDirtyChunks
private final long	numDirtyDocs
private final int	numDocs
private final int	packedIntsVersion
private final CompressingStoredFieldsReader.BlockState	state
private final int	version

Fields inherited from interface org.apache.lucene.util.Accountable

NULL_ACCOUNTABLE

Constructor Summary

Constructors

Modifier	Constructor	Description
private	CompressingStoredFieldsReader(CompressingStoredFieldsReader reader, boolean merging)
	CompressingStoredFieldsReader(Directory d, SegmentInfo si, String segmentSuffix, FieldInfos fn, IOContext context, String formatName, CompressionMode compressionMode)	Sole constructor.

Method Summary

Modifier and Type	Method	Description
void	checkIntegrity()	Checks consistency of this reader.
StoredFieldsReader	clone()
void	close()	Close the underlying IndexInputs.
(package private) CompressingStoredFieldsReader.SerializedDocument	document(int docID)
private void	ensureOpen()
Collection<Accountable>	getChildResources()	Returns nested resources of this class.
(package private) int	getChunkSize()
(package private) CompressionMode	getCompressionMode()
(package private) IndexInput	getFieldsStream()
(package private) FieldsIndex	getIndexReader()
(package private) long	getMaxPointer()
StoredFieldsReader	getMergeInstance()	Returns an instance optimized for merging.
(package private) long	getNumDirtyChunks()
(package private) long	getNumDirtyDocs()
(package private) int	getNumDocs()
(package private) int	getPackedIntsVersion()
(package private) int	getVersion()
long	ramBytesUsed()	Return the memory usage of this object in bytes.
private static void	readField(DataInput in, StoredFieldVisitor visitor, FieldInfo info, int bits)
(package private) static long	readTLong(DataInput in)	Reads a long in a variable-length format.
(package private) static double	readZDouble(DataInput in)	Reads a double in a variable-length format.
(package private) static float	readZFloat(DataInput in)	Reads a float in a variable-length format.
private static void	skipField(DataInput in, int bits)
String	toString()
void	visitDocument(int docID, StoredFieldVisitor visitor)	Visit the stored fields for document docID

Methods inherited from class java.lang.Object

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

Field Details

version

private final int version

fieldInfos

private final FieldInfos fieldInfos

indexReader

private final FieldsIndex indexReader

maxPointer

private final long maxPointer

fieldsStream

private final IndexInput fieldsStream

chunkSize

private final int chunkSize

packedIntsVersion

private final int packedIntsVersion

compressionMode

private final CompressionMode compressionMode

decompressor

private final Decompressor decompressor

numDocs

private final int numDocs

merging

private final boolean merging

state

private final CompressingStoredFieldsReader.BlockState state

numDirtyChunks

private final long numDirtyChunks

numDirtyDocs

private final long numDirtyDocs

closed

private boolean closed

Constructor Details

CompressingStoredFieldsReader

private CompressingStoredFieldsReader(CompressingStoredFieldsReader reader,
 boolean merging)

CompressingStoredFieldsReader

public CompressingStoredFieldsReader(Directory d,
 SegmentInfo si,
 String segmentSuffix,
 FieldInfos fn,
 IOContext context,
 String formatName,
 CompressionMode compressionMode)
                              throws IOException

Sole constructor.

Throws:

IOException

Method Details

ensureOpen

private void ensureOpen()
                 throws AlreadyClosedException

Throws:

AlreadyClosedException - if this FieldsReader is closed

close

public void close()
           throws IOException

Close the underlying IndexInputs.

Throws:

IOException

readField

private static void readField(DataInput in,
 StoredFieldVisitor visitor,
 FieldInfo info,
 int bits)
                       throws IOException

Throws:

IOException

skipField

private static void skipField(DataInput in,
 int bits)
                       throws IOException

Throws:

IOException

readZFloat

static float readZFloat(DataInput in)
                 throws IOException

Reads a float in a variable-length format. Reads between one and five bytes. Small integral values typically take fewer bytes.

Throws:

IOException

readZDouble

static double readZDouble(DataInput in)
                   throws IOException

Reads a double in a variable-length format. Reads between one and nine bytes. Small integral values typically take fewer bytes.

Throws:

IOException

readTLong

static long readTLong(DataInput in)
               throws IOException

Reads a long in a variable-length format. Reads between one andCorePropLo nine bytes. Small values typically take fewer bytes.

Throws:

IOException

document

CompressingStoredFieldsReader.SerializedDocument document(int docID)
                                                   throws IOException

Throws:

IOException

visitDocument

public void visitDocument(int docID,
 StoredFieldVisitor visitor)
                   throws IOException

Description copied from class: StoredFieldsReader

Visit the stored fields for document docID

Specified by:

visitDocument in class StoredFieldsReader

Throws:

IOException

clone

public StoredFieldsReader clone()

Specified by:

clone in class StoredFieldsReader

getMergeInstance

public StoredFieldsReader getMergeInstance()

Description copied from class: StoredFieldsReader

Returns an instance optimized for merging. This instance may not be cloned.

The default implementation returns this

Overrides:

getMergeInstance in class StoredFieldsReader

getVersion

int getVersion()

getCompressionMode

CompressionMode getCompressionMode()

getIndexReader

FieldsIndex getIndexReader()

getMaxPointer

long getMaxPointer()

getFieldsStream

IndexInput getFieldsStream()

getChunkSize

int getChunkSize()

getNumDirtyDocs

long getNumDirtyDocs()

getNumDirtyChunks

long getNumDirtyChunks()

getNumDocs

int getNumDocs()

getPackedIntsVersion

int getPackedIntsVersion()

ramBytesUsed

public long ramBytesUsed()

Description copied from interface: Accountable

Return the memory usage of this object in bytes. Negative values are illegal.

getChildResources

public Collection<Accountable> getChildResources()

Description copied from interface: Accountable

Returns nested resources of this class. The result should be a point-in-time snapshot (to avoid race conditions).

See Also:

• Accountables

checkIntegrity

public void checkIntegrity()
                    throws IOException

Description copied from class: StoredFieldsReader

Checks consistency of this reader.

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 StoredFieldsReader

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object