Package org.apache.flink.datastream.impl.operators

Class TwoOutputProcessOperator<IN,OUT_MAIN,OUT_SIDE>

java.lang.Object

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

org.apache.flink.streaming.api.operators.AbstractUdfStreamOperator<OUT_MAIN,TwoOutputStreamProcessFunction<IN,OUT_MAIN,OUT_SIDE>>

org.apache.flink.datastream.impl.operators.TwoOutputProcessOperator<IN,OUT_MAIN,OUT_SIDE>

All Implemented Interfaces:

Serializable, CheckpointListener, BoundedOneInput, Input<IN>, KeyContext, KeyContextHandler, OneInputStreamOperator<IN,OUT_MAIN>, OutputTypeConfigurable<OUT_MAIN>, StreamOperator<OUT_MAIN>, StreamOperatorStateHandler.CheckpointedStreamOperator, UserFunctionProvider<TwoOutputStreamProcessFunction<IN,OUT_MAIN,OUT_SIDE>>, YieldingOperator<OUT_MAIN>

Direct Known Subclasses:

KeyedTwoOutputProcessOperator

public class TwoOutputProcessOperator<IN,OUT_MAIN,OUT_SIDE>
extends AbstractUdfStreamOperator<OUT_MAIN,TwoOutputStreamProcessFunction<IN,OUT_MAIN,OUT_SIDE>>
implements OneInputStreamOperator<IN,OUT_MAIN>, BoundedOneInput

Operator for TwoOutputStreamProcessFunction.

We support the second output via flink side-output mechanism.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	TwoOutputProcessOperator.SideOutputCollector	This is a special implementation of TimestampCollector that using side-output mechanism to emit data.

Field Summary

Fields

Modifier and Type	Field	Description
protected DefaultRuntimeContext	context
protected TimestampCollector<OUT_MAIN>	mainCollector
protected TwoOutputNonPartitionedContext<OUT_MAIN,OUT_SIDE>	nonPartitionedContext
protected OutputTag<OUT_SIDE>	outputTag
protected DefaultPartitionedContext	partitionedContext
protected TimestampCollector<OUT_SIDE>	sideCollector

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

userFunction

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

config, lastRecordAttributes1, lastRecordAttributes2, latencyStats, LOG, metrics, output, processingTimeService, stateHandler, stateKeySelector1, stateKeySelector2, timeServiceManager

Constructor Summary

Constructors

Constructor	Description
TwoOutputProcessOperator(TwoOutputStreamProcessFunction<IN,OUT_MAIN,OUT_SIDE> userFunction, OutputTag<OUT_SIDE> outputTag)

Method Summary

Modifier and Type	Method	Description
protected Object	currentKey()
void	endInput()	It is notified that no more data will arrive from the input.
protected TimestampCollector<OUT_MAIN>	getMainCollector()
protected TwoOutputNonPartitionedContext<OUT_MAIN,OUT_SIDE>	getNonPartitionedContext()
protected ProcessingTimeManager	getProcessingTimeManager()
TimestampCollector<OUT_SIDE>	getSideCollector()
void	open()	This method is called immediately before any elements are processed, it should contain the operator's initialization logic, e.g. state initialization.
void	processElement(StreamRecord<IN> element)	Processes one element that arrived on this input of the MultipleInputStreamOperator.

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

close, finish, getUserFunction, getUserFunctionParameters, initializeState, notifyCheckpointAborted, notifyCheckpointComplete, setOutputType, setup, snapshotState

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

getContainingTask, getCurrentKey, getExecutionConfig, getInternalTimerService, getKeyedStateBackend, getKeyedStateStore, getMetricGroup, getOperatorConfig, getOperatorID, getOperatorName, getOperatorStateBackend, getOrCreateKeyedState, getPartitionedState, getPartitionedState, getProcessingTimeService, getRuntimeContext, getStateKeySelector1, getStateKeySelector2, getTimeServiceManager, getUserCodeClassloader, hasKeyContext1, hasKeyContext2, initializeState, isUsingCustomRawKeyedState, prepareSnapshotPreBarrier, processLatencyMarker, processLatencyMarker1, processLatencyMarker2, processRecordAttributes, processRecordAttributes1, processRecordAttributes2, processWatermark, processWatermark1, processWatermark2, processWatermarkStatus, processWatermarkStatus1, processWatermarkStatus2, reportOrForwardLatencyMarker, setCurrentKey, setKeyContextElement1, setKeyContextElement2, setMailboxExecutor, setProcessingTimeService, snapshotState, useSplittableTimers

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.api.common.state.CheckpointListener

notifyCheckpointAborted, notifyCheckpointComplete

Methods inherited from interface org.apache.flink.streaming.api.operators.Input

processLatencyMarker, processRecordAttributes, processWatermark, processWatermarkStatus

Methods inherited from interface org.apache.flink.streaming.api.operators.KeyContext

getCurrentKey, setCurrentKey

Methods inherited from interface org.apache.flink.streaming.api.operators.KeyContextHandler

hasKeyContext

Methods inherited from interface org.apache.flink.streaming.api.operators.OneInputStreamOperator

setKeyContextElement

Methods inherited from interface org.apache.flink.streaming.api.operators.StreamOperator

close, finish, getMetricGroup, getOperatorAttributes, getOperatorID, initializeState, prepareSnapshotPreBarrier, setKeyContextElement1, setKeyContextElement2, snapshotState

Field Detail

mainCollector

protected transient TimestampCollector<OUT_MAIN> mainCollector

sideCollector

protected transient TimestampCollector<OUT_SIDE> sideCollector

context

protected transient DefaultRuntimeContext context

partitionedContext

protected transient DefaultPartitionedContext partitionedContext

nonPartitionedContext

protected transient TwoOutputNonPartitionedContext<OUT_MAIN,OUT_SIDE> nonPartitionedContext

outputTag

protected OutputTag<OUT_SIDE> outputTag

Constructor Detail

TwoOutputProcessOperator

public TwoOutputProcessOperator(TwoOutputStreamProcessFunction<IN,OUT_MAIN,OUT_SIDE> userFunction,
                                OutputTag<OUT_SIDE> outputTag)

Method Detail

open

public void open()
          throws Exception

Description copied from class: AbstractStreamOperator

This method is called immediately before any elements are processed, it should contain the operator's initialization logic, e.g. state initialization.

The default implementation does nothing.

Specified by:

open in interface StreamOperator<IN>

Overrides:

open in class AbstractUdfStreamOperator<OUT_MAIN,TwoOutputStreamProcessFunction<IN,OUT_MAIN,OUT_SIDE>>

Throws:

Exception - An exception in this method causes the operator to fail.

processElement

public void processElement(StreamRecord<IN> element)
                    throws Exception

Description copied from interface: Input

Processes one element that arrived on this input of the MultipleInputStreamOperator. This method is guaranteed to not be called concurrently with other methods of the operator.

Specified by:

processElement in interface Input<IN>

Throws:

Exception

endInput

public void endInput()
              throws Exception

Description copied from interface: BoundedOneInput

It is notified that no more data will arrive from the input.

WARNING: It is not safe to use this method to commit any transactions or other side effects! You can use this method to flush any buffered data that can later on be committed e.g. in a CheckpointListener.notifyCheckpointComplete(long).

NOTE: Given it is semantically very similar to the StreamOperator.finish() method. It might be dropped in favour of the other method at some point in time.

Specified by:

endInput in interface BoundedOneInput

Throws:

Exception

getMainCollector

protected TimestampCollector<OUT_MAIN> getMainCollector()

getSideCollector

public TimestampCollector<OUT_SIDE> getSideCollector()

currentKey

protected Object currentKey()

getNonPartitionedContext

protected TwoOutputNonPartitionedContext<OUT_MAIN,OUT_SIDE> getNonPartitionedContext()

getProcessingTimeManager

protected ProcessingTimeManager getProcessingTimeManager()