org.apache.flink.table.runtime.operators.window.internal

Class InternalWindowProcessFunction<K,W extends Window>

java.lang.Object

org.apache.flink.table.runtime.operators.window.internal.InternalWindowProcessFunction<K,W>

Type Parameters:

W - type of window

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

GeneralWindowProcessFunction, MergingWindowProcessFunction, PanedWindowProcessFunction

public abstract class InternalWindowProcessFunction<K,W extends Window>
extends Object
implements Serializable

The internal interface for functions that process over grouped windows.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	InternalWindowProcessFunction.Context<K,W extends Window> Information available in an invocation of methods of InternalWindowProcessFunction.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	allowedLateness
protected InternalWindowProcessFunction.Context<K,W>	ctx
protected NamespaceAggsHandleFunction<W>	windowAggregator
protected WindowAssigner<W>	windowAssigner

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InternalWindowProcessFunction(WindowAssigner<W> windowAssigner, NamespaceAggsHandleFunction<W> windowAggregator, long allowedLateness)

Method Summary

Modifier and Type	Method and Description
abstract Collection<W>	assignActualWindows(BaseRow inputRow, long timestamp) Assigns the input element into the actual windows which the Trigger should trigger on.
abstract Collection<W>	assignStateNamespace(BaseRow inputRow, long timestamp) Assigns the input element into the state namespace which the input element should be accumulated/retracted into.
abstract void	cleanWindowIfNeeded(W window, long currentTime) Cleans the given window if needed.
void	close() The tear-down method of the function.
abstract BaseRow	getWindowAggregationResult(W window) Gets the aggregation result and window properties of the given window.
protected boolean	isCleanupTime(W window, long time) Returns true if the given time is the cleanup time for the given window.
protected boolean	isWindowLate(W window) Returns true if the watermark is after the end timestamp plus the allowed lateness of the given window.
void	open(InternalWindowProcessFunction.Context<K,W> ctx) Initialization method for the function.

Methods inherited from class java.lang.Object

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

Field Detail

windowAssigner

protected final WindowAssigner<W extends Window> windowAssigner

windowAggregator

protected final NamespaceAggsHandleFunction<W extends Window> windowAggregator

allowedLateness

protected final long allowedLateness

ctx

protected InternalWindowProcessFunction.Context<K,W extends Window> ctx

Constructor Detail

InternalWindowProcessFunction

protected InternalWindowProcessFunction(WindowAssigner<W> windowAssigner,
                                        NamespaceAggsHandleFunction<W> windowAggregator,
                                        long allowedLateness)

Method Detail

open

public void open(InternalWindowProcessFunction.Context<K,W> ctx)
          throws Exception

Initialization method for the function. It is called before the actual working methods.

Throws:

Exception

assignStateNamespace

public abstract Collection<W> assignStateNamespace(BaseRow inputRow,
                                                   long timestamp)
                                            throws Exception

Assigns the input element into the state namespace which the input element should be accumulated/retracted into.

Parameters:

inputRow - the input element

timestamp - the timestamp of the element or the processing time (depends on the type of assigner)

Returns:

the state namespace

Throws:

Exception

assignActualWindows

public abstract Collection<W> assignActualWindows(BaseRow inputRow,
                                                  long timestamp)
                                           throws Exception

Assigns the input element into the actual windows which the Trigger should trigger on.

Parameters:

inputRow - the input element

timestamp - the timestamp of the element or the processing time (depends on the type of assigner)

Returns:

the actual windows

Throws:

Exception

getWindowAggregationResult

public abstract BaseRow getWindowAggregationResult(W window)
                                            throws Exception

Gets the aggregation result and window properties of the given window.

Parameters:

window - the window

Returns:

the aggregation result and window properties

Throws:

Exception

cleanWindowIfNeeded

public abstract void cleanWindowIfNeeded(W window,
                                         long currentTime)
                                  throws Exception

Cleans the given window if needed.

Parameters:

window - the window to cleanup

currentTime - the current timestamp

Throws:

Exception

close

public void close()
           throws Exception

The tear-down method of the function. It is called after the last call to the main working methods.

Throws:

Exception

isCleanupTime

protected final boolean isCleanupTime(W window,
                                      long time)

Returns true if the given time is the cleanup time for the given window.

isWindowLate

protected boolean isWindowLate(W window)

Returns true if the watermark is after the end timestamp plus the allowed lateness of the given window.