blob: 2366625037e9a9b438bbf75012b8eb6cadb6c2d0 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>RexChecker (Apache Calcite API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.calcite.rex, class: RexChecker">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<div class="about-language"><b>Apache Calcite</b></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.calcite.rex</a></div>
<h1 title="Class RexChecker" class="title">Class RexChecker</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance"><a href="RexVisitorImpl.html" title="class in org.apache.calcite.rex">org.apache.calcite.rex.RexVisitorImpl</a>&lt;@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>&gt;
<div class="inheritance">org.apache.calcite.rex.RexChecker</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="RexVisitor.html" title="interface in org.apache.calcite.rex">RexVisitor</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>&gt;</code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">RexChecker</span>
<span class="extends-implements">extends <a href="RexVisitorImpl.html" title="class in org.apache.calcite.rex">RexVisitorImpl</a>&lt;@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>&gt;</span></div>
<div class="block">Visitor which checks the validity of a <a href="RexNode.html" title="class in org.apache.calcite.rex"><code>RexNode</code></a> expression.
<p>There are two modes of operation:
<ul>
<li>Use<code>fail=true</code> to throw an <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AssertionError.html" title="class or interface in java.lang" class="external-link"><code>AssertionError</code></a> as soon as
an invalid node is detected:
<blockquote><code>RexNode node;<br>
RelDataType rowType;<br>
assert new RexChecker(rowType, true).isValid(node);</code></blockquote>
This mode requires that assertions are enabled.</li>
<li>Use <code>fail=false</code> to test for validity without throwing an
error.
<blockquote><code>RexNode node;<br>
RelDataType rowType;<br>
RexChecker checker = new RexChecker(rowType, false);<br>
node.accept(checker);<br>
if (!checker.valid) {<br>
&nbsp;&nbsp;&nbsp;...<br>
}</code></blockquote>
</li>
</ul></div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="RexNode.html" title="class in org.apache.calcite.rex"><code>RexNode</code></a></li>
</ul>
</dd>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>protected final @Nullable <a href="../rel/RelNode.Context.html" title="interface in org.apache.calcite.rel">RelNode.Context</a></code></div>
<div class="col-second even-row-color"><code><a href="#context" class="member-name-link">context</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>protected int</code></div>
<div class="col-second odd-row-color"><code><a href="#failCount" class="member-name-link">failCount</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>protected final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&gt;</code></div>
<div class="col-second even-row-color"><code><a href="#inputTypeList" class="member-name-link">inputTypeList</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>protected final <a href="../util/Litmus.html" title="interface in org.apache.calcite.util">Litmus</a></code></div>
<div class="col-second odd-row-color"><code><a href="#litmus" class="member-name-link">litmus</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.apache.calcite.rex.RexVisitorImpl">Fields inherited from class&nbsp;org.apache.calcite.rex.<a href="RexVisitorImpl.html" title="class in org.apache.calcite.rex">RexVisitorImpl</a></h3>
<code><a href="RexVisitorImpl.html#deep">deep</a></code></div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.util.List,org.apache.calcite.rel.RelNode.Context,org.apache.calcite.util.Litmus)" class="member-name-link">RexChecker</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&gt;&nbsp;inputTypeList,
@Nullable <a href="../rel/RelNode.Context.html" title="interface in org.apache.calcite.rel">RelNode.Context</a>&nbsp;context,
<a href="../util/Litmus.html" title="interface in org.apache.calcite.util">Litmus</a>&nbsp;litmus)</code></div>
<div class="col-last even-row-color">
<div class="block">Creates a RexChecker with a given set of input fields.</div>
</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.calcite.rel.type.RelDataType,org.apache.calcite.rel.RelNode.Context,org.apache.calcite.util.Litmus)" class="member-name-link">RexChecker</a><wbr>(<a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&nbsp;inputRowType,
@Nullable <a href="../rel/RelNode.Context.html" title="interface in org.apache.calcite.rel">RelNode.Context</a>&nbsp;context,
<a href="../util/Litmus.html" title="interface in org.apache.calcite.util">Litmus</a>&nbsp;litmus)</code></div>
<div class="col-last odd-row-color">
<div class="block">Creates a RexChecker with a given input row type.</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFailureCount()" class="member-name-link">getFailureCount</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the number of failures encountered.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isValid(org.apache.calcite.rex.RexNode)" class="member-name-link">isValid</a><wbr>(<a href="RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>&nbsp;expr)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns whether an expression is valid.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#visitCall(org.apache.calcite.rex.RexCall)" class="member-name-link">visitCall</a><wbr>(<a href="RexCall.html" title="class in org.apache.calcite.rex">RexCall</a>&nbsp;call)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#visitCorrelVariable(org.apache.calcite.rex.RexCorrelVariable)" class="member-name-link">visitCorrelVariable</a><wbr>(<a href="RexCorrelVariable.html" title="class in org.apache.calcite.rex">RexCorrelVariable</a>&nbsp;v)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#visitFieldAccess(org.apache.calcite.rex.RexFieldAccess)" class="member-name-link">visitFieldAccess</a><wbr>(<a href="RexFieldAccess.html" title="class in org.apache.calcite.rex">RexFieldAccess</a>&nbsp;fieldAccess)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#visitInputRef(org.apache.calcite.rex.RexInputRef)" class="member-name-link">visitInputRef</a><wbr>(<a href="RexInputRef.html" title="class in org.apache.calcite.rex">RexInputRef</a>&nbsp;ref)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#visitLocalRef(org.apache.calcite.rex.RexLocalRef)" class="member-name-link">visitLocalRef</a><wbr>(<a href="RexLocalRef.html" title="class in org.apache.calcite.rex">RexLocalRef</a>&nbsp;ref)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.calcite.rex.RexVisitorImpl">Methods inherited from class&nbsp;org.apache.calcite.rex.<a href="RexVisitorImpl.html" title="class in org.apache.calcite.rex">RexVisitorImpl</a></h3>
<code><a href="RexVisitorImpl.html#visitArrayAnd(org.apache.calcite.rex.RexVisitor,java.util.List)">visitArrayAnd</a>, <a href="RexVisitorImpl.html#visitArrayOr(org.apache.calcite.rex.RexVisitor,java.util.List)">visitArrayOr</a>, <a href="RexVisitorImpl.html#visitDynamicParam(org.apache.calcite.rex.RexDynamicParam)">visitDynamicParam</a>, <a href="RexVisitorImpl.html#visitLiteral(org.apache.calcite.rex.RexLiteral)">visitLiteral</a>, <a href="RexVisitorImpl.html#visitOver(org.apache.calcite.rex.RexOver)">visitOver</a>, <a href="RexVisitorImpl.html#visitPatternFieldRef(org.apache.calcite.rex.RexPatternFieldRef)">visitPatternFieldRef</a>, <a href="RexVisitorImpl.html#visitRangeRef(org.apache.calcite.rex.RexRangeRef)">visitRangeRef</a>, <a href="RexVisitorImpl.html#visitSubQuery(org.apache.calcite.rex.RexSubQuery)">visitSubQuery</a>, <a href="RexVisitorImpl.html#visitTableInputRef(org.apache.calcite.rex.RexTableInputRef)">visitTableInputRef</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.calcite.rex.RexVisitor">Methods inherited from interface&nbsp;org.apache.calcite.rex.<a href="RexVisitor.html" title="interface in org.apache.calcite.rex">RexVisitor</a></h3>
<code><a href="RexVisitor.html#visitEach(java.lang.Iterable)">visitEach</a>, <a href="RexVisitor.html#visitList(java.lang.Iterable)">visitList</a>, <a href="RexVisitor.html#visitList(java.lang.Iterable,java.util.List)">visitList</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="context">
<h3>context</h3>
<div class="member-signature"><span class="modifiers">protected final</span>&nbsp;<span class="return-type">@Nullable <a href="../rel/RelNode.Context.html" title="interface in org.apache.calcite.rel">RelNode.Context</a></span>&nbsp;<span class="element-name">context</span></div>
</section>
</li>
<li>
<section class="detail" id="litmus">
<h3>litmus</h3>
<div class="member-signature"><span class="modifiers">protected final</span>&nbsp;<span class="return-type"><a href="../util/Litmus.html" title="interface in org.apache.calcite.util">Litmus</a></span>&nbsp;<span class="element-name">litmus</span></div>
</section>
</li>
<li>
<section class="detail" id="inputTypeList">
<h3>inputTypeList</h3>
<div class="member-signature"><span class="modifiers">protected final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&gt;</span>&nbsp;<span class="element-name">inputTypeList</span></div>
</section>
</li>
<li>
<section class="detail" id="failCount">
<h3>failCount</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">failCount</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(org.apache.calcite.rel.type.RelDataType,org.apache.calcite.rel.RelNode.Context,org.apache.calcite.util.Litmus)">
<h3>RexChecker</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">RexChecker</span><wbr><span class="parameters">(<a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&nbsp;inputRowType,
@Nullable <a href="../rel/RelNode.Context.html" title="interface in org.apache.calcite.rel">RelNode.Context</a>&nbsp;context,
<a href="../util/Litmus.html" title="interface in org.apache.calcite.util">Litmus</a>&nbsp;litmus)</span></div>
<div class="block">Creates a RexChecker with a given input row type.
<p>If <code>fail</code> is true, the checker will throw an
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AssertionError.html" title="class or interface in java.lang" class="external-link"><code>AssertionError</code></a> if an invalid node is found and assertions are
enabled.
<p>Otherwise, each method returns whether its part of the tree is valid.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>inputRowType</code> - Input row type</dd>
<dd><code>context</code> - Context of the enclosing <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a>, or null</dd>
<dd><code>litmus</code> - What to do if an invalid node is detected</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(java.util.List,org.apache.calcite.rel.RelNode.Context,org.apache.calcite.util.Litmus)">
<h3>RexChecker</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">RexChecker</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&gt;&nbsp;inputTypeList,
@Nullable <a href="../rel/RelNode.Context.html" title="interface in org.apache.calcite.rel">RelNode.Context</a>&nbsp;context,
<a href="../util/Litmus.html" title="interface in org.apache.calcite.util">Litmus</a>&nbsp;litmus)</span></div>
<div class="block">Creates a RexChecker with a given set of input fields.
<p>If <code>fail</code> is true, the checker will throw an
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AssertionError.html" title="class or interface in java.lang" class="external-link"><code>AssertionError</code></a> if an invalid node is found and assertions are
enabled.
<p>Otherwise, each method returns whether its part of the tree is valid.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>inputTypeList</code> - Input row type</dd>
<dd><code>context</code> - Context of the enclosing <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a>, or null</dd>
<dd><code>litmus</code> - What to do if an error is detected</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getFailureCount()">
<h3>getFailureCount</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getFailureCount</span>()</div>
<div class="block">Returns the number of failures encountered.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>Number of failures</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="visitInputRef(org.apache.calcite.rex.RexInputRef)">
<h3>visitInputRef</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></span>&nbsp;<span class="element-name">visitInputRef</span><wbr><span class="parameters">(<a href="RexInputRef.html" title="class in org.apache.calcite.rex">RexInputRef</a>&nbsp;ref)</span></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="RexVisitor.html#visitInputRef(org.apache.calcite.rex.RexInputRef)">visitInputRef</a></code>&nbsp;in interface&nbsp;<code><a href="RexVisitor.html" title="interface in org.apache.calcite.rex">RexVisitor</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>&gt;</code></dd>
<dt>Overrides:</dt>
<dd><code><a href="RexVisitorImpl.html#visitInputRef(org.apache.calcite.rex.RexInputRef)">visitInputRef</a></code>&nbsp;in class&nbsp;<code><a href="RexVisitorImpl.html" title="class in org.apache.calcite.rex">RexVisitorImpl</a>&lt;@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>&gt;</code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="visitLocalRef(org.apache.calcite.rex.RexLocalRef)">
<h3>visitLocalRef</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></span>&nbsp;<span class="element-name">visitLocalRef</span><wbr><span class="parameters">(<a href="RexLocalRef.html" title="class in org.apache.calcite.rex">RexLocalRef</a>&nbsp;ref)</span></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="RexVisitor.html#visitLocalRef(org.apache.calcite.rex.RexLocalRef)">visitLocalRef</a></code>&nbsp;in interface&nbsp;<code><a href="RexVisitor.html" title="interface in org.apache.calcite.rex">RexVisitor</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>&gt;</code></dd>
<dt>Overrides:</dt>
<dd><code><a href="RexVisitorImpl.html#visitLocalRef(org.apache.calcite.rex.RexLocalRef)">visitLocalRef</a></code>&nbsp;in class&nbsp;<code><a href="RexVisitorImpl.html" title="class in org.apache.calcite.rex">RexVisitorImpl</a>&lt;@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>&gt;</code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="visitCall(org.apache.calcite.rex.RexCall)">
<h3>visitCall</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></span>&nbsp;<span class="element-name">visitCall</span><wbr><span class="parameters">(<a href="RexCall.html" title="class in org.apache.calcite.rex">RexCall</a>&nbsp;call)</span></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="RexVisitor.html#visitCall(org.apache.calcite.rex.RexCall)">visitCall</a></code>&nbsp;in interface&nbsp;<code><a href="RexVisitor.html" title="interface in org.apache.calcite.rex">RexVisitor</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>&gt;</code></dd>
<dt>Overrides:</dt>
<dd><code><a href="RexVisitorImpl.html#visitCall(org.apache.calcite.rex.RexCall)">visitCall</a></code>&nbsp;in class&nbsp;<code><a href="RexVisitorImpl.html" title="class in org.apache.calcite.rex">RexVisitorImpl</a>&lt;@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>&gt;</code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="visitFieldAccess(org.apache.calcite.rex.RexFieldAccess)">
<h3>visitFieldAccess</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></span>&nbsp;<span class="element-name">visitFieldAccess</span><wbr><span class="parameters">(<a href="RexFieldAccess.html" title="class in org.apache.calcite.rex">RexFieldAccess</a>&nbsp;fieldAccess)</span></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="RexVisitor.html#visitFieldAccess(org.apache.calcite.rex.RexFieldAccess)">visitFieldAccess</a></code>&nbsp;in interface&nbsp;<code><a href="RexVisitor.html" title="interface in org.apache.calcite.rex">RexVisitor</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>&gt;</code></dd>
<dt>Overrides:</dt>
<dd><code><a href="RexVisitorImpl.html#visitFieldAccess(org.apache.calcite.rex.RexFieldAccess)">visitFieldAccess</a></code>&nbsp;in class&nbsp;<code><a href="RexVisitorImpl.html" title="class in org.apache.calcite.rex">RexVisitorImpl</a>&lt;@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>&gt;</code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="visitCorrelVariable(org.apache.calcite.rex.RexCorrelVariable)">
<h3>visitCorrelVariable</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></span>&nbsp;<span class="element-name">visitCorrelVariable</span><wbr><span class="parameters">(<a href="RexCorrelVariable.html" title="class in org.apache.calcite.rex">RexCorrelVariable</a>&nbsp;v)</span></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="RexVisitor.html#visitCorrelVariable(org.apache.calcite.rex.RexCorrelVariable)">visitCorrelVariable</a></code>&nbsp;in interface&nbsp;<code><a href="RexVisitor.html" title="interface in org.apache.calcite.rex">RexVisitor</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>&gt;</code></dd>
<dt>Overrides:</dt>
<dd><code><a href="RexVisitorImpl.html#visitCorrelVariable(org.apache.calcite.rex.RexCorrelVariable)">visitCorrelVariable</a></code>&nbsp;in class&nbsp;<code><a href="RexVisitorImpl.html" title="class in org.apache.calcite.rex">RexVisitorImpl</a>&lt;@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>&gt;</code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isValid(org.apache.calcite.rex.RexNode)">
<h3>isValid</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isValid</span><wbr><span class="parameters">(<a href="RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>&nbsp;expr)</span></div>
<div class="block">Returns whether an expression is valid.</div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &copy; 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>