org.apache.flink.table.planner.plan.rules.logical

Class ImmutableFlinkFilterJoinRuleConfig

java.lang.Object

org.apache.flink.table.planner.plan.rules.logical.ImmutableFlinkFilterJoinRuleConfig

All Implemented Interfaces:

org.apache.calcite.plan.RelRule.Config, FlinkFilterJoinRule.Config, FlinkFilterJoinRule.FlinkJoinConditionPushRule.FlinkFilterJoinRuleConfig

@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
 @CheckReturnValue
public final class ImmutableFlinkFilterJoinRuleConfig
extends Object
implements FlinkFilterJoinRule.FlinkJoinConditionPushRule.FlinkFilterJoinRuleConfig

Immutable implementation of FlinkFilterJoinRule.FlinkJoinConditionPushRule.FlinkFilterJoinRuleConfig.

Use the builder to create immutable instances: ImmutableFlinkFilterJoinRuleConfig.builder(). Use the static factory method to create immutable instances: ImmutableFlinkFilterJoinRuleConfig.of().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableFlinkFilterJoinRuleConfig.Builder Builds instances of type ImmutableFlinkFilterJoinRuleConfig.

Field Summary

Fields inherited from interface org.apache.flink.table.planner.plan.rules.logical.FlinkFilterJoinRule.FlinkJoinConditionPushRule.FlinkFilterJoinRuleConfig

DEFAULT

Method Summary

Modifier and Type	Method and Description
static ImmutableFlinkFilterJoinRuleConfig.Builder	builder() Creates a builder for ImmutableFlinkFilterJoinRuleConfig.
static ImmutableFlinkFilterJoinRuleConfig	copyOf(FlinkFilterJoinRule.FlinkJoinConditionPushRule.FlinkFilterJoinRuleConfig instance) Creates an immutable copy of a FlinkFilterJoinRule.FlinkJoinConditionPushRule.FlinkFilterJoinRuleConfig value.
String	description()
boolean	equals(Object another) This instance is equal to all instances of ImmutableFlinkFilterJoinRuleConfig that have equal attribute values.
FlinkFilterJoinRule.Predicate	getPredicate() Predicate that returns whether a filter is valid in the ON clause of a join for this particular kind of join.
int	hashCode() Computes a hash code from attributes: relBuilderFactory, description, operandSupplier, smart, predicate.
boolean	isSmart() Whether to try to strengthen join-type, default false.
static ImmutableFlinkFilterJoinRuleConfig	of(FlinkFilterJoinRule.Predicate predicate) Construct a new immutable FlinkFilterJoinRuleConfig instance.
org.apache.calcite.plan.RelRule.OperandTransform	operandSupplier()
org.apache.calcite.tools.RelBuilderFactory	relBuilderFactory()
String	toString() Prints the immutable value FlinkFilterJoinRuleConfig with attribute values.
ImmutableFlinkFilterJoinRuleConfig	withDescription(String value) Copy the current immutable object by setting a value for the description attribute.
ImmutableFlinkFilterJoinRuleConfig	withOperandSupplier(org.apache.calcite.plan.RelRule.OperandTransform value) Copy the current immutable object by setting a value for the operandSupplier attribute.
ImmutableFlinkFilterJoinRuleConfig	withPredicate(FlinkFilterJoinRule.Predicate value) Copy the current immutable object by setting a value for the predicate attribute.
ImmutableFlinkFilterJoinRuleConfig	withRelBuilderFactory(org.apache.calcite.tools.RelBuilderFactory value) Copy the current immutable object by setting a value for the relBuilderFactory attribute.
ImmutableFlinkFilterJoinRuleConfig	withSmart(boolean value) Copy the current immutable object by setting a value for the smart attribute.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.flink.table.planner.plan.rules.logical.FlinkFilterJoinRule.FlinkJoinConditionPushRule.FlinkFilterJoinRuleConfig

toRule

Methods inherited from interface org.apache.calcite.plan.RelRule.Config

as

Method Detail

relBuilderFactory

public org.apache.calcite.tools.RelBuilderFactory relBuilderFactory()

Specified by:

relBuilderFactory in interface org.apache.calcite.plan.RelRule.Config

Returns:

The value of the relBuilderFactory attribute

description

@Nullable
public String description()

Specified by:

description in interface org.apache.calcite.plan.RelRule.Config

Returns:

The value of the description attribute

operandSupplier

public org.apache.calcite.plan.RelRule.OperandTransform operandSupplier()

Specified by:

operandSupplier in interface org.apache.calcite.plan.RelRule.Config

Returns:

The value of the operandSupplier attribute

isSmart

public boolean isSmart()

Whether to try to strengthen join-type, default false.

Specified by:

isSmart in interface FlinkFilterJoinRule.Config

getPredicate

public FlinkFilterJoinRule.Predicate getPredicate()

Predicate that returns whether a filter is valid in the ON clause of a join for this particular kind of join. If not, Calcite will push it back to above the join.

Specified by:

getPredicate in interface FlinkFilterJoinRule.Config

withRelBuilderFactory

public final ImmutableFlinkFilterJoinRuleConfig withRelBuilderFactory(org.apache.calcite.tools.RelBuilderFactory value)

Copy the current immutable object by setting a value for the relBuilderFactory attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Specified by:

withRelBuilderFactory in interface org.apache.calcite.plan.RelRule.Config

Parameters:

value - A new value for relBuilderFactory

Returns:

A modified copy of the this object

withDescription

public final ImmutableFlinkFilterJoinRuleConfig withDescription(@Nullable
                                                                String value)

Copy the current immutable object by setting a value for the description attribute. An equals check used to prevent copying of the same value by returning this.

Specified by:

withDescription in interface org.apache.calcite.plan.RelRule.Config

Parameters:

value - A new value for description (can be null)

Returns:

A modified copy of the this object

withOperandSupplier

public final ImmutableFlinkFilterJoinRuleConfig withOperandSupplier(org.apache.calcite.plan.RelRule.OperandTransform value)

Copy the current immutable object by setting a value for the operandSupplier attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Specified by:

withOperandSupplier in interface org.apache.calcite.plan.RelRule.Config

Parameters:

value - A new value for operandSupplier

Returns:

A modified copy of the this object

withSmart

public final ImmutableFlinkFilterJoinRuleConfig withSmart(boolean value)

Copy the current immutable object by setting a value for the smart attribute. A value equality check is used to prevent copying of the same value by returning this.

Specified by:

withSmart in interface FlinkFilterJoinRule.Config

Parameters:

value - A new value for smart

Returns:

A modified copy of the this object

withPredicate

public final ImmutableFlinkFilterJoinRuleConfig withPredicate(FlinkFilterJoinRule.Predicate value)

Copy the current immutable object by setting a value for the predicate attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Specified by:

withPredicate in interface FlinkFilterJoinRule.Config

Parameters:

value - A new value for predicate

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableFlinkFilterJoinRuleConfig that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: relBuilderFactory, description, operandSupplier, smart, predicate.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value FlinkFilterJoinRuleConfig with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static ImmutableFlinkFilterJoinRuleConfig of(FlinkFilterJoinRule.Predicate predicate)

Construct a new immutable FlinkFilterJoinRuleConfig instance.

Parameters:

predicate - The value for the predicate attribute

Returns:

An immutable FlinkFilterJoinRuleConfig instance

copyOf

public static ImmutableFlinkFilterJoinRuleConfig copyOf(FlinkFilterJoinRule.FlinkJoinConditionPushRule.FlinkFilterJoinRuleConfig instance)

Creates an immutable copy of a FlinkFilterJoinRule.FlinkJoinConditionPushRule.FlinkFilterJoinRuleConfig value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable FlinkFilterJoinRuleConfig instance

builder

public static ImmutableFlinkFilterJoinRuleConfig.Builder builder()

Creates a builder for ImmutableFlinkFilterJoinRuleConfig.

 ImmutableFlinkFilterJoinRuleConfig.builder()
    .withRelBuilderFactory(org.apache.calcite.tools.RelBuilderFactory) // optional relBuilderFactory
    .withDescription(String | null) // nullable description
    .withOperandSupplier(org.apache.calcite.plan.RelRule.OperandTransform) // optional operandSupplier
    .withSmart(boolean) // optional smart
    .withPredicate(org.apache.flink.table.planner.plan.rules.logical.FlinkFilterJoinRule.Predicate) // required predicate
    .build();
 

Returns:

A new ImmutableFlinkFilterJoinRuleConfig builder