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

Class ProcTimeBoundedStreamJoin

java.lang.Object

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

org.apache.flink.streaming.api.functions.co.CoProcessFunction<BaseRow,BaseRow,BaseRow>

org.apache.flink.table.runtime.operators.join.ProcTimeBoundedStreamJoin

All Implemented Interfaces:

Serializable, Function, RichFunction

public final class ProcTimeBoundedStreamJoin
extends CoProcessFunction<BaseRow,BaseRow,BaseRow>

The function to execute processing time bounded stream inner-join.

See Also:

Serialized Form

Nested Class Summary

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

CoProcessFunction.Context, CoProcessFunction.OnTimerContext

Field Summary

Fields

Modifier and Type	Field and Description
protected long	allowedLateness
protected long	leftOperatorTime
protected long	leftRelativeSize
protected long	rightOperatorTime
protected long	rightRelativeSize

Constructor Summary

Constructors

Constructor and Description
ProcTimeBoundedStreamJoin(FlinkJoinType joinType, long leftLowerBound, long leftUpperBound, BaseRowTypeInfo leftType, BaseRowTypeInfo rightType, GeneratedFunction<FlatJoinFunction<BaseRow,BaseRow,BaseRow>> genJoinFunc)

Method Summary

Modifier and Type	Method and Description
void	onTimer(long timestamp, CoProcessFunction.OnTimerContext ctx, Collector<BaseRow> out) Called when a timer set using TimerService fires.
void	open(Configuration parameters) Initialization method for the function.
void	processElement1(BaseRow leftRow, CoProcessFunction.Context ctx, Collector<BaseRow> out) This method is called for each element in the first of the connected streams.
void	processElement2(BaseRow rightRow, CoProcessFunction.Context ctx, Collector<BaseRow> out) This method is called for each element in the second of the connected streams.

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

Field Detail

leftRelativeSize

protected final long leftRelativeSize

rightRelativeSize

protected final long rightRelativeSize

allowedLateness

protected final long allowedLateness

leftOperatorTime

protected long leftOperatorTime

rightOperatorTime

protected long rightOperatorTime

Constructor Detail

ProcTimeBoundedStreamJoin

public ProcTimeBoundedStreamJoin(FlinkJoinType joinType,
                                 long leftLowerBound,
                                 long leftUpperBound,
                                 BaseRowTypeInfo leftType,
                                 BaseRowTypeInfo rightType,
                                 GeneratedFunction<FlatJoinFunction<BaseRow,BaseRow,BaseRow>> genJoinFunc)

Method Detail

open

public void open(Configuration parameters)
          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 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 MyFilter extends RichFilterFunction<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.

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.

See Also:

Configuration

processElement1

public void processElement1(BaseRow leftRow,
                            CoProcessFunction.Context ctx,
                            Collector<BaseRow> out)
                     throws Exception

Description copied from class: CoProcessFunction

This method is called for each element in the first of the connected streams.

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

Specified by:

processElement1 in class CoProcessFunction<BaseRow,BaseRow,BaseRow>

Parameters:

leftRow - The stream element

ctx - A CoProcessFunction.Context that allows querying the timestamp of the element, querying the TimeDomain of the firing timer 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 to emit resulting elements to

Throws:

Exception - The function may throw exceptions which cause the streaming program to fail and go into recovery.

processElement2

public void processElement2(BaseRow rightRow,
                            CoProcessFunction.Context ctx,
                            Collector<BaseRow> out)
                     throws Exception

Description copied from class: CoProcessFunction

This method is called for each element in the second of the connected streams.

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

Specified by:

processElement2 in class CoProcessFunction<BaseRow,BaseRow,BaseRow>

Parameters:

rightRow - The stream element

ctx - A CoProcessFunction.Context that allows querying the timestamp of the element, querying the TimeDomain of the firing timer 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 to emit resulting elements to

Throws:

Exception - The function may throw exceptions which cause the streaming program to fail and go into recovery.

onTimer

public void onTimer(long timestamp,
                    CoProcessFunction.OnTimerContext ctx,
                    Collector<BaseRow> out)
             throws Exception

Description copied from class: CoProcessFunction

Called when a timer set using TimerService fires.

Overrides:

onTimer in class CoProcessFunction<BaseRow,BaseRow,BaseRow>

Parameters:

timestamp - The timestamp of the firing timer.

ctx - An CoProcessFunction.OnTimerContext that allows querying the timestamp of the firing timer, querying the TimeDomain of the firing timer 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.