Package io.substrait.relation

Class ImmutableNamedWrite

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

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

    • getTableSchema

      public NamedStruct getTableSchema()
      Returns the target table schema (names + types).
      Specified by:
      getTableSchema in class AbstractWriteRel
      Returns:
      target table NamedStruct

    • getOperation

      public AbstractWriteRel.WriteOp getOperation()
      Returns the write operation (insert/delete/update/ctas).
      Specified by:
      getOperation in class AbstractWriteRel
      Returns:
      write operation

    • getCreateMode

      public AbstractWriteRel.CreateMode getCreateMode()
      Returns the table creation behavior when the target exists.
      Specified by:
      getCreateMode in class AbstractWriteRel
      Returns:
      create mode

    • getOutputMode

      public AbstractWriteRel.OutputMode getOutputMode()
      Returns the output behavior of the write (e.g., rows returned).
      Specified by:
      getOutputMode in class AbstractWriteRel
      Returns:
      output mode

    • getNames

      public List<String> getNames()
      Specified by:
      getNames in class NamedWrite
      Returns:
      The value of the names attribute

    • withExtension

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

    • withTableSchema

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

    • withOperation

      public final ImmutableNamedWrite withOperation(AbstractWriteRel.WriteOp value)
      Copy the current immutable object by setting a value for the operation attribute. A value equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for operation
      Returns:
      A modified copy or the this object

    • withCreateMode

      public final ImmutableNamedWrite withCreateMode(AbstractWriteRel.CreateMode value)
      Copy the current immutable object by setting a value for the createMode attribute. A value equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for createMode
      Returns:
      A modified copy or the this object

    • withOutputMode

      public final ImmutableNamedWrite withOutputMode(AbstractWriteRel.OutputMode value)
      Copy the current immutable object by setting a value for the outputMode attribute. A value equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for outputMode
      Returns:
      A modified copy or the this object

    • withNames

      public final ImmutableNamedWrite withNames(String... elements)
      Copy the current immutable object with elements that replace the content of names.
      Parameters:
      elements - The elements to set
      Returns:
      A modified copy of this object

    • withNames

      public final ImmutableNamedWrite withNames(Iterable<String> elements)
      Copy the current immutable object with elements that replace the content of names. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      elements - An iterable of names 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 ImmutableNamedWrite 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, tableSchema, operation, createMode, outputMode, names.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

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

    • copyOf

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

    • builder

      public static ImmutableNamedWrite.Builder builder()
      Creates a builder for ImmutableNamedWrite. 
       ImmutableNamedWrite.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
    .tableSchema(io.substrait.type.NamedStruct) // required tableSchema
    .operation(io.substrait.relation.AbstractWriteRel.WriteOp) // required operation
    .createMode(io.substrait.relation.AbstractWriteRel.CreateMode) // required createMode
    .outputMode(io.substrait.relation.AbstractWriteRel.OutputMode) // required outputMode
    .addNames|addAllNames(String) // names elements
    .build();
      Returns:
      A new ImmutableNamedWrite builder