Package org.apache.pinot.segment.local.segment.creator.impl.fwd

Class SingleValueVarByteRawIndexCreator

java.lang.Object

org.apache.pinot.segment.local.segment.creator.impl.fwd.SingleValueVarByteRawIndexCreator

All Implemented Interfaces:

Closeable, AutoCloseable, ForwardIndexCreator, IndexCreator

public class SingleValueVarByteRawIndexCreator
extends Object
implements ForwardIndexCreator

Forward index creator for raw (non-dictionary-encoded) single-value column of variable length data type (BIG_DECIMAL, STRING, BYTES).

Constructor Summary

Constructors

Constructor	Description
SingleValueVarByteRawIndexCreator(File baseIndexDir, ChunkCompressionType compressionType, String column, int totalDocs, FieldSpec.DataType valueType, int maxLength)	Create a var-byte raw index creator for the given column
SingleValueVarByteRawIndexCreator(File baseIndexDir, ChunkCompressionType compressionType, String column, int totalDocs, FieldSpec.DataType valueType, int maxLength, boolean deriveNumDocsPerChunk, int writerVersion)	Create a var-byte raw index creator for the given column

Method Summary

Modifier and Type	Method	Description
void	close()
static int	getNumDocsPerChunk(int lengthOfLongestEntry)
FieldSpec.DataType	getValueType()
boolean	isDictionaryEncoded()
boolean	isSingleValue()
void	putBigDecimal(BigDecimal value)
void	putBytes(byte[] value)
void	putString(String 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.creator.ForwardIndexCreator

add, add, putBytesMV, putDictId, putDictIdMV, putDouble, putDoubleMV, putFloat, putFloatMV, putInt, putIntMV, putLong, putLongMV, putStringMV, seal

Constructor Detail

SingleValueVarByteRawIndexCreator

public SingleValueVarByteRawIndexCreator(File baseIndexDir,
                                         ChunkCompressionType compressionType,
                                         String column,
                                         int totalDocs,
                                         FieldSpec.DataType valueType,
                                         int maxLength)
                                  throws IOException

Create a var-byte raw index creator for the given column

Parameters:

baseIndexDir - Index directory

compressionType - Type of compression to use

column - Name of column to index

totalDocs - Total number of documents to index

valueType - Type of the values

maxLength - length of longest entry (in bytes)

Throws:

IOException

SingleValueVarByteRawIndexCreator

public SingleValueVarByteRawIndexCreator(File baseIndexDir,
                                         ChunkCompressionType compressionType,
                                         String column,
                                         int totalDocs,
                                         FieldSpec.DataType valueType,
                                         int maxLength,
                                         boolean deriveNumDocsPerChunk,
                                         int writerVersion)
                                  throws IOException

Create a var-byte raw index creator for the given column

Parameters:

baseIndexDir - Index directory

compressionType - Type of compression to use

column - Name of column to index

totalDocs - Total number of documents to index

valueType - Type of the values

maxLength - length of longest entry (in bytes)

deriveNumDocsPerChunk - true if writer should auto-derive the number of rows per chunk

writerVersion - writer format version

Throws:

IOException

Method Detail

getNumDocsPerChunk

public static int getNumDocsPerChunk(int lengthOfLongestEntry)

isDictionaryEncoded

public boolean isDictionaryEncoded()

Specified by:

isDictionaryEncoded in interface ForwardIndexCreator

isSingleValue

public boolean isSingleValue()

Specified by:

isSingleValue in interface ForwardIndexCreator

getValueType

public FieldSpec.DataType getValueType()

Specified by:

getValueType in interface ForwardIndexCreator

putBigDecimal

public void putBigDecimal(BigDecimal value)

Specified by:

putBigDecimal in interface ForwardIndexCreator

putString

public void putString(String value)

Specified by:

putString in interface ForwardIndexCreator

putBytes

public void putBytes(byte[] value)

Specified by:

putBytes in interface ForwardIndexCreator

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException