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

Class AbstractAlignedProcessingTimeWindowOperator<KEY,IN,OUT,STATE,F extends org.apache.flink.api.common.functions.Function>

java.lang.Object

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

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

org.apache.flink.streaming.runtime.operators.windowing.AbstractAlignedProcessingTimeWindowOperator<KEY,IN,OUT,STATE,F>

All Implemented Interfaces:

Serializable, OneInputStreamOperator<IN,OUT>, OutputTypeConfigurable<OUT>, StreamOperator<OUT>, Triggerable

Direct Known Subclasses:

AccumulatingProcessingTimeWindowOperator, AggregatingProcessingTimeWindowOperator

@Internal
public abstract class AbstractAlignedProcessingTimeWindowOperator<KEY,IN,OUT,STATE,F extends org.apache.flink.api.common.functions.Function>
extends AbstractUdfStreamOperator<OUT,F>
implements OneInputStreamOperator<IN,OUT>, Triggerable

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.streaming.api.operators.AbstractStreamOperator

AbstractStreamOperator.CountingOutput

Field Summary

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

userFunction

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

chainingStrategy, LOG, metrics, output

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAlignedProcessingTimeWindowOperator(F function, org.apache.flink.api.java.functions.KeySelector<IN,KEY> keySelector, org.apache.flink.api.common.typeutils.TypeSerializer<KEY> keySerializer, org.apache.flink.api.common.typeutils.TypeSerializer<STATE> stateTypeSerializer, long windowLength, long windowSlide)

Method Summary

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 abstract AbstractKeyedTimePanes<IN,KEY,STATE,OUT>	createPanes(org.apache.flink.api.java.functions.KeySelector<IN,KEY> keySelector, org.apache.flink.api.common.functions.Function function)
void	dispose() This method is called at the very end of the operator's life, both in the case of a successful completion of the operation, and in the case of a failure and canceling.
long	getNextEvaluationTime()
long	getNextSlideTime()
int	getNumPanesPerWindow()
long	getPaneSize()
long	getWindowSize()
long	getWindowSlide()
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.
StreamTaskState	snapshotOperatorState(long checkpointId, long timestamp) Called to draw a state snapshot from the operator.
String	toString()
void	trigger(long timestamp) This method is invoked with the timestamp for which the trigger was scheduled.

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

getUserFunction, getUserFunctionParameters, notifyOfCompletedCheckpoint, setOutputType, setup

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

getChainingStrategy, getContainingTask, getCurrentProcessingTime, getExecutionConfig, getMetricGroup, getOperatorConfig, getPartitionedState, getPartitionedState, getRuntimeContext, getStateBackend, getUserCodeClassloader, registerTimer, setChainingStrategy, setKeyContext, setKeyContextElement1, setKeyContextElement2

Methods inherited from class java.lang.Object

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

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

getChainingStrategy, getMetricGroup, notifyOfCompletedCheckpoint, setChainingStrategy, setKeyContextElement1, setKeyContextElement2, setup

Constructor Detail

AbstractAlignedProcessingTimeWindowOperator

protected AbstractAlignedProcessingTimeWindowOperator(F function,
                                                      org.apache.flink.api.java.functions.KeySelector<IN,KEY> keySelector,
                                                      org.apache.flink.api.common.typeutils.TypeSerializer<KEY> keySerializer,
                                                      org.apache.flink.api.common.typeutils.TypeSerializer<STATE> stateTypeSerializer,
                                                      long windowLength,
                                                      long windowSlide)

Method Detail

createPanes

protected abstract AbstractKeyedTimePanes<IN,KEY,STATE,OUT> createPanes(org.apache.flink.api.java.functions.KeySelector<IN,KEY> keySelector,
                                                                        org.apache.flink.api.common.functions.Function function)

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.

The default implementation does nothing.

Specified by:

open in interface StreamOperator<OUT>

Overrides:

open in class AbstractUdfStreamOperator<OUT,F extends org.apache.flink.api.common.functions.Function>

Throws:

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

close

public 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,F extends org.apache.flink.api.common.functions.Function>

Throws:

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

dispose

public void dispose()

Description copied from class: AbstractStreamOperator

This method is called at the very end of the operator's life, both in the case of a successful completion of the operation, and in the case of a failure and canceling. This method is expected to make a thorough effort to release all resources that the operator has acquired.

Specified by:

dispose in interface StreamOperator<OUT>

Overrides:

dispose in class AbstractUdfStreamOperator<OUT,F extends org.apache.flink.api.common.functions.Function>

processElement

public 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

processWatermark

public void processWatermark(Watermark mark)

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>

See Also:

Watermark

trigger

public void trigger(long timestamp)
             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:

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

Throws:

Exception

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,F extends org.apache.flink.api.common.functions.Function>

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 occurred).

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,F extends org.apache.flink.api.common.functions.Function>

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.

getWindowSize

public long getWindowSize()

getWindowSlide

public long getWindowSlide()

getPaneSize

public long getPaneSize()

getNumPanesPerWindow

public int getNumPanesPerWindow()

getNextEvaluationTime

public long getNextEvaluationTime()

getNextSlideTime

public long getNextSlideTime()

toString

public String toString()

Overrides:

toString in class Object