org.apache.flink.runtime.state.heap

Class AbstractHeapState<K,N,SV,S extends State,SD extends StateDescriptor<S,?>>

java.lang.Object

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

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

SD - The type of StateDescriptor for the State S

All Implemented Interfaces:

State, InternalKvState<N>

Direct Known Subclasses:

AbstractHeapMergingState, HeapFoldingState, HeapMapState, HeapValueState

public abstract class AbstractHeapState<K,N,SV,S extends State,SD extends StateDescriptor<S,?>>
extends Object
implements InternalKvState<N>

Base class for partitioned ListState 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 TypeSerializer<K>	keySerializer
protected TypeSerializer<N>	namespaceSerializer
protected SD	stateDesc This holds the name of the state and can create an initial default value for the state.
protected StateTable<K,N,SV>	stateTable Map containing the actual key/value pairs.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractHeapState(SD stateDesc, StateTable<K,N,SV> stateTable, TypeSerializer<K> keySerializer, TypeSerializer<N> namespaceSerializer) 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() Removes the value mapped under the current key.
byte[]	getSerializedValue(byte[] serializedKeyAndNamespace) Returns the serialized value for the given key and namespace.
byte[]	getSerializedValue(K key, N 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

Field Detail

stateTable

protected final StateTable<K,N,SV> stateTable

Map containing the actual key/value pairs.

stateDesc

protected final SD extends StateDescriptor<S,?> stateDesc

This holds the name of the state and can create an initial default value for the state.

currentNamespace

protected N currentNamespace

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

keySerializer

protected final TypeSerializer<K> keySerializer

namespaceSerializer

protected final TypeSerializer<N> namespaceSerializer

Constructor Detail

AbstractHeapState

protected AbstractHeapState(SD stateDesc,
                            StateTable<K,N,SV> stateTable,
                            TypeSerializer<K> keySerializer,
                            TypeSerializer<N> namespaceSerializer)

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

Parameters:

stateDesc - The state identifier for the state. This contains name and can create a default state value.

stateTable - The state tab;e to use in this kev/value state. May contain initial state.

Method Detail

clear

public final void clear()

Description copied from interface: State

Removes the value mapped under the current key.

Specified by:

clear in interface 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<N>

Parameters:

namespace - The namespace.

getSerializedValue

public byte[] getSerializedValue(byte[] serializedKeyAndNamespace)
                          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.

Specified by:

getSerializedValue in interface InternalKvState<N>

Parameters:

serializedKeyAndNamespace - Serialized key and namespace

Returns:

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

Throws:

Exception - Exceptions during serialization are forwarded

getSerializedValue

public byte[] getSerializedValue(K key,
                                 N namespace)
                          throws Exception

Throws:

Exception

getStateTable

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

This should only be used for testing.