Package io.substrait.expression

Class ExpressionCreator

java.lang.Object

io.substrait.expression.ExpressionCreator

public class ExpressionCreator
extends Object

Method Summary

Modifier and Type	Method	Description
static AggregateFunctionInvocation	aggregateFunction(SimpleExtension.AggregateFunctionVariant declaration, Type outputType, Expression.AggregationPhase phase, List<Expression.SortField> sort, Expression.AggregationInvocation invocation, FunctionArg... arguments)
static AggregateFunctionInvocation	aggregateFunction(SimpleExtension.AggregateFunctionVariant declaration, Type outputType, Expression.AggregationPhase phase, List<Expression.SortField> sort, Expression.AggregationInvocation invocation, Iterable<? extends FunctionArg> arguments)	Use AggregateFunctionInvocation.builder() directly to specify other parameters, e.g.
static Expression.BinaryLiteral	binary(boolean nullable, byte[] value)
static Expression.BinaryLiteral	binary(boolean nullable, com.google.protobuf.ByteString value)
static Expression.BoolLiteral	bool(boolean nullable, boolean value)
static Expression	cast(Type type, Expression expression, Expression.FailureBehavior failureBehavior)
static Expression.DateLiteral	date(boolean nullable, int value)
static Expression.DecimalLiteral	decimal(boolean nullable, com.google.protobuf.ByteString value, int precision, int scale)
static Expression.DecimalLiteral	decimal(boolean nullable, BigDecimal value, int precision, int scale)
static Expression.EmptyListLiteral	emptyList(boolean listNullable, Type elementType)
static Expression.EmptyMapLiteral	emptyMap(boolean nullable, Type keyType, Type valueType)
static Expression.FixedBinaryLiteral	fixedBinary(boolean nullable, byte[] bytes)
static Expression.FixedBinaryLiteral	fixedBinary(boolean nullable, com.google.protobuf.ByteString bytes)
static Expression.FixedCharLiteral	fixedChar(boolean nullable, String str)
static Expression.FP32Literal	fp32(boolean nullable, float value)
static Expression.FP64Literal	fp64(boolean nullable, double value)
static Expression.I16Literal	i16(boolean nullable, int value)
static Expression.I32Literal	i32(boolean nullable, int value)
static Expression.I64Literal	i64(boolean nullable, long value)
static Expression.I8Literal	i8(boolean nullable, int value)
static Expression.IfClause	ifThenClause(Expression conditionExpression, Expression resultExpression)
static Expression.IfThen	ifThenStatement(Expression elseExpression, Expression.IfClause... conditionClauses)
static Expression.IfThen	ifThenStatement(Expression elseExpression, Iterable<? extends Expression.IfClause> conditionClauses)
static Expression.IntervalCompoundLiteral	intervalCompound(boolean nullable, int years, int months, int days, int seconds, long subseconds, int precision)
static Expression.IntervalDayLiteral	intervalDay(boolean nullable, int days, int seconds)
static Expression.IntervalDayLiteral	intervalDay(boolean nullable, int days, int seconds, long subseconds, int precision)
static Expression.IntervalYearLiteral	intervalYear(boolean nullable, int years, int months)
static Expression.ListLiteral	list(boolean nullable, Expression.Literal... values)
static Expression.ListLiteral	list(boolean nullable, Iterable<? extends Expression.Literal> values)
static Expression.MapLiteral	map(boolean nullable, Map<Expression.Literal,Expression.Literal> values)
static Expression.NestedList	nestedList(boolean nullable, List<Expression> values)	Creates a nested list expression with one or more elements.
static Expression.NestedStruct	nestedStruct(boolean nullable, Expression... fields)
static Expression.NestedStruct	nestedStruct(boolean nullable, Iterable<Expression> fields)
static Expression.PrecisionTimeLiteral	precisionTime(boolean nullable, long value, int precision)
static Expression.PrecisionTimeLiteral	precisionTime(boolean nullable, LocalTime value)	Creates a precision time literal from a LocalTime value.
static Expression.PrecisionTimestampLiteral	precisionTimestamp(boolean nullable, long value, int precision)
static Expression.PrecisionTimestampLiteral	precisionTimestamp(boolean nullable, LocalDateTime value)	Creates a precision timestamp literal from a LocalDateTime value.
static Expression.PrecisionTimestampTZLiteral	precisionTimestampTZ(boolean nullable, long value, int precision)
static Expression.ScalarFunctionInvocation	scalarFunction(SimpleExtension.ScalarFunctionVariant declaration, Type outputType, FunctionArg... arguments)
static Expression.ScalarFunctionInvocation	scalarFunction(SimpleExtension.ScalarFunctionVariant declaration, Type outputType, Iterable<? extends FunctionArg> arguments)	Use Expression.ScalarFunctionInvocation.builder() directly to specify other parameters, e.g.
static Expression.StrLiteral	string(boolean nullable, String value)
static Expression.StructLiteral	struct(boolean nullable, Expression.Literal... values)
static Expression.StructLiteral	struct(boolean nullable, Iterable<? extends Expression.Literal> values)
static Expression.SwitchClause	switchClause(Expression.Literal expectedValue, Expression resultExpression)
static Expression.Switch	switchStatement(Expression match, Expression defaultExpression, Expression.SwitchClause... conditionClauses)
static Expression.Switch	switchStatement(Expression match, Expression defaultExpression, Iterable<? extends Expression.SwitchClause> conditionClauses)
static Expression.TimeLiteral	time(boolean nullable, long value)	Deprecated. Time is deprecated in favor of PrecisionTime
static Expression.TimestampLiteral	timestamp(boolean nullable, int year, int month, int dayOfMonth, int hour, int minute, int second, int micros)	Deprecated. Timestamp is deprecated in favor of PrecisionTimestamp
static Expression.TimestampLiteral	timestamp(boolean nullable, long value)	Deprecated. Timestamp is deprecated in favor of PrecisionTimestamp
static Expression.TimestampLiteral	timestamp(boolean nullable, LocalDateTime value)	Deprecated. Timestamp is deprecated in favor of PrecisionTimestamp
static Expression.TimestampTZLiteral	timestampTZ(boolean nullable, long value)	Deprecated. TimestampTZ is deprecated in favor of PrecisionTimestampTZ
static Expression.TimestampTZLiteral	timestampTZ(boolean nullable, Instant value)	Deprecated. TimestampTZ is deprecated in favor of PrecisionTimestampTZ
static Expression.NullLiteral	typedNull(Type t)
static Expression.UserDefinedAnyLiteral	userDefinedLiteralAny(boolean nullable, String urn, String name, List<Type.Parameter> typeParameters, com.google.protobuf.Any value)	Create a UserDefinedAnyLiteral with google.protobuf.Any representation.
static Expression.UserDefinedStructLiteral	userDefinedLiteralStruct(boolean nullable, String urn, String name, List<Type.Parameter> typeParameters, List<Expression.Literal> fields)	Create a UserDefinedStructLiteral with Struct representation.
static Expression.UUIDLiteral	uuid(boolean nullable, com.google.protobuf.ByteString uuid)
static Expression.UUIDLiteral	uuid(boolean nullable, UUID uuid)
static Expression.VarCharLiteral	varChar(boolean nullable, String str, int len)
static Expression.WindowFunctionInvocation	windowFunction(SimpleExtension.WindowFunctionVariant declaration, Type outputType, Expression.AggregationPhase phase, List<Expression.SortField> sort, Expression.AggregationInvocation invocation, List<Expression> partitionBy, Expression.WindowBoundsType boundsType, WindowBound lowerBound, WindowBound upperBound, FunctionArg... arguments)
static Expression.WindowFunctionInvocation	windowFunction(SimpleExtension.WindowFunctionVariant declaration, Type outputType, Expression.AggregationPhase phase, List<Expression.SortField> sort, Expression.AggregationInvocation invocation, List<Expression> partitionBy, Expression.WindowBoundsType boundsType, WindowBound lowerBound, WindowBound upperBound, Iterable<? extends FunctionArg> arguments)	Use Expression.WindowFunctionInvocation.builder() directly to specify other parameters, e.g.
static ConsistentPartitionWindow.WindowRelFunctionInvocation	windowRelFunction(SimpleExtension.WindowFunctionVariant declaration, Type outputType, Expression.AggregationPhase phase, Expression.AggregationInvocation invocation, Expression.WindowBoundsType boundsType, WindowBound lowerBound, WindowBound upperBound, Iterable<? extends FunctionArg> arguments)	Use ConsistentPartitionWindow.WindowRelFunctionInvocation.builder() directly to specify other parameters, e.g.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

typedNull

public static Expression.NullLiteral typedNull(Type t)

bool

public static Expression.BoolLiteral bool(boolean nullable,
 boolean value)

i8

public static Expression.I8Literal i8(boolean nullable,
 int value)

i16

public static Expression.I16Literal i16(boolean nullable,
 int value)

i32

public static Expression.I32Literal i32(boolean nullable,
 int value)

i64

public static Expression.I64Literal i64(boolean nullable,
 long value)

fp32

public static Expression.FP32Literal fp32(boolean nullable,
 float value)

fp64

public static Expression.FP64Literal fp64(boolean nullable,
 double value)

string

public static Expression.StrLiteral string(boolean nullable,
 String value)

binary

public static Expression.BinaryLiteral binary(boolean nullable,
 com.google.protobuf.ByteString value)

binary

public static Expression.BinaryLiteral binary(boolean nullable,
 byte[] value)

date

public static Expression.DateLiteral date(boolean nullable,
 int value)

time

@Deprecated
public static Expression.TimeLiteral time(boolean nullable,
 long value)

Deprecated.

Time is deprecated in favor of PrecisionTime

precisionTime

public static Expression.PrecisionTimeLiteral precisionTime(boolean nullable,
 long value,
 int precision)

precisionTime

public static Expression.PrecisionTimeLiteral precisionTime(boolean nullable,
 LocalTime value)

Creates a precision time literal from a LocalTime value.

This method converts a Java LocalTime to a Substrait precision time literal with nanosecond precision (precision = 9). The time value is represented as nanoseconds since midnight (00:00:00).

Parameters:

nullable - whether the literal can be null

value - the LocalTime value to convert

Returns:

a PrecisionTimeLiteral with nanosecond precision representing the given time

See Also:

• for creating precision time with custom precision

timestamp

@Deprecated
public static Expression.TimestampLiteral timestamp(boolean nullable,
 long value)

Deprecated.

Timestamp is deprecated in favor of PrecisionTimestamp

timestamp

@Deprecated
public static Expression.TimestampLiteral timestamp(boolean nullable,
 LocalDateTime value)

Deprecated.

Timestamp is deprecated in favor of PrecisionTimestamp

timestamp

@Deprecated
public static Expression.TimestampLiteral timestamp(boolean nullable,
 int year,
 int month,
 int dayOfMonth,
 int hour,
 int minute,
 int second,
 int micros)

Deprecated.

Timestamp is deprecated in favor of PrecisionTimestamp

timestampTZ

@Deprecated
public static Expression.TimestampTZLiteral timestampTZ(boolean nullable,
 long value)

Deprecated.

TimestampTZ is deprecated in favor of PrecisionTimestampTZ

timestampTZ

@Deprecated
public static Expression.TimestampTZLiteral timestampTZ(boolean nullable,
 Instant value)

Deprecated.

TimestampTZ is deprecated in favor of PrecisionTimestampTZ

precisionTimestamp

public static Expression.PrecisionTimestampLiteral precisionTimestamp(boolean nullable,
 long value,
 int precision)

precisionTimestamp

public static Expression.PrecisionTimestampLiteral precisionTimestamp(boolean nullable,
 LocalDateTime value)

Creates a precision timestamp literal from a LocalDateTime value.

This method converts a Java LocalDateTime to a Substrait precision timestamp literal with nanosecond precision (precision = 9). The timestamp value is represented as nanoseconds since the Unix epoch (1970-01-01 00:00:00 UTC), assuming the LocalDateTime is in UTC timezone.

Parameters:

nullable - whether the literal can be null

value - the LocalDateTime value to convert (interpreted as UTC)

Returns:

a PrecisionTimestampLiteral with nanosecond precision representing the given timestamp

See Also:

• for creating precision timestamp with custom precision

precisionTimestampTZ

public static Expression.PrecisionTimestampTZLiteral precisionTimestampTZ(boolean nullable,
 long value,
 int precision)

intervalYear

public static Expression.IntervalYearLiteral intervalYear(boolean nullable,
 int years,
 int months)

intervalDay

public static Expression.IntervalDayLiteral intervalDay(boolean nullable,
 int days,
 int seconds)

intervalDay

public static Expression.IntervalDayLiteral intervalDay(boolean nullable,
 int days,
 int seconds,
 long subseconds,
 int precision)

intervalCompound

public static Expression.IntervalCompoundLiteral intervalCompound(boolean nullable,
 int years,
 int months,
 int days,
 int seconds,
 long subseconds,
 int precision)

uuid

public static Expression.UUIDLiteral uuid(boolean nullable,
 com.google.protobuf.ByteString uuid)

uuid

public static Expression.UUIDLiteral uuid(boolean nullable,
 UUID uuid)

fixedChar

public static Expression.FixedCharLiteral fixedChar(boolean nullable,
 String str)

varChar

public static Expression.VarCharLiteral varChar(boolean nullable,
 String str,
 int len)

fixedBinary

public static Expression.FixedBinaryLiteral fixedBinary(boolean nullable,
 com.google.protobuf.ByteString bytes)

fixedBinary

public static Expression.FixedBinaryLiteral fixedBinary(boolean nullable,
 byte[] bytes)

decimal

public static Expression.DecimalLiteral decimal(boolean nullable,
 com.google.protobuf.ByteString value,
 int precision,
 int scale)

decimal

public static Expression.DecimalLiteral decimal(boolean nullable,
 BigDecimal value,
 int precision,
 int scale)

map

public static Expression.MapLiteral map(boolean nullable,
 Map<Expression.Literal,Expression.Literal> values)

emptyMap

public static Expression.EmptyMapLiteral emptyMap(boolean nullable,
 Type keyType,
 Type valueType)

list

public static Expression.ListLiteral list(boolean nullable,
 Expression.Literal... values)

list

public static Expression.ListLiteral list(boolean nullable,
 Iterable<? extends Expression.Literal> values)

emptyList

public static Expression.EmptyListLiteral emptyList(boolean listNullable,
 Type elementType)

struct

public static Expression.StructLiteral struct(boolean nullable,
 Expression.Literal... values)

nestedList

public static Expression.NestedList nestedList(boolean nullable,
 List<Expression> values)

Creates a nested list expression with one or more elements.

Note: This class cannot be used to construct an empty list. To create an empty list, use emptyList(boolean, Type) which returns an Expression.EmptyListLiteral.

struct

public static Expression.StructLiteral struct(boolean nullable,
 Iterable<? extends Expression.Literal> values)

nestedStruct

public static Expression.NestedStruct nestedStruct(boolean nullable,
 Iterable<Expression> fields)

nestedStruct

public static Expression.NestedStruct nestedStruct(boolean nullable,
 Expression... fields)

userDefinedLiteralAny

public static Expression.UserDefinedAnyLiteral userDefinedLiteralAny(boolean nullable,
 String urn,
 String name,
 List<Type.Parameter> typeParameters,
 com.google.protobuf.Any value)

Create a UserDefinedAnyLiteral with google.protobuf.Any representation.

Parameters:

nullable - whether the literal is nullable

urn - the URN of the user-defined type

name - the name of the user-defined type

typeParameters - the type parameters for the user-defined type (can be an empty list)

value - the value, encoded as google.protobuf.Any

userDefinedLiteralStruct

public static Expression.UserDefinedStructLiteral userDefinedLiteralStruct(boolean nullable,
 String urn,
 String name,
 List<Type.Parameter> typeParameters,
 List<Expression.Literal> fields)

Create a UserDefinedStructLiteral with Struct representation.

Parameters:

nullable - whether the literal is nullable

urn - the URN of the user-defined type

name - the name of the user-defined type

typeParameters - the type parameters for the user-defined type (can be an empty list)

fields - the fields, as a list of Literal values

switchStatement

public static Expression.Switch switchStatement(Expression match,
 Expression defaultExpression,
 Expression.SwitchClause... conditionClauses)

switchStatement

public static Expression.Switch switchStatement(Expression match,
 Expression defaultExpression,
 Iterable<? extends Expression.SwitchClause> conditionClauses)

switchClause

public static Expression.SwitchClause switchClause(Expression.Literal expectedValue,
 Expression resultExpression)

ifThenStatement

public static Expression.IfThen ifThenStatement(Expression elseExpression,
 Expression.IfClause... conditionClauses)

ifThenStatement

public static Expression.IfThen ifThenStatement(Expression elseExpression,
 Iterable<? extends Expression.IfClause> conditionClauses)

ifThenClause

public static Expression.IfClause ifThenClause(Expression conditionExpression,
 Expression resultExpression)

scalarFunction

public static Expression.ScalarFunctionInvocation scalarFunction(SimpleExtension.ScalarFunctionVariant declaration,
 Type outputType,
 FunctionArg... arguments)

scalarFunction

public static Expression.ScalarFunctionInvocation scalarFunction(SimpleExtension.ScalarFunctionVariant declaration,
 Type outputType,
 Iterable<? extends FunctionArg> arguments)

Use Expression.ScalarFunctionInvocation.builder() directly to specify other parameters, e.g. options

aggregateFunction

public static AggregateFunctionInvocation aggregateFunction(SimpleExtension.AggregateFunctionVariant declaration,
 Type outputType,
 Expression.AggregationPhase phase,
 List<Expression.SortField> sort,
 Expression.AggregationInvocation invocation,
 Iterable<? extends FunctionArg> arguments)

Use AggregateFunctionInvocation.builder() directly to specify other parameters, e.g. options

aggregateFunction

public static AggregateFunctionInvocation aggregateFunction(SimpleExtension.AggregateFunctionVariant declaration,
 Type outputType,
 Expression.AggregationPhase phase,
 List<Expression.SortField> sort,
 Expression.AggregationInvocation invocation,
 FunctionArg... arguments)

windowFunction

public static Expression.WindowFunctionInvocation windowFunction(SimpleExtension.WindowFunctionVariant declaration,
 Type outputType,
 Expression.AggregationPhase phase,
 List<Expression.SortField> sort,
 Expression.AggregationInvocation invocation,
 List<Expression> partitionBy,
 Expression.WindowBoundsType boundsType,
 WindowBound lowerBound,
 WindowBound upperBound,
 Iterable<? extends FunctionArg> arguments)

Use Expression.WindowFunctionInvocation.builder() directly to specify other parameters, e.g. options

windowRelFunction

public static ConsistentPartitionWindow.WindowRelFunctionInvocation windowRelFunction(SimpleExtension.WindowFunctionVariant declaration,
 Type outputType,
 Expression.AggregationPhase phase,
 Expression.AggregationInvocation invocation,
 Expression.WindowBoundsType boundsType,
 WindowBound lowerBound,
 WindowBound upperBound,
 Iterable<? extends FunctionArg> arguments)

Use ConsistentPartitionWindow.WindowRelFunctionInvocation.builder() directly to specify other parameters, e.g. options

windowFunction

public static Expression.WindowFunctionInvocation windowFunction(SimpleExtension.WindowFunctionVariant declaration,
 Type outputType,
 Expression.AggregationPhase phase,
 List<Expression.SortField> sort,
 Expression.AggregationInvocation invocation,
 List<Expression> partitionBy,
 Expression.WindowBoundsType boundsType,
 WindowBound lowerBound,
 WindowBound upperBound,
 FunctionArg... arguments)

cast

public static Expression cast(Type type,
 Expression expression,
 Expression.FailureBehavior failureBehavior)