org.apache.paimon.data

Class BinaryArray

java.lang.Object

org.apache.paimon.data.BinarySection

org.apache.paimon.data.BinaryArray

All Implemented Interfaces:

Serializable, DataGetters, DataSetters, InternalArray

@Public
public final class BinaryArray
extends BinarySection
implements InternalArray, DataSetters

A binary implementation of InternalArray which is backed by MemorySegments.

For fields that hold fixed-length primitive types, such as long, double or int, they are stored compacted in bytes, just like the original java array.

The binary layout of BinaryArray:

 [size(int)] + [null bits(4-byte word boundaries)] + [values or offset&length] + [variable length part].
 

Since:

0.4.0

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.paimon.data.InternalArray

InternalArray.ElementGetter

Field Summary

Fields inherited from class org.apache.paimon.data.BinarySection

HIGHEST_FIRST_BIT, HIGHEST_SECOND_TO_EIGHTH_BIT, MAX_FIX_PART_DATA_SIZE, offset, segments, sizeInBytes

Constructor Summary

Constructors

Constructor and Description
BinaryArray()

Method Summary

Modifier and Type	Method and Description
boolean	anyNull()
static int	calculateFixLengthPartSize(DataType type) It store real value when type is primitive.
static int	calculateHeaderInBytes(int numFields)
BinaryArray	copy()
BinaryArray	copy(BinaryArray reuse)
static BinaryArray	fromLongArray(InternalArray arr)
static BinaryArray	fromLongArray(Long[] arr)
static BinaryArray	fromPrimitiveArray(boolean[] arr)
static BinaryArray	fromPrimitiveArray(byte[] arr)
static BinaryArray	fromPrimitiveArray(double[] arr)
static BinaryArray	fromPrimitiveArray(float[] arr)
static BinaryArray	fromPrimitiveArray(int[] arr)
static BinaryArray	fromPrimitiveArray(long[] arr)
static BinaryArray	fromPrimitiveArray(short[] arr)
InternalArray	getArray(int pos) Returns the array value at the given position.
byte[]	getBinary(int pos) Returns the binary value at the given position.
boolean	getBoolean(int pos) Returns the boolean value at the given position.
byte	getByte(int pos) Returns the byte value at the given position.
Decimal	getDecimal(int pos, int precision, int scale) Returns the decimal value at the given position.
double	getDouble(int pos) Returns the double value at the given position.
float	getFloat(int pos) Returns the float value at the given position.
int	getInt(int pos) Returns the integer value at the given position.
long	getLong(int pos) Returns the long value at the given position.
InternalMap	getMap(int pos) Returns the map value at the given position.
InternalRow	getRow(int pos, int numFields) Returns the row value at the given position.
short	getShort(int pos) Returns the short value at the given position.
BinaryString	getString(int pos) Returns the string value at the given position.
Timestamp	getTimestamp(int pos, int precision) Returns the timestamp value at the given position.
int	hashCode()
boolean	isNullAt(int pos) Returns true if the element is null at the given position.
void	pointTo(MemorySegment[] segments, int offset, int sizeInBytes)
void	setBoolean(int pos, boolean value)
void	setByte(int pos, byte value)
void	setDecimal(int pos, Decimal value, int precision) Set the decimal column value.
void	setDouble(int pos, double value)
void	setFloat(int pos, float value)
void	setInt(int pos, int value)
void	setLong(int pos, long value)
void	setNotNullAt(int pos)
void	setNullAt(int pos)
void	setNullBoolean(int pos)
void	setNullByte(int pos)
void	setNullDouble(int pos)
void	setNullFloat(int pos)
void	setNullInt(int pos)
void	setNullLong(int pos)
void	setNullShort(int pos)
void	setShort(int pos, short value)
void	setTimestamp(int pos, Timestamp value, int precision) Set Timestamp value.
int	size() Returns the number of elements in this array.
boolean[]	toBooleanArray()
byte[]	toByteArray()
double[]	toDoubleArray()
float[]	toFloatArray()
int[]	toIntArray()
long[]	toLongArray()
<T> T[]	toObjectArray(DataType elementType)
short[]	toShortArray()

Methods inherited from class org.apache.paimon.data.BinarySection

equals, getOffset, getSegments, getSizeInBytes, pointTo, toBytes

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.paimon.data.InternalArray

createElementGetter

Constructor Detail

BinaryArray

public BinaryArray()

Method Detail

calculateHeaderInBytes

public static int calculateHeaderInBytes(int numFields)

calculateFixLengthPartSize

public static int calculateFixLengthPartSize(DataType type)

It store real value when type is primitive. It store the length and offset of variable-length part when type is string, map, etc.

size

public int size()

Description copied from interface: InternalArray

Returns the number of elements in this array.

Specified by:

size in interface InternalArray

pointTo

public void pointTo(MemorySegment[] segments,
                    int offset,
                    int sizeInBytes)

Overrides:

pointTo in class BinarySection

isNullAt

public boolean isNullAt(int pos)

Description copied from interface: DataGetters

Returns true if the element is null at the given position.

Specified by:

isNullAt in interface DataGetters

setNullAt

public void setNullAt(int pos)

Specified by:

setNullAt in interface DataSetters

setNotNullAt

public void setNotNullAt(int pos)

getLong

public long getLong(int pos)

Description copied from interface: DataGetters

Returns the long value at the given position.

Specified by:

getLong in interface DataGetters

setLong

public void setLong(int pos,
                    long value)

Specified by:

setLong in interface DataSetters

setNullLong

public void setNullLong(int pos)

getInt

public int getInt(int pos)

Description copied from interface: DataGetters

Returns the integer value at the given position.

Specified by:

getInt in interface DataGetters

setInt

public void setInt(int pos,
                   int value)

Specified by:

setInt in interface DataSetters

setNullInt

public void setNullInt(int pos)

getString

public BinaryString getString(int pos)

Description copied from interface: DataGetters

Returns the string value at the given position.

Specified by:

getString in interface DataGetters

getDecimal

public Decimal getDecimal(int pos,
                          int precision,
                          int scale)

Description copied from interface: DataGetters

Returns the decimal value at the given position.

The precision and scale are required to determine whether the decimal value was stored in a compact representation (see Decimal).

Specified by:

getDecimal in interface DataGetters

getTimestamp

public Timestamp getTimestamp(int pos,
                              int precision)

Description copied from interface: DataGetters

Returns the timestamp value at the given position.

The precision is required to determine whether the timestamp value was stored in a compact representation (see Timestamp).

Specified by:

getTimestamp in interface DataGetters

getBinary

public byte[] getBinary(int pos)

Description copied from interface: DataGetters

Returns the binary value at the given position.

Specified by:

getBinary in interface DataGetters

getArray

public InternalArray getArray(int pos)

Description copied from interface: DataGetters

Returns the array value at the given position.

Specified by:

getArray in interface DataGetters

getMap

public InternalMap getMap(int pos)

Description copied from interface: DataGetters

Returns the map value at the given position.

Specified by:

getMap in interface DataGetters

getRow

public InternalRow getRow(int pos,
                          int numFields)

Description copied from interface: DataGetters

Returns the row value at the given position.

The number of fields is required to correctly extract the row.

Specified by:

getRow in interface DataGetters

getBoolean

public boolean getBoolean(int pos)

Description copied from interface: DataGetters

Returns the boolean value at the given position.

Specified by:

getBoolean in interface DataGetters

setBoolean

public void setBoolean(int pos,
                       boolean value)

Specified by:

setBoolean in interface DataSetters

setNullBoolean

public void setNullBoolean(int pos)

getByte

public byte getByte(int pos)

Description copied from interface: DataGetters

Returns the byte value at the given position.

Specified by:

getByte in interface DataGetters

setByte

public void setByte(int pos,
                    byte value)

Specified by:

setByte in interface DataSetters

setNullByte

public void setNullByte(int pos)

getShort

public short getShort(int pos)

Description copied from interface: DataGetters

Returns the short value at the given position.

Specified by:

getShort in interface DataGetters

setShort

public void setShort(int pos,
                     short value)

Specified by:

setShort in interface DataSetters

setNullShort

public void setNullShort(int pos)

getFloat

public float getFloat(int pos)

Description copied from interface: DataGetters

Returns the float value at the given position.

Specified by:

getFloat in interface DataGetters

setFloat

public void setFloat(int pos,
                     float value)

Specified by:

setFloat in interface DataSetters

setNullFloat

public void setNullFloat(int pos)

getDouble

public double getDouble(int pos)

Description copied from interface: DataGetters

Returns the double value at the given position.

Specified by:

getDouble in interface DataGetters

setDouble

public void setDouble(int pos,
                      double value)

Specified by:

setDouble in interface DataSetters

setNullDouble

public void setNullDouble(int pos)

setDecimal

public void setDecimal(int pos,
                       Decimal value,
                       int precision)

Description copied from interface: DataSetters

Set the decimal column value.

Note: Precision is compact: can call DataSetters.setNullAt(int) when decimal is null. Precision is not compact: can not call DataSetters.setNullAt(int) when decimal is null, must call setDecimal(pos, null, precision) because we need update var-length-part.

Specified by:

setDecimal in interface DataSetters

setTimestamp

public void setTimestamp(int pos,
                         Timestamp value,
                         int precision)

Description copied from interface: DataSetters

Set Timestamp value.

Note: If precision is compact: can call DataSetters.setNullAt(int) when TimestampData value is null. Otherwise: can not call DataSetters.setNullAt(int) when TimestampData value is null, must call setTimestamp(pos, null, precision) because we need to update var-length-part.

Specified by:

setTimestamp in interface DataSetters

anyNull

public boolean anyNull()

toBooleanArray

public boolean[] toBooleanArray()

Specified by:

toBooleanArray in interface InternalArray

toByteArray

public byte[] toByteArray()

Specified by:

toByteArray in interface InternalArray

toShortArray

public short[] toShortArray()

Specified by:

toShortArray in interface InternalArray

toIntArray

public int[] toIntArray()

Specified by:

toIntArray in interface InternalArray

toLongArray

public long[] toLongArray()

Specified by:

toLongArray in interface InternalArray

toFloatArray

public float[] toFloatArray()

Specified by:

toFloatArray in interface InternalArray

toDoubleArray

public double[] toDoubleArray()

Specified by:

toDoubleArray in interface InternalArray

toObjectArray

public <T> T[] toObjectArray(DataType elementType)

copy

public BinaryArray copy()

copy

public BinaryArray copy(BinaryArray reuse)

hashCode

public int hashCode()

Overrides:

hashCode in class BinarySection

fromPrimitiveArray

public static BinaryArray fromPrimitiveArray(boolean[] arr)

fromPrimitiveArray

public static BinaryArray fromPrimitiveArray(byte[] arr)

fromPrimitiveArray

public static BinaryArray fromPrimitiveArray(short[] arr)

fromPrimitiveArray

public static BinaryArray fromPrimitiveArray(int[] arr)

fromPrimitiveArray

public static BinaryArray fromPrimitiveArray(long[] arr)

fromPrimitiveArray

public static BinaryArray fromPrimitiveArray(float[] arr)

fromPrimitiveArray

public static BinaryArray fromPrimitiveArray(double[] arr)

fromLongArray

public static BinaryArray fromLongArray(Long[] arr)

fromLongArray

public static BinaryArray fromLongArray(InternalArray arr)