Package io.substrait.relation

Class ImmutableAggregate

java.lang.Object
io.substrait.relation.AbstractRel
io.substrait.relation.SingleInputRel
io.substrait.relation.Aggregate
io.substrait.relation.ImmutableAggregate
All Implemented Interfaces:
HasExtension, Rel
public final class ImmutableAggregate extends Aggregate
Immutable implementation of Aggregate.

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

    • getGroupings

      public List<Aggregate.Grouping> getGroupings()
      Specified by:
      getGroupings in class Aggregate
      Returns:
      The value of the groupings attribute

    • getMeasures

      public List<Aggregate.Measure> getMeasures()
      Specified by:
      getMeasures in class Aggregate
      Returns:
      The value of the measures attribute

    • withExtension

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

    • withGroupings

      public final ImmutableAggregate withGroupings(Aggregate.Grouping... elements)
      Copy the current immutable object with elements that replace the content of groupings.
      Parameters:
      elements - The elements to set
      Returns:
      A modified copy of this object

    • withGroupings

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

    • withMeasures

      public final ImmutableAggregate withMeasures(Aggregate.Measure... elements)
      Copy the current immutable object with elements that replace the content of measures.
      Parameters:
      elements - The elements to set
      Returns:
      A modified copy of this object

    • withMeasures

      public final ImmutableAggregate withMeasures(Iterable<? extends Aggregate.Measure> elements)
      Copy the current immutable object with elements that replace the content of measures. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      elements - An iterable of measures 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 ImmutableAggregate 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, groupings, measures.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

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

    • copyOf

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

    • builder

      public static ImmutableAggregate.Builder builder()
      Creates a builder for ImmutableAggregate. 
       ImmutableAggregate.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
    .addGroupings|addAllGroupings(io.substrait.relation.Aggregate.Grouping) // groupings elements
    .addMeasures|addAllMeasures(io.substrait.relation.Aggregate.Measure) // measures elements
    .build();
      Returns:
      A new ImmutableAggregate builder