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, org.apache.flink.api.java.typeutils.InputTypeConfigurable, OneInputStreamOperator<IN,OUT>, OutputTypeConfigurable<OUT>, StreamOperator<OUT>, Triggerable

@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 evict elements from panes before processing a window and after a Trigger has fired.

See Also:

Serialized Form

Nested Class Summary

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

WindowOperator.Context, WindowOperator.Timer<K,W extends Window>

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.runtime.operators.windowing.WindowOperator

allowedLateness, context, currentWatermark, inputSerializer, keySelector, keySerializer, mergingWindowsByKey, processingTimeTimerFutures, processingTimeTimers, processingTimeTimersQueue, processingTimeTimerTimestamps, timestampedCollector, trigger, watermarkTimers, watermarkTimersQueue, 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

chainingStrategy, LOG, metrics, output

Constructor Summary

Constructors

Constructor and Description

EvictingWindowOperator(WindowAssigner<? super IN,W> windowAssigner, org.apache.flink.api.common.typeutils.TypeSerializer<W> windowSerializer, org.apache.flink.api.java.functions.KeySelector<IN,K> keySelector, org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer, org.apache.flink.api.common.state.StateDescriptor<? extends org.apache.flink.api.common.state.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)

Method Summary

Modifier and Type	Method and Description
Evictor<? super IN,? super W>	getEvictor()
org.apache.flink.api.common.state.StateDescriptor<? extends org.apache.flink.api.common.state.AppendingState<IN,Iterable<IN>>,?>	getStateDescriptor()
void	processElement(StreamRecord<IN> element) Processes one element that arrived at this operator.
void	processWatermark(Watermark mark) Processes a Watermark.
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.runtime.operators.windowing.WindowOperator

close, deleteCleanupTimer, dispose, getKeySelector, getMergingWindowSet, getTrigger, getWindowAssigner, isCleanupTime, isLate, open, registerCleanupTimer, restoreState, setInputType, snapshotOperatorState

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, toString, wait, wait, wait

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

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

Constructor Detail

EvictingWindowOperator

public EvictingWindowOperator(WindowAssigner<? super IN,W> windowAssigner,
                              org.apache.flink.api.common.typeutils.TypeSerializer<W> windowSerializer,
                              org.apache.flink.api.java.functions.KeySelector<IN,K> keySelector,
                              org.apache.flink.api.common.typeutils.TypeSerializer<K> keySerializer,
                              org.apache.flink.api.common.state.StateDescriptor<? extends org.apache.flink.api.common.state.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)

Method Detail

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>

Overrides:

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

Throws:

Exception

processWatermark

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

Overrides:

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

Throws:

Exception

See Also:

Watermark

trigger

public 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

Overrides:

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

Parameters:

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

Throws:

Exception

getEvictor

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

getStateDescriptor

public org.apache.flink.api.common.state.StateDescriptor<? extends org.apache.flink.api.common.state.AppendingState<IN,Iterable<IN>>,?> getStateDescriptor()

Overrides:

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