org.apache.flink.api.common.operators.base

Class CoGroupOperatorBase<IN1,IN2,OUT,FT extends CoGroupFunction<IN1,IN2,OUT>>

java.lang.Object

org.apache.flink.api.common.operators.Operator<OUT>

org.apache.flink.api.common.operators.AbstractUdfOperator<OUT,FT>

org.apache.flink.api.common.operators.DualInputOperator<IN1,IN2,OUT,FT>

org.apache.flink.api.common.operators.base.CoGroupOperatorBase<IN1,IN2,OUT,FT>

All Implemented Interfaces:

Visitable<Operator<?>>

@Internal
public class CoGroupOperatorBase<IN1,IN2,OUT,FT extends CoGroupFunction<IN1,IN2,OUT>>
extends DualInputOperator<IN1,IN2,OUT,FT>

See Also:

CoGroupFunction

Field Summary

Fields inherited from class org.apache.flink.api.common.operators.DualInputOperator

input1, input2

Fields inherited from class org.apache.flink.api.common.operators.AbstractUdfOperator

broadcastInputs, userFunction

Fields inherited from class org.apache.flink.api.common.operators.Operator

compilerHints, name, operatorInfo, parameters

Constructor Summary

Constructors

Constructor and Description
CoGroupOperatorBase(Class<? extends FT> udf, BinaryOperatorInformation<IN1,IN2,OUT> operatorInfo, int[] keyPositions1, int[] keyPositions2, String name)
CoGroupOperatorBase(FT udf, BinaryOperatorInformation<IN1,IN2,OUT> operatorInfo, int[] keyPositions1, int[] keyPositions2, String name)
CoGroupOperatorBase(UserCodeWrapper<FT> udf, BinaryOperatorInformation<IN1,IN2,OUT> operatorInfo, int[] keyPositions1, int[] keyPositions2, String name)

Method Summary

Modifier and Type	Method and Description
protected List<OUT>	executeOnCollections(List<IN1> input1, List<IN2> input2, RuntimeContext ctx, ExecutionConfig executionConfig)
Partitioner<?>	getCustomPartitioner()
Ordering	getGroupOrder(int inputNum) Gets the value order for an input, i.e.
Ordering	getGroupOrderForInputOne() Gets the order of elements within a group for the first input.
Ordering	getGroupOrderForInputTwo() Gets the order of elements within a group for the second input.
boolean	isCombinableFirst()
boolean	isCombinableSecond()
void	setCombinableFirst(boolean combinableFirst)
void	setCombinableSecond(boolean combinableSecond)
void	setCustomPartitioner(Partitioner<?> customPartitioner)
void	setGroupOrder(int inputNum, Ordering order) Sets the order of the elements within a group for the given input.
void	setGroupOrderForInputOne(Ordering order) Sets the order of the elements within a group for the first input.
void	setGroupOrderForInputTwo(Ordering order) Sets the order of the elements within a group for the second input.

Methods inherited from class org.apache.flink.api.common.operators.DualInputOperator

accept, addFirstInput, addFirstInputs, addSecondInput, addSecondInputs, clearFirstInput, clearSecondInput, getFirstInput, getKeyColumns, getNumberOfInputs, getOperatorInfo, getSecondInput, getSemanticProperties, setFirstInput, setFirstInput, setFirstInputs, setSecondInput, setSecondInput, setSecondInputs, setSemanticProperties

Methods inherited from class org.apache.flink.api.common.operators.AbstractUdfOperator

asArray, emptyClassArray, getBroadcastInputs, getUserCodeWrapper, setBroadcastVariable, setBroadcastVariables

Methods inherited from class org.apache.flink.api.common.operators.Operator

createUnionCascade, createUnionCascade, createUnionCascade, getCompilerHints, getName, getParallelism, getParameters, setName, setParallelism, setParameter, setParameter, setParameter, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CoGroupOperatorBase

public CoGroupOperatorBase(UserCodeWrapper<FT> udf,
                           BinaryOperatorInformation<IN1,IN2,OUT> operatorInfo,
                           int[] keyPositions1,
                           int[] keyPositions2,
                           String name)

CoGroupOperatorBase

public CoGroupOperatorBase(FT udf,
                           BinaryOperatorInformation<IN1,IN2,OUT> operatorInfo,
                           int[] keyPositions1,
                           int[] keyPositions2,
                           String name)

CoGroupOperatorBase

public CoGroupOperatorBase(Class<? extends FT> udf,
                           BinaryOperatorInformation<IN1,IN2,OUT> operatorInfo,
                           int[] keyPositions1,
                           int[] keyPositions2,
                           String name)

Method Detail

setGroupOrder

public void setGroupOrder(int inputNum,
                          Ordering order)

Sets the order of the elements within a group for the given input.

Parameters:

inputNum - The number of the input (here either 0 or 1).

order - The order for the elements in a group.

setGroupOrderForInputOne

public void setGroupOrderForInputOne(Ordering order)

Sets the order of the elements within a group for the first input.

Parameters:

order - The order for the elements in a group.

setGroupOrderForInputTwo

public void setGroupOrderForInputTwo(Ordering order)

Sets the order of the elements within a group for the second input.

Parameters:

order - The order for the elements in a group.

getGroupOrder

public Ordering getGroupOrder(int inputNum)

Gets the value order for an input, i.e. the order of elements within a group. If no such order has been set, this method returns null.

Parameters:

inputNum - The number of the input (here either 0 or 1).

Returns:

The group order.

getGroupOrderForInputOne

public Ordering getGroupOrderForInputOne()

Gets the order of elements within a group for the first input. If no such order has been set, this method returns null.

Returns:

The group order for the first input.

getGroupOrderForInputTwo

public Ordering getGroupOrderForInputTwo()

Gets the order of elements within a group for the second input. If no such order has been set, this method returns null.

Returns:

The group order for the second input.

isCombinableFirst

public boolean isCombinableFirst()

setCombinableFirst

public void setCombinableFirst(boolean combinableFirst)

isCombinableSecond

public boolean isCombinableSecond()

setCombinableSecond

public void setCombinableSecond(boolean combinableSecond)

setCustomPartitioner

public void setCustomPartitioner(Partitioner<?> customPartitioner)

getCustomPartitioner

public Partitioner<?> getCustomPartitioner()

executeOnCollections

protected List<OUT> executeOnCollections(List<IN1> input1,
                                         List<IN2> input2,
                                         RuntimeContext ctx,
                                         ExecutionConfig executionConfig)
                                  throws Exception

Specified by:

executeOnCollections in class DualInputOperator<IN1,IN2,OUT,FT extends CoGroupFunction<IN1,IN2,OUT>>

Throws:

Exception