Package org.apache.lucene.codecs.compressing

Class CompressingTermVectorsReader

java.lang.Object

org.apache.lucene.codecs.TermVectorsReader

org.apache.lucene.codecs.compressing.CompressingTermVectorsReader

All Implemented Interfaces:

Closeable, AutoCloseable, Cloneable, Accountable

public final class CompressingTermVectorsReader
extends TermVectorsReader
implements Closeable

TermVectorsReader for CompressingTermVectorsFormat.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	CompressingTermVectorsReader.TVFields
private static class	CompressingTermVectorsReader.TVPostingsEnum
private static class	CompressingTermVectorsReader.TVTerms
private static class	CompressingTermVectorsReader.TVTermsEnum

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
(package private) final FieldsIndex	indexReader
private final long	maxPointer
private final long	numDirtyChunks
private final long	numDirtyDocs
private final int	numDocs
private final int	packedIntsVersion
private final BlockPackedReaderIterator	reader
(package private) final IndexInput	vectorsStream
private final int	version

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

NULL_ACCOUNTABLE

Constructor Summary

Constructors

Modifier	Constructor	Description
private	CompressingTermVectorsReader(CompressingTermVectorsReader reader)
	CompressingTermVectorsReader(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.
TermVectorsReader	clone()	Create a clone that one caller at a time may use to read term vectors.
void	close()
private void	ensureOpen()
Fields	get(int doc)	Returns term vectors for this document, or null if term vectors were not indexed.
Collection<Accountable>	getChildResources()	Returns nested resources of this class.
(package private) int	getChunkSize()
(package private) CompressionMode	getCompressionMode()
(package private) FieldsIndex	getIndexReader()
(package private) long	getMaxPointer()
(package private) long	getNumDirtyChunks()
(package private) long	getNumDirtyDocs()
(package private) int	getNumDocs()
(package private) int	getPackedIntsVersion()
(package private) IndexInput	getVectorsStream()
(package private) int	getVersion()
private int[][]	positionIndex(int skip, int numFields, PackedInts.Reader numTerms, int[] termFreqs)
long	ramBytesUsed()	Return the memory usage of this object in bytes.
private int[][]	readPositions(int skip, int numFields, PackedInts.Reader flags, PackedInts.Reader numTerms, int[] termFreqs, int flag, int totalPositions, int[][] positionIndex)
private static int	sum(int[] arr)
String	toString()

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

getMergeInstance

Methods inherited from class java.lang.Object

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

Field Details

fieldInfos

private final FieldInfos fieldInfos

indexReader

final FieldsIndex indexReader

vectorsStream

final IndexInput vectorsStream

version

private final int version

packedIntsVersion

private final int packedIntsVersion

compressionMode

private final CompressionMode compressionMode

decompressor

private final Decompressor decompressor

chunkSize

private final int chunkSize

numDocs

private final int numDocs

closed

private boolean closed

reader

private final BlockPackedReaderIterator reader

numDirtyChunks

private final long numDirtyChunks

numDirtyDocs

private final long numDirtyDocs

maxPointer

private final long maxPointer

Constructor Details

CompressingTermVectorsReader

private CompressingTermVectorsReader(CompressingTermVectorsReader reader)

CompressingTermVectorsReader

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

Sole constructor.

Throws:

IOException

Method Details

getCompressionMode

CompressionMode getCompressionMode()

getChunkSize

int getChunkSize()

getPackedIntsVersion

int getPackedIntsVersion()

getVersion

int getVersion()

getIndexReader

FieldsIndex getIndexReader()

getVectorsStream

IndexInput getVectorsStream()

getMaxPointer

long getMaxPointer()

getNumDirtyDocs

long getNumDirtyDocs()

getNumDirtyChunks

long getNumDirtyChunks()

getNumDocs

int getNumDocs()

ensureOpen

private void ensureOpen()
                 throws AlreadyClosedException

Throws:

AlreadyClosedException - if this TermVectorsReader is closed

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

clone

public TermVectorsReader clone()

Description copied from class: TermVectorsReader

Create a clone that one caller at a time may use to read term vectors.

Specified by:

clone in class TermVectorsReader

get

public Fields get(int doc)
           throws IOException

Description copied from class: TermVectorsReader

Returns term vectors for this document, or null if term vectors were not indexed. If offsets are available they are in an OffsetAttribute available from the PostingsEnum.

Specified by:

get in class TermVectorsReader

Throws:

IOException

positionIndex

private int[][] positionIndex(int skip,
 int numFields,
 PackedInts.Reader numTerms,
 int[] termFreqs)

readPositions

private int[][] readPositions(int skip,
 int numFields,
 PackedInts.Reader flags,
 PackedInts.Reader numTerms,
 int[] termFreqs,
 int flag,
 int totalPositions,
 int[][] positionIndex)
                       throws IOException

Throws:

IOException

sum

private static int sum(int[] arr)

ramBytesUsed

public long ramBytesUsed()

Description copied from interface: Accountable

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

Specified by:

ramBytesUsed in interface Accountable

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

Specified by:

getChildResources in interface Accountable

See Also:

• Accountables

checkIntegrity

public void checkIntegrity()
                    throws IOException

Description copied from class: TermVectorsReader

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 TermVectorsReader

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object