org.apache.flink.table.dataformat

Class LazyBinaryFormat<T>

java.lang.Object

org.apache.flink.table.dataformat.LazyBinaryFormat<T>

All Implemented Interfaces:

BinaryFormat

Direct Known Subclasses:

BinaryGeneric, BinaryString

public abstract class LazyBinaryFormat<T>
extends Object
implements BinaryFormat

Lazy binary format.

If the Binary format is used in all the SQL representations, consider the following Case: udf0(input) -> udf1(result0) -> udf2(result1) ->udf3 (result2) Such nested calls, if udf's return values are JavaObject format, will result in multiple conversions if store local variables in Binary format: converterToBinary(Udf0(converterToJavaObject(input))) -> converterToBinary(Udf1(converterToJavaObject(result0))) .....

So we introduced Lazy Binary Format to avoid this situation, Lazy Binary Format has three forms: 1. Binary form 2. JavaObject form 3. Binary and JavaObject coexist It can lazy the conversions as much as possible. Only when it is needed can it be converted into the required form.

Field Summary

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
LazyBinaryFormat()
LazyBinaryFormat(org.apache.flink.core.memory.MemorySegment[] segments, int offset, int sizeInBytes)
LazyBinaryFormat(org.apache.flink.core.memory.MemorySegment[] segments, int offset, int sizeInBytes, T javaObject)
LazyBinaryFormat(T javaObject)
LazyBinaryFormat(T javaObject, BinarySection binarySection)

Method Summary

Modifier and Type	Method and Description
void	ensureMaterialized(org.apache.flink.api.common.typeutils.TypeSerializer<T> serializer) Ensure we have materialized binary format.
T	getJavaObject()
int	getOffset()
org.apache.flink.core.memory.MemorySegment[]	getSegments()
int	getSizeInBytes()
protected abstract BinarySection	materialize(org.apache.flink.api.common.typeutils.TypeSerializer<T> serializer) Materialize java object to binary format.
void	setJavaObject(T javaObject) Must be public as it is used during code generation.

Methods inherited from class java.lang.Object

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

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

readBinaryFieldFromSegments, readBinaryStringFieldFromSegments

Constructor Detail

LazyBinaryFormat

public LazyBinaryFormat()

LazyBinaryFormat

public LazyBinaryFormat(org.apache.flink.core.memory.MemorySegment[] segments,
                        int offset,
                        int sizeInBytes,
                        T javaObject)

LazyBinaryFormat

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

LazyBinaryFormat

public LazyBinaryFormat(T javaObject)

LazyBinaryFormat

public LazyBinaryFormat(T javaObject,
                        BinarySection binarySection)

Method Detail

getJavaObject

public T getJavaObject()

setJavaObject

public void setJavaObject(T javaObject)

Must be public as it is used during code generation.

getSegments

public org.apache.flink.core.memory.MemorySegment[] getSegments()

Specified by:

getSegments in interface BinaryFormat

getOffset

public int getOffset()

Specified by:

getOffset in interface BinaryFormat

getSizeInBytes

public int getSizeInBytes()

Specified by:

getSizeInBytes in interface BinaryFormat

ensureMaterialized

public final void ensureMaterialized(org.apache.flink.api.common.typeutils.TypeSerializer<T> serializer)

Ensure we have materialized binary format.

materialize

protected abstract BinarySection materialize(org.apache.flink.api.common.typeutils.TypeSerializer<T> serializer)
                                      throws IOException

Materialize java object to binary format. Inherited classes need to hold the information they need. (For example, BinaryGeneric needs javaObjectSerializer).

Throws:

IOException