RichFlatJoinFunction (Flink : 2.0-SNAPSHOT API)

java.lang.Object
- org.apache.flink.api.common.functions.AbstractRichFunction
- - org.apache.flink.api.common.functions.RichFlatJoinFunction<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, FlatJoinFunction<IN1,IN2,OUT>, Function, RichFunction

Direct Known Subclasses:

IntervalJoinFunction
```
@Public
public abstract class RichFlatJoinFunction<IN1,IN2,OUT>
extends AbstractRichFunction
implements FlatJoinFunction<IN1,IN2,OUT>
```
Rich variant of the FlatJoinFunction. 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

RichFlatJoinFunction()

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`abstract void`	`join(IN1 first, IN2 second, Collector<OUT> out)`	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
  - RichFlatJoinFunction
```
public RichFlatJoinFunction()
```
- Method Detail
  - join
```
public abstract void join(IN1 first,
                          IN2 second,
                          Collector<OUT> out)
                   throws Exception
```
    Description copied from interface: FlatJoinFunction
    
    The join method, called once per joined pair of elements.
    
    Specified by:
    
    join in interface FlatJoinFunction<IN1,IN2,OUT>
    
    Parameters:
    
    first - The element from first input.
    
    second - The element from second input.
    
    out - The collector used to return zero, one, or more elements.
    
    Throws:
    
    Exception - This method may throw exceptions. Throwing an exception will cause the operation to fail and may trigger recovery.