Package io.substrait.relation

Class ImmutableJoin

java.lang.Object
io.substrait.relation.AbstractRel
io.substrait.relation.BiRel
io.substrait.relation.Join
io.substrait.relation.ImmutableJoin
All Implemented Interfaces:
HasExtension, Rel
public final class ImmutableJoin extends Join
Immutable implementation of Join.

Use the builder to create immutable instances: ImmutableJoin.builder().

  • Method Details

    • getExtension

      public Optional<AdvancedExtension> getExtension()
      Returns:
      the AdvancedExtension associated directly with the class

    • getRemap

      public Optional<Rel.Remap> getRemap()
      Returns:
      The value of the remap attribute

    • getCommonExtension

      public Optional<AdvancedExtension> getCommonExtension()
      Returns:
      the AdvancedExtension associated with a RelCommon message, if present

    • getHint

      public Optional<Hint> getHint()
      Returns:
      The value of the hint attribute

    • getLeft

      public Rel getLeft()
      Specified by:
      getLeft in class BiRel
      Returns:
      The value of the left attribute

    • getRight

      public Rel getRight()
      Specified by:
      getRight in class BiRel
      Returns:
      The value of the right attribute

    • getCondition

      public Optional<Expression> getCondition()
      Specified by:
      getCondition in class Join
      Returns:
      The value of the condition attribute

    • getPostJoinFilter

      public Optional<Expression> getPostJoinFilter()
      Specified by:
      getPostJoinFilter in class Join
      Returns:
      The value of the postJoinFilter attribute

    • getJoinType

      public Join.JoinType getJoinType()
      Specified by:
      getJoinType in class Join
      Returns:
      The value of the joinType attribute

    • withExtension

      public final ImmutableJoin withExtension(AdvancedExtension value)
      Copy the current immutable object by setting a present value for the optional extension attribute.
      Parameters:
      value - The value for extension
      Returns:
      A modified copy or this if not changed

    • withExtension

      public final ImmutableJoin withExtension(Optional<? extends AdvancedExtension> optional)
      Copy the current immutable object by setting an optional value for the extension attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
      Parameters:
      optional - An optional value for extension
      Returns:
      A modified copy or this if not changed

    • withRemap

      public final ImmutableJoin withRemap(Rel.Remap value)
      Copy the current immutable object by setting a present value for the optional remap attribute.
      Parameters:
      value - The value for remap
      Returns:
      A modified copy or this if not changed

    • withRemap

      public final ImmutableJoin withRemap(Optional<? extends Rel.Remap> optional)
      Copy the current immutable object by setting an optional value for the remap attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
      Parameters:
      optional - An optional value for remap
      Returns:
      A modified copy or this if not changed

    • withCommonExtension

      public final ImmutableJoin withCommonExtension(AdvancedExtension value)
      Copy the current immutable object by setting a present value for the optional commonExtension attribute.
      Parameters:
      value - The value for commonExtension
      Returns:
      A modified copy or this if not changed

    • withCommonExtension

      public final ImmutableJoin withCommonExtension(Optional<? extends AdvancedExtension> optional)
      Copy the current immutable object by setting an optional value for the commonExtension attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
      Parameters:
      optional - An optional value for commonExtension
      Returns:
      A modified copy or this if not changed

    • withHint

      public final ImmutableJoin withHint(Hint value)
      Copy the current immutable object by setting a present value for the optional hint attribute.
      Parameters:
      value - The value for hint
      Returns:
      A modified copy or this if not changed

    • withHint

      public final ImmutableJoin withHint(Optional<? extends Hint> optional)
      Copy the current immutable object by setting an optional value for the hint attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
      Parameters:
      optional - An optional value for hint
      Returns:
      A modified copy or this if not changed

    • withLeft

      public final ImmutableJoin withLeft(Rel value)
      Copy the current immutable object by setting a value for the left attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for left
      Returns:
      A modified copy or the this object

    • withRight

      public final ImmutableJoin withRight(Rel value)
      Copy the current immutable object by setting a value for the right attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for right
      Returns:
      A modified copy or the this object

    • withCondition

      public final ImmutableJoin withCondition(Expression value)
      Copy the current immutable object by setting a present value for the optional condition attribute.
      Parameters:
      value - The value for condition
      Returns:
      A modified copy or this if not changed

    • withCondition

      public final ImmutableJoin withCondition(Optional<? extends Expression> optional)
      Copy the current immutable object by setting an optional value for the condition attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
      Parameters:
      optional - An optional value for condition
      Returns:
      A modified copy or this if not changed

    • withPostJoinFilter

      public final ImmutableJoin withPostJoinFilter(Expression value)
      Copy the current immutable object by setting a present value for the optional postJoinFilter attribute.
      Parameters:
      value - The value for postJoinFilter
      Returns:
      A modified copy or this if not changed

    • withPostJoinFilter

      public final ImmutableJoin withPostJoinFilter(Optional<? extends Expression> optional)
      Copy the current immutable object by setting an optional value for the postJoinFilter attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
      Parameters:
      optional - An optional value for postJoinFilter
      Returns:
      A modified copy or this if not changed

    • withJoinType

      public final ImmutableJoin withJoinType(Join.JoinType value)
      Copy the current immutable object by setting a value for the joinType attribute. A value equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for joinType
      Returns:
      A modified copy or the this object

    • equals

      public boolean equals(Object another)
      This instance is equal to all instances of ImmutableJoin 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: extension, remap, commonExtension, hint, left, right, condition, postJoinFilter, joinType.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

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

    • copyOf

      public static ImmutableJoin copyOf(Join instance)
      Creates an immutable copy of a Join 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 Join instance

    • builder

      public static ImmutableJoin.Builder builder()
      Creates a builder for ImmutableJoin. 
       ImmutableJoin.builder()
    .extension(Optional<io.substrait.extension.AdvancedExtension>) // optional extension
    .remap(Optional<io.substrait.relation.Rel.Remap>) // optional remap
    .commonExtension(Optional<io.substrait.extension.AdvancedExtension>) // optional commonExtension
    .hint(Optional<io.substrait.hint.Hint>) // optional hint
    .left(io.substrait.relation.Rel) // required left
    .right(io.substrait.relation.Rel) // required right
    .condition(Optional<io.substrait.expression.Expression>) // optional condition
    .postJoinFilter(Optional<io.substrait.expression.Expression>) // optional postJoinFilter
    .joinType(io.substrait.relation.Join.JoinType) // required joinType
    .build();
      Returns:
      A new ImmutableJoin builder