org.apache.flink.streaming.runtime.operators.windowing

Class NonKeyedWindowOperator<IN,OUT,W extends Window>

java.lang.Object

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

org.apache.flink.streaming.api.operators.AbstractUdfStreamOperator<OUT,AllWindowFunction<IN,OUT,W>>

org.apache.flink.streaming.runtime.operators.windowing.NonKeyedWindowOperator<IN,OUT,W>

Type Parameters:

IN - The type of the incoming elements.

OUT - The type of elements emitted by the WindowFunction.

W - The type of Window that the WindowAssigner assigns.

All Implemented Interfaces:

Serializable, org.apache.flink.api.java.typeutils.InputTypeConfigurable, OneInputStreamOperator<IN,OUT>, OutputTypeConfigurable<OUT>, StreamOperator<OUT>, Triggerable

Direct Known Subclasses:

EvictingNonKeyedWindowOperator

public class NonKeyedWindowOperator<IN,OUT,W extends Window>
extends AbstractUdfStreamOperator<OUT,AllWindowFunction<IN,OUT,W>>
implements OneInputStreamOperator<IN,OUT>, Triggerable, org.apache.flink.api.java.typeutils.InputTypeConfigurable

Window operator for non-keyed windows.

See Also:

WindowOperator, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	NonKeyedWindowOperator.Context The Context is responsible for keeping track of the state of one pane.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	currentWatermark To keep track of the current watermark so that we can immediately fire if a trigger registers an event time callback for a timestamp that lies in the past.
protected TimestampedCollector<OUT>	timestampedCollector This is given to the WindowFunction for emitting elements with a given timestamp.
protected Map<W,NonKeyedWindowOperator.Context>	windows The windows (panes) that are currently in-flight.

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

userFunction

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

chainingStrategy, output

Constructor Summary

Constructors

Constructor and Description
NonKeyedWindowOperator(WindowAssigner<? super IN,W> windowAssigner, TypeSerializer<W> windowSerializer, WindowBufferFactory<? super IN,? extends WindowBuffer<IN>> windowBufferFactory, AllWindowFunction<IN,OUT,W> windowFunction, Trigger<? super IN,? super W> trigger) Creates a new WindowOperator based on the given policies and user functions.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() This method is called after all records have been added to the operators via the methods OneInputStreamOperator.processElement(StreamRecord), or TwoInputStreamOperator.processElement1(StreamRecord) and TwoInputStreamOperator.processElement2(StreamRecord).
protected void	emitWindow(NonKeyedWindowOperator.Context context)
NonKeyedWindowOperator<IN,OUT,W>	enableSetProcessingTime(boolean setProcessingTime) When this flag is enabled the current processing time is set as the timestamp of elements upon arrival.
Trigger<? super IN,? super W>	getTrigger()
WindowAssigner<? super IN,W>	getWindowAssigner()
WindowBufferFactory<? super IN,? extends WindowBuffer<IN>>	getWindowBufferFactory()
boolean	isSetProcessingTime()
void	open() This method is called immediately before any elements are processed, it should contain the operator's initialization logic.
void	processElement(StreamRecord<IN> element) Processes one element that arrived at this operator.
void	processWatermark(Watermark mark) Processes a Watermark.
void	restoreState(StreamTaskState taskState) Restores the operator state, if this operator's execution is recovering from a checkpoint.
void	setInputType(TypeInformation<?> type, ExecutionConfig executionConfig)
StreamTaskState	snapshotOperatorState(long checkpointId, long timestamp) Called to draw a state snapshot from the operator.
void	trigger(long time) This method is invoked with the timestamp for which the trigger was scheduled.

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

dispose, getUserFunction, getUserFunctionParameters, notifyOfCompletedCheckpoint, setOutputType, setup

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

createKeyValueState, createKeyValueState, disableInputCopy, getChainingStrategy, getContainingTask, getExecutionConfig, getOperatorConfig, getRuntimeContext, getStateBackend, getUserCodeClassloader, isInputCopyingDisabled, registerTimer, setChainingStrategy, setKeyContext, setKeyContextElement

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

dispose, getChainingStrategy, isInputCopyingDisabled, notifyOfCompletedCheckpoint, setChainingStrategy, setKeyContextElement, setup

Field Detail

timestampedCollector

protected transient TimestampedCollector<OUT> timestampedCollector

This is given to the WindowFunction for emitting elements with a given timestamp.

currentWatermark

protected transient long currentWatermark

To keep track of the current watermark so that we can immediately fire if a trigger registers an event time callback for a timestamp that lies in the past.

windows

protected transient Map<W extends Window,NonKeyedWindowOperator.Context> windows

The windows (panes) that are currently in-flight. Each pane has a WindowBuffer and a TriggerContext that stores the Trigger for that pane.

Constructor Detail

NonKeyedWindowOperator

public NonKeyedWindowOperator(WindowAssigner<? super IN,W> windowAssigner,
                      TypeSerializer<W> windowSerializer,
                      WindowBufferFactory<? super IN,? extends WindowBuffer<IN>> windowBufferFactory,
                      AllWindowFunction<IN,OUT,W> windowFunction,
                      Trigger<? super IN,? super W> trigger)

Creates a new WindowOperator based on the given policies and user functions.

Method Detail

setInputType

public final void setInputType(TypeInformation<?> type,
                ExecutionConfig executionConfig)

Specified by:

setInputType in interface org.apache.flink.api.java.typeutils.InputTypeConfigurable

open

public final 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.

The default implementation does nothing.

Specified by:

open in interface StreamOperator<OUT>

Overrides:

open in class AbstractUdfStreamOperator<OUT,AllWindowFunction<IN,OUT,W extends Window>>

Throws:

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

close

public final void close()
                 throws Exception

Description copied from class: AbstractStreamOperator

This method is called after all records have been added to the operators via the methods OneInputStreamOperator.processElement(StreamRecord), or TwoInputStreamOperator.processElement1(StreamRecord) and TwoInputStreamOperator.processElement2(StreamRecord).

The method is expected to flush all remaining buffered data. Exceptions during this flushing of buffered should be propagated, in order to cause the operation to be recognized asa failed, because the last data items are not processed properly.

Specified by:

close in interface StreamOperator<OUT>

Overrides:

close in class AbstractUdfStreamOperator<OUT,AllWindowFunction<IN,OUT,W extends Window>>

Throws:

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

processElement

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

Description copied from interface: OneInputStreamOperator

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

Specified by:

processElement in interface OneInputStreamOperator<IN,OUT>

Throws:

Exception

emitWindow

protected void emitWindow(NonKeyedWindowOperator.Context context)
                   throws Exception

Throws:

Exception

processWatermark

public final void processWatermark(Watermark mark)
                            throws Exception

Description copied from interface: OneInputStreamOperator

Processes a Watermark. This method is guaranteed to not be called concurrently with other methods of the operator.

Specified by:

processWatermark in interface OneInputStreamOperator<IN,OUT>

Throws:

Exception

See Also:

Watermark

trigger

public final void trigger(long time)
                   throws Exception

Description copied from interface: Triggerable

This method is invoked with the timestamp for which the trigger was scheduled.

If the triggering is delayed for whatever reason (trigger timer was blocked, JVM stalled due to a garbage collection), the timestamp supplied to this function will still be the original timestamp for which the trigger was scheduled.

Specified by:

trigger in interface Triggerable

Parameters:

time - The timestamp for which the trigger event was scheduled.

Throws:

Exception

enableSetProcessingTime

public NonKeyedWindowOperator<IN,OUT,W> enableSetProcessingTime(boolean setProcessingTime)

When this flag is enabled the current processing time is set as the timestamp of elements upon arrival. This must be used, for example, when using the TimeEvictor with processing time semantics.

snapshotOperatorState

public StreamTaskState snapshotOperatorState(long checkpointId,
                                    long timestamp)
                                      throws Exception

Description copied from interface: StreamOperator

Called to draw a state snapshot from the operator. This method snapshots the operator state (if the operator is stateful) and the key/value state (if it is being used and has been initialized).

Specified by:

snapshotOperatorState in interface StreamOperator<OUT>

Overrides:

snapshotOperatorState in class AbstractUdfStreamOperator<OUT,AllWindowFunction<IN,OUT,W extends Window>>

Parameters:

checkpointId - The ID of the checkpoint.

timestamp - The timestamp of the checkpoint.

Returns:

The StreamTaskState object, possibly containing the snapshots for the operator and key/value state.

Throws:

Exception - Forwards exceptions that occur while drawing snapshots from the operator and the key/value state.

restoreState

public void restoreState(StreamTaskState taskState)
                  throws Exception

Description copied from interface: StreamOperator

Restores the operator state, if this operator's execution is recovering from a checkpoint. This method restores the operator state (if the operator is stateful) and the key/value state (if it had been used and was initialized when the snapshot ocurred).

This method is called after StreamOperator.setup(StreamTask, StreamConfig, Output) and before StreamOperator.open().

Specified by:

restoreState in interface StreamOperator<OUT>

Overrides:

restoreState in class AbstractUdfStreamOperator<OUT,AllWindowFunction<IN,OUT,W extends Window>>

Parameters:

taskState - The state of operator that was snapshotted as part of checkpoint from which the execution is restored.

Throws:

Exception - Exceptions during state restore should be forwarded, so that the system can properly react to failed state restore and fail the execution attempt.

isSetProcessingTime

public boolean isSetProcessingTime()

getTrigger

public Trigger<? super IN,? super W> getTrigger()

getWindowAssigner

public WindowAssigner<? super IN,W> getWindowAssigner()

getWindowBufferFactory

public WindowBufferFactory<? super IN,? extends WindowBuffer<IN>> getWindowBufferFactory()