Package org.apache.calcite.rex

Class RexChecker

java.lang.Object

org.apache.calcite.rex.RexVisitorImpl<java.lang.Boolean>

org.apache.calcite.rex.RexChecker

All Implemented Interfaces:

RexVisitor<java.lang.Boolean>

Direct Known Subclasses:

RexProgram.Checker

public class RexChecker
extends RexVisitorImpl<java.lang.Boolean>

Visitor which checks the validity of a RexNode expression.

There are two modes of operation:

• Usefail=true to throw an AssertionError as soon as an invalid node is detected:

  RexNode node;
RelDataType rowType;
assert new RexChecker(rowType, true).isValid(node);

  This mode requires that assertions are enabled.
• Use fail=false to test for validity without throwing an error.

  RexNode node;
RelDataType rowType;
RexChecker checker = new RexChecker(rowType, false);
node.accept(checker);
if (!checker.valid) {
...
}

See Also:

RexNode

Field Summary

Fields

Modifier and Type	Field	Description
protected RelNode.Context	context
protected int	failCount
protected java.util.List<RelDataType>	inputTypeList
protected Litmus	litmus

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

deep

Constructor Summary

Constructors

Constructor	Description
RexChecker(java.util.List<RelDataType> inputTypeList, RelNode.Context context, Litmus litmus)	Creates a RexChecker with a given set of input fields.
RexChecker(RelDataType inputRowType, 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.
boolean	isValid(RexNode expr)	Returns whether an expression is valid.
java.lang.Boolean	visitCall(RexCall call)
java.lang.Boolean	visitCorrelVariable(RexCorrelVariable v)
java.lang.Boolean	visitFieldAccess(RexFieldAccess fieldAccess)
java.lang.Boolean	visitInputRef(RexInputRef ref)
java.lang.Boolean	visitLocalRef(RexLocalRef ref)

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

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

Methods inherited from class java.lang.Object

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

Field Detail

context

protected final RelNode.Context context

litmus

protected final Litmus litmus

inputTypeList

protected final java.util.List<RelDataType> inputTypeList

failCount

protected int failCount

Constructor Detail

RexChecker

public RexChecker(RelDataType inputRowType,
                  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(java.util.List<RelDataType> inputTypeList,
                  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 Detail

getFailureCount

public int getFailureCount()

Returns the number of failures encountered.

Returns:

Number of failures

visitInputRef

public java.lang.Boolean visitInputRef(RexInputRef ref)

Specified by:

visitInputRef in interface RexVisitor<java.lang.Boolean>

Overrides:

visitInputRef in class RexVisitorImpl<java.lang.Boolean>

visitLocalRef

public java.lang.Boolean visitLocalRef(RexLocalRef ref)

Specified by:

visitLocalRef in interface RexVisitor<java.lang.Boolean>

Overrides:

visitLocalRef in class RexVisitorImpl<java.lang.Boolean>

visitCall

public java.lang.Boolean visitCall(RexCall call)

Specified by:

visitCall in interface RexVisitor<java.lang.Boolean>

Overrides:

visitCall in class RexVisitorImpl<java.lang.Boolean>

visitFieldAccess

public java.lang.Boolean visitFieldAccess(RexFieldAccess fieldAccess)

Specified by:

visitFieldAccess in interface RexVisitor<java.lang.Boolean>

Overrides:

visitFieldAccess in class RexVisitorImpl<java.lang.Boolean>

visitCorrelVariable

public java.lang.Boolean visitCorrelVariable(RexCorrelVariable v)

Specified by:

visitCorrelVariable in interface RexVisitor<java.lang.Boolean>

Overrides:

visitCorrelVariable in class RexVisitorImpl<java.lang.Boolean>

isValid

public final boolean isValid(RexNode expr)

Returns whether an expression is valid.