org.apache.flink.api.java.operators

Class JoinOperator<I1,I2,OUT>

java.lang.Object

org.apache.flink.api.java.DataSet<OUT>

org.apache.flink.api.java.operators.Operator<OUT,O>

org.apache.flink.api.java.operators.TwoInputOperator<IN1,IN2,OUT,O>

org.apache.flink.api.java.operators.TwoInputUdfOperator<I1,I2,OUT,JoinOperator<I1,I2,OUT>>

org.apache.flink.api.java.operators.JoinOperator<I1,I2,OUT>

Type Parameters:

I1 - The type of the first input DataSet of the Join transformation.

I2 - The type of the second input DataSet of the Join transformation.

OUT - The type of the result of the Join transformation.

All Implemented Interfaces:

UdfOperator<JoinOperator<I1,I2,OUT>>

Direct Known Subclasses:

JoinOperator.EquiJoin

@Public
public abstract class JoinOperator<I1,I2,OUT>
extends TwoInputUdfOperator<I1,I2,OUT,JoinOperator<I1,I2,OUT>>

A DataSet that is the result of a Join transformation.

See Also:

DataSet

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JoinOperator.DefaultJoin<I1,I2> A Join transformation that wraps pairs of joining elements into Tuple2.
static class	JoinOperator.EquiJoin<I1,I2,OUT> A Join transformation that applies a JoinFunction on each pair of joining elements.
static class	JoinOperator.JoinOperatorSets<I1,I2> Intermediate step of a Join transformation.
static class	JoinOperator.ProjectJoin<I1,I2,OUT extends org.apache.flink.api.java.tuple.Tuple> A Join transformation that projects joining elements or fields of joining Tuples into result Tuples.

Field Summary

Fields

Modifier and Type	Field and Description
protected JoinType	joinType
protected org.apache.flink.api.common.operators.Keys<I1>	keys1
protected org.apache.flink.api.common.operators.Keys<I2>	keys2

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

minResources, name, parallelism, preferredResources

Fields inherited from class org.apache.flink.api.java.DataSet

context

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JoinOperator(DataSet<I1> input1, DataSet<I2> input2, org.apache.flink.api.common.operators.Keys<I1> keys1, org.apache.flink.api.common.operators.Keys<I2> keys2, org.apache.flink.api.common.typeinfo.TypeInformation<OUT> returnType, org.apache.flink.api.common.operators.base.JoinOperatorBase.JoinHint hint, JoinType type)

Method Summary

Modifier and Type	Method and Description
org.apache.flink.api.common.operators.base.JoinOperatorBase.JoinHint	getJoinHint() Gets the JoinHint that describes how the join is executed.
JoinType	getJoinType() Gets the JoinType that describes this join operation (e.g.
protected org.apache.flink.api.common.operators.Keys<I1>	getKeys1()
protected org.apache.flink.api.common.operators.Keys<I2>	getKeys2()
org.apache.flink.api.common.functions.Partitioner<?>	getPartitioner() Gets the custom partitioner used by this join, or null, if none is set.
JoinOperator<I1,I2,OUT>	withPartitioner(org.apache.flink.api.common.functions.Partitioner<?> partitioner) Sets a custom partitioner for this join.

Methods inherited from class org.apache.flink.api.java.operators.TwoInputUdfOperator

extractSemanticAnnotationsFromUdf, getAnalyzedUdfSemanticsFlag, getBroadcastSets, getFunction, getParameters, getSemanticProperties, returns, returns, returns, setAnalyzedUdfSemanticsFlag, setSemanticProperties, udfWithForwardedFieldsFirstAnnotation, udfWithForwardedFieldsSecondAnnotation, withBroadcastSet, withForwardedFieldsFirst, withForwardedFieldsSecond, withParameters

Methods inherited from class org.apache.flink.api.java.operators.TwoInputOperator

getInput1, getInput1Type, getInput2, getInput2Type, translateToDataFlow

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

getMinResources, getName, getParallelism, getPreferredResources, getResultType, name, setParallelism

Methods inherited from class org.apache.flink.api.java.DataSet

aggregate, checkSameExecutionContext, clean, coGroup, collect, combineGroup, count, cross, crossWithHuge, crossWithTiny, distinct, distinct, distinct, distinct, fillInType, filter, first, flatMap, fullOuterJoin, fullOuterJoin, getExecutionEnvironment, getType, groupBy, groupBy, groupBy, iterate, iterateDelta, join, join, joinWithHuge, joinWithTiny, leftOuterJoin, leftOuterJoin, map, mapPartition, max, maxBy, min, minBy, output, partitionByHash, partitionByHash, partitionByHash, partitionByRange, partitionByRange, partitionByRange, partitionCustom, partitionCustom, partitionCustom, print, print, printOnTaskManager, printToErr, printToErr, project, rebalance, reduce, reduceGroup, rightOuterJoin, rightOuterJoin, runOperation, sortPartition, sortPartition, sortPartition, sum, union, write, write, writeAsCsv, writeAsCsv, writeAsCsv, writeAsCsv, writeAsFormattedText, writeAsFormattedText, writeAsText, writeAsText

Methods inherited from class java.lang.Object

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

Field Detail

keys1

protected final org.apache.flink.api.common.operators.Keys<I1> keys1

keys2

protected final org.apache.flink.api.common.operators.Keys<I2> keys2

joinType

protected final JoinType joinType

Constructor Detail

JoinOperator

protected JoinOperator(DataSet<I1> input1,
                       DataSet<I2> input2,
                       org.apache.flink.api.common.operators.Keys<I1> keys1,
                       org.apache.flink.api.common.operators.Keys<I2> keys2,
                       org.apache.flink.api.common.typeinfo.TypeInformation<OUT> returnType,
                       org.apache.flink.api.common.operators.base.JoinOperatorBase.JoinHint hint,
                       JoinType type)

Method Detail

getKeys1

protected org.apache.flink.api.common.operators.Keys<I1> getKeys1()

getKeys2

protected org.apache.flink.api.common.operators.Keys<I2> getKeys2()

getJoinHint

@Internal
public org.apache.flink.api.common.operators.base.JoinOperatorBase.JoinHint getJoinHint()

Gets the JoinHint that describes how the join is executed.

Returns:

The JoinHint.

getJoinType

@Internal
public JoinType getJoinType()

Gets the JoinType that describes this join operation (e.g. inner, outer)

Returns:

The JoinType

withPartitioner

public JoinOperator<I1,I2,OUT> withPartitioner(org.apache.flink.api.common.functions.Partitioner<?> partitioner)

Sets a custom partitioner for this join. The partitioner will be called on the join keys to determine the partition a key should be assigned to. The partitioner is evaluated on both join inputs in the same way.

NOTE: A custom partitioner can only be used with single-field join keys, not with composite join keys.

Parameters:

partitioner - The custom partitioner to be used.

Returns:

This join operator, to allow for function chaining.

getPartitioner

@Internal
public org.apache.flink.api.common.functions.Partitioner<?> getPartitioner()

Gets the custom partitioner used by this join, or null, if none is set.

Returns:

The custom partitioner used by this join;