org.apache.flink.runtime.state

Class GenericFoldingState<K,N,T,ACC,Backend extends AbstractStateBackend,W extends ValueState<ACC> & KvState<K,N,ValueState<ACC>,ValueStateDescriptor<ACC>,Backend>>

java.lang.Object

org.apache.flink.runtime.state.GenericFoldingState<K,N,T,ACC,Backend,W>

Type Parameters:

K - The type of the key.

N - The type of the namespace.

T - The type of the values that can be folded into the state.

ACC - The type of the value in the folding state.

Backend - The type of AbstractStateBackend that manages this KvState.

W - Generic type that extends both the underlying ValueState and KvState.

All Implemented Interfaces:

AppendingState<T,ACC>, FoldingState<T,ACC>, State, KvState<K,N,FoldingState<T,ACC>,FoldingStateDescriptor<T,ACC>,Backend>

public class GenericFoldingState<K,N,T,ACC,Backend extends AbstractStateBackend,W extends ValueState<ACC> & KvState<K,N,ValueState<ACC>,ValueStateDescriptor<ACC>,Backend>>
extends Object
implements FoldingState<T,ACC>, KvState<K,N,FoldingState<T,ACC>,FoldingStateDescriptor<T,ACC>,Backend>

Generic implementation of FoldingState based on a wrapped ValueState.

Constructor Summary

Constructors

Constructor and Description
GenericFoldingState(ValueState<ACC> wrappedState, FoldFunction<T,ACC> foldFunction) Creates a new FoldingState that wraps the given ValueState.

Method Summary

Modifier and Type	Method and Description
void	add(T value) Updates the operator state accessible by AppendingState.get() by adding the given value to the list of values.
void	clear() Removes the value mapped under the current key.
void	dispose() Disposes the key/value state, releasing all occupied resources.
ACC	get() Returns the current value for the state.
void	setCurrentKey(K key) 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.
KvStateSnapshot<K,N,FoldingState<T,ACC>,FoldingStateDescriptor<T,ACC>,Backend>	snapshot(long checkpointId, long timestamp) Creates a snapshot of this state.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GenericFoldingState

public GenericFoldingState(ValueState<ACC> wrappedState,
                           FoldFunction<T,ACC> foldFunction)

Creates a new FoldingState that wraps the given ValueState. The ValueState must have the initial value of the fold as default value.

Parameters:

wrappedState - The wrapped ValueState

foldFunction - The FoldFunction to use for folding values into the state

Method Detail

setCurrentKey

public void setCurrentKey(K key)

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,FoldingState<T,ACC>,FoldingStateDescriptor<T,ACC>,Backend extends AbstractStateBackend>

Parameters:

key - The key.

setCurrentNamespace

public 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,FoldingState<T,ACC>,FoldingStateDescriptor<T,ACC>,Backend extends AbstractStateBackend>

Parameters:

namespace - The namespace.

snapshot

public KvStateSnapshot<K,N,FoldingState<T,ACC>,FoldingStateDescriptor<T,ACC>,Backend> snapshot(long checkpointId,
                                                                                               long timestamp)
                                                                                        throws Exception

Description copied from interface: KvState

Creates a snapshot of this state.

Specified by:

snapshot in interface KvState<K,N,FoldingState<T,ACC>,FoldingStateDescriptor<T,ACC>,Backend extends AbstractStateBackend>

Parameters:

checkpointId - The ID of the checkpoint for which the snapshot should be created.

timestamp - The timestamp of the checkpoint.

Returns:

A snapshot handle for this key/value state.

Throws:

Exception - Exceptions during snapshotting the state should be forwarded, so the system can react to failed snapshots.

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,FoldingState<T,ACC>,FoldingStateDescriptor<T,ACC>,Backend extends AbstractStateBackend>

get

public ACC get()
        throws Exception

Description copied from interface: AppendingState

Returns the current value for the state. When the state is not partitioned the returned value is the same for all inputs in a given operator instance. If state partitioning is applied, the value returned depends on the current operator input, as the operator maintains an independent state for each partition.

NOTE TO IMPLEMENTERS: if the state is empty, then this method should return null.

Specified by:

get in interface AppendingState<T,ACC>

Returns:

The operator state value corresponding to the current input or null if the state is empty.

Throws:

Exception - Thrown if the system cannot access the state.

add

public void add(T value)
         throws Exception

Description copied from interface: AppendingState

Updates the operator state accessible by AppendingState.get() by adding the given value to the list of values. The next time AppendingState.get() is called (for the same state partition) the returned state will represent the updated list.

Specified by:

add in interface AppendingState<T,ACC>

Parameters:

value - The new value for the state.

Throws:

IOException - Thrown if the system cannot access the state.

Exception

clear

public void clear()

Description copied from interface: State

Removes the value mapped under the current key.

Specified by:

clear in interface State