org.apache.flink.table.dataformat

Class BinaryArray

java.lang.Object

org.apache.flink.table.dataformat.BinarySection

org.apache.flink.table.dataformat.BinaryArray

All Implemented Interfaces:

BaseArray, BinaryFormat, TypeGetterSetters

public final class BinaryArray
extends BinarySection
implements BaseArray

For fields that hold fixed-length primitive types, such as long, double, or int, we store the value directly in the field, just like the original java array.

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

BinaryArray are influenced by Apache Spark UnsafeArrayData.

Field Summary

Fields inherited from class org.apache.flink.table.dataformat.BinarySection

offset, segments, sizeInBytes

Fields inherited from interface org.apache.flink.table.dataformat.BinaryFormat

HIGHEST_FIRST_BIT, HIGHEST_SECOND_TO_EIGHTH_BIT, MAX_FIX_PART_DATA_SIZE

Constructor Summary

Constructors

Constructor and Description
BinaryArray()

Method Summary

Modifier and Type	Method and Description
boolean	anyNull()
static int	calculateFixLengthPartSize(org.apache.flink.table.types.logical.LogicalType type) It store real value when type is primitive.
static int	calculateHeaderInBytes(int numFields)
BinaryArray	copy()
BinaryArray	copy(BinaryArray reuse)
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)
BaseArray	getArray(int pos) Get array value, internal format is BaseArray.
byte[]	getBinary(int pos) Get binary value, internal format is byte[].
boolean	getBoolean(int pos) Get boolean value.
byte	getByte(int pos) Get byte value.
Decimal	getDecimal(int pos, int precision, int scale) Get decimal value, internal format is Decimal.
double	getDouble(int pos) Get double value.
float	getFloat(int pos) Get float value.
<T> BinaryGeneric<T>	getGeneric(int pos) Get generic value, internal format is BinaryGeneric.
int	getInt(int pos) Get int value.
long	getLong(int pos) Get long value.
BaseMap	getMap(int pos) Get map value, internal format is BaseMap.
BaseRow	getRow(int pos, int numFields) Get row value, internal format is BaseRow.
short	getShort(int pos) Get short value.
BinaryString	getString(int pos) Get string value, internal format is BinaryString.
int	hashCode()
boolean	isNullAt(int pos) Because the specific row implementation such as BinaryRow uses the binary format.
int	numElements()
void	pointTo(org.apache.flink.core.memory.MemorySegment[] segments, int offset, int sizeInBytes)
void	setBoolean(int pos, boolean value) Set boolean value.
void	setByte(int pos, byte value) Set byte value.
void	setDecimal(int pos, Decimal value, int precision) Set the decimal column value.
void	setDouble(int pos, double value) Set double value.
void	setFloat(int pos, float value) Set float value.
void	setInt(int pos, int value) Set int value.
void	setLong(int pos, long value) Set long value.
void	setNotNullAt(int pos)
void	setNullAt(int pos) Set null to this field.
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) Set short value.
boolean[]	toBooleanArray()
byte[]	toByteArray()
<T> T[]	toClassArray(org.apache.flink.table.types.logical.LogicalType elementType, Class<T> elementClass)
double[]	toDoubleArray()
float[]	toFloatArray()
int[]	toIntArray()
long[]	toLongArray()
short[]	toShortArray()

Methods inherited from class org.apache.flink.table.dataformat.BinarySection

equals, getOffset, getSegments, getSizeInBytes, pointTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.table.dataformat.TypeGetterSetters

get

Methods inherited from interface org.apache.flink.table.dataformat.BinaryFormat

readBinaryFieldFromSegments, readBinaryStringFieldFromSegments

Constructor Detail

BinaryArray

public BinaryArray()

Method Detail

calculateHeaderInBytes

public static int calculateHeaderInBytes(int numFields)

calculateFixLengthPartSize

public static int calculateFixLengthPartSize(org.apache.flink.table.types.logical.LogicalType 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.

numElements

public int numElements()

Specified by:

numElements in interface BaseArray

pointTo

public void pointTo(org.apache.flink.core.memory.MemorySegment[] segments,
                    int offset,
                    int sizeInBytes)

Overrides:

pointTo in class BinarySection

isNullAt

public boolean isNullAt(int pos)

Description copied from interface: TypeGetterSetters

Because the specific row implementation such as BinaryRow uses the binary format. We must first determine if it is null, and then make a specific get.

Specified by:

isNullAt in interface BaseArray

Specified by:

isNullAt in interface TypeGetterSetters

Returns:

true if this field is null.

setNullAt

public void setNullAt(int pos)

Description copied from interface: TypeGetterSetters

Set null to this field.

Specified by:

setNullAt in interface BaseArray

Specified by:

setNullAt in interface TypeGetterSetters

setNotNullAt

public void setNotNullAt(int pos)

Specified by:

setNotNullAt in interface BaseArray

getLong

public long getLong(int pos)

Description copied from interface: TypeGetterSetters

Get long value.

Specified by:

getLong in interface TypeGetterSetters

setLong

public void setLong(int pos,
                    long value)

Description copied from interface: TypeGetterSetters

Set long value.

Specified by:

setLong in interface TypeGetterSetters

setNullLong

public void setNullLong(int pos)

Specified by:

setNullLong in interface BaseArray

getInt

public int getInt(int pos)

Description copied from interface: TypeGetterSetters

Get int value.

Specified by:

getInt in interface TypeGetterSetters

setInt

public void setInt(int pos,
                   int value)

Description copied from interface: TypeGetterSetters

Set int value.

Specified by:

setInt in interface TypeGetterSetters

setNullInt

public void setNullInt(int pos)

Specified by:

setNullInt in interface BaseArray

getString

public BinaryString getString(int pos)

Description copied from interface: TypeGetterSetters

Get string value, internal format is BinaryString.

Specified by:

getString in interface TypeGetterSetters

getDecimal

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

Description copied from interface: TypeGetterSetters

Get decimal value, internal format is Decimal.

Specified by:

getDecimal in interface TypeGetterSetters

getGeneric

public <T> BinaryGeneric<T> getGeneric(int pos)

Description copied from interface: TypeGetterSetters

Get generic value, internal format is BinaryGeneric.

Specified by:

getGeneric in interface TypeGetterSetters

getBinary

public byte[] getBinary(int pos)

Description copied from interface: TypeGetterSetters

Get binary value, internal format is byte[].

Specified by:

getBinary in interface TypeGetterSetters

getArray

public BaseArray getArray(int pos)

Description copied from interface: TypeGetterSetters

Get array value, internal format is BaseArray.

Specified by:

getArray in interface TypeGetterSetters

getMap

public BaseMap getMap(int pos)

Description copied from interface: TypeGetterSetters

Get map value, internal format is BaseMap.

Specified by:

getMap in interface TypeGetterSetters

getRow

public BaseRow getRow(int pos,
                      int numFields)

Description copied from interface: TypeGetterSetters

Get row value, internal format is BaseRow.

Specified by:

getRow in interface TypeGetterSetters

getBoolean

public boolean getBoolean(int pos)

Description copied from interface: TypeGetterSetters

Get boolean value.

Specified by:

getBoolean in interface TypeGetterSetters

setBoolean

public void setBoolean(int pos,
                       boolean value)

Description copied from interface: TypeGetterSetters

Set boolean value.

Specified by:

setBoolean in interface TypeGetterSetters

setNullBoolean

public void setNullBoolean(int pos)

Specified by:

setNullBoolean in interface BaseArray

getByte

public byte getByte(int pos)

Description copied from interface: TypeGetterSetters

Get byte value.

Specified by:

getByte in interface TypeGetterSetters

setByte

public void setByte(int pos,
                    byte value)

Description copied from interface: TypeGetterSetters

Set byte value.

Specified by:

setByte in interface TypeGetterSetters

setNullByte

public void setNullByte(int pos)

Specified by:

setNullByte in interface BaseArray

getShort

public short getShort(int pos)

Description copied from interface: TypeGetterSetters

Get short value.

Specified by:

getShort in interface TypeGetterSetters

setShort

public void setShort(int pos,
                     short value)

Description copied from interface: TypeGetterSetters

Set short value.

Specified by:

setShort in interface TypeGetterSetters

setNullShort

public void setNullShort(int pos)

Specified by:

setNullShort in interface BaseArray

getFloat

public float getFloat(int pos)

Description copied from interface: TypeGetterSetters

Get float value.

Specified by:

getFloat in interface TypeGetterSetters

setFloat

public void setFloat(int pos,
                     float value)

Description copied from interface: TypeGetterSetters

Set float value.

Specified by:

setFloat in interface TypeGetterSetters

setNullFloat

public void setNullFloat(int pos)

Specified by:

setNullFloat in interface BaseArray

getDouble

public double getDouble(int pos)

Description copied from interface: TypeGetterSetters

Get double value.

Specified by:

getDouble in interface TypeGetterSetters

setDouble

public void setDouble(int pos,
                      double value)

Description copied from interface: TypeGetterSetters

Set double value.

Specified by:

setDouble in interface TypeGetterSetters

setNullDouble

public void setNullDouble(int pos)

Specified by:

setNullDouble in interface BaseArray

setDecimal

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

Description copied from interface: TypeGetterSetters

Set the decimal column value.

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

Specified by:

setDecimal in interface TypeGetterSetters

anyNull

public boolean anyNull()

toBooleanArray

public boolean[] toBooleanArray()

Specified by:

toBooleanArray in interface BaseArray

toByteArray

public byte[] toByteArray()

Specified by:

toByteArray in interface BaseArray

toShortArray

public short[] toShortArray()

Specified by:

toShortArray in interface BaseArray

toIntArray

public int[] toIntArray()

Specified by:

toIntArray in interface BaseArray

toLongArray

public long[] toLongArray()

Specified by:

toLongArray in interface BaseArray

toFloatArray

public float[] toFloatArray()

Specified by:

toFloatArray in interface BaseArray

toDoubleArray

public double[] toDoubleArray()

Specified by:

toDoubleArray in interface BaseArray

toClassArray

public <T> T[] toClassArray(org.apache.flink.table.types.logical.LogicalType elementType,
                            Class<T> elementClass)

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)