Class MapViewSerializer<K,V>
- java.lang.Object
-
- org.apache.flink.api.common.typeutils.TypeSerializer<MapView<K,V>>
-
- org.apache.flink.table.dataview.MapViewSerializer<K,V>
-
- Type Parameters:
K
- The type of the keys in the map.V
- The type of the values in the map.
- All Implemented Interfaces:
Serializable
,LegacySerializerSnapshotTransformer<MapView<K,V>>
@Internal @Deprecated public class MapViewSerializer<K,V> extends TypeSerializer<MapView<K,V>> implements LegacySerializerSnapshotTransformer<MapView<K,V>>
Deprecated.A serializer forMapView
. The serializer relies on a key serializer and a value serializer for the serialization of the map's key-value pairs.The serialization format for the map is as follows: four bytes for the length of the map, followed by the serialized representation of each key-value pair. To allow null values, each value is prefixed by a null marker.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description MapViewSerializer(TypeSerializer<Map<K,V>> mapSerializer)
Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
copy(DataInputView source, DataOutputView target)
Deprecated.Copies exactly one record from the source input view to the target output view.MapView<K,V>
copy(MapView<K,V> from)
Deprecated.Creates a deep copy of the given element in a new element.MapView<K,V>
copy(MapView<K,V> from, MapView<K,V> reuse)
Deprecated.Creates a copy from the given element.MapView<K,V>
createInstance()
Deprecated.Creates a new instance of the data type.MapView<K,V>
deserialize(DataInputView source)
Deprecated.De-serializes a record from the given source input view.MapView<K,V>
deserialize(MapView<K,V> reuse, DataInputView source)
Deprecated.De-serializes a record from the given source input view into the given reuse record instance if mutable.TypeSerializer<MapView<K,V>>
duplicate()
Deprecated.Creates a deep copy of this serializer if it is necessary, i.e. if it is stateful.boolean
equals(Object obj)
Deprecated.int
getLength()
Deprecated.Gets the length of the data type, if it is a fix length data type.TypeSerializer<Map<K,V>>
getMapSerializer()
Deprecated.int
hashCode()
Deprecated.boolean
isImmutableType()
Deprecated.Gets whether the type is an immutable type.void
serialize(MapView<K,V> record, DataOutputView target)
Deprecated.Serializes the given record to the given target output view.TypeSerializerSnapshot<MapView<K,V>>
snapshotConfiguration()
Deprecated.Snapshots the configuration of this TypeSerializer.<U> TypeSerializerSnapshot<MapView<K,V>>
transformLegacySerializerSnapshot(TypeSerializerSnapshot<U> legacySnapshot)
Deprecated.We need to override this as aLegacySerializerSnapshotTransformer
because in Flink 1.6.x and below, this serializer was incorrectly returning directly the snapshot of the nested map serializer as its own snapshot.
-
-
-
Constructor Detail
-
MapViewSerializer
public MapViewSerializer(TypeSerializer<Map<K,V>> mapSerializer)
Deprecated.
-
-
Method Detail
-
isImmutableType
public boolean isImmutableType()
Deprecated.Description copied from class:TypeSerializer
Gets whether the type is an immutable type.- Specified by:
isImmutableType
in classTypeSerializer<MapView<K,V>>
- Returns:
- True, if the type is immutable.
-
duplicate
public TypeSerializer<MapView<K,V>> duplicate()
Deprecated.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.
- Specified by:
duplicate
in classTypeSerializer<MapView<K,V>>
-
createInstance
public MapView<K,V> createInstance()
Deprecated.Description copied from class:TypeSerializer
Creates a new instance of the data type.- Specified by:
createInstance
in classTypeSerializer<MapView<K,V>>
- Returns:
- A new instance of the data type.
-
copy
public MapView<K,V> copy(MapView<K,V> from)
Deprecated.Description copied from class:TypeSerializer
Creates a deep copy of the given element in a new element.- Specified by:
copy
in classTypeSerializer<MapView<K,V>>
- Parameters:
from
- The element reuse be copied.- Returns:
- A deep copy of the element.
-
copy
public MapView<K,V> copy(MapView<K,V> from, MapView<K,V> reuse)
Deprecated.Description copied from class:TypeSerializer
Creates a copy from the given element. The method makes an attempt to store the copy in the given reuse element, if the type is mutable. This is, however, not guaranteed.- Specified by:
copy
in classTypeSerializer<MapView<K,V>>
- Parameters:
from
- The element to be copied.reuse
- The element to be reused. May or may not be used.- Returns:
- A deep copy of the element.
-
getLength
public int getLength()
Deprecated.Description copied from class:TypeSerializer
Gets the length of the data type, if it is a fix length data type.- Specified by:
getLength
in classTypeSerializer<MapView<K,V>>
- Returns:
- The length of the data type, or
-1
for variable length data types.
-
serialize
public void serialize(MapView<K,V> record, DataOutputView target) throws IOException
Deprecated.Description copied from class:TypeSerializer
Serializes the given record to the given target output view.- Specified by:
serialize
in classTypeSerializer<MapView<K,V>>
- Parameters:
record
- 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 MapView<K,V> deserialize(DataInputView source) throws IOException
Deprecated.Description copied from class:TypeSerializer
De-serializes a record from the given source input view.- Specified by:
deserialize
in classTypeSerializer<MapView<K,V>>
- 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 MapView<K,V> deserialize(MapView<K,V> reuse, DataInputView source) throws IOException
Deprecated.Description copied from class:TypeSerializer
De-serializes a record from the given source input view into the given reuse record instance if mutable.- Specified by:
deserialize
in classTypeSerializer<MapView<K,V>>
- 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
Deprecated.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 astarget.write(source, 8);
.- Specified by:
copy
in classTypeSerializer<MapView<K,V>>
- 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.
-
equals
public boolean equals(Object obj)
Deprecated.- Specified by:
equals
in classTypeSerializer<MapView<K,V>>
-
hashCode
public int hashCode()
Deprecated.- Specified by:
hashCode
in classTypeSerializer<MapView<K,V>>
-
snapshotConfiguration
public TypeSerializerSnapshot<MapView<K,V>> snapshotConfiguration()
Deprecated.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.
- Specified by:
snapshotConfiguration
in classTypeSerializer<MapView<K,V>>
- Returns:
- snapshot of the serializer's current configuration (cannot be
null
). - See Also:
TypeSerializerSnapshot.resolveSchemaCompatibility(TypeSerializerSnapshot)
-
transformLegacySerializerSnapshot
public <U> TypeSerializerSnapshot<MapView<K,V>> transformLegacySerializerSnapshot(TypeSerializerSnapshot<U> legacySnapshot)
Deprecated.We need to override this as aLegacySerializerSnapshotTransformer
because in Flink 1.6.x and below, this serializer was incorrectly returning directly the snapshot of the nested map serializer as its own snapshot.This method transforms the incorrect map serializer snapshot to be a proper
MapViewSerializerSnapshot
.- Specified by:
transformLegacySerializerSnapshot
in interfaceLegacySerializerSnapshotTransformer<K>
- Type Parameters:
U
- the legacy snapshot's serializer data type.- Parameters:
legacySnapshot
- the snapshot to transform.- Returns:
- a possibly transformed snapshot.
-
getMapSerializer
public TypeSerializer<Map<K,V>> getMapSerializer()
Deprecated.
-
-