org.apache.flink.state.api.input.operator

Class StateReaderOperator<F extends Function,KEY,N,OUT>

java.lang.Object

org.apache.flink.state.api.input.operator.StateReaderOperator<F,KEY,N,OUT>

Type Parameters:

F - The type of the user function.

KEY - The key type.

N - The namespace type.

OUT - The output type.

All Implemented Interfaces:

Serializable, AutoCloseable, KeyContext

Direct Known Subclasses:

KeyedStateReaderOperator, WindowReaderOperator

@Internal
public abstract class StateReaderOperator<F extends Function,KEY,N,OUT>
extends Object
implements KeyContext, AutoCloseable, Serializable

Base class for executing functions that read keyed state.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected F	function
protected TypeSerializer<N>	namespaceSerializer

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StateReaderOperator(F function, TypeInformation<KEY> keyType, TypeSerializer<N> namespaceSerializer)

Method Summary

Modifier and Type	Method and Description
void	close()
Object	getCurrentKey()
ExecutionConfig	getExecutionConfig()
protected InternalTimerService<N>	getInternalTimerService(String name)
KeyedStateBackend<KEY>	getKeyedStateBackend()
abstract CloseableIterator<Tuple2<KEY,N>>	getKeysAndNamespaces(SavepointRuntimeContext ctx)
TypeInformation<KEY>	getKeyType()
void	open()
abstract void	processElement(KEY key, N namespace, Collector<OUT> out)
void	setCurrentKey(Object key)
void	setup(ExecutionConfig executionConfig, KeyedStateBackend<KEY> keyKeyedStateBackend, InternalTimeServiceManager<KEY> timerServiceManager, SavepointRuntimeContext ctx)

Methods inherited from class java.lang.Object

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

Field Detail

function

protected final F extends Function function

namespaceSerializer

protected final TypeSerializer<N> namespaceSerializer

Constructor Detail

StateReaderOperator

protected StateReaderOperator(F function,
                              TypeInformation<KEY> keyType,
                              TypeSerializer<N> namespaceSerializer)

Method Detail

processElement

public abstract void processElement(KEY key,
                                    N namespace,
                                    Collector<OUT> out)
                             throws Exception

Throws:

Exception

getKeysAndNamespaces

public abstract CloseableIterator<Tuple2<KEY,N>> getKeysAndNamespaces(SavepointRuntimeContext ctx)
                                                               throws Exception

Throws:

Exception

setup

public final void setup(ExecutionConfig executionConfig,
                        KeyedStateBackend<KEY> keyKeyedStateBackend,
                        InternalTimeServiceManager<KEY> timerServiceManager,
                        SavepointRuntimeContext ctx)

getInternalTimerService

protected final InternalTimerService<N> getInternalTimerService(String name)

open

public void open()
          throws Exception

Throws:

Exception

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

setCurrentKey

public final void setCurrentKey(Object key)

Specified by:

setCurrentKey in interface KeyContext

getCurrentKey

public final Object getCurrentKey()

Specified by:

getCurrentKey in interface KeyContext

getKeyedStateBackend

public final KeyedStateBackend<KEY> getKeyedStateBackend()

getKeyType

public final TypeInformation<KEY> getKeyType()

getExecutionConfig

public final ExecutionConfig getExecutionConfig()