org.apache.flink.table.runtime

Class MapSideJoinRunner<IN1,IN2,SINGLE_IN,MULTI_IN,OUT>

java.lang.Object

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

org.apache.flink.api.common.functions.RichFlatMapFunction<MULTI_IN,OUT>

org.apache.flink.table.runtime.MapSideJoinRunner<IN1,IN2,SINGLE_IN,MULTI_IN,OUT>

All Implemented Interfaces:

Serializable, FlatMapFunction<MULTI_IN,OUT>, Function, RichFunction, ResultTypeQueryable<OUT>, Compiler<FlatJoinFunction<IN1,IN2,OUT>>, Logging

Direct Known Subclasses:

MapJoinLeftRunner, MapJoinRightRunner

public abstract class MapSideJoinRunner<IN1,IN2,SINGLE_IN,MULTI_IN,OUT>
extends RichFlatMapFunction<MULTI_IN,OUT>
implements ResultTypeQueryable<OUT>, Compiler<FlatJoinFunction<IN1,IN2,OUT>>, Logging

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MapSideJoinRunner(String name, String code, TypeInformation<OUT> returnType, String broadcastSetName)

Method Summary

Modifier and Type	Method and Description
protected scala.Option<SINGLE_IN>	broadcastSet()
protected FlatJoinFunction<IN1,IN2,OUT>	function()
TypeInformation<OUT>	getProducedType() Gets the data type (as a TypeInformation) produced by this function or input format.
void	open(Configuration parameters) Initialization method for the function.
TypeInformation<OUT>	returnType()

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

flatMap

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

close, getIterationRuntimeContext, getRuntimeContext, setRuntimeContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.table.codegen.Compiler

compile

Methods inherited from interface org.apache.flink.table.util.Logging

LOG

Constructor Detail

MapSideJoinRunner

public MapSideJoinRunner(String name,
                         String code,
                         TypeInformation<OUT> returnType,
                         String broadcastSetName)

Method Detail

returnType

public TypeInformation<OUT> returnType()

function

protected FlatJoinFunction<IN1,IN2,OUT> function()

broadcastSet

protected scala.Option<SINGLE_IN> broadcastSet()

open

public void open(Configuration parameters)

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 MyMapper extends FilterFunction<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 AbstractRichFunction

Parameters:

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

See Also:

Configuration

getProducedType

public TypeInformation<OUT> getProducedType()

Description copied from interface: ResultTypeQueryable

Gets the data type (as a TypeInformation) produced by this function or input format.

Specified by:

getProducedType in interface ResultTypeQueryable<OUT>

Returns:

The data type produced by this function or input format.