org.apache.flink.streaming.api.operators

Class AbstractUdfStreamOperator<OUT,F extends org.apache.flink.api.common.functions.Function & Serializable>

java.lang.Object

org.apache.flink.streaming.api.operators.AbstractStreamOperator<OUT>

org.apache.flink.streaming.api.operators.AbstractUdfStreamOperator<OUT,F>

Type Parameters:

OUT - The output type of the operator

F - The type of the user function

All Implemented Interfaces:

Serializable, StatefulStreamOperator<OUT>, StreamOperator<OUT>

Direct Known Subclasses:

CoStreamFlatMap, CoStreamMap, CoStreamReduce, CoStreamWindow, StreamFilter, StreamFlatMap, StreamFold, StreamMap, StreamReduce, StreamSink, StreamSource

public abstract class AbstractUdfStreamOperator<OUT,F extends org.apache.flink.api.common.functions.Function & Serializable>
extends AbstractStreamOperator<OUT>
implements StatefulStreamOperator<OUT>

This is used as the base class for operators that have a user-defined function.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.streaming.api.operators.StreamOperator

StreamOperator.ChainingStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected F	userFunction

Fields inherited from class org.apache.flink.streaming.api.operators.AbstractStreamOperator

chainingStrategy, executionConfig, inputCopyDisabled, output, runtimeContext

Constructor Summary

Constructors

Constructor and Description
AbstractUdfStreamOperator(F userFunction)

Method Summary

Modifier and Type	Method and Description
void	close() This method is called after no more elements for can arrive for processing.
void	confirmCheckpointCompleted(long checkpointId, long timestamp)
Serializable	getStateSnapshotFromFunction(long checkpointId, long timestamp)
F	getUserFunction()
void	open(org.apache.flink.configuration.Configuration parameters) This method is called before any elements are processed.
void	restoreInitialState(Serializable state)
void	setup(Output<OUT> output, org.apache.flink.api.common.functions.RuntimeContext runtimeContext) Initializes the StreamOperator for input and output handling.

Methods inherited from class org.apache.flink.streaming.api.operators.AbstractStreamOperator

disableInputCopy, getChainingStrategy, isInputCopyingDisabled, setChainingStrategy

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.streaming.api.operators.StreamOperator

getChainingStrategy, isInputCopyingDisabled, setChainingStrategy

Field Detail

userFunction

protected final F extends org.apache.flink.api.common.functions.Function & Serializable userFunction

Constructor Detail

AbstractUdfStreamOperator

public AbstractUdfStreamOperator(F userFunction)

Method Detail

setup

public final void setup(Output<OUT> output,
                        org.apache.flink.api.common.functions.RuntimeContext runtimeContext)

Description copied from interface: StreamOperator

Initializes the StreamOperator for input and output handling.

Specified by:

setup in interface StreamOperator<OUT>

Overrides:

setup in class AbstractStreamOperator<OUT>

open

public void open(org.apache.flink.configuration.Configuration parameters)
          throws Exception

Description copied from interface: StreamOperator

This method is called before any elements are processed.

Specified by:

open in interface StreamOperator<OUT>

Overrides:

open in class AbstractStreamOperator<OUT>

Throws:

Exception

close

public void close()
           throws Exception

Description copied from interface: StreamOperator

This method is called after no more elements for can arrive for processing.

Specified by:

close in interface StreamOperator<OUT>

Overrides:

close in class AbstractStreamOperator<OUT>

Throws:

Exception

restoreInitialState

public void restoreInitialState(Serializable state)
                         throws Exception

Specified by:

restoreInitialState in interface StatefulStreamOperator<OUT>

Throws:

Exception

getStateSnapshotFromFunction

public Serializable getStateSnapshotFromFunction(long checkpointId,
                                                 long timestamp)
                                          throws Exception

Specified by:

getStateSnapshotFromFunction in interface StatefulStreamOperator<OUT>

Throws:

Exception

confirmCheckpointCompleted

public void confirmCheckpointCompleted(long checkpointId,
                                       long timestamp)
                                throws Exception

Specified by:

confirmCheckpointCompleted in interface StatefulStreamOperator<OUT>

Throws:

Exception

getUserFunction

public F getUserFunction()