Package io.substrait.relation.physical

Class ImmutableScatterExchange

java.lang.Object
io.substrait.relation.AbstractRel
io.substrait.relation.SingleInputRel
io.substrait.relation.physical.AbstractExchangeRel
io.substrait.relation.physical.ScatterExchange
io.substrait.relation.physical.ImmutableScatterExchange
All Implemented Interfaces:
HasExtension, Rel
public final class ImmutableScatterExchange extends ScatterExchange
Immutable implementation of ScatterExchange.

Use the builder to create immutable instances: ImmutableScatterExchange.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

    • getInput

      public Rel getInput()
      Specified by:
      getInput in class SingleInputRel
      Returns:
      The value of the input attribute

    • getPartitionCount

      public Integer getPartitionCount()
      Returns the number of partitions for this exchange.
      Specified by:
      getPartitionCount in class AbstractExchangeRel
      Returns:
      the partition count, or null if unspecified

    • getTargets

      public List<AbstractExchangeRel.ExchangeTarget> getTargets()
      Returns the configured exchange targets.
      Specified by:
      getTargets in class AbstractExchangeRel
      Returns:
      the list of exchange targets (never null)

    • getFields

      public List<FieldReference> getFields()
      Specified by:
      getFields in class ScatterExchange
      Returns:
      The value of the fields attribute

    • withExtension

      public final ImmutableScatterExchange 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 ImmutableScatterExchange 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 ImmutableScatterExchange 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 ImmutableScatterExchange 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 ImmutableScatterExchange 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 ImmutableScatterExchange 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 ImmutableScatterExchange 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 ImmutableScatterExchange 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

    • withInput

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

    • withPartitionCount

      public final ImmutableScatterExchange withPartitionCount(Integer value)
      Copy the current immutable object by setting a value for the partitionCount attribute. An equals check used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for partitionCount
      Returns:
      A modified copy or the this object

    • withTargets

      public final ImmutableScatterExchange withTargets(AbstractExchangeRel.ExchangeTarget... elements)
      Copy the current immutable object with elements that replace the content of targets.
      Parameters:
      elements - The elements to set
      Returns:
      A modified copy of this object

    • withTargets

      public final ImmutableScatterExchange withTargets(Iterable<? extends AbstractExchangeRel.ExchangeTarget> elements)
      Copy the current immutable object with elements that replace the content of targets. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      elements - An iterable of targets elements to set
      Returns:
      A modified copy or this if not changed

    • withFields

      public final ImmutableScatterExchange withFields(FieldReference... elements)
      Copy the current immutable object with elements that replace the content of fields.
      Parameters:
      elements - The elements to set
      Returns:
      A modified copy of this object

    • withFields

      public final ImmutableScatterExchange withFields(Iterable<? extends FieldReference> elements)
      Copy the current immutable object with elements that replace the content of fields. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      elements - An iterable of fields elements to set
      Returns:
      A modified copy or this if not changed

    • equals

      public boolean equals(Object another)
      This instance is equal to all instances of ImmutableScatterExchange 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, input, partitionCount, targets, fields.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

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

    • copyOf

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

    • builder

      public static ImmutableScatterExchange.Builder builder()
      Creates a builder for ImmutableScatterExchange. 
       ImmutableScatterExchange.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
    .input(io.substrait.relation.Rel) // required input
    .partitionCount(Integer) // required partitionCount
    .addTargets|addAllTargets(io.substrait.relation.physical.AbstractExchangeRel.ExchangeTarget) // targets elements
    .addFields|addAllFields(io.substrait.expression.FieldReference) // fields elements
    .build();
      Returns:
      A new ImmutableScatterExchange builder