org.apache.flink.runtime.state.heap

Class HeapMapState<K,N,UK,UV>

java.lang.Object

org.apache.flink.runtime.state.heap.AbstractHeapState<K,N,Map<UK,UV>,org.apache.flink.api.common.state.MapState<UK,UV>>

org.apache.flink.runtime.state.heap.HeapMapState<K,N,UK,UV>

Type Parameters:

K - The type of the key.

N - The type of the namespace.

UK - The type of the keys in the state.

UV - The type of the values in the state.

All Implemented Interfaces:

org.apache.flink.api.common.state.MapState<UK,UV>, org.apache.flink.api.common.state.State, InternalKvState<K,N,Map<UK,UV>>, InternalMapState<K,N,UK,UV>

public class HeapMapState<K,N,UK,UV>
extends AbstractHeapState<K,N,Map<UK,UV>,org.apache.flink.api.common.state.MapState<UK,UV>>
implements InternalMapState<K,N,UK,UV>

Heap-backed partitioned MapState that is snapshotted into files.

Field Summary

Fields inherited from class org.apache.flink.runtime.state.heap.AbstractHeapState

currentNamespace, keySerializer, namespaceSerializer, stateTable, valueSerializer

Constructor Summary

Constructors

Constructor and Description
HeapMapState(StateTable<K,N,Map<UK,UV>> stateTable, org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer, org.apache.flink.api.common.typeutils.TypeSerializer<Map<UK,UV>> valueSerializer, org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer, Map<UK,UV> defaultValue) Creates a new key/value state for the given hash map of key/value pairs.

Method Summary

Modifier and Type	Method and Description
boolean	contains(UK userKey)
Iterable<Map.Entry<UK,UV>>	entries()
UV	get(UK userKey)
org.apache.flink.api.common.typeutils.TypeSerializer<K>	getKeySerializer() Returns the TypeSerializer for the type of key this state is associated to.
org.apache.flink.api.common.typeutils.TypeSerializer<N>	getNamespaceSerializer() Returns the TypeSerializer for the type of namespace this state is associated to.
byte[]	getSerializedValue(byte[] serializedKeyAndNamespace, org.apache.flink.api.common.typeutils.TypeSerializer<K> safeKeySerializer, org.apache.flink.api.common.typeutils.TypeSerializer<N> safeNamespaceSerializer, org.apache.flink.api.common.typeutils.TypeSerializer<Map<UK,UV>> safeValueSerializer) Returns the serialized value for the given key and namespace.
org.apache.flink.api.common.typeutils.TypeSerializer<Map<UK,UV>>	getValueSerializer() Returns the TypeSerializer for the type of value this state holds.
Iterator<Map.Entry<UK,UV>>	iterator()
Iterable<UK>	keys()
void	put(UK userKey, UV userValue)
void	putAll(Map<UK,UV> value)
void	remove(UK userKey)
Iterable<UV>	values()

Methods inherited from class org.apache.flink.runtime.state.heap.AbstractHeapState

clear, getDefaultValue, getStateTable, setCurrentNamespace

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.runtime.state.internal.InternalKvState

setCurrentNamespace

Methods inherited from interface org.apache.flink.api.common.state.State

clear

Constructor Detail

HeapMapState

public HeapMapState(StateTable<K,N,Map<UK,UV>> stateTable,
                    org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer,
                    org.apache.flink.api.common.typeutils.TypeSerializer<Map<UK,UV>> valueSerializer,
                    org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer,
                    Map<UK,UV> defaultValue)

Creates a new key/value state for the given hash map of key/value pairs.

Parameters:

stateTable - The state table for which this state is associated to.

keySerializer - The serializer for the keys.

valueSerializer - The serializer for the state.

namespaceSerializer - The serializer for the namespace.

defaultValue - The default value for the state.

Method Detail

getKeySerializer

public org.apache.flink.api.common.typeutils.TypeSerializer<K> getKeySerializer()

Description copied from interface: InternalKvState

Returns the TypeSerializer for the type of key this state is associated to.

Specified by:

getKeySerializer in interface InternalKvState<K,N,Map<UK,UV>>

getNamespaceSerializer

public org.apache.flink.api.common.typeutils.TypeSerializer<N> getNamespaceSerializer()

Description copied from interface: InternalKvState

Returns the TypeSerializer for the type of namespace this state is associated to.

Specified by:

getNamespaceSerializer in interface InternalKvState<K,N,Map<UK,UV>>

getValueSerializer

public org.apache.flink.api.common.typeutils.TypeSerializer<Map<UK,UV>> getValueSerializer()

Description copied from interface: InternalKvState

Returns the TypeSerializer for the type of value this state holds.

Specified by:

getValueSerializer in interface InternalKvState<K,N,Map<UK,UV>>

get

public UV get(UK userKey)

Specified by:

get in interface org.apache.flink.api.common.state.MapState<UK,UV>

put

public void put(UK userKey,
                UV userValue)

Specified by:

put in interface org.apache.flink.api.common.state.MapState<UK,UV>

putAll

public void putAll(Map<UK,UV> value)

Specified by:

putAll in interface org.apache.flink.api.common.state.MapState<UK,UV>

remove

public void remove(UK userKey)

Specified by:

remove in interface org.apache.flink.api.common.state.MapState<UK,UV>

contains

public boolean contains(UK userKey)

Specified by:

contains in interface org.apache.flink.api.common.state.MapState<UK,UV>

entries

public Iterable<Map.Entry<UK,UV>> entries()

Specified by:

entries in interface org.apache.flink.api.common.state.MapState<UK,UV>

keys

public Iterable<UK> keys()

Specified by:

keys in interface org.apache.flink.api.common.state.MapState<UK,UV>

values

public Iterable<UV> values()

Specified by:

values in interface org.apache.flink.api.common.state.MapState<UK,UV>

iterator

public Iterator<Map.Entry<UK,UV>> iterator()

Specified by:

iterator in interface org.apache.flink.api.common.state.MapState<UK,UV>

getSerializedValue

public byte[] getSerializedValue(byte[] serializedKeyAndNamespace,
                                 org.apache.flink.api.common.typeutils.TypeSerializer<K> safeKeySerializer,
                                 org.apache.flink.api.common.typeutils.TypeSerializer<N> safeNamespaceSerializer,
                                 org.apache.flink.api.common.typeutils.TypeSerializer<Map<UK,UV>> safeValueSerializer)
                          throws Exception

Description copied from interface: InternalKvState

Returns the serialized value for the given key and namespace.

If no value is associated with key and namespace, null is returned.

TO IMPLEMENTERS: This method is called by multiple threads. Anything stateful (e.g. serializers) should be either duplicated or protected from undesired consequences of concurrent invocations.

Specified by:

getSerializedValue in interface InternalKvState<K,N,Map<UK,UV>>

Overrides:

getSerializedValue in class AbstractHeapState<K,N,Map<UK,UV>,org.apache.flink.api.common.state.MapState<UK,UV>>

Parameters:

serializedKeyAndNamespace - Serialized key and namespace

safeKeySerializer - A key serializer which is safe to be used even in multi-threaded context

safeNamespaceSerializer - A namespace serializer which is safe to be used even in multi-threaded context

safeValueSerializer - A value serializer which is safe to be used even in multi-threaded context

Returns:

Serialized value or null if no value is associated with the key and namespace.

Throws:

Exception - Exceptions during serialization are forwarded