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

Class InternalAggregateProcessAllWindowFunction<T,ACC,V,R,W extends Window>

java.lang.Object

org.apache.flink.api.common.functions.AbstractRichFunction

org.apache.flink.api.java.operators.translation.WrappingFunction<ProcessAllWindowFunction<V,R,W>>

org.apache.flink.streaming.runtime.operators.windowing.functions.InternalAggregateProcessAllWindowFunction<T,ACC,V,R,W>

Type Parameters:

W - The window type

T - The type of the input to the AggregateFunction

ACC - The type of the AggregateFunction's accumulator

V - The type of the AggregateFunction's result, and the input to the WindowFunction

R - The result type of the WindowFunction

All Implemented Interfaces:

Serializable, Function, RichFunction, InternalWindowFunction<Iterable<T>,R,Byte,W>

public final class InternalAggregateProcessAllWindowFunction<T,ACC,V,R,W extends Window>
extends WrappingFunction<ProcessAllWindowFunction<V,R,W>>
implements InternalWindowFunction<Iterable<T>,R,Byte,W>

Internal window function for wrapping a ProcessAllWindowFunction that takes an Iterable and an AggregateFunction.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.streaming.runtime.operators.windowing.functions.InternalWindowFunction

InternalWindowFunction.InternalWindowContext

Field Summary

Fields inherited from class org.apache.flink.api.java.operators.translation.WrappingFunction

wrappedFunction

Constructor Summary

Constructors

Constructor and Description
InternalAggregateProcessAllWindowFunction(AggregateFunction<T,ACC,V> aggFunction, ProcessAllWindowFunction<V,R,W> windowFunction)

Method Summary

Modifier and Type	Method and Description
void	clear(W window, InternalWindowFunction.InternalWindowContext context) Deletes any state in the Context when the Window expires (the watermark passes its maxTimestamp + allowedLateness).
IterationRuntimeContext	getIterationRuntimeContext() Gets a specialized version of the RuntimeContext, which has additional information about the iteration in which the function is executed.
RuntimeContext	getRuntimeContext() Gets the context that contains information about the UDF's runtime, such as the parallelism of the function, the subtask index of the function, or the name of the task that executes the function.
void	open(Configuration parameters) Initialization method for the function.
void	process(Byte key, W window, InternalWindowFunction.InternalWindowContext context, Iterable<T> input, Collector<R> out) Evaluates the window and outputs none or several elements.

Methods inherited from class org.apache.flink.api.java.operators.translation.WrappingFunction

close, getWrappedFunction, setRuntimeContext

Methods inherited from class java.lang.Object

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

Constructor Detail

InternalAggregateProcessAllWindowFunction

public InternalAggregateProcessAllWindowFunction(AggregateFunction<T,ACC,V> aggFunction,
                                                 ProcessAllWindowFunction<V,R,W> windowFunction)

Method Detail

open

public void open(Configuration parameters)
          throws Exception

Description copied from interface: RichFunction

Initialization method for the function. It is called before the actual working methods (like map or join) and thus suitable for one time setup work. For functions that are part of an iteration, this method will be invoked at the beginning of each iteration superstep.

The configuration object passed to the function can be used for configuration and initialization. The configuration contains all parameters that were configured on the function in the program composition.

 public class MyFilter extends RichFilterFunction<String> {

     private String searchString;

     public void open(Configuration parameters) {
         this.searchString = parameters.getString("foo");
     }

     public boolean filter(String value) {
         return value.equals(searchString);
     }
 }
 

By default, this method does nothing.

Specified by:

open in interface RichFunction

Overrides:

open in class WrappingFunction<ProcessAllWindowFunction<V,R,W extends Window>>

Parameters:

parameters - The configuration containing the parameters attached to the contract.

Throws:

Exception - Implementations may forward exceptions, which are caught by the runtime. When the runtime catches an exception, it aborts the task and lets the fail-over logic decide whether to retry the task execution.

See Also:

Configuration

process

public void process(Byte key,
                    W window,
                    InternalWindowFunction.InternalWindowContext context,
                    Iterable<T> input,
                    Collector<R> out)
             throws Exception

Description copied from interface: InternalWindowFunction

Evaluates the window and outputs none or several elements.

Specified by:

process in interface InternalWindowFunction<Iterable<T>,R,Byte,W extends Window>

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

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

Description copied from interface: InternalWindowFunction

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

Specified by:

clear in interface InternalWindowFunction<Iterable<T>,R,Byte,W extends Window>

context - The context to which the window is being evaluated

Throws:

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

getRuntimeContext

public RuntimeContext getRuntimeContext()

Description copied from interface: RichFunction

Gets the context that contains information about the UDF's runtime, such as the parallelism of the function, the subtask index of the function, or the name of the task that executes the function.

The RuntimeContext also gives access to the Accumulators and the DistributedCache.

Specified by:

getRuntimeContext in interface RichFunction

Overrides:

getRuntimeContext in class AbstractRichFunction

Returns:

The UDF's runtime context.

getIterationRuntimeContext

public IterationRuntimeContext getIterationRuntimeContext()

Description copied from interface: RichFunction

Gets a specialized version of the RuntimeContext, which has additional information about the iteration in which the function is executed. This IterationRuntimeContext is only available if the function is part of an iteration. Otherwise, this method throws an exception.

Specified by:

getIterationRuntimeContext in interface RichFunction

Overrides:

getIterationRuntimeContext in class AbstractRichFunction

Returns:

The IterationRuntimeContext.