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

Class ImmutableCorrelateSortToRankRule.CorrelateSortToRankRuleConfig

java.lang.Object
org.apache.flink.table.planner.plan.rules.logical.ImmutableCorrelateSortToRankRule.CorrelateSortToRankRuleConfig
All Implemented Interfaces:
org.apache.calcite.plan.RelRule.Config, CorrelateSortToRankRule.CorrelateSortToRankRuleConfig
Enclosing class:
ImmutableCorrelateSortToRankRule
@Immutable @CheckReturnValue public static final class ImmutableCorrelateSortToRankRule.CorrelateSortToRankRuleConfig extends Object implements CorrelateSortToRankRule.CorrelateSortToRankRuleConfig
Immutable implementation of CorrelateSortToRankRule.CorrelateSortToRankRuleConfig.

Use the builder to create immutable instances: ImmutableCorrelateSortToRankRule.CorrelateSortToRankRuleConfig.builder().

  • Method Details

    • 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

    • withRelBuilderFactory

      public final ImmutableCorrelateSortToRankRule.CorrelateSortToRankRuleConfig 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 ImmutableCorrelateSortToRankRule.CorrelateSortToRankRuleConfig 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 ImmutableCorrelateSortToRankRule.CorrelateSortToRankRuleConfig 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

    • equals

      public boolean equals(@Nullable Object another)
      This instance is equal to all instances of CorrelateSortToRankRuleConfig 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.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

      public String toString()
      Prints the immutable value CorrelateSortToRankRuleConfig with attribute values.
      Overrides:
      toString in class Object
      Returns:
      A string representation of the value

    • copyOf

      public static ImmutableCorrelateSortToRankRule.CorrelateSortToRankRuleConfig copyOf(CorrelateSortToRankRule.CorrelateSortToRankRuleConfig instance)
      Creates an immutable copy of a CorrelateSortToRankRule.CorrelateSortToRankRuleConfig 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 CorrelateSortToRankRuleConfig instance

    • builder

      public static ImmutableCorrelateSortToRankRule.CorrelateSortToRankRuleConfig.Builder builder()
      Creates a builder for CorrelateSortToRankRuleConfig. 
       ImmutableCorrelateSortToRankRule.CorrelateSortToRankRuleConfig.builder()
    .relBuilderFactory(org.apache.calcite.tools.RelBuilderFactory) // optional relBuilderFactory
    .description(String | null) // nullable description
    .operandSupplier(org.apache.calcite.plan.RelRule.OperandTransform) // optional operandSupplier
    .build();
      Returns:
      A new CorrelateSortToRankRuleConfig builder