org.apache.flink.runtime.state

Class AbstractHeapState<K,N,SV,S extends org.apache.flink.api.common.state.State,SD extends org.apache.flink.api.common.state.StateDescriptor<S,?>,Backend extends AbstractStateBackend>

java.lang.Object

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

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

Backend - The type of the backend that snapshots this key/value state.

All Implemented Interfaces:

org.apache.flink.api.common.state.State, KvState<K,N,S,SD,Backend>

Direct Known Subclasses:

AbstractFsState, AbstractMemState

public abstract class AbstractHeapState<K,N,SV,S extends org.apache.flink.api.common.state.State,SD extends org.apache.flink.api.common.state.StateDescriptor<S,?>,Backend extends AbstractStateBackend>
extends Object
implements KvState<K,N,S,SD,Backend>, org.apache.flink.api.common.state.State

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 K	currentKey The current key, which the next value methods will refer to
protected N	currentNamespace The current namespace, which the access methods will refer to.
protected Map<K,SV>	currentNSState Cache the state map for the current key.
protected org.apache.flink.api.common.typeutils.TypeSerializer<K>	keySerializer The serializer for the keys
protected org.apache.flink.api.common.typeutils.TypeSerializer<N>	namespaceSerializer The serializer for the namespace
protected HashMap<N,Map<K,SV>>	state Map containing the actual key/value pairs
protected SD	stateDesc This holds the name of the state and can create an initial default value for the state.
protected org.apache.flink.api.common.typeutils.TypeSerializer<SV>	stateSerializer Serializer for the state value.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractHeapState(org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer, org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer, org.apache.flink.api.common.typeutils.TypeSerializer<SV> stateSerializer, SD stateDesc) Creates a new empty key/value state.
protected	AbstractHeapState(org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer, org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer, org.apache.flink.api.common.typeutils.TypeSerializer<SV> stateSerializer, SD stateDesc, HashMap<N,Map<K,SV>> state) 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()
void	dispose() Disposes the key/value state, releasing all occupied resources.
org.apache.flink.api.common.typeutils.TypeSerializer<K>	getKeySerializer() Gets the serializer for the keys.
org.apache.flink.api.common.typeutils.TypeSerializer<N>	getNamespaceSerializer() Gets the serializer for the namespace.
void	setCurrentKey(K currentKey) Sets the current key, which will be used when using the state access methods.
void	setCurrentNamespace(N namespace) Sets the current namespace, which will be used when using the state access methods.
protected int	size() Returns the number of all state pairs in this state, across namespaces.

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.KvState

snapshot

Field Detail

state

protected final HashMap<N,Map<K,SV>> state

Map containing the actual key/value pairs

stateSerializer

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

Serializer for the state value. The state value could be a List, for example.

keySerializer

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

The serializer for the keys

namespaceSerializer

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

The serializer for the namespace

stateDesc

protected final SD extends org.apache.flink.api.common.state.StateDescriptor<S,?> stateDesc

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

currentKey

protected K currentKey

The current key, which the next value methods will refer to

currentNamespace

protected N currentNamespace

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

currentNSState

protected Map<K,SV> currentNSState

Cache the state map for the current key.

Constructor Detail

AbstractHeapState

protected AbstractHeapState(org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer,
                            org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer,
                            org.apache.flink.api.common.typeutils.TypeSerializer<SV> stateSerializer,
                            SD stateDesc)

Creates a new empty key/value state.

Parameters:

keySerializer - The serializer for the keys.

namespaceSerializer - The serializer for the namespace.

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

AbstractHeapState

protected AbstractHeapState(org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer,
                            org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer,
                            org.apache.flink.api.common.typeutils.TypeSerializer<SV> stateSerializer,
                            SD stateDesc,
                            HashMap<N,Map<K,SV>> state)

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

Parameters:

keySerializer - The serializer for the keys.

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

state - The state map to use in this kev/value state. May contain initial state.

Method Detail

clear

public final void clear()

Specified by:

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

setCurrentKey

public final void setCurrentKey(K currentKey)

Description copied from interface: KvState

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

Specified by:

setCurrentKey in interface KvState<K,N,S extends org.apache.flink.api.common.state.State,SD extends org.apache.flink.api.common.state.StateDescriptor<S,?>,Backend extends AbstractStateBackend>

Parameters:

currentKey - The key.

setCurrentNamespace

public final void setCurrentNamespace(N namespace)

Description copied from interface: KvState

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

Specified by:

setCurrentNamespace in interface KvState<K,N,S extends org.apache.flink.api.common.state.State,SD extends org.apache.flink.api.common.state.StateDescriptor<S,?>,Backend extends AbstractStateBackend>

Parameters:

namespace - The namespace.

size

protected final int size()

Returns the number of all state pairs in this state, across namespaces.

dispose

public void dispose()

Description copied from interface: KvState

Disposes the key/value state, releasing all occupied resources.

Specified by:

dispose in interface KvState<K,N,S extends org.apache.flink.api.common.state.State,SD extends org.apache.flink.api.common.state.StateDescriptor<S,?>,Backend extends AbstractStateBackend>

getKeySerializer

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

Gets the serializer for the keys.

Returns:

The serializer for the keys.

getNamespaceSerializer

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

Gets the serializer for the namespace.

Returns:

The serializer for the namespace.