Package io.substrait.expression

Class FieldReference

java.lang.Object

io.substrait.expression.FieldReference

All Implemented Interfaces:

Expression, FunctionArg

Direct Known Subclasses:

ImmutableFieldReference

@Immutable
public abstract class FieldReference
extends Object
implements Expression

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FieldReference.ListElement
static class	FieldReference.MapKey
static interface	FieldReference.ReferenceSegment
static class	FieldReference.StructField

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

Constructor Summary

Constructors

Constructor	Description
FieldReference()

Method Summary

Modifier and Type	Method	Description
<R, C extends VisitationContext, E extends Throwable> R	accept(ExpressionVisitor<R,C,E> visitor, C context)
static ImmutableFieldReference.Builder	builder()
protected void	check()
FieldReference	dereferenceList(int index)
FieldReference	dereferenceMap(Expression.Literal mapKey)
FieldReference	dereferenceStruct(int index)
Type	getType()
abstract Optional<Expression>	inputExpression()
boolean	isLambdaParameterReference()	Returns true if this field reference refers to a lambda parameter.
boolean	isOuterReference()
boolean	isSimpleRootReference()
abstract Optional<Integer>	lambdaParameterReferenceStepsOut()
static FieldReference	newInputRelReference(int index, Rel rel)
static FieldReference	newInputRelReference(int index, List<Rel> rels)
static FieldReference	newListReference(int index, Expression expression)
static FieldReference	newMapReference(Expression.Literal mapKey, Expression expression)
static FieldReference	newRootStructOuterReference(int index, Type knownType, int stepsOut)
static FieldReference	newRootStructReference(int index, Type knownType)
static FieldReference	newStructReference(int index, Expression expression)
static FieldReference	ofExpression(Expression expression, List<FieldReference.ReferenceSegment> segments)
static FieldReference	ofRoot(Type.Struct struct, List<FieldReference.ReferenceSegment> segments)
abstract Optional<Integer>	outerReferenceStepsOut()
abstract List<FieldReference.ReferenceSegment>	segments()
abstract Type	type()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.substrait.expression.Expression

accept

Constructor Details

FieldReference

public FieldReference()

Method Details

segments

public abstract List<FieldReference.ReferenceSegment> segments()

type

public abstract Type type()

inputExpression

public abstract Optional<Expression> inputExpression()

outerReferenceStepsOut

public abstract Optional<Integer> outerReferenceStepsOut()

lambdaParameterReferenceStepsOut

public abstract Optional<Integer> lambdaParameterReferenceStepsOut()

getType

public Type getType()

Specified by:

getType in interface Expression

builder

public static ImmutableFieldReference.Builder builder()

accept

public <R,
C extends VisitationContext,
E extends Throwable>
R accept(ExpressionVisitor<R,C,E> visitor,
 C context)
  throws E

Specified by:

accept in interface Expression

Throws:

E extends Throwable

check

@Check
protected void check()

isSimpleRootReference

public boolean isSimpleRootReference()

isOuterReference

public boolean isOuterReference()

isLambdaParameterReference

public boolean isLambdaParameterReference()

Returns true if this field reference refers to a lambda parameter.

dereferenceStruct

public FieldReference dereferenceStruct(int index)

dereferenceList

public FieldReference dereferenceList(int index)

dereferenceMap

public FieldReference dereferenceMap(Expression.Literal mapKey)

newMapReference

public static FieldReference newMapReference(Expression.Literal mapKey,
 Expression expression)

newListReference

public static FieldReference newListReference(int index,
 Expression expression)

newStructReference

public static FieldReference newStructReference(int index,
 Expression expression)

newRootStructReference

public static FieldReference newRootStructReference(int index,
 Type knownType)

newRootStructOuterReference

public static FieldReference newRootStructOuterReference(int index,
 Type knownType,
 int stepsOut)

newInputRelReference

public static FieldReference newInputRelReference(int index,
 Rel rel)

newInputRelReference

public static FieldReference newInputRelReference(int index,
 List<Rel> rels)

ofExpression

public static FieldReference ofExpression(Expression expression,
 List<FieldReference.ReferenceSegment> segments)

ofRoot

public static FieldReference ofRoot(Type.Struct struct,
 List<FieldReference.ReferenceSegment> segments)