org.apache.flink.api.java.record.operators

Class CoGroupOperator.Builder

java.lang.Object

org.apache.flink.api.java.record.operators.CoGroupOperator.Builder

Enclosing class:

CoGroupOperator

public static class CoGroupOperator.Builder
extends Object

Builder pattern, straight from Joshua Bloch's Effective Java (2nd Edition).

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder(org.apache.flink.api.common.operators.util.UserCodeWrapper<org.apache.flink.api.common.functions.CoGroupFunction<org.apache.flink.types.Record,org.apache.flink.types.Record,org.apache.flink.types.Record>> udf) Creates a Builder with the provided CoGroupFunction implementation.
protected	Builder(org.apache.flink.api.common.operators.util.UserCodeWrapper<org.apache.flink.api.common.functions.CoGroupFunction<org.apache.flink.types.Record,org.apache.flink.types.Record,org.apache.flink.types.Record>> udf, Class<? extends org.apache.flink.types.Key<?>> keyClass, int keyColumn1, int keyColumn2) Creates a Builder with the provided CoGroupFunction implementation.

Method Summary

Modifier and Type	Method and Description
CoGroupOperator	build() Creates and returns a CoGroupOperator from using the values given to the builder.
CoGroupOperator.Builder	input1(org.apache.flink.api.common.operators.Operator<org.apache.flink.types.Record>... inputs) Sets one or several inputs (union) for input 1.
CoGroupOperator.Builder	input1(org.apache.flink.api.common.operators.Operator<org.apache.flink.types.Record> input) Sets the input operator for input 1.
CoGroupOperator.Builder	input2(org.apache.flink.api.common.operators.Operator<org.apache.flink.types.Record>... inputs) Sets one or several inputs (union) for input 2.
CoGroupOperator.Builder	input2(org.apache.flink.api.common.operators.Operator<org.apache.flink.types.Record> input) Sets the input operator for input 2.
CoGroupOperator.Builder	inputs1(List<org.apache.flink.api.common.operators.Operator<org.apache.flink.types.Record>> inputs) Sets the first inputs.
CoGroupOperator.Builder	inputs2(List<org.apache.flink.api.common.operators.Operator<org.apache.flink.types.Record>> inputs) Sets the second inputs.
CoGroupOperator.Builder	keyField(Class<? extends org.apache.flink.types.Key<?>> keyClass, int keyColumn1, int keyColumn2) Adds additional key field.
CoGroupOperator.Builder	name(String name) Sets the name of this operator.
CoGroupOperator.Builder	secondaryOrder1(org.apache.flink.api.common.operators.Ordering order) Sets the order of the elements within a group for the first input.
CoGroupOperator.Builder	secondaryOrder2(org.apache.flink.api.common.operators.Ordering order) Sets the order of the elements within a group for the second input.
CoGroupOperator.Builder	setBroadcastVariable(String name, org.apache.flink.api.common.operators.Operator<org.apache.flink.types.Record> input) Binds the result produced by a plan rooted at root to a variable used by the UDF wrapped in this operator.
CoGroupOperator.Builder	setBroadcastVariables(Map<String,org.apache.flink.api.common.operators.Operator<org.apache.flink.types.Record>> inputs) Binds multiple broadcast variables.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

protected Builder(org.apache.flink.api.common.operators.util.UserCodeWrapper<org.apache.flink.api.common.functions.CoGroupFunction<org.apache.flink.types.Record,org.apache.flink.types.Record,org.apache.flink.types.Record>> udf,
                  Class<? extends org.apache.flink.types.Key<?>> keyClass,
                  int keyColumn1,
                  int keyColumn2)

Creates a Builder with the provided CoGroupFunction implementation.

Parameters:

udf - The CoGroupFunction implementation for this CoGroup operator.

keyClass - The class of the key data type.

keyColumn1 - The position of the key in the first input's records.

keyColumn2 - The position of the key in the second input's records.

Builder

protected Builder(org.apache.flink.api.common.operators.util.UserCodeWrapper<org.apache.flink.api.common.functions.CoGroupFunction<org.apache.flink.types.Record,org.apache.flink.types.Record,org.apache.flink.types.Record>> udf)

Creates a Builder with the provided CoGroupFunction implementation. This method is intended for special case sub-types only.

Parameters:

udf - The CoGroupFunction implementation for this CoGroup operator.

Method Detail

keyField

public CoGroupOperator.Builder keyField(Class<? extends org.apache.flink.types.Key<?>> keyClass,
                                        int keyColumn1,
                                        int keyColumn2)

Adds additional key field.

Parameters:

keyClass - The class of the key data type.

keyColumn1 - The position of the key in the first input's records.

keyColumn2 - The position of the key in the second input's records.

secondaryOrder1

public CoGroupOperator.Builder secondaryOrder1(org.apache.flink.api.common.operators.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.

secondaryOrder2

public CoGroupOperator.Builder secondaryOrder2(org.apache.flink.api.common.operators.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.

input1

public CoGroupOperator.Builder input1(org.apache.flink.api.common.operators.Operator<org.apache.flink.types.Record> input)

Sets the input operator for input 1.

Parameters:

input - The input operator for input 1.

input1

public CoGroupOperator.Builder input1(org.apache.flink.api.common.operators.Operator<org.apache.flink.types.Record>... inputs)

Sets one or several inputs (union) for input 1.

Parameters:

inputs -

input2

public CoGroupOperator.Builder input2(org.apache.flink.api.common.operators.Operator<org.apache.flink.types.Record> input)

Sets the input operator for input 2.

Parameters:

input - The input operator for input 2.

input2

public CoGroupOperator.Builder input2(org.apache.flink.api.common.operators.Operator<org.apache.flink.types.Record>... inputs)

Sets one or several inputs (union) for input 2.

Parameters:

inputs -

inputs1

public CoGroupOperator.Builder inputs1(List<org.apache.flink.api.common.operators.Operator<org.apache.flink.types.Record>> inputs)

Sets the first inputs.

Parameters:

inputs -

inputs2

public CoGroupOperator.Builder inputs2(List<org.apache.flink.api.common.operators.Operator<org.apache.flink.types.Record>> inputs)

Sets the second inputs.

Parameters:

inputs -

setBroadcastVariable

public CoGroupOperator.Builder setBroadcastVariable(String name,
                                                    org.apache.flink.api.common.operators.Operator<org.apache.flink.types.Record> input)

Binds the result produced by a plan rooted at root to a variable used by the UDF wrapped in this operator.

setBroadcastVariables

public CoGroupOperator.Builder setBroadcastVariables(Map<String,org.apache.flink.api.common.operators.Operator<org.apache.flink.types.Record>> inputs)

Binds multiple broadcast variables.

name

public CoGroupOperator.Builder name(String name)

Sets the name of this operator.

Parameters:

name -

build

public CoGroupOperator build()

Creates and returns a CoGroupOperator from using the values given to the builder.

Returns:

The created operator