Package io.substrait.type

Interface Type

All Superinterfaces:

FunctionArg, NullableType, ParameterizedType, TypeExpression

All Known Implementing Classes:

ImmutableType.Binary, ImmutableType.Bool, ImmutableType.Date, ImmutableType.Decimal, ImmutableType.FixedBinary, ImmutableType.FixedChar, ImmutableType.FP32, ImmutableType.FP64, ImmutableType.Func, ImmutableType.I16, ImmutableType.I32, ImmutableType.I64, ImmutableType.I8, ImmutableType.IntervalCompound, ImmutableType.IntervalDay, ImmutableType.IntervalYear, ImmutableType.ListType, ImmutableType.Map, ImmutableType.PrecisionTime, ImmutableType.PrecisionTimestamp, ImmutableType.PrecisionTimestampTZ, ImmutableType.Str, ImmutableType.Struct, ImmutableType.Time, ImmutableType.Timestamp, ImmutableType.TimestampTZ, ImmutableType.UserDefined, ImmutableType.UUID, ImmutableType.VarChar, Type.Binary, Type.Bool, Type.Date, Type.Decimal, Type.FixedBinary, Type.FixedChar, Type.FP32, Type.FP64, Type.Func, Type.I16, Type.I32, Type.I64, Type.I8, Type.IntervalCompound, Type.IntervalDay, Type.IntervalYear, Type.ListType, Type.Map, Type.PrecisionTime, Type.PrecisionTimestamp, Type.PrecisionTimestampTZ, Type.Str, Type.Struct, Type.Time, Type.Timestamp, Type.TimestampTZ, Type.UserDefined, Type.UUID, Type.VarChar

@Enclosing
public interface Type
extends TypeExpression, ParameterizedType, NullableType, FunctionArg

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Type.Binary
static class	Type.Bool
static class	Type.Date
static class	Type.Decimal
static class	Type.FixedBinary
static class	Type.FixedChar
static class	Type.FP32
static class	Type.FP64
static class	Type.Func
static class	Type.I16
static class	Type.I32
static class	Type.I64
static class	Type.I8
static class	Type.IntervalCompound
static class	Type.IntervalDay
static class	Type.IntervalYear
static class	Type.ListType
static class	Type.Map
static interface	Type.Parameter	Represents a type parameter for user-defined types.
static class	Type.ParameterBooleanValue	A boolean value parameter.
static class	Type.ParameterDataType	A data type parameter, such as the i32 in List<i32>.
static class	Type.ParameterEnumValue	An enum value parameter (represented as a string).
static class	Type.ParameterIntegerValue	An integer value parameter, such as the 10 in VARCHAR<10>.
static class	Type.ParameterNull	An explicitly null/unspecified parameter, used to select the default value (if any).
static class	Type.ParameterStringValue	A string value parameter.
static class	Type.PrecisionTime
static class	Type.PrecisionTimestamp
static class	Type.PrecisionTimestampTZ
static class	Type.Str
static class	Type.Struct
static class	Type.Time	Deprecated.
static class	Type.Timestamp	Deprecated.
static class	Type.TimestampTZ	Deprecated.
static class	Type.UserDefined
static class	Type.UUID
static class	Type.VarChar

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

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

Nested classes/interfaces inherited from interface io.substrait.function.ParameterizedType

ParameterizedType.BaseParameterizedType, ParameterizedType.NullableParameterizedType, ParameterizedType.RequiredParameterizedVisitorException, ParameterizedType.StringLiteral

Nested classes/interfaces inherited from interface io.substrait.function.TypeExpression

TypeExpression.BaseTypeExpression, TypeExpression.BinaryOperation, TypeExpression.IfOperation, TypeExpression.IntegerLiteral, TypeExpression.NotOperation, TypeExpression.RequiredTypeExpressionVisitorException, TypeExpression.ReturnProgram

Method Summary

Modifier and Type	Method	Description
default <R, C extends VisitationContext, E extends Throwable> R	accept(SimpleExtension.Function fnDef, int argIdx, FunctionArg.FuncArgVisitor<R,C,E> fnArgVisitor, C context)
<R, E extends Throwable> R	accept(TypeVisitor<R,E> typeVisitor)
default boolean	equalsIgnoringNullability(Type other)	Compares this type with another type, ignoring nullability differences.
static TypeCreator	withNullability(boolean nullable)
Type	withNullable(boolean nullable)	Returns a copy of the Type with the specified nullability.

Methods inherited from interface io.substrait.function.NullableType

nullable

Methods inherited from interface io.substrait.function.ParameterizedType

isWildcard

Method Details

withNullable

Type withNullable(boolean nullable)

Returns a copy of the Type with the specified nullability.

This method is implemented by all concrete Type classes via Immutables code generation.

withNullability

static TypeCreator withNullability(boolean nullable)

accept

<R,
E extends Throwable> R accept(TypeVisitor<R,E> typeVisitor)
                          throws E

Specified by:

accept in interface ParameterizedType

Specified by:

accept in interface TypeExpression

Throws:

E extends Throwable

accept

default <R,
C extends VisitationContext,
E extends Throwable>
R accept(SimpleExtension.Function fnDef,
 int argIdx,
 FunctionArg.FuncArgVisitor<R,C,E> fnArgVisitor,
 C context)
  throws E

Specified by:

accept in interface FunctionArg

Throws:

E extends Throwable

equalsIgnoringNullability

default boolean equalsIgnoringNullability(Type other)

Compares this type with another type, ignoring nullability differences.

Parameters:

other - the type to compare with

Returns:

true if the types are equal when both are treated as nullable