org.apache.flink.runtime.state.heap

Class AbstractHeapState<K,N,SV,S extends org.apache.flink.api.common.state.State>

java.lang.Object

org.apache.flink.runtime.state.heap.AbstractHeapState<K,N,SV,S>

Type Parameters:

K - The type of the key.

N - The type of the namespace.

SV - The type of the values in the state.

S - The type of State

All Implemented Interfaces:

org.apache.flink.api.common.state.State, InternalKvState<K,N,SV>

Direct Known Subclasses:

AbstractHeapMergingState, HeapFoldingState, HeapMapState, HeapValueState

public abstract class AbstractHeapState<K,N,SV,S extends org.apache.flink.api.common.state.State>
extends Object
implements InternalKvState<K,N,SV>

Base class for partitioned State implementations that are backed by a regular heap hash map. The concrete implementations define how the state is checkpointed.

Field Summary

Fields

Modifier and Type	Field and Description
protected N	currentNamespace The current namespace, which the access methods will refer to.
protected org.apache.flink.api.common.typeutils.TypeSerializer<K>	keySerializer
protected org.apache.flink.api.common.typeutils.TypeSerializer<N>	namespaceSerializer
protected StateTable<K,N,SV>	stateTable Map containing the actual key/value pairs.
protected org.apache.flink.api.common.typeutils.TypeSerializer<SV>	valueSerializer

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	clear()
protected SV	getDefaultValue()
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<SV> safeValueSerializer) Returns the serialized value for the given key and namespace.
StateTable<K,N,SV>	getStateTable() This should only be used for testing.
void	setCurrentNamespace(N namespace) Sets the current namespace, which will be used when using the state access methods.

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

getKeySerializer, getNamespaceSerializer, getValueSerializer

Field Detail

stateTable

protected final StateTable<K,N,SV> stateTable

Map containing the actual key/value pairs.

currentNamespace

protected N currentNamespace

The current namespace, which the access methods will refer to.

keySerializer

protected final org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer

valueSerializer

protected final org.apache.flink.api.common.typeutils.TypeSerializer<SV> valueSerializer

namespaceSerializer

protected final org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer

Constructor Detail

AbstractHeapState

protected AbstractHeapState(StateTable<K,N,SV> stateTable,
                            org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer,
                            org.apache.flink.api.common.typeutils.TypeSerializer<SV> valueSerializer,
                            org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer,
                            SV 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

clear

public final void clear()

Specified by:

clear in interface org.apache.flink.api.common.state.State

setCurrentNamespace

public final void setCurrentNamespace(N namespace)

Description copied from interface: InternalKvState

Sets the current namespace, which will be used when using the state access methods.

Specified by:

setCurrentNamespace in interface InternalKvState<K,N,SV>

Parameters:

namespace - The namespace.

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<SV> 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,SV>

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

getStateTable

@VisibleForTesting
public StateTable<K,N,SV> getStateTable()

This should only be used for testing.

getDefaultValue

protected SV getDefaultValue()