Package org.apache.flink.table.runtime.operators.join.stream.state

Class JoinInputSideSpec

java.lang.Object

org.apache.flink.table.runtime.operators.join.stream.state.JoinInputSideSpec

All Implemented Interfaces:

Serializable

public class JoinInputSideSpec
extends Object
implements Serializable

The JoinInputSideSpec is ap specification which describes input side information of a Join.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
org.apache.flink.api.java.functions.KeySelector<org.apache.flink.table.data.RowData,org.apache.flink.table.data.RowData>	getUniqueKeySelector()	Returns the KeySelector to extract unique key from the input row.
InternalTypeInfo<org.apache.flink.table.data.RowData>	getUniqueKeyType()	Returns the TypeInformation of the unique key.
boolean	hasUniqueKey()	Returns true if the input has unique key, otherwise false.
boolean	joinKeyContainsUniqueKey()	Returns true if the join key contains the unique key of the input.
String	toString()
static JoinInputSideSpec	withoutUniqueKey()	Creates a JoinInputSideSpec that input hasn't any unique keys.
static JoinInputSideSpec	withUniqueKey(InternalTypeInfo<org.apache.flink.table.data.RowData> uniqueKeyType, org.apache.flink.api.java.functions.KeySelector<org.apache.flink.table.data.RowData,org.apache.flink.table.data.RowData> uniqueKeySelector)	Creates a JoinInputSideSpec that the input has an unique key.
static JoinInputSideSpec	withUniqueKeyContainedByJoinKey(InternalTypeInfo<org.apache.flink.table.data.RowData> uniqueKeyType, org.apache.flink.api.java.functions.KeySelector<org.apache.flink.table.data.RowData,org.apache.flink.table.data.RowData> uniqueKeySelector)	Creates a JoinInputSideSpec that input has an unique key and the unique key is contained by the join key.

Methods inherited from class java.lang.Object

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

Method Detail

hasUniqueKey

public boolean hasUniqueKey()

Returns true if the input has unique key, otherwise false.

joinKeyContainsUniqueKey

public boolean joinKeyContainsUniqueKey()

Returns true if the join key contains the unique key of the input.

getUniqueKeyType

@Nullable
public InternalTypeInfo<org.apache.flink.table.data.RowData> getUniqueKeyType()

Returns the TypeInformation of the unique key. Returns null if the input hasn't unique key.

getUniqueKeySelector

@Nullable
public org.apache.flink.api.java.functions.KeySelector<org.apache.flink.table.data.RowData,org.apache.flink.table.data.RowData> getUniqueKeySelector()

Returns the KeySelector to extract unique key from the input row. Returns null if the input hasn't unique key.

withUniqueKey

public static JoinInputSideSpec withUniqueKey(InternalTypeInfo<org.apache.flink.table.data.RowData> uniqueKeyType,
                                              org.apache.flink.api.java.functions.KeySelector<org.apache.flink.table.data.RowData,org.apache.flink.table.data.RowData> uniqueKeySelector)

Creates a JoinInputSideSpec that the input has an unique key.

Parameters:

uniqueKeyType - type information of the unique key

uniqueKeySelector - key selector to extract unique key from the input row

withUniqueKeyContainedByJoinKey

public static JoinInputSideSpec withUniqueKeyContainedByJoinKey(InternalTypeInfo<org.apache.flink.table.data.RowData> uniqueKeyType,
                                                                org.apache.flink.api.java.functions.KeySelector<org.apache.flink.table.data.RowData,org.apache.flink.table.data.RowData> uniqueKeySelector)

Creates a JoinInputSideSpec that input has an unique key and the unique key is contained by the join key.

Parameters:

uniqueKeyType - type information of the unique key

uniqueKeySelector - key selector to extract unique key from the input row

withoutUniqueKey

public static JoinInputSideSpec withoutUniqueKey()

Creates a JoinInputSideSpec that input hasn't any unique keys.

toString

public String toString()

Overrides:

toString in class Object