org.apache.flink.runtime.state.heap

Class HeapListState<K,N,V>

java.lang.Object

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

org.apache.flink.runtime.state.heap.AbstractHeapMergingState<K,N,V,List<V>,Iterable<V>,org.apache.flink.api.common.state.ListState<V>>

org.apache.flink.runtime.state.heap.HeapListState<K,N,V>

Type Parameters:

K - The type of the key.

N - The type of the namespace.

V - The type of the value.

All Implemented Interfaces:

org.apache.flink.api.common.state.AppendingState<V,Iterable<V>>, org.apache.flink.api.common.state.ListState<V>, org.apache.flink.api.common.state.MergingState<V,Iterable<V>>, org.apache.flink.api.common.state.State, InternalAppendingState<K,N,V,List<V>,Iterable<V>>, InternalKvState<K,N,List<V>>, InternalListState<K,N,V>, InternalMergingState<K,N,V,List<V>,Iterable<V>>

public class HeapListState<K,N,V>
extends AbstractHeapMergingState<K,N,V,List<V>,Iterable<V>,org.apache.flink.api.common.state.ListState<V>>
implements InternalListState<K,N,V>

Heap-backed partitioned ListState 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
HeapListState(StateTable<K,N,List<V>> stateTable, org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer, org.apache.flink.api.common.typeutils.TypeSerializer<List<V>> valueSerializer, org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer, List<V> 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	add(V value)
void	addAll(List<V> values) Updates the operator state accessible by AppendingState.get() by adding the given values to existing list of values.
Iterable<V>	get()
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<List<V>> safeValueSerializer) Returns the serialized value for the given key and namespace.
org.apache.flink.api.common.typeutils.TypeSerializer<List<V>>	getValueSerializer() Returns the TypeSerializer for the type of value this state holds.
protected List<V>	mergeState(List<V> a, List<V> b)
void	update(List<V> values) Updates the operator state accessible by AppendingState.get() by updating existing values to to the given list of values.

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

mergeNamespaces

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

mergeNamespaces

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

HeapListState

public HeapListState(StateTable<K,N,List<V>> stateTable,
                     org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer,
                     org.apache.flink.api.common.typeutils.TypeSerializer<List<V>> valueSerializer,
                     org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer,
                     List<V> 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,List<V>>

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,List<V>>

getValueSerializer

public org.apache.flink.api.common.typeutils.TypeSerializer<List<V>> 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,List<V>>

get

public Iterable<V> get()

Specified by:

get in interface org.apache.flink.api.common.state.AppendingState<V,Iterable<V>>

add

public void add(V value)

Specified by:

add in interface org.apache.flink.api.common.state.AppendingState<V,Iterable<V>>

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<List<V>> 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,List<V>>

Overrides:

getSerializedValue in class AbstractHeapState<K,N,List<V>,org.apache.flink.api.common.state.ListState<V>>

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

mergeState

protected List<V> mergeState(List<V> a,
                             List<V> b)

Specified by:

mergeState in class AbstractHeapMergingState<K,N,V,List<V>,Iterable<V>,org.apache.flink.api.common.state.ListState<V>>

update

public void update(List<V> values)
            throws Exception

Description copied from interface: InternalListState

Updates the operator state accessible by AppendingState.get() by updating existing values to to the given list of values. The next time AppendingState.get() is called (for the same state partition) the returned state will represent the updated list. If `null` or an empty list is passed in, the state value will be null

Specified by:

update in interface org.apache.flink.api.common.state.ListState<V>

Specified by:

update in interface InternalListState<K,N,V>

Parameters:

values - The new values for the state.

Throws:

Exception - The method may forward exception thrown internally (by I/O or functions).

addAll

public void addAll(List<V> values)
            throws Exception

Description copied from interface: InternalListState

Updates the operator state accessible by AppendingState.get() by adding the given values to existing list of values. The next time AppendingState.get() is called (for the same state partition) the returned state will represent the updated list. If `null` or an empty list is passed in, the state value remains unchanged

Specified by:

addAll in interface org.apache.flink.api.common.state.ListState<V>

Specified by:

addAll in interface InternalListState<K,N,V>

Parameters:

values - The new values to be added to the state.

Throws:

Exception - The method may forward exception thrown internally (by I/O or functions).