Package org.apache.flink.api.common.functions

Class RichCrossFunction<IN1,IN2,OUT>

java.lang.Object

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

org.apache.flink.api.common.functions.RichCrossFunction<IN1,IN2,OUT>

Type Parameters:

IN1 - The type of the elements in the first input.

IN2 - The type of the elements in the second input.

OUT - The type of the result elements.

All Implemented Interfaces:

Serializable, CrossFunction<IN1,IN2,OUT>, Function, RichFunction

@Public
public abstract class RichCrossFunction<IN1,IN2,OUT>
extends AbstractRichFunction
implements CrossFunction<IN1,IN2,OUT>

Rich variant of the CrossFunction. As a RichFunction, it gives access to the RuntimeContext and provides setup and teardown methods: RichFunction.open(OpenContext) and RichFunction.close().

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
RichCrossFunction()

Method Summary

Modifier and Type	Method	Description
abstract OUT	cross(IN1 first, IN2 second)	Cross UDF method.

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

RichCrossFunction

public RichCrossFunction()

Method Detail

cross

public abstract OUT cross(IN1 first,
                          IN2 second)
                   throws Exception

Description copied from interface: CrossFunction

Cross UDF method. Called once per pair of elements in the Cartesian product of the inputs.

Specified by:

cross in interface CrossFunction<IN1,IN2,OUT>

Parameters:

first - Element from first input.

second - Element from the second input.

Returns:

The result element.

Throws:

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