org.apache.flink.table.runtime.typeutils.serializers.python

Class MapDataSerializer

java.lang.Object

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

org.apache.flink.table.runtime.typeutils.MapDataSerializer

org.apache.flink.table.runtime.typeutils.serializers.python.MapDataSerializer

All Implemented Interfaces:

Serializable

@Internal
public class MapDataSerializer
extends MapDataSerializer

A TypeSerializer for MapData. It should be noted that the header will not be encoded. Currently Python doesn't support BinaryMapData natively, so we can't use BaseArraySerializer in blink directly.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapDataSerializer.BaseMapSerializerSnapshot TypeSerializerSnapshot for MapDataSerializer.

Nested classes/interfaces inherited from class org.apache.flink.table.runtime.typeutils.MapDataSerializer

MapDataSerializer.MapDataSerializerSnapshot

Constructor Summary

Constructors

Constructor and Description
MapDataSerializer(LogicalType keyType, LogicalType valueType, TypeSerializer keyTypeSerializer, TypeSerializer valueTypeSerializer)

Method Summary

Modifier and Type	Method and Description
void	copy(DataInputView source, DataOutputView target) Copies exactly one record from the source input view to the target output view.
MapData	deserialize(DataInputView source) De-serializes a record from the given source input view.
MapData	deserialize(MapData reuse, DataInputView source) De-serializes a record from the given source input view into the given reuse record instance if mutable.
TypeSerializer<MapData>	duplicate() Creates a deep copy of this serializer if it is necessary, i.e.
void	serialize(MapData map, DataOutputView target) Serializes the given record to the given target output view.
TypeSerializerSnapshot<MapData>	snapshotConfiguration() Snapshots the configuration of this TypeSerializer.

Methods inherited from class org.apache.flink.table.runtime.typeutils.MapDataSerializer

copy, copy, createInstance, equals, getKeySerializer, getLength, getValueSerializer, hashCode, isImmutableType, toBinaryMap

Methods inherited from class java.lang.Object

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

Constructor Detail

MapDataSerializer

public MapDataSerializer(LogicalType keyType,
                         LogicalType valueType,
                         TypeSerializer keyTypeSerializer,
                         TypeSerializer valueTypeSerializer)

Method Detail

serialize

public void serialize(MapData map,
                      DataOutputView target)
               throws IOException

Description copied from class: TypeSerializer

Serializes the given record to the given target output view.

Overrides:

serialize in class MapDataSerializer

Parameters:

map - The record to serialize.

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

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.

deserialize

public MapData deserialize(DataInputView source)
                    throws IOException

Description copied from class: TypeSerializer

De-serializes a record from the given source input view.

Overrides:

deserialize in class MapDataSerializer

Parameters:

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

Returns:

The deserialized 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.

deserialize

public MapData deserialize(MapData reuse,
                           DataInputView source)
                    throws IOException

Description copied from class: TypeSerializer

De-serializes a record from the given source input view into the given reuse record instance if mutable.

Overrides:

deserialize in class MapDataSerializer

Parameters:

reuse - The record instance into which to de-serialize the data.

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

Returns:

The deserialized 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.

copy

public void copy(DataInputView source,
                 DataOutputView target)
          throws IOException

Description copied from class: TypeSerializer

Copies exactly one record from the source input view to the target output view. Whether this operation works on binary data or partially de-serializes the record to determine its length (such as for records of variable length) is up to the implementer. Binary copies are typically faster. A copy of a record containing two integer numbers (8 bytes total) is most efficiently implemented as target.write(source, 8);.

Overrides:

copy in class MapDataSerializer

Parameters:

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

target - The target output view to which to write the record.

Throws:

IOException - Thrown if any of the two views raises an exception.

duplicate

public TypeSerializer<MapData> duplicate()

Description copied from class: TypeSerializer

Creates a deep copy of this serializer if it is necessary, i.e. if it is stateful. This can return itself if the serializer is not stateful.

We need this because Serializers might be used in several threads. Stateless serializers are inherently thread-safe while stateful serializers might not be thread-safe.

Overrides:

duplicate in class MapDataSerializer

snapshotConfiguration

public TypeSerializerSnapshot<MapData> snapshotConfiguration()

Description copied from class: TypeSerializer

Snapshots the configuration of this TypeSerializer. This method is only relevant if the serializer is used to state stored in checkpoints/savepoints.

The snapshot of the TypeSerializer is supposed to contain all information that affects the serialization format of the serializer. The snapshot serves two purposes: First, to reproduce the serializer when the checkpoint/savepoint is restored, and second, to check whether the serialization format is compatible with the serializer used in the restored program.

IMPORTANT: TypeSerializerSnapshots changed after Flink 1.6. Serializers implemented against Flink versions up to 1.6 should still work, but adjust to new model to enable state evolution and be future-proof. See the class-level comments, section "Upgrading TypeSerializers to the new TypeSerializerSnapshot model" for details.

Overrides:

snapshotConfiguration in class MapDataSerializer

Returns:

snapshot of the serializer's current configuration (cannot be null).

See Also:

TypeSerializerSnapshot.resolveSchemaCompatibility(TypeSerializer)