org.apache.paimon.fileindex.bitmap

Class BitmapFileIndexMeta

java.lang.Object

org.apache.paimon.fileindex.bitmap.BitmapFileIndexMeta

Direct Known Subclasses:

BitmapFileIndexMetaV2

public class BitmapFileIndexMeta
extends Object

 Bitmap file index format (V1)
 +-------------------------------------------------+-----------------
 | version (1 byte)                                |
 +-------------------------------------------------+
 | row count (4 bytes int)                         |
 +-------------------------------------------------+
 | non-null value bitmap number (4 bytes int)      |
 +-------------------------------------------------+
 | has null value (1 byte)                         |
 +-------------------------------------------------+
 | null value offset (4 bytes if has null value)   |       HEAD
 +-------------------------------------------------+
 | value 1 | offset 1                              |
 +-------------------------------------------------+
 | value 2 | offset 2                              |
 +-------------------------------------------------+
 | value 3 | offset 3                              |
 +-------------------------------------------------+
 | ...                                             |
 +-------------------------------------------------+-----------------
 | serialized bitmap 1                             |
 +-------------------------------------------------+
 | serialized bitmap 2                             |
 +-------------------------------------------------+       BODY
 | serialized bitmap 3                             |
 +-------------------------------------------------+
 | ...                                             |
 +-------------------------------------------------+-----------------

 value x:                       var bytes for any data type (as bitmap identifier)
 offset:                        4 bytes int (when it is negative, it represents that there is only one value
                                  and its position is the inverse of the negative value)
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BitmapFileIndexMeta.Entry Bitmap entry.
static interface	BitmapFileIndexMeta.ThrowableConsumer functional interface.
static interface	BitmapFileIndexMeta.ThrowableSupplier functional interface.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<Object,Integer>	bitmapLengths
protected LinkedHashMap<Object,Integer>	bitmapOffsets
protected long	bodyStart
protected DataType	dataType
protected boolean	hasNullValue
protected int	nonNullBitmapNumber
protected int	nullValueOffset
protected Options	options
protected int	rowCount

Constructor Summary

Constructors

Constructor and Description
BitmapFileIndexMeta(DataType dataType, Options options)
BitmapFileIndexMeta(DataType dataType, Options options, int rowCount, int nonNullBitmapNumber, boolean hasNullValue, int nullValueOffset, LinkedHashMap<Object,Integer> bitmapOffsets)

Method Summary

Modifier and Type	Method and Description
void	deserialize(SeekableInputStream seekableInputStream)
BitmapFileIndexMeta.Entry	findEntry(Object bitmapId) Find entry for bitmap.
long	getBodyStart()
int	getRowCount()
protected java.util.function.Function<Object,Integer>	getSerializeSizeMeasure()
protected BitmapFileIndexMeta.ThrowableSupplier	getValueReader(DataInput in)
protected BitmapFileIndexMeta.ThrowableConsumer	getValueWriter(DataOutput out)
void	serialize(DataOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

dataType

protected final DataType dataType

options

protected final Options options

rowCount

protected int rowCount

nonNullBitmapNumber

protected int nonNullBitmapNumber

hasNullValue

protected boolean hasNullValue

nullValueOffset

protected int nullValueOffset

bitmapOffsets

protected LinkedHashMap<Object,Integer> bitmapOffsets

bitmapLengths

protected Map<Object,Integer> bitmapLengths

bodyStart

protected long bodyStart

Constructor Detail

BitmapFileIndexMeta

public BitmapFileIndexMeta(DataType dataType,
                           Options options)

BitmapFileIndexMeta

public BitmapFileIndexMeta(DataType dataType,
                           Options options,
                           int rowCount,
                           int nonNullBitmapNumber,
                           boolean hasNullValue,
                           int nullValueOffset,
                           LinkedHashMap<Object,Integer> bitmapOffsets)

Method Detail

getRowCount

public int getRowCount()

getBodyStart

public long getBodyStart()

findEntry

public BitmapFileIndexMeta.Entry findEntry(Object bitmapId)

Find entry for bitmap.

Parameters:

bitmapId - the bitmap identifier to be searched.

Returns:

an BitmapFileIndexMeta.Entry which contains offset and length of bitmap if it is contained in the index meta; otherwise `null`.

serialize

public void serialize(DataOutput out)
               throws Exception

Throws:

Exception

deserialize

public void deserialize(SeekableInputStream seekableInputStream)
                 throws Exception

Throws:

Exception

getSerializeSizeMeasure

protected java.util.function.Function<Object,Integer> getSerializeSizeMeasure()

getValueWriter

protected BitmapFileIndexMeta.ThrowableConsumer getValueWriter(DataOutput out)

getValueReader

protected BitmapFileIndexMeta.ThrowableSupplier getValueReader(DataInput in)