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

Class EvictingWindowOperator<K,IN,OUT,W extends Window>

java.lang.Object

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

org.apache.flink.streaming.api.operators.AbstractUdfStreamOperator<OUT,InternalWindowFunction<ACC,OUT,K,W>>

org.apache.flink.streaming.runtime.operators.windowing.WindowOperator<K,IN,Iterable<IN>,OUT,W>

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

Type Parameters:

K - The type of key returned by the KeySelector.

IN - The type of the incoming elements.

OUT - The type of elements emitted by the InternalWindowFunction.

W - The type of Window that the WindowAssigner assigns.

All Implemented Interfaces:

Serializable, CheckpointListener, Input<IN>, KeyContext, KeyContextHandler, OneInputStreamOperator<IN,OUT>, OutputTypeConfigurable<OUT>, StreamOperator<OUT>, StreamOperatorStateHandler.CheckpointedStreamOperator, Triggerable<K,W>, UserFunctionProvider<InternalWindowFunction<Iterable<IN>,OUT,K,W>>, YieldingOperator<OUT>

@Internal
public class EvictingWindowOperator<K,IN,OUT,W extends Window>
extends WindowOperator<K,IN,Iterable<IN>,OUT,W>

A WindowOperator that also allows an Evictor to be used.

The Evictor is used to remove elements from a pane before/after the evaluation of InternalWindowFunction and after the window evaluation gets triggered by a Trigger.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.streaming.runtime.operators.windowing.WindowOperator

WindowOperator.AbstractPerWindowStateStore, WindowOperator.Context, WindowOperator.MergingWindowStateStore, WindowOperator.PerWindowStateStore, WindowOperator.Timer<K,W extends Window>, WindowOperator.WindowContext

Field Summary

Fields inherited from class org.apache.flink.streaming.runtime.operators.windowing.WindowOperator

allowedLateness, internalTimerService, keySerializer, lateDataOutputTag, numLateRecordsDropped, processContext, timestampedCollector, triggerContext, windowAssigner, windowAssignerContext, windowSerializer

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

EvictingWindowOperator(WindowAssigner<? super IN,W> windowAssigner, TypeSerializer<W> windowSerializer, KeySelector<IN,K> keySelector, TypeSerializer<K> keySerializer, StateDescriptor<? extends ListState<StreamRecord<IN>>,?> windowStateDescriptor, InternalWindowFunction<Iterable<IN>,OUT,K,W> windowFunction, Trigger<? super IN,? super W> trigger, Evictor<? super IN,? super W> evictor, long allowedLateness, OutputTag<IN> lateDataOutputTag)

Method Summary

Modifier and Type	Method	Description
void	close()	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.
Evictor<? super IN,? super W>	getEvictor()
StateDescriptor<? extends AppendingState<IN,Iterable<IN>>,?>	getStateDescriptor()
void	onEventTime(InternalTimer<K,W> timer)	Invoked when an event-time timer fires.
void	onProcessingTime(InternalTimer<K,W> timer)	Invoked when a processing-time timer fires.
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.runtime.operators.windowing.WindowOperator

deleteCleanupTimer, getKeySelector, getMergingWindowSet, getOperatorAttributes, getTrigger, getWindowAssigner, isCleanupTime, isElementLate, isWindowLate, registerCleanupTimer, setProcessingTimeService, setup, sideOutput

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

finish, getUserFunction, getUserFunctionParameters, initializeState, notifyCheckpointAborted, notifyCheckpointComplete, setOutputType, 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, 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

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

Constructor Detail

EvictingWindowOperator

public EvictingWindowOperator(WindowAssigner<? super IN,W> windowAssigner,
                              TypeSerializer<W> windowSerializer,
                              KeySelector<IN,K> keySelector,
                              TypeSerializer<K> keySerializer,
                              StateDescriptor<? extends ListState<StreamRecord<IN>>,?> windowStateDescriptor,
                              InternalWindowFunction<Iterable<IN>,OUT,K,W> windowFunction,
                              Trigger<? super IN,? super W> trigger,
                              Evictor<? super IN,? super W> evictor,
                              long allowedLateness,
                              OutputTag<IN> lateDataOutputTag)

Method Detail

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<K>

Overrides:

processElement in class WindowOperator<K,IN,Iterable<IN>,OUT,W extends Window>

Throws:

Exception

onEventTime

public void onEventTime(InternalTimer<K,W> timer)
                 throws Exception

Description copied from interface: Triggerable

Invoked when an event-time timer fires.

Specified by:

onEventTime in interface Triggerable<K,IN>

Overrides:

onEventTime in class WindowOperator<K,IN,Iterable<IN>,OUT,W extends Window>

Throws:

Exception

onProcessingTime

public void onProcessingTime(InternalTimer<K,W> timer)
                      throws Exception

Description copied from interface: Triggerable

Invoked when a processing-time timer fires.

Specified by:

onProcessingTime in interface Triggerable<K,IN>

Overrides:

onProcessingTime in class WindowOperator<K,IN,Iterable<IN>,OUT,W extends Window>

Throws:

Exception

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<K>

Overrides:

open in class WindowOperator<K,IN,Iterable<IN>,OUT,W extends Window>

Throws:

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

close

public void close()
           throws Exception

Description copied from interface: StreamOperator

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.

NOTE:It can not emit any records! If you need to emit records at the end of processing, do so in the StreamOperator.finish() method.

Specified by:

close in interface StreamOperator<K>

Overrides:

close in class WindowOperator<K,IN,Iterable<IN>,OUT,W extends Window>

Throws:

Exception

getEvictor

@VisibleForTesting
public Evictor<? super IN,? super W> getEvictor()

getStateDescriptor

@VisibleForTesting
public StateDescriptor<? extends AppendingState<IN,Iterable<IN>>,?> getStateDescriptor()

Overrides:

getStateDescriptor in class WindowOperator<K,IN,Iterable<IN>,OUT,W extends Window>