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

Class BaseImmutableDictionary

java.lang.Object

org.apache.pinot.segment.local.segment.index.readers.BaseImmutableDictionary

All Implemented Interfaces:

Closeable, AutoCloseable, Dictionary

Direct Known Subclasses:

BigDecimalDictionary, BytesDictionary, ConstantValueBigDecimalDictionary, ConstantValueBytesDictionary, ConstantValueDoubleDictionary, ConstantValueFloatDictionary, ConstantValueIntDictionary, ConstantValueLongDictionary, ConstantValueStringDictionary, DocIdDictionary, DoubleDictionary, FloatDictionary, IntDictionary, LongDictionary, OnHeapBigDecimalDictionary, OnHeapBytesDictionary, OnHeapDoubleDictionary, OnHeapFloatDictionary, OnHeapIntDictionary, OnHeapLongDictionary, OnHeapStringDictionary, StringDictionary

public abstract class BaseImmutableDictionary
extends Object
implements Dictionary

Base implementation of immutable dictionary.

Field Summary

Fields inherited from interface org.apache.pinot.segment.spi.index.reader.Dictionary

NULL_VALUE_INDEX

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseImmutableDictionary(int length)	For virtual dictionary.
protected	BaseImmutableDictionary(PinotDataBuffer dataBuffer, int length, int numBytesPerValue, byte paddingByte)

Method Summary

Modifier and Type	Method	Description
protected int	binarySearch(byte[] value)
protected int	binarySearch(double value)
protected int	binarySearch(float value)
protected int	binarySearch(int value)
protected int	binarySearch(long value)
protected int	binarySearch(String value)	WARNING: With non-zero padding byte, binary search result might not reflect the real insertion index for the value.
protected int	binarySearch(BigDecimal value)
void	close()
int	compare(int dictId1, int dictId2)
protected BigDecimal	getBigDecimal(int dictId)
protected byte[]	getBuffer()
protected byte[]	getBytes(int dictId)
it.unimi.dsi.fastutil.ints.IntSet	getDictIdsInRange(String lower, String upper, boolean includeLower, boolean includeUpper)
protected double	getDouble(int dictId)
protected float	getFloat(int dictId)
protected int	getInt(int dictId)
protected long	getLong(int dictId)
Comparable	getMaxVal()
Comparable	getMinVal()
protected String	getPaddedString(int dictId, byte[] buffer)
Object	getSortedValues()
protected String	getUnpaddedString(int dictId, byte[] buffer)
int	indexOf(String stringValue)
boolean	isSorted()
int	length()
protected int	normalizeIndex(int index)
protected String	padString(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.reader.Dictionary

get, getBigDecimalValue, getByteArrayValue, getBytesValue, getDoubleValue, getFloatValue, getInternal, getIntValue, getLongValue, getStringValue, getValueType, indexOf, indexOf, indexOf, indexOf, indexOf, indexOf, insertionIndexOf, readBigDecimalValues, readBytesValues, readDoubleValues, readFloatValues, readIntValues, readLongValues, readStringValues

Constructor Detail

BaseImmutableDictionary

protected BaseImmutableDictionary(PinotDataBuffer dataBuffer,
                                  int length,
                                  int numBytesPerValue,
                                  byte paddingByte)

BaseImmutableDictionary

protected BaseImmutableDictionary(int length)

For virtual dictionary.

Method Detail

isSorted

public boolean isSorted()

Specified by:

isSorted in interface Dictionary

length

public int length()

Specified by:

length in interface Dictionary

indexOf

public int indexOf(String stringValue)

Specified by:

indexOf in interface Dictionary

normalizeIndex

protected final int normalizeIndex(int index)

getDictIdsInRange

public it.unimi.dsi.fastutil.ints.IntSet getDictIdsInRange(String lower,
                                                           String upper,
                                                           boolean includeLower,
                                                           boolean includeUpper)

Specified by:

getDictIdsInRange in interface Dictionary

compare

public int compare(int dictId1,
                   int dictId2)

Specified by:

compare in interface Dictionary

getMinVal

public Comparable getMinVal()

Specified by:

getMinVal in interface Dictionary

getMaxVal

public Comparable getMaxVal()

Specified by:

getMaxVal in interface Dictionary

getSortedValues

public Object getSortedValues()

Specified by:

getSortedValues in interface Dictionary

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

binarySearch

protected int binarySearch(int value)

binarySearch

protected int binarySearch(long value)

binarySearch

protected int binarySearch(float value)

binarySearch

protected int binarySearch(double value)

binarySearch

protected int binarySearch(BigDecimal value)

binarySearch

protected int binarySearch(String value)

WARNING: With non-zero padding byte, binary search result might not reflect the real insertion index for the value. E.g. with padding byte 'b', if unpadded value "aa" is in the dictionary, and stored as "aab", then unpadded value "a" will be mis-positioned after value "aa"; unpadded value "aab" will return positive value even if value "aab" is not in the dictionary. TODO: Clean up the segments with legacy non-zero padding byte, and remove the support for non-zero padding byte

binarySearch

protected int binarySearch(byte[] value)

padString

protected String padString(String value)

getInt

protected int getInt(int dictId)

getLong

protected long getLong(int dictId)

getFloat

protected float getFloat(int dictId)

getDouble

protected double getDouble(int dictId)

getBigDecimal

protected BigDecimal getBigDecimal(int dictId)

getUnpaddedString

protected String getUnpaddedString(int dictId,
                                   byte[] buffer)

getPaddedString

protected String getPaddedString(int dictId,
                                 byte[] buffer)

getBytes

protected byte[] getBytes(int dictId)

getBuffer

protected byte[] getBuffer()