Package org.apache.calcite.rex

Class RexChecker

java.lang.Object

org.apache.calcite.rex.RexVisitorImpl<@Nullable Boolean>

org.apache.calcite.rex.RexChecker

All Implemented Interfaces:

RexVisitor<Boolean>

public class RexChecker
extends RexVisitorImpl<@Nullable Boolean>

Visitor which checks the validity of a RexNode expression.

This visitor can operate in two modes, controlled by the Litmus argument:

• Litmus.THROW causes the checker to throw an AssertionError as soon as an invalid node is detected. Note: This mode requires that assertions are enabled.

   // Example usage of Litmus.THROW
   RexNode node;
   RelDataType rowType;
   RexChecker checker = new RexChecker(rowType, Litmus.THROW);
   node.accept(checker); // Will throw an AssertionError if node is invalid
   

• Litmus.IGNORE tests validity without throwing an error.

   // Example usage of Litmus.IGNORE
   RexNode node;
   RelDataType rowType;
   RexChecker checker = new RexChecker(rowType, Litmus.IGNORE);
   node.accept(checker);
   if (!checker.isValid()) {
       // Handle invalid node
   }
   

See Also:

• RexNode

Field Summary

Fields

Modifier and Type	Field	Description
protected final @Nullable RelNode.Context	context
protected int	failCount
protected final List<RelDataType>	inputTypeList
protected final Litmus	litmus

Fields inherited from class org.apache.calcite.rex.RexVisitorImpl

deep

Constructor Summary

Constructors

Constructor	Description
RexChecker(List<RelDataType> inputTypeList, @Nullable RelNode.Context context, Litmus litmus)	Creates a RexChecker with a given set of input fields.
RexChecker(RelDataType inputRowType, @Nullable RelNode.Context context, Litmus litmus)	Creates a RexChecker with a given input row type.

Method Summary

Modifier and Type	Method	Description
int	getFailureCount()	Returns the number of failures encountered.
final boolean	isValid(RexNode expr)	Returns whether an expression is valid.
Boolean	visitCall(RexCall call)
Boolean	visitCorrelVariable(RexCorrelVariable v)
Boolean	visitFieldAccess(RexFieldAccess fieldAccess)
Boolean	visitInputRef(RexInputRef ref)
Boolean	visitLocalRef(RexLocalRef ref)

Methods inherited from class org.apache.calcite.rex.RexVisitorImpl

visitArrayAnd, visitArrayOr, visitDynamicParam, visitLambda, visitLambdaRef, visitLiteral, visitOver, visitPatternFieldRef, visitRangeRef, visitSubQuery, visitTableInputRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.calcite.rex.RexVisitor

visitEach, visitList, visitList

Field Details

context

protected final @Nullable RelNode.Context context

litmus

protected final Litmus litmus

inputTypeList

protected final List<RelDataType> inputTypeList

failCount

protected int failCount

Constructor Details

RexChecker

public RexChecker(RelDataType inputRowType,
 @Nullable RelNode.Context context,
 Litmus litmus)

Creates a RexChecker with a given input row type.

If fail is true, the checker will throw an AssertionError if an invalid node is found and assertions are enabled.

Otherwise, each method returns whether its part of the tree is valid.

Parameters:

inputRowType - Input row type

context - Context of the enclosing RelNode, or null

litmus - What to do if an invalid node is detected

RexChecker

public RexChecker(List<RelDataType> inputTypeList,
 @Nullable RelNode.Context context,
 Litmus litmus)

Creates a RexChecker with a given set of input fields.

If fail is true, the checker will throw an AssertionError if an invalid node is found and assertions are enabled.

Otherwise, each method returns whether its part of the tree is valid.

Parameters:

inputTypeList - Input row type

context - Context of the enclosing RelNode, or null

litmus - What to do if an error is detected

Method Details

getFailureCount

public int getFailureCount()

Returns the number of failures encountered.

Returns:

Number of failures

visitInputRef

public Boolean visitInputRef(RexInputRef ref)

Specified by:

visitInputRef in interface RexVisitor<Boolean>

Overrides:

visitInputRef in class RexVisitorImpl<@Nullable Boolean>

visitLocalRef

public Boolean visitLocalRef(RexLocalRef ref)

Specified by:

visitLocalRef in interface RexVisitor<Boolean>

Overrides:

visitLocalRef in class RexVisitorImpl<@Nullable Boolean>

visitCall

public Boolean visitCall(RexCall call)

Specified by:

visitCall in interface RexVisitor<Boolean>

Overrides:

visitCall in class RexVisitorImpl<@Nullable Boolean>

visitFieldAccess

public Boolean visitFieldAccess(RexFieldAccess fieldAccess)

Specified by:

visitFieldAccess in interface RexVisitor<Boolean>

Overrides:

visitFieldAccess in class RexVisitorImpl<@Nullable Boolean>

visitCorrelVariable

public Boolean visitCorrelVariable(RexCorrelVariable v)

Specified by:

visitCorrelVariable in interface RexVisitor<Boolean>

Overrides:

visitCorrelVariable in class RexVisitorImpl<@Nullable Boolean>

isValid

public final boolean isValid(RexNode expr)

Returns whether an expression is valid.