Package org.apache.flink.table.runtime.operators.join.lookup

Class LookupJoinRunner

java.lang.Object

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

org.apache.flink.streaming.api.functions.ProcessFunction<RowData,RowData>

org.apache.flink.table.runtime.operators.join.lookup.LookupJoinRunner

All Implemented Interfaces:

Serializable, Function, RichFunction

Direct Known Subclasses:

LookupJoinWithCalcRunner

public class LookupJoinRunner
extends ProcessFunction<RowData,RowData>

The join runner to lookup the dimension table.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.streaming.api.functions.ProcessFunction

ProcessFunction.Context, ProcessFunction.OnTimerContext

Field Summary

Fields

Modifier and Type	Field	Description
protected ListenableCollector<RowData>	collector
protected boolean	isLeftOuterJoin
protected GenericRowData	nullRow
protected JoinedRowData	outRow
protected FilterCondition	preFilterCondition
protected int	tableFieldsCount

Constructor Summary

Constructors

Constructor	Description
LookupJoinRunner(GeneratedFunction<FlatMapFunction<RowData,RowData>> generatedFetcher, GeneratedCollector<ListenableCollector<RowData>> generatedCollector, GeneratedFunction<FilterCondition> generatedPreFilterCondition, boolean isLeftOuterJoin, int tableFieldsCount)

Method Summary

Modifier and Type	Method	Description
void	close()	Tear-down method for the user code.
void	doFetch(RowData in)
Collector<RowData>	getFetcherCollector()
void	open(OpenContext openContext)	Initialization method for the function.
void	padNullForLeftJoin(RowData in, Collector<RowData> out)
boolean	preFilter(RowData in)
void	prepareCollector(RowData in, Collector<RowData> out)
void	processElement(RowData in, ProcessFunction.Context ctx, Collector<RowData> out)	Process one element from the input stream.

Methods inherited from class org.apache.flink.streaming.api.functions.ProcessFunction

onTimer

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

getIterationRuntimeContext, getRuntimeContext, setRuntimeContext

Methods inherited from class java.lang.Object

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

Field Detail

isLeftOuterJoin

protected final boolean isLeftOuterJoin

tableFieldsCount

protected final int tableFieldsCount

collector

protected transient ListenableCollector<RowData> collector

outRow

protected transient JoinedRowData outRow

preFilterCondition

protected transient FilterCondition preFilterCondition

nullRow

protected transient GenericRowData nullRow

Constructor Detail

LookupJoinRunner

public LookupJoinRunner(GeneratedFunction<FlatMapFunction<RowData,RowData>> generatedFetcher,
                        GeneratedCollector<ListenableCollector<RowData>> generatedCollector,
                        GeneratedFunction<FilterCondition> generatedPreFilterCondition,
                        boolean isLeftOuterJoin,
                        int tableFieldsCount)

Method Detail

open

public void open(OpenContext openContext)
          throws Exception

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 openContext object passed to the function can be used for configuration and initialization. The openContext contains some necessary information that were configured on the function in the program composition.

 public class MyFilter extends RichFilterFunction<String> {

     private String searchString;

     public void open(OpenContext openContext) {
         // initialize the value of searchString
     }

     public boolean filter(String value) {
         return value.equals(searchString);
     }
 }
 

Specified by:

open in interface RichFunction

Overrides:

open in class AbstractRichFunction

Parameters:

openContext - The context containing information about the context in which the function is opened.

Throws:

Exception - Implementations may forward exceptions, which are caught by the runtime. When the runtime catches an exception, it aborts the task and lets the fail-over logic decide whether to retry the task execution.

processElement

public void processElement(RowData in,
                           ProcessFunction.Context ctx,
                           Collector<RowData> out)
                    throws Exception

Description copied from class: ProcessFunction

Process one element from the input stream.

This function can output zero or more elements using the Collector parameter and also update internal state or set timers using the ProcessFunction.Context parameter.

Specified by:

processElement in class ProcessFunction<RowData,RowData>

Parameters:

in - The input value.

ctx - A ProcessFunction.Context that allows querying the timestamp of the element and getting a TimerService for registering timers and querying the time. The context is only valid during the invocation of this method, do not store it.

out - The collector for returning result values.

Throws:

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

prepareCollector

public void prepareCollector(RowData in,
                             Collector<RowData> out)

preFilter

public boolean preFilter(RowData in)
                  throws Exception

Throws:

Exception

doFetch

public void doFetch(RowData in)
             throws Exception

Throws:

Exception

padNullForLeftJoin

public void padNullForLeftJoin(RowData in,
                               Collector<RowData> out)

getFetcherCollector

public Collector<RowData> getFetcherCollector()

close

public void close()
           throws Exception

Description copied from interface: RichFunction

Tear-down method for the user code. It is called after the last call to the main working methods (e.g. map or join). For functions that are part of an iteration, this method will be invoked after each iteration superstep.

This method can be used for clean up work.

Specified by:

close in interface RichFunction

Overrides:

close in class AbstractRichFunction

Throws:

Exception - Implementations may forward exceptions, which are caught by the runtime. When the runtime catches an exception, it aborts the task and lets the fail-over logic decide whether to retry the task execution.