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

Class RowTimeIntervalJoin

java.lang.Object

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

org.apache.flink.streaming.api.functions.co.KeyedCoProcessFunction<RowData,RowData,RowData,RowData>

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

All Implemented Interfaces:

Serializable, Function, RichFunction

public final class RowTimeIntervalJoin
extends KeyedCoProcessFunction<RowData,RowData,RowData,RowData>

The function to execute row(event) time interval stream inner-join.

See Also:

Serialized Form

Nested Class Summary

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

KeyedCoProcessFunction.Context, KeyedCoProcessFunction.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
RowTimeIntervalJoin(FlinkJoinType joinType, long leftLowerBound, long leftUpperBound, long allowedLateness, long minCleanUpInterval, InternalTypeInfo<RowData> leftType, InternalTypeInfo<RowData> rightType, IntervalJoinFunction joinFunc, int leftTimeIdx, int rightTimeIdx)

Method Summary

Modifier and Type	Method and Description
void	close() Tear-down method for the user code.
long	getMaxOutputDelay() Get the maximum interval between receiving a row and emitting it (as part of a joined result).
void	onTimer(long timestamp, KeyedCoProcessFunction.OnTimerContext ctx, Collector<RowData> out) Called when a timer set using TimerService fires.
void	open(OpenContext openContext) Initialization method for the function.
void	processElement1(RowData leftRow, KeyedCoProcessFunction.Context ctx, Collector<RowData> out) This method is called for each element in the first of the connected streams.
void	processElement2(RowData rightRow, KeyedCoProcessFunction.Context ctx, Collector<RowData> 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

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

RowTimeIntervalJoin

public RowTimeIntervalJoin(FlinkJoinType joinType,
                           long leftLowerBound,
                           long leftUpperBound,
                           long allowedLateness,
                           long minCleanUpInterval,
                           InternalTypeInfo<RowData> leftType,
                           InternalTypeInfo<RowData> rightType,
                           IntervalJoinFunction joinFunc,
                           int leftTimeIdx,
                           int rightTimeIdx)

Method Detail

getMaxOutputDelay

public long getMaxOutputDelay()

Get the maximum interval between receiving a row and emitting it (as part of a joined result). This is the time interval by which watermarks need to be held back.

Returns:

the maximum delay for the outputs

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.

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.

processElement1

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

Description copied from class: KeyedCoProcessFunction

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 KeyedCoProcessFunction.Context parameter.

Specified by:

processElement1 in class KeyedCoProcessFunction<RowData,RowData,RowData,RowData>

Parameters:

leftRow - The stream element

ctx - A KeyedCoProcessFunction.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(RowData rightRow,
                            KeyedCoProcessFunction.Context ctx,
                            Collector<RowData> out)
                     throws Exception

Description copied from class: KeyedCoProcessFunction

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 KeyedCoProcessFunction.Context parameter.

Specified by:

processElement2 in class KeyedCoProcessFunction<RowData,RowData,RowData,RowData>

Parameters:

rightRow - The stream element

ctx - A KeyedCoProcessFunction.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,
                    KeyedCoProcessFunction.OnTimerContext ctx,
                    Collector<RowData> out)
             throws Exception

Description copied from class: KeyedCoProcessFunction

Called when a timer set using TimerService fires.

Overrides:

onTimer in class KeyedCoProcessFunction<RowData,RowData,RowData,RowData>

Parameters:

timestamp - The timestamp of the firing timer.

ctx - An KeyedCoProcessFunction.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.