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

Class JoinOperator.Builder

java.lang.Object

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

Enclosing class:

JoinOperator

public static class JoinOperator.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<JoinFunction> udf) Creates a Builder with the provided JoinFunction implementation.
protected	Builder(org.apache.flink.api.common.operators.util.UserCodeWrapper<JoinFunction> udf, Class<? extends org.apache.flink.types.Key<?>> keyClass, int keyColumn1, int keyColumn2) Creates a Builder with the provided JoinFunction implementation

Method Summary

Modifier and Type	Method and Description
JoinOperator	build() Creates and returns a JoinOperator from using the values given to the builder.
JoinOperator.Builder	input1(org.apache.flink.api.common.operators.Operator<org.apache.flink.types.Record>... inputs) Sets one or several inputs (union) for input 1.
JoinOperator.Builder	input1(org.apache.flink.api.common.operators.Operator<org.apache.flink.types.Record> input) Sets the first input.
JoinOperator.Builder	input2(org.apache.flink.api.common.operators.Operator<org.apache.flink.types.Record>... inputs) Sets one or several inputs (union) for input 2.
JoinOperator.Builder	input2(org.apache.flink.api.common.operators.Operator<org.apache.flink.types.Record> input) Sets the second input.
JoinOperator.Builder	inputs1(List<org.apache.flink.api.common.operators.Operator<org.apache.flink.types.Record>> inputs) Sets the first inputs.
JoinOperator.Builder	inputs2(List<org.apache.flink.api.common.operators.Operator<org.apache.flink.types.Record>> inputs) Sets the second inputs.
JoinOperator.Builder	keyField(Class<? extends org.apache.flink.types.Key<?>> keyClass, int keyColumn1, int keyColumn2) Adds additional key field.
JoinOperator.Builder	name(String name) Sets the name of this operator.
JoinOperator.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.
JoinOperator.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<JoinFunction> udf,
                  Class<? extends org.apache.flink.types.Key<?>> keyClass,
                  int keyColumn1,
                  int keyColumn2)

Creates a Builder with the provided JoinFunction implementation

Parameters:

udf - The JoinFunction implementation for this Match 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<JoinFunction> udf)

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

Parameters:

udf - The JoinFunction implementation for this Match operator.

Method Detail

keyField

public JoinOperator.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.

input1

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

Sets the first input.

Parameters:

input - The first input.

input2

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

Sets the second input.

Parameters:

input - The second input.

input1

public JoinOperator.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 JoinOperator.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 JoinOperator.Builder inputs1(List<org.apache.flink.api.common.operators.Operator<org.apache.flink.types.Record>> inputs)

Sets the first inputs.

Parameters:

inputs -

inputs2

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

Sets the second inputs.

Parameters:

inputs -

setBroadcastVariable

public JoinOperator.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 JoinOperator.Builder setBroadcastVariables(Map<String,org.apache.flink.api.common.operators.Operator<org.apache.flink.types.Record>> inputs)

Binds multiple broadcast variables.

name

public JoinOperator.Builder name(String name)

Sets the name of this operator.

build

public JoinOperator build()

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

Returns:

The created operator