Package io.substrait.relation

Class ImmutableNamedScan

java.lang.Object
io.substrait.relation.AbstractRel
io.substrait.relation.ZeroInputRel
io.substrait.relation.AbstractReadRel
io.substrait.relation.NamedScan
io.substrait.relation.ImmutableNamedScan
All Implemented Interfaces:
HasExtension, Rel
public final class ImmutableNamedScan extends NamedScan
Immutable implementation of NamedScan.

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

    • getInitialSchema

      public NamedStruct getInitialSchema()
      Specified by:
      getInitialSchema in class AbstractReadRel
      Returns:
      The value of the initialSchema attribute

    • getFilter

      public Optional<Expression> getFilter()
      Specified by:
      getFilter in class AbstractReadRel
      Returns:
      The value of the filter attribute

    • getBestEffortFilter

      public Optional<Expression> getBestEffortFilter()
      Specified by:
      getBestEffortFilter in class AbstractReadRel
      Returns:
      The value of the bestEffortFilter attribute

    • getNames

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

    • withExtension

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

    • withInitialSchema

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

    • withFilter

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

    • withFilter

      public final ImmutableNamedScan withFilter(Optional<? extends Expression> optional)
      Copy the current immutable object by setting an optional value for the filter 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 filter
      Returns:
      A modified copy or this if not changed

    • withBestEffortFilter

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

    • withBestEffortFilter

      public final ImmutableNamedScan withBestEffortFilter(Optional<? extends Expression> optional)
      Copy the current immutable object by setting an optional value for the bestEffortFilter 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 bestEffortFilter
      Returns:
      A modified copy or this if not changed

    • withNames

      public final ImmutableNamedScan 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 ImmutableNamedScan 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 ImmutableNamedScan 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, initialSchema, filter, bestEffortFilter, names.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

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

    • copyOf

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

    • builder

      public static ImmutableNamedScan.Builder builder()
      Creates a builder for ImmutableNamedScan. 
       ImmutableNamedScan.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
    .initialSchema(io.substrait.type.NamedStruct) // required initialSchema
    .filter(Optional<io.substrait.expression.Expression>) // optional filter
    .bestEffortFilter(Optional<io.substrait.expression.Expression>) // optional bestEffortFilter
    .addNames|addAllNames(String) // names elements
    .build();
      Returns:
      A new ImmutableNamedScan builder