Package org.apache.pinot.segment.local.segment.index.readers.forward

Class FixedBitSVForwardIndexReader

java.lang.Object

org.apache.pinot.segment.local.segment.index.readers.forward.FixedBitSVForwardIndexReader

All Implemented Interfaces:

Closeable, AutoCloseable, IndexReader, ForwardIndexReader<ForwardIndexReaderContext>

public final class FixedBitSVForwardIndexReader
extends Object
implements ForwardIndexReader<ForwardIndexReaderContext>

Bit-compressed dictionary-encoded forward index reader for single-value columns. The values returned are dictionary ids.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.pinot.segment.spi.index.reader.ForwardIndexReader

ForwardIndexReader.ByteRange

Constructor Summary

Constructors

Constructor	Description
FixedBitSVForwardIndexReader(PinotDataBuffer dataBuffer, int numDocs, int numBitsPerValue)

Method Summary

Modifier and Type	Method	Description
void	close()
int	getDictId(int docId, ForwardIndexReaderContext context)
int	getDocLength()
long	getRawDataStartOffset()
FieldSpec.DataType	getStoredType()
boolean	isBufferByteRangeInfoSupported()
boolean	isDictionaryEncoded()
boolean	isDocLengthInBits()
boolean	isFixedOffsetMappingType()
boolean	isSingleValue()
void	readDictIds(int[] docIds, int length, int[] dictIdBuffer, ForwardIndexReaderContext context)
void	recordDocIdByteRanges(int docId, ForwardIndexReaderContext context, List<ForwardIndexReader.ByteRange> ranges)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.pinot.segment.spi.index.reader.ForwardIndexReader

createContext, getBigDecimal, getBytes, getBytesMV, getBytesMV, getCompressionType, getDictIdCompressionType, getDictIdMV, getDictIdMV, getDouble, getDoubleMV, getDoubleMV, getFloat, getFloatMV, getFloatMV, getInt, getIntMV, getIntMV, getLengthOfLongestEntry, getLong, getLongMV, getLongMV, getNumValuesMV, getString, getStringMV, getStringMV, readValuesMV, readValuesMV, readValuesMV, readValuesMV, readValuesMV, readValuesMV, readValuesSV, readValuesSV, readValuesSV, readValuesSV, readValuesSV

Constructor Detail

FixedBitSVForwardIndexReader

public FixedBitSVForwardIndexReader(PinotDataBuffer dataBuffer,
                                    int numDocs,
                                    int numBitsPerValue)

Method Detail

isDictionaryEncoded

public boolean isDictionaryEncoded()

Specified by:

isDictionaryEncoded in interface ForwardIndexReader<ForwardIndexReaderContext>

isSingleValue

public boolean isSingleValue()

Specified by:

isSingleValue in interface ForwardIndexReader<ForwardIndexReaderContext>

getStoredType

public FieldSpec.DataType getStoredType()

Specified by:

getStoredType in interface ForwardIndexReader<ForwardIndexReaderContext>

getDictId

public int getDictId(int docId,
                     ForwardIndexReaderContext context)

Specified by:

getDictId in interface ForwardIndexReader<ForwardIndexReaderContext>

readDictIds

public void readDictIds(int[] docIds,
                        int length,
                        int[] dictIdBuffer,
                        ForwardIndexReaderContext context)

Specified by:

readDictIds in interface ForwardIndexReader<ForwardIndexReaderContext>

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

isBufferByteRangeInfoSupported

public boolean isBufferByteRangeInfoSupported()

Specified by:

isBufferByteRangeInfoSupported in interface ForwardIndexReader<ForwardIndexReaderContext>

recordDocIdByteRanges

public void recordDocIdByteRanges(int docId,
                                  ForwardIndexReaderContext context,
                                  List<ForwardIndexReader.ByteRange> ranges)

Specified by:

recordDocIdByteRanges in interface ForwardIndexReader<ForwardIndexReaderContext>

isFixedOffsetMappingType

public boolean isFixedOffsetMappingType()

Specified by:

isFixedOffsetMappingType in interface ForwardIndexReader<ForwardIndexReaderContext>

getRawDataStartOffset

public long getRawDataStartOffset()

Specified by:

getRawDataStartOffset in interface ForwardIndexReader<ForwardIndexReaderContext>

getDocLength

public int getDocLength()

Specified by:

getDocLength in interface ForwardIndexReader<ForwardIndexReaderContext>

isDocLengthInBits

public boolean isDocLengthInBits()

Specified by:

isDocLengthInBits in interface ForwardIndexReader<ForwardIndexReaderContext>