Package io.substrait.expression

Class ImmutableExpression.ScalarFunctionInvocation

java.lang.Object

io.substrait.expression.Expression.ScalarFunctionInvocation

io.substrait.expression.ImmutableExpression.ScalarFunctionInvocation

All Implemented Interfaces:

Expression, FunctionArg

Enclosing class:

ImmutableExpression

public static final class ImmutableExpression.ScalarFunctionInvocation
extends Expression.ScalarFunctionInvocation

Immutable implementation of Expression.ScalarFunctionInvocation.

Use the builder to create immutable instances: ImmutableExpression.ScalarFunctionInvocation.builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ImmutableExpression.ScalarFunctionInvocation.Builder	Builds instances of type ScalarFunctionInvocation.

Nested classes/interfaces inherited from interface io.substrait.expression.Expression

Expression.AggregationInvocation, Expression.AggregationPhase, Expression.BinaryLiteral, Expression.BoolLiteral, Expression.Cast, Expression.DateLiteral, Expression.DecimalLiteral, Expression.EmptyListLiteral, Expression.EmptyMapLiteral, Expression.FailureBehavior, Expression.FixedBinaryLiteral, Expression.FixedCharLiteral, Expression.FP32Literal, Expression.FP64Literal, Expression.I16Literal, Expression.I32Literal, Expression.I64Literal, Expression.I8Literal, Expression.IfClause, Expression.IfThen, Expression.InPredicate, Expression.IntervalCompoundLiteral, Expression.IntervalDayLiteral, Expression.IntervalYearLiteral, Expression.Lambda, Expression.ListLiteral, Expression.Literal, Expression.MapLiteral, Expression.MultiOrList, Expression.MultiOrListRecord, Expression.Nested, Expression.NestedList, Expression.NestedStruct, Expression.NullLiteral, Expression.PrecisionTimeLiteral, Expression.PrecisionTimestampLiteral, Expression.PrecisionTimestampTZLiteral, Expression.PredicateOp, Expression.ScalarFunctionInvocation, Expression.ScalarSubquery, Expression.SetPredicate, Expression.SingleOrList, Expression.SortDirection, Expression.SortField, Expression.StrLiteral, Expression.StructLiteral, Expression.Subquery, Expression.Switch, Expression.SwitchClause, Expression.TimeLiteral, Expression.TimestampLiteral, Expression.TimestampTZLiteral, Expression.UserDefinedAnyLiteral, Expression.UserDefinedLiteral, Expression.UserDefinedStructLiteral, Expression.UUIDLiteral, Expression.VarCharLiteral, Expression.WindowBoundsType, Expression.WindowFunctionInvocation

Nested classes/interfaces inherited from interface io.substrait.expression.FunctionArg

FunctionArg.FuncArgVisitor<R,C extends VisitationContext,E extends Throwable>, FunctionArg.ProtoFrom

Method Summary

Modifier and Type	Method	Description
List<FunctionArg>	arguments()
static ImmutableExpression.ScalarFunctionInvocation.Builder	builder()	Creates a builder for ScalarFunctionInvocation.
static ImmutableExpression.ScalarFunctionInvocation	copyOf(Expression.ScalarFunctionInvocation instance)	Creates an immutable copy of a Expression.ScalarFunctionInvocation value.
SimpleExtension.ScalarFunctionVariant	declaration()
boolean	equals(Object another)	This instance is equal to all instances of ScalarFunctionInvocation that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: declaration, arguments, options, outputType.
List<FunctionOption>	options()
Type	outputType()
String	toString()	Prints the immutable value ScalarFunctionInvocation with attribute values.
final ImmutableExpression.ScalarFunctionInvocation	withArguments(FunctionArg... elements)	Copy the current immutable object with elements that replace the content of arguments.
final ImmutableExpression.ScalarFunctionInvocation	withArguments(Iterable<? extends FunctionArg> elements)	Copy the current immutable object with elements that replace the content of arguments.
final ImmutableExpression.ScalarFunctionInvocation	withDeclaration(SimpleExtension.ScalarFunctionVariant value)	Copy the current immutable object by setting a value for the declaration attribute.
final ImmutableExpression.ScalarFunctionInvocation	withOptions(FunctionOption... elements)	Copy the current immutable object with elements that replace the content of options.
final ImmutableExpression.ScalarFunctionInvocation	withOptions(Iterable<? extends FunctionOption> elements)	Copy the current immutable object with elements that replace the content of options.
final ImmutableExpression.ScalarFunctionInvocation	withOutputType(Type value)	Copy the current immutable object by setting a value for the outputType attribute.

Methods inherited from class io.substrait.expression.Expression.ScalarFunctionInvocation

accept, check, getType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.substrait.expression.Expression

accept

Method Details

declaration

public SimpleExtension.ScalarFunctionVariant declaration()

Specified by:

declaration in class Expression.ScalarFunctionInvocation

Returns:

The value of the declaration attribute

arguments

public List<FunctionArg> arguments()

Specified by:

arguments in class Expression.ScalarFunctionInvocation

Returns:

The value of the arguments attribute

options

public List<FunctionOption> options()

Specified by:

options in class Expression.ScalarFunctionInvocation

Returns:

The value of the options attribute

outputType

public Type outputType()

Specified by:

outputType in class Expression.ScalarFunctionInvocation

Returns:

The value of the outputType attribute

withDeclaration

public final ImmutableExpression.ScalarFunctionInvocation withDeclaration(SimpleExtension.ScalarFunctionVariant value)

Copy the current immutable object by setting a value for the declaration attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for declaration

Returns:

A modified copy or the this object

withArguments

public final ImmutableExpression.ScalarFunctionInvocation withArguments(FunctionArg... elements)

Copy the current immutable object with elements that replace the content of arguments.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withArguments

public final ImmutableExpression.ScalarFunctionInvocation withArguments(Iterable<? extends FunctionArg> elements)

Copy the current immutable object with elements that replace the content of arguments. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of arguments elements to set

Returns:

A modified copy or this if not changed

withOptions

public final ImmutableExpression.ScalarFunctionInvocation withOptions(FunctionOption... elements)

Copy the current immutable object with elements that replace the content of options.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withOptions

public final ImmutableExpression.ScalarFunctionInvocation withOptions(Iterable<? extends FunctionOption> elements)

Copy the current immutable object with elements that replace the content of options. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of options elements to set

Returns:

A modified copy or this if not changed

withOutputType

public final ImmutableExpression.ScalarFunctionInvocation withOutputType(Type value)

Copy the current immutable object by setting a value for the outputType attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for outputType

Returns:

A modified copy or the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of ScalarFunctionInvocation 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: declaration, arguments, options, outputType.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value ScalarFunctionInvocation with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableExpression.ScalarFunctionInvocation copyOf(Expression.ScalarFunctionInvocation instance)

Creates an immutable copy of a Expression.ScalarFunctionInvocation 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 ScalarFunctionInvocation instance

builder

public static ImmutableExpression.ScalarFunctionInvocation.Builder builder()

Creates a builder for ScalarFunctionInvocation.

 ImmutableExpression.ScalarFunctionInvocation.builder()
    .declaration(io.substrait.extension.SimpleExtension.ScalarFunctionVariant) // required declaration
    .addArguments|addAllArguments(io.substrait.expression.FunctionArg) // arguments elements
    .addOptions|addAllOptions(io.substrait.expression.FunctionOption) // options elements
    .outputType(io.substrait.type.Type) // required outputType
    .build();
 

Returns:

A new ScalarFunctionInvocation builder