org.apache.flink.api.common.functions

Class RichGroupCombineFunction<IN,OUT>

java.lang.Object

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

org.apache.flink.api.common.functions.RichGroupCombineFunction<IN,OUT>

Type Parameters:

IN - The data type of the elements to be combined.

OUT - The resulting data type of the elements to be combined.

All Implemented Interfaces:

Serializable, Function, GroupCombineFunction<IN,OUT>, RichFunction

@Public
public abstract class RichGroupCombineFunction<IN,OUT>
extends AbstractRichFunction
implements GroupCombineFunction<IN,OUT>

Rich variant of the GroupCombineFunction. As a RichFunction, it gives access to the RuntimeContext and provides setup and teardown methods: RichFunction.open(org.apache.flink.configuration.Configuration) and RichFunction.close().

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RichGroupCombineFunction()

Method Summary

Modifier and Type	Method and Description
abstract void	combine(Iterable<IN> values, Collector<OUT> out) The combine method, called (potentially multiple timed) with subgroups of elements.

Methods inherited from class org.apache.flink.api.common.functions.AbstractRichFunction

close, getIterationRuntimeContext, getRuntimeContext, open, setRuntimeContext

Methods inherited from class java.lang.Object

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

Constructor Detail

RichGroupCombineFunction

public RichGroupCombineFunction()

Method Detail

combine

public abstract void combine(Iterable<IN> values,
                             Collector<OUT> out)
                      throws Exception

Description copied from interface: GroupCombineFunction

The combine method, called (potentially multiple timed) with subgroups of elements.

Specified by:

combine in interface GroupCombineFunction<IN,OUT>

Parameters:

values - The elements to be combined.

out - The collector to use to return values from the function.

Throws:

Exception - The function may throw Exceptions, which will cause the program to cancel, and may trigger the recovery logic.