Package org.apache.flink.runtime.operators.sort

Class AbstractMergeOuterJoinIterator<T1,T2,O>

java.lang.Object

org.apache.flink.runtime.operators.sort.AbstractMergeIterator<T1,T2,O>

org.apache.flink.runtime.operators.sort.AbstractMergeOuterJoinIterator<T1,T2,O>

All Implemented Interfaces:

JoinTaskIterator<T1,T2,O>

Direct Known Subclasses:

NonReusingMergeOuterJoinIterator, ReusingMergeOuterJoinIterator

public abstract class AbstractMergeOuterJoinIterator<T1,T2,O>
extends AbstractMergeIterator<T1,T2,O>

An implementation of the JoinTaskIterator that realizes the outer join through a sort-merge join strategy.

Field Summary

Fields inherited from class org.apache.flink.runtime.operators.sort.AbstractMergeIterator

blockHeadCopy, copy1, copy2, iterator1, iterator2, pairComparator, serializer1, serializer2, spillHeadCopy

Constructor Summary

Constructors

Constructor

Description

AbstractMergeOuterJoinIterator(OuterJoinOperatorBase.OuterJoinType outerJoinType, MutableObjectIterator<T1> input1, MutableObjectIterator<T2> input2, TypeSerializer<T1> serializer1, TypeComparator<T1> comparator1, TypeSerializer<T2> serializer2, TypeComparator<T2> comparator2, TypePairComparator<T1,T2> pairComparator, MemoryManager memoryManager, IOManager ioManager, int numMemoryPages, AbstractInvokable parentTask)

Method Summary

Modifier and Type	Method	Description
boolean	callWithNextKey(FlatJoinFunction<T1,T2,O> joinFunction, Collector<O> collector)	Calls the JoinFunction#join() method for all two key-value pairs that share the same key and come from different inputs.

Methods inherited from class org.apache.flink.runtime.operators.sort.AbstractMergeIterator

abort, close, createCopy, createKeyGroupedIterator, crossMatchingGroup, open

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMergeOuterJoinIterator

public AbstractMergeOuterJoinIterator(OuterJoinOperatorBase.OuterJoinType outerJoinType,
                                      MutableObjectIterator<T1> input1,
                                      MutableObjectIterator<T2> input2,
                                      TypeSerializer<T1> serializer1,
                                      TypeComparator<T1> comparator1,
                                      TypeSerializer<T2> serializer2,
                                      TypeComparator<T2> comparator2,
                                      TypePairComparator<T1,T2> pairComparator,
                                      MemoryManager memoryManager,
                                      IOManager ioManager,
                                      int numMemoryPages,
                                      AbstractInvokable parentTask)
                               throws MemoryAllocationException

Throws:

MemoryAllocationException

Method Detail

callWithNextKey

public boolean callWithNextKey(FlatJoinFunction<T1,T2,O> joinFunction,
                               Collector<O> collector)
                        throws Exception

Calls the JoinFunction#join() method for all two key-value pairs that share the same key and come from different inputs. Furthermore, depending on the outer join type (LEFT, RIGHT, FULL), all key-value pairs where no matching partner from the other input exists are joined with null. The output of the join() method is forwarded.

Specified by:

callWithNextKey in interface JoinTaskIterator<T1,T2,O>

Specified by:

callWithNextKey in class AbstractMergeIterator<T1,T2,O>

Parameters:

joinFunction - The match stub containing the match function which is called with the keys.

collector - The collector to pass the match function.

Returns:

True, if a next key exists, false if no more keys exist.

Throws:

Exception - Forwards all exceptions from the user code and the I/O system.

See Also:

JoinTaskIterator.callWithNextKey(org.apache.flink.api.common.functions.FlatJoinFunction, org.apache.flink.util.Collector)