org.apache.flink.table.runtime.typeutils

Class BaseRowSerializer

java.lang.Object

org.apache.flink.api.common.typeutils.TypeSerializer<T>

org.apache.flink.table.runtime.typeutils.AbstractRowSerializer<BaseRow>

org.apache.flink.table.runtime.typeutils.BaseRowSerializer

All Implemented Interfaces:

Serializable

public class BaseRowSerializer
extends AbstractRowSerializer<BaseRow>

Serializer for BaseRow.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseRowSerializer.BaseRowSerializerSnapshot TypeSerializerSnapshot for BinaryRowSerializer.

Constructor Summary

Constructors

Constructor and Description
BaseRowSerializer(org.apache.flink.api.common.ExecutionConfig config, org.apache.flink.table.types.logical.LogicalType... types)
BaseRowSerializer(org.apache.flink.api.common.ExecutionConfig config, org.apache.flink.table.types.logical.RowType rowType)
BaseRowSerializer(org.apache.flink.table.types.logical.LogicalType[] types, org.apache.flink.api.common.typeutils.TypeSerializer[] fieldSerializers)

Method Summary

Modifier and Type	Method and Description
BaseRow	copy(BaseRow from)
BaseRow	copy(BaseRow from, BaseRow reuse)
void	copy(org.apache.flink.core.memory.DataInputView source, org.apache.flink.core.memory.DataOutputView target)
BaseRow	createInstance()
BaseRow	deserialize(BaseRow reuse, org.apache.flink.core.memory.DataInputView source)
BaseRow	deserialize(org.apache.flink.core.memory.DataInputView source)
BaseRow	deserializeFromPages(org.apache.flink.runtime.memory.AbstractPagedInputView source) De-serializes a record from the given source paged input view.
BaseRow	deserializeFromPages(BaseRow reuse, org.apache.flink.runtime.memory.AbstractPagedInputView source) Reuse version of AbstractRowSerializer.deserializeFromPages(AbstractPagedInputView).
org.apache.flink.api.common.typeutils.TypeSerializer<BaseRow>	duplicate()
boolean	equals(Object obj)
int	getArity() Get the number of fields.
int	getLength()
int	hashCode()
boolean	isImmutableType()
BaseRow	mapFromPages(org.apache.flink.runtime.memory.AbstractPagedInputView source) Map a record from the given source paged input view.
BaseRow	mapFromPages(BaseRow reuse, org.apache.flink.runtime.memory.AbstractPagedInputView source) Reuse version of AbstractRowSerializer.mapFromPages(AbstractPagedInputView).
void	serialize(BaseRow row, org.apache.flink.core.memory.DataOutputView target)
int	serializeToPages(BaseRow row, org.apache.flink.runtime.memory.AbstractPagedOutputView target) Serializes the given record to the given target paged output view.
org.apache.flink.api.common.typeutils.TypeSerializerSnapshot<BaseRow>	snapshotConfiguration()
BinaryRow	toBinaryRow(BaseRow row) Convert base row to binary row.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseRowSerializer

public BaseRowSerializer(org.apache.flink.api.common.ExecutionConfig config,
                         org.apache.flink.table.types.logical.RowType rowType)

BaseRowSerializer

public BaseRowSerializer(org.apache.flink.api.common.ExecutionConfig config,
                         org.apache.flink.table.types.logical.LogicalType... types)

BaseRowSerializer

public BaseRowSerializer(org.apache.flink.table.types.logical.LogicalType[] types,
                         org.apache.flink.api.common.typeutils.TypeSerializer[] fieldSerializers)

Method Detail

duplicate

public org.apache.flink.api.common.typeutils.TypeSerializer<BaseRow> duplicate()

Specified by:

duplicate in class org.apache.flink.api.common.typeutils.TypeSerializer<BaseRow>

createInstance

public BaseRow createInstance()

Specified by:

createInstance in class org.apache.flink.api.common.typeutils.TypeSerializer<BaseRow>

serialize

public void serialize(BaseRow row,
                      org.apache.flink.core.memory.DataOutputView target)
               throws IOException

Specified by:

serialize in class org.apache.flink.api.common.typeutils.TypeSerializer<BaseRow>

Throws:

IOException

deserialize

public BaseRow deserialize(org.apache.flink.core.memory.DataInputView source)
                    throws IOException

Specified by:

deserialize in class org.apache.flink.api.common.typeutils.TypeSerializer<BaseRow>

Throws:

IOException

deserialize

public BaseRow deserialize(BaseRow reuse,
                           org.apache.flink.core.memory.DataInputView source)
                    throws IOException

Specified by:

deserialize in class org.apache.flink.api.common.typeutils.TypeSerializer<BaseRow>

Throws:

IOException

copy

public BaseRow copy(BaseRow from)

Specified by:

copy in class org.apache.flink.api.common.typeutils.TypeSerializer<BaseRow>

copy

public BaseRow copy(BaseRow from,
                    BaseRow reuse)

Specified by:

copy in class org.apache.flink.api.common.typeutils.TypeSerializer<BaseRow>

copy

public void copy(org.apache.flink.core.memory.DataInputView source,
                 org.apache.flink.core.memory.DataOutputView target)
          throws IOException

Specified by:

copy in class org.apache.flink.api.common.typeutils.TypeSerializer<BaseRow>

Throws:

IOException

getArity

public int getArity()

Description copied from class: AbstractRowSerializer

Get the number of fields.

Specified by:

getArity in class AbstractRowSerializer<BaseRow>

toBinaryRow

public BinaryRow toBinaryRow(BaseRow row)

Convert base row to binary row. TODO modify it to code gen.

Specified by:

toBinaryRow in class AbstractRowSerializer<BaseRow>

serializeToPages

public int serializeToPages(BaseRow row,
                            org.apache.flink.runtime.memory.AbstractPagedOutputView target)
                     throws IOException

Description copied from class: AbstractRowSerializer

Serializes the given record to the given target paged output view. Some implementations may skip some bytes if current page does not have enough space left, .e.g BinaryRow.

Specified by:

serializeToPages in class AbstractRowSerializer<BaseRow>

Parameters:

row - The record to serialize.

target - The output view to write the serialized data to.

Returns:

Returns the skipped number of bytes.

Throws:

IOException - Thrown, if the serialization encountered an I/O related error. Typically raised by the output view, which may have an underlying I/O channel to which it delegates.

deserializeFromPages

public BaseRow deserializeFromPages(org.apache.flink.runtime.memory.AbstractPagedInputView source)
                             throws IOException

Description copied from class: AbstractRowSerializer

De-serializes a record from the given source paged input view. For consistency with serialize format, some implementations may need to skip some bytes of source before de-serializing, .e.g BinaryRow. Typically, the content read from source should be copied out when de-serializing, and we are not expecting the underlying data from source is reused. If you have such requirement, see AbstractRowSerializer.mapFromPages(AbstractPagedInputView).

Specified by:

deserializeFromPages in class AbstractRowSerializer<BaseRow>

Parameters:

source - The input view from which to read the data.

Returns:

The de-serialized element.

Throws:

IOException - Thrown, if the de-serialization encountered an I/O related error. Typically raised by the input view, which may have an underlying I/O channel from which it reads.

deserializeFromPages

public BaseRow deserializeFromPages(BaseRow reuse,
                                    org.apache.flink.runtime.memory.AbstractPagedInputView source)
                             throws IOException

Description copied from class: AbstractRowSerializer

Reuse version of AbstractRowSerializer.deserializeFromPages(AbstractPagedInputView).

Specified by:

deserializeFromPages in class AbstractRowSerializer<BaseRow>

Throws:

IOException

mapFromPages

public BaseRow mapFromPages(org.apache.flink.runtime.memory.AbstractPagedInputView source)
                     throws IOException

Description copied from class: AbstractRowSerializer

Map a record from the given source paged input view. This method provides a possibility to achieve zero copy when de-serializing. You can either choose copy or not copy the content read from source, but we encourage to make it zero copy.

If you choose the zero copy way, you have to deal with the lifecycle of the pages properly.

Specified by:

mapFromPages in class AbstractRowSerializer<BaseRow>

Parameters:

source - The input view from which to read the data.

Returns:

The mapped element.

Throws:

IOException - Thrown, if the de-serialization encountered an I/O related error. Typically raised by the input view, which may have an underlying I/O channel from which it reads.

mapFromPages

public BaseRow mapFromPages(BaseRow reuse,
                            org.apache.flink.runtime.memory.AbstractPagedInputView source)
                     throws IOException

Description copied from class: AbstractRowSerializer

Reuse version of AbstractRowSerializer.mapFromPages(AbstractPagedInputView).

Specified by:

mapFromPages in class AbstractRowSerializer<BaseRow>

Throws:

IOException

equals

public boolean equals(Object obj)

Specified by:

equals in class org.apache.flink.api.common.typeutils.TypeSerializer<BaseRow>

hashCode

public int hashCode()

Specified by:

hashCode in class org.apache.flink.api.common.typeutils.TypeSerializer<BaseRow>

isImmutableType

public boolean isImmutableType()

Specified by:

isImmutableType in class org.apache.flink.api.common.typeutils.TypeSerializer<BaseRow>

getLength

public int getLength()

Specified by:

getLength in class org.apache.flink.api.common.typeutils.TypeSerializer<BaseRow>

snapshotConfiguration

public org.apache.flink.api.common.typeutils.TypeSerializerSnapshot<BaseRow> snapshotConfiguration()

Specified by:

snapshotConfiguration in class org.apache.flink.api.common.typeutils.TypeSerializer<BaseRow>