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

Interface InternalWindowFunction<IN,OUT,KEY,W extends Window>

Type Parameters:

IN - The type of the input value.

OUT - The type of the output value.

KEY - The type of the key.

All Superinterfaces:

Function, Serializable

All Known Implementing Classes:

InternalAggregateProcessAllWindowFunction, InternalAggregateProcessWindowFunction, InternalIterableAllWindowFunction, InternalIterableProcessAllWindowFunction, InternalIterableProcessWindowFunction, InternalIterableWindowFunction, InternalSingleValueAllWindowFunction, InternalSingleValueProcessAllWindowFunction, InternalSingleValueProcessWindowFunction, InternalSingleValueWindowFunction

public interface InternalWindowFunction<IN,OUT,KEY,W extends Window>
extends Function

Internal interface for functions that are evaluated over keyed (grouped) windows.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	InternalWindowFunction.InternalWindowContext	A context for InternalWindowFunction, similar to ProcessWindowFunction.Context but for internal use.

Method Summary

Modifier and Type	Method	Description
void	clear(W window, InternalWindowFunction.InternalWindowContext context)	Deletes any state in the Context when the Window expires (the watermark passes its maxTimestamp + allowedLateness).
void	process(KEY key, W window, InternalWindowFunction.InternalWindowContext context, IN input, Collector<OUT> out)	Evaluates the window and outputs none or several elements.

Method Detail

process

void process(KEY key,
             W window,
             InternalWindowFunction.InternalWindowContext context,
             IN input,
             Collector<OUT> out)
      throws Exception

Evaluates the window and outputs none or several elements.

Parameters:

context - The context in which the window is being evaluated.

input - The elements in the window being evaluated.

out - A collector for emitting elements.

Throws:

Exception - The function may throw exceptions to fail the program and trigger recovery.

clear

void clear(W window,
           InternalWindowFunction.InternalWindowContext context)
    throws Exception

Deletes any state in the Context when the Window expires (the watermark passes its maxTimestamp + allowedLateness).

Parameters:

context - The context to which the window is being evaluated

Throws:

Exception - The function may throw exceptions to fail the program and trigger recovery.