org.apache.flink.runtime.state.heap

Class HeapAggregatingState<K,N,IN,ACC,OUT>

java.lang.Object

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

org.apache.flink.runtime.state.heap.AbstractHeapMergingState<K,N,IN,ACC,OUT,org.apache.flink.api.common.state.AggregatingState<IN,OUT>>

org.apache.flink.runtime.state.heap.HeapAggregatingState<K,N,IN,ACC,OUT>

Type Parameters:

K - The type of the key.

N - The type of the namespace.

IN - The type of the value added to the state.

ACC - The type of the value stored in the state (the accumulator type).

OUT - The type of the value returned from the state.

All Implemented Interfaces:

org.apache.flink.api.common.state.AggregatingState<IN,OUT>, org.apache.flink.api.common.state.AppendingState<IN,OUT>, org.apache.flink.api.common.state.MergingState<IN,OUT>, org.apache.flink.api.common.state.State, InternalAggregatingState<K,N,IN,ACC,OUT>, InternalAppendingState<K,N,IN,ACC,OUT>, InternalKvState<K,N,ACC>, InternalMergingState<K,N,IN,ACC,OUT>

public class HeapAggregatingState<K,N,IN,ACC,OUT>
extends AbstractHeapMergingState<K,N,IN,ACC,OUT,org.apache.flink.api.common.state.AggregatingState<IN,OUT>>
implements InternalAggregatingState<K,N,IN,ACC,OUT>

Heap-backed partitioned AggregatingState 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

HeapAggregatingState(StateTable<K,N,ACC> stateTable, org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer, org.apache.flink.api.common.typeutils.TypeSerializer<ACC> valueSerializer, org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer, ACC defaultValue, org.apache.flink.api.common.functions.AggregateFunction<IN,ACC,OUT> aggregateFunction) 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(IN value)
OUT	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.
org.apache.flink.api.common.typeutils.TypeSerializer<ACC>	getValueSerializer() Returns the TypeSerializer for the type of value this state holds.
protected ACC	mergeState(ACC a, ACC b)

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

getSerializedValue, setCurrentNamespace

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

clear

Constructor Detail

HeapAggregatingState

public HeapAggregatingState(StateTable<K,N,ACC> stateTable,
                            org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer,
                            org.apache.flink.api.common.typeutils.TypeSerializer<ACC> valueSerializer,
                            org.apache.flink.api.common.typeutils.TypeSerializer<N> namespaceSerializer,
                            ACC defaultValue,
                            org.apache.flink.api.common.functions.AggregateFunction<IN,ACC,OUT> aggregateFunction)

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.

aggregateFunction - The aggregating function used for aggregating 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,ACC>

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

getValueSerializer

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

get

public OUT get()

Specified by:

get in interface org.apache.flink.api.common.state.AppendingState<IN,OUT>

add

public void add(IN value)
         throws IOException

Specified by:

add in interface org.apache.flink.api.common.state.AppendingState<IN,OUT>

Throws:

IOException

mergeState

protected ACC mergeState(ACC a,
                         ACC b)
                  throws Exception

Specified by:

mergeState in class AbstractHeapMergingState<K,N,IN,ACC,OUT,org.apache.flink.api.common.state.AggregatingState<IN,OUT>>

Throws:

Exception