org.apache.flink.api.common.functions

Class RichJoinFunction<IN1,IN2,OUT>

java.lang.Object

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

org.apache.flink.api.common.functions.RichJoinFunction<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, Function, JoinFunction<IN1,IN2,OUT>, RichFunction

@Public
public abstract class RichJoinFunction<IN1,IN2,OUT>
extends AbstractRichFunction
implements JoinFunction<IN1,IN2,OUT>

Rich variant of the JoinFunction. 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
RichJoinFunction()

Method Summary

Modifier and Type	Method and Description
abstract OUT	join(IN1 first, IN2 second) The join method, called once per joined pair 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

RichJoinFunction

public RichJoinFunction()

Method Detail

join

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

Description copied from interface: JoinFunction

The join method, called once per joined pair of elements.

Specified by:

join in interface JoinFunction<IN1,IN2,OUT>

Parameters:

first - The element from first input.

second - The element from second input.

Returns:

The resulting element.

Throws:

Exception - This method may throw exceptions. Throwing an exception will cause the operation to fail and may trigger recovery.