Package org.apache.pinot.segment.local.realtime.impl.forward

Class FixedByteSVMutableForwardIndex

java.lang.Object

org.apache.pinot.segment.local.realtime.impl.forward.FixedByteSVMutableForwardIndex

All Implemented Interfaces:

Closeable, AutoCloseable, IndexReader, MutableForwardIndex, MutableIndex, ForwardIndexReader<ForwardIndexReaderContext>

public class FixedByteSVMutableForwardIndex
extends Object
implements MutableForwardIndex

This class implements reader as well as writer interfaces for fixed-byte single column and single value data.

• Auto expands memory allocation on-demand.
• Supports random reads and writes.
• Callers should ensure they are only reading row that were written, as allocated but not written rows are not guaranteed to have a deterministic value.

Constructor Summary

Constructors

Constructor	Description
FixedByteSVMutableForwardIndex(boolean dictionaryEncoded, FieldSpec.DataType storedType, int fixedLength, int numRowsPerChunk, PinotDataBufferMemoryManager memoryManager, String allocationContext)
FixedByteSVMutableForwardIndex(boolean dictionaryEncoded, FieldSpec.DataType valueType, int numRowsPerChunk, PinotDataBufferMemoryManager memoryManager, String allocationContext)

Method Summary

Modifier and Type	Method	Description
void	close()
BigDecimal	getBigDecimal(int docId)
byte[]	getBytes(int docId)
int	getDictId(int docId)
double	getDouble(int docId)
float	getFloat(int docId)
int	getInt(int docId)
int	getLengthOfLongestElement()
int	getLengthOfShortestElement()
long	getLong(int docId)
FieldSpec.DataType	getStoredType()
boolean	isDictionaryEncoded()
boolean	isSingleValue()
void	readDictIds(int[] docIds, int length, int[] dictIdBuffer)
void	setBytes(int docId, byte[] value)
void	setDictId(int docId, int dictId)
void	setDouble(int docId, double value)
void	setFloat(int docId, float value)
void	setInt(int docId, int value)
void	setLong(int docId, long value)

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, getCompressionType, getLengthOfLongestEntry, readValuesMV, readValuesMV, readValuesMV, readValuesMV, readValuesMV, readValuesMV, readValuesSV, readValuesSV, readValuesSV, readValuesSV, readValuesSV

Methods inherited from interface org.apache.pinot.segment.spi.index.mutable.MutableForwardIndex

add, add, getBigDecimal, getBytes, getBytesMV, getBytesMV, getBytesMV, getBytesMV, getDictId, getDictIdMV, getDictIdMV, getDictIdMV, getDictIdMV, getDouble, getDoubleMV, getDoubleMV, getDoubleMV, getDoubleMV, getFloat, getFloatMV, getFloatMV, getFloatMV, getFloatMV, getInt, getIntMV, getIntMV, getIntMV, getIntMV, getLong, getLongMV, getLongMV, getLongMV, getLongMV, getNumValuesMV, getNumValuesMV, getString, getString, getStringMV, getStringMV, getStringMV, getStringMV, readDictIds, setBigDecimal, setBytesMV, setDictIdMV, setDoubleMV, setFloatMV, setIntMV, setLongMV, setString, setStringMV

Constructor Detail

FixedByteSVMutableForwardIndex

public FixedByteSVMutableForwardIndex(boolean dictionaryEncoded,
                                      FieldSpec.DataType storedType,
                                      int fixedLength,
                                      int numRowsPerChunk,
                                      PinotDataBufferMemoryManager memoryManager,
                                      String allocationContext)

Parameters:

storedType - Data type of the values

fixedLength - Fixed length of values if known: only used for BYTES field (HyperLogLog and BigDecimal storage)

numRowsPerChunk - Number of rows to pack in one chunk before a new chunk is created.

memoryManager - Memory manager to be used for allocating memory.

allocationContext - Allocation allocationContext.

FixedByteSVMutableForwardIndex

public FixedByteSVMutableForwardIndex(boolean dictionaryEncoded,
                                      FieldSpec.DataType valueType,
                                      int numRowsPerChunk,
                                      PinotDataBufferMemoryManager memoryManager,
                                      String allocationContext)

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>

getLengthOfShortestElement

public int getLengthOfShortestElement()

Specified by:

getLengthOfShortestElement in interface MutableForwardIndex

getLengthOfLongestElement

public int getLengthOfLongestElement()

Specified by:

getLengthOfLongestElement in interface MutableForwardIndex

getDictId

public int getDictId(int docId)

Specified by:

getDictId in interface MutableForwardIndex

readDictIds

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

Specified by:

readDictIds in interface MutableForwardIndex

getInt

public int getInt(int docId)

Specified by:

getInt in interface MutableForwardIndex

getLong

public long getLong(int docId)

Specified by:

getLong in interface MutableForwardIndex

getFloat

public float getFloat(int docId)

Specified by:

getFloat in interface MutableForwardIndex

getDouble

public double getDouble(int docId)

Specified by:

getDouble in interface MutableForwardIndex

getBigDecimal

public BigDecimal getBigDecimal(int docId)

Specified by:

getBigDecimal in interface MutableForwardIndex

setDictId

public void setDictId(int docId,
                      int dictId)

Specified by:

setDictId in interface MutableForwardIndex

setInt

public void setInt(int docId,
                   int value)

Specified by:

setInt in interface MutableForwardIndex

setLong

public void setLong(int docId,
                    long value)

Specified by:

setLong in interface MutableForwardIndex

setFloat

public void setFloat(int docId,
                     float value)

Specified by:

setFloat in interface MutableForwardIndex

setDouble

public void setDouble(int docId,
                      double value)

Specified by:

setDouble in interface MutableForwardIndex

getBytes

public byte[] getBytes(int docId)

Specified by:

getBytes in interface MutableForwardIndex

setBytes

public void setBytes(int docId,
                     byte[] value)

Specified by:

setBytes in interface MutableForwardIndex

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException