| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>SqlToRelConverter.Blackboard (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.sql2rel, class: SqlToRelConverter, class: Blackboard"> |
| <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: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </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> <a href="package-summary.html">org.apache.calcite.sql2rel</a></div> |
| <h1 title="Class SqlToRelConverter.Blackboard" class="title">Class SqlToRelConverter.Blackboard</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">org.apache.calcite.sql2rel.SqlToRelConverter.Blackboard</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../sql/util/SqlVisitor.html" title="interface in org.apache.calcite.sql.util">SqlVisitor</a><<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>></code>, <code><a href="InitializerContext.html" title="interface in org.apache.calcite.sql2rel">InitializerContext</a></code>, <code><a href="SqlRexContext.html" title="interface in org.apache.calcite.sql2rel">SqlRexContext</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Enclosing class:</dt> |
| <dd><a href="SqlToRelConverter.html" title="class in org.apache.calcite.sql2rel">SqlToRelConverter</a></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">protected class </span><span class="element-name type-name-label">SqlToRelConverter.Blackboard</span> |
| <span class="extends-implements">extends <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> |
| implements <a href="SqlRexContext.html" title="interface in org.apache.calcite.sql2rel">SqlRexContext</a>, <a href="../sql/util/SqlVisitor.html" title="interface in org.apache.calcite.sql.util">SqlVisitor</a><<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>>, <a href="InitializerContext.html" title="interface in org.apache.calcite.sql2rel">InitializerContext</a></span></div> |
| <div class="block">Workspace for translating an individual SELECT statement (or sub-SELECT).</div> |
| </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>@Nullable <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#root" class="member-name-link">root</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>final @Nullable <a href="../sql/validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#scope" class="member-name-link">scope</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Collection of <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a> objects which correspond to a SELECT |
| statement.</div> |
| </div> |
| </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 three-column-summary"> |
| <div class="table-header col-first">Modifier</div> |
| <div class="table-header col-second">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.calcite.sql.validate.SqlValidatorScope,java.util.Map,boolean)" class="member-name-link">Blackboard</a><wbr>(@Nullable <a href="../sql/validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a> scope, |
| @Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>> nameToNodeMap, |
| boolean top)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a Blackboard.</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><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated 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><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#convertExpression(org.apache.calcite.sql.SqlNode)" class="member-name-link">convertExpression</a><wbr>(<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> expr)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Converts an expression from <a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql"><code>SqlNode</code></a> to <a href="../rex/RexNode.html" title="class in org.apache.calcite.rex"><code>RexNode</code></a> format.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#convertInterval(org.apache.calcite.sql.SqlIntervalQualifier)" class="member-name-link">convertInterval</a><wbr>(<a href="../sql/SqlIntervalQualifier.html" title="class in org.apache.calcite.sql">SqlIntervalQualifier</a> intervalQualifier)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#convertLiteral(org.apache.calcite.sql.SqlLiteral)" class="member-name-link">convertLiteral</a><wbr>(<a href="../sql/SqlLiteral.html" title="class in org.apache.calcite.sql">SqlLiteral</a> literal)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Converts a literal.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="../rex/RexFieldCollation.html" title="class in org.apache.calcite.rex">RexFieldCollation</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#convertSortExpression(org.apache.calcite.sql.SqlNode,org.apache.calcite.rel.RelFieldCollation.Direction,org.apache.calcite.rel.RelFieldCollation.NullDirection)" class="member-name-link">convertSortExpression</a><wbr>(<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> expr, |
| <a href="../rel/RelFieldCollation.Direction.html" title="enum in org.apache.calcite.rel">RelFieldCollation.Direction</a> direction, |
| <a href="../rel/RelFieldCollation.NullDirection.html" title="enum in org.apache.calcite.rel">RelFieldCollation.NullDirection</a> nullDirection)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#flatten(java.util.List,int,int%5B%5D,java.util.List)" class="member-name-link">flatten</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><<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> rels, |
| int systemFieldCount, |
| int[] start, |
| <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><<a href="../util/Pair.html" title="class in org.apache.calcite.util">Pair</a><<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>>> relOffsetList)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </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/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../sql/validate/SqlMonotonicity.html" title="enum in org.apache.calcite.sql.validate">SqlMonotonicity</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getColumnMonotonicities()" class="member-name-link">getColumnMonotonicities</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </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="#getGroupCount()" class="member-name-link">getGroupCount</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">If the operator call occurs in an aggregate query, returns the number of |
| columns in the GROUP BY clause.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="InitializerExpressionFactory.html" title="interface in org.apache.calcite.sql2rel">InitializerExpressionFactory</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getInitializerExpressionFactory()" class="member-name-link">getInitializerExpressionFactory</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the factory which supplies default values for INSERT, UPDATE, and |
| NEW.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../rex/RexBuilder.html" title="class in org.apache.calcite.rex">RexBuilder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRexBuilder()" class="member-name-link">getRexBuilder</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 <a href="../rex/RexBuilder.html" title="class in org.apache.calcite.rex"><code>RexBuilder</code></a> to use to create <a href="../rex/RexNode.html" title="class in org.apache.calcite.rex"><code>RexNode</code></a> objects.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../rex/RexRangeRef.html" title="class in org.apache.calcite.rex">RexRangeRef</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSubQueryExpr(org.apache.calcite.sql.SqlCall)" class="member-name-link">getSubQueryExpr</a><wbr>(<a href="../sql/SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the expression used to access a given IN or EXISTS |
| <a href="../sql/SqlSelect.html" title="class in org.apache.calcite.sql"><code>sub-query</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTypeFactory()" class="member-name-link">getTypeFactory</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 type factory.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../sql/validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getValidator()" class="member-name-link">getValidator</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the validator.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#register(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.core.JoinRelType)" class="member-name-link">register</a><wbr>(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| <a href="../rel/core/JoinRelType.html" title="enum in org.apache.calcite.rel.core">JoinRelType</a> joinType)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#register(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.core.JoinRelType,java.util.List)" class="member-name-link">register</a><wbr>(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| <a href="../rel/core/JoinRelType.html" title="enum in org.apache.calcite.rel.core">JoinRelType</a> joinType, |
| @Nullable <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><<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>> leftKeys)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Registers a relational expression.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reRegister(org.apache.calcite.rel.RelNode)" class="member-name-link">reRegister</a><wbr>(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> root)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Re-register the <code>registered</code> with given root node and |
| return the new root node.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#root()" class="member-name-link">root</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../sql/validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#scope()" class="member-name-link">scope</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setDataset(java.lang.String)" class="member-name-link">setDataset</a><wbr>(@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> datasetName)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Notifies this Blackboard that the root just set using |
| <a href="#setRoot(org.apache.calcite.rel.RelNode,boolean)"><code>setRoot(RelNode, boolean)</code></a> was derived using dataset |
| substitution.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setPatternVarRef(boolean)" class="member-name-link">setPatternVarRef</a><wbr>(boolean isVarRef)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setRoot(org.apache.calcite.rel.RelNode,boolean)" class="member-name-link">setRoot</a><wbr>(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> root, |
| boolean leaf)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets a new root relational expression, as the translation process |
| backs its way further up the tree.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#validateExpression(org.apache.calcite.rel.type.RelDataType,org.apache.calcite.sql.SqlNode)" class="member-name-link">validateExpression</a><wbr>(<a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> rowType, |
| <a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> expr)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Validate the expression with a base table row type.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#visit(org.apache.calcite.sql.SqlCall)" class="member-name-link">visit</a><wbr>(<a href="../sql/SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Visits a call to a <a href="../sql/SqlOperator.html" title="class in org.apache.calcite.sql"><code>SqlOperator</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#visit(org.apache.calcite.sql.SqlDataTypeSpec)" class="member-name-link">visit</a><wbr>(<a href="../sql/SqlDataTypeSpec.html" title="class in org.apache.calcite.sql">SqlDataTypeSpec</a> type)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Visits a datatype specification.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#visit(org.apache.calcite.sql.SqlDynamicParam)" class="member-name-link">visit</a><wbr>(<a href="../sql/SqlDynamicParam.html" title="class in org.apache.calcite.sql">SqlDynamicParam</a> param)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Visits a dynamic parameter.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#visit(org.apache.calcite.sql.SqlIdentifier)" class="member-name-link">visit</a><wbr>(<a href="../sql/SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a> id)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Visits an identifier.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#visit(org.apache.calcite.sql.SqlIntervalQualifier)" class="member-name-link">visit</a><wbr>(<a href="../sql/SqlIntervalQualifier.html" title="class in org.apache.calcite.sql">SqlIntervalQualifier</a> intervalQualifier)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Visits an interval qualifier.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#visit(org.apache.calcite.sql.SqlLiteral)" class="member-name-link">visit</a><wbr>(<a href="../sql/SqlLiteral.html" title="class in org.apache.calcite.sql">SqlLiteral</a> literal)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Visits a literal.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#visit(org.apache.calcite.sql.SqlNodeList)" class="member-name-link">visit</a><wbr>(<a href="../sql/SqlNodeList.html" title="class in org.apache.calcite.sql">SqlNodeList</a> nodeList)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Visits a list of <a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql"><code>SqlNode</code></a> objects.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class 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.sql2rel.InitializerContext">Methods inherited from interface org.apache.calcite.sql2rel.<a href="InitializerContext.html" title="interface in org.apache.calcite.sql2rel">InitializerContext</a></h3> |
| <code><a href="InitializerContext.html#parseExpression(org.apache.calcite.sql.parser.SqlParser.Config,java.lang.String)">parseExpression</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.sql.util.SqlVisitor">Methods inherited from interface org.apache.calcite.sql.util.<a href="../sql/util/SqlVisitor.html" title="interface in org.apache.calcite.sql.util">SqlVisitor</a></h3> |
| <code><a href="../sql/util/SqlVisitor.html#visitNode(org.apache.calcite.sql.SqlNode)">visitNode</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="scope"> |
| <h3>scope</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">@Nullable <a href="../sql/validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a></span> <span class="element-name">scope</span></div> |
| <div class="block">Collection of <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a> objects which correspond to a SELECT |
| statement.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="root"> |
| <h3>root</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">@Nullable <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span> <span class="element-name">root</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="<init>(org.apache.calcite.sql.validate.SqlValidatorScope,java.util.Map,boolean)"> |
| <h3>Blackboard</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">Blackboard</span><wbr><span class="parameters">(@Nullable <a href="../sql/validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a> scope, |
| @Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>> nameToNodeMap, |
| boolean top)</span></div> |
| <div class="block">Creates a Blackboard.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>scope</code> - Name-resolution scope for expressions validated |
| within this query. Can be null if this Blackboard is |
| for a leaf node, say</dd> |
| <dd><code>nameToNodeMap</code> - Map which translates the expression to map a |
| given parameter into, if translating expressions; |
| null otherwise</dd> |
| <dd><code>top</code> - Whether this is the root of the query</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="root()"> |
| <h3>root</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span> <span class="element-name">root</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="scope()"> |
| <h3>scope</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../sql/validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a></span> <span class="element-name">scope</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setPatternVarRef(boolean)"> |
| <h3>setPatternVarRef</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setPatternVarRef</span><wbr><span class="parameters">(boolean isVarRef)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="register(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.core.JoinRelType)"> |
| <h3>register</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></span> <span class="element-name">register</span><wbr><span class="parameters">(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| <a href="../rel/core/JoinRelType.html" title="enum in org.apache.calcite.rel.core">JoinRelType</a> joinType)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="register(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.core.JoinRelType,java.util.List)"> |
| <h3>register</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></span> <span class="element-name">register</span><wbr><span class="parameters">(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| <a href="../rel/core/JoinRelType.html" title="enum in org.apache.calcite.rel.core">JoinRelType</a> joinType, |
| @Nullable <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><<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>> leftKeys)</span></div> |
| <div class="block">Registers a relational expression.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rel</code> - Relational expression</dd> |
| <dd><code>joinType</code> - Join type</dd> |
| <dd><code>leftKeys</code> - LHS of IN clause, or null for expressions |
| other than IN</dd> |
| <dt>Returns:</dt> |
| <dd>Expression with which to refer to the row (or partial row) |
| coming from this relational expression's side of the join</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="reRegister(org.apache.calcite.rel.RelNode)"> |
| <h3>reRegister</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></span> <span class="element-name">reRegister</span><wbr><span class="parameters">(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> root)</span></div> |
| <div class="block">Re-register the <code>registered</code> with given root node and |
| return the new root node.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>root</code> - The given root, never leaf</dd> |
| <dt>Returns:</dt> |
| <dd>new root after the registration</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setRoot(org.apache.calcite.rel.RelNode,boolean)"> |
| <h3>setRoot</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setRoot</span><wbr><span class="parameters">(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> root, |
| boolean leaf)</span></div> |
| <div class="block">Sets a new root relational expression, as the translation process |
| backs its way further up the tree.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>root</code> - New root relational expression</dd> |
| <dd><code>leaf</code> - Whether the relational expression is a leaf, that is, |
| derived from an atomic relational expression such as a table |
| name in the from clause, or the projection on top of a |
| select-sub-query. In particular, relational expressions |
| derived from JOIN operators are not leaves, but set |
| expressions are.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setDataset(java.lang.String)"> |
| <h3>setDataset</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setDataset</span><wbr><span class="parameters">(@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> datasetName)</span></div> |
| <div class="block">Notifies this Blackboard that the root just set using |
| <a href="#setRoot(org.apache.calcite.rel.RelNode,boolean)"><code>setRoot(RelNode, boolean)</code></a> was derived using dataset |
| substitution. |
| |
| <p>The default implementation is not interested in such |
| notifications, and does nothing.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>datasetName</code> - Dataset name</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="flatten(java.util.List,int,int[],java.util.List)"> |
| <h3>flatten</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">flatten</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><<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> rels, |
| int systemFieldCount, |
| int[] start, |
| <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><<a href="../util/Pair.html" title="class in org.apache.calcite.util">Pair</a><<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>>> relOffsetList)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertExpression(org.apache.calcite.sql.SqlNode)"> |
| <h3>convertExpression</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></span> <span class="element-name">convertExpression</span><wbr><span class="parameters">(<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> expr)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SqlRexContext.html#convertExpression(org.apache.calcite.sql.SqlNode)">SqlRexContext</a></code></span></div> |
| <div class="block">Converts an expression from <a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql"><code>SqlNode</code></a> to <a href="../rex/RexNode.html" title="class in org.apache.calcite.rex"><code>RexNode</code></a> format.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="InitializerContext.html#convertExpression(org.apache.calcite.sql.SqlNode)">convertExpression</a></code> in interface <code><a href="InitializerContext.html" title="interface in org.apache.calcite.sql2rel">InitializerContext</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SqlRexContext.html#convertExpression(org.apache.calcite.sql.SqlNode)">convertExpression</a></code> in interface <code><a href="SqlRexContext.html" title="interface in org.apache.calcite.sql2rel">SqlRexContext</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>expr</code> - Expression to translate</dd> |
| <dt>Returns:</dt> |
| <dd>Converted expression</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertSortExpression(org.apache.calcite.sql.SqlNode,org.apache.calcite.rel.RelFieldCollation.Direction,org.apache.calcite.rel.RelFieldCollation.NullDirection)"> |
| <h3>convertSortExpression</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="../rex/RexFieldCollation.html" title="class in org.apache.calcite.rex">RexFieldCollation</a></span> <span class="element-name">convertSortExpression</span><wbr><span class="parameters">(<a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> expr, |
| <a href="../rel/RelFieldCollation.Direction.html" title="enum in org.apache.calcite.rel">RelFieldCollation.Direction</a> direction, |
| <a href="../rel/RelFieldCollation.NullDirection.html" title="enum in org.apache.calcite.rel">RelFieldCollation.NullDirection</a> nullDirection)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block">Converts an item in an ORDER BY clause inside a window (OVER) clause, |
| extracting DESC, NULLS LAST and NULLS FIRST flags first.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getGroupCount()"> |
| <h3>getGroupCount</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getGroupCount</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SqlRexContext.html#getGroupCount()">SqlRexContext</a></code></span></div> |
| <div class="block">If the operator call occurs in an aggregate query, returns the number of |
| columns in the GROUP BY clause. For example, for "SELECT count(*) FROM emp |
| GROUP BY deptno, gender", returns 2. |
| If the operator call occurs in window aggregate query, then returns 1 if |
| the window is guaranteed to be non-empty, or 0 if the window might be |
| empty. |
| |
| <p>Returns 0 if the query is implicitly "GROUP BY ()" because of an |
| aggregate expression. For example, "SELECT sum(sal) FROM emp".</p> |
| |
| <p>Returns -1 if the query is not an aggregate query.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SqlRexContext.html#getGroupCount()">getGroupCount</a></code> in interface <code><a href="SqlRexContext.html" title="interface in org.apache.calcite.sql2rel">SqlRexContext</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>0 if the query is implicitly GROUP BY (), -1 if the query is not |
| and aggregate query</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="../sql/SqlOperatorBinding.html#getGroupCount()"><code>SqlOperatorBinding.getGroupCount()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRexBuilder()"> |
| <h3>getRexBuilder</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../rex/RexBuilder.html" title="class in org.apache.calcite.rex">RexBuilder</a></span> <span class="element-name">getRexBuilder</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SqlRexContext.html#getRexBuilder()">SqlRexContext</a></code></span></div> |
| <div class="block">Returns the <a href="../rex/RexBuilder.html" title="class in org.apache.calcite.rex"><code>RexBuilder</code></a> to use to create <a href="../rex/RexNode.html" title="class in org.apache.calcite.rex"><code>RexNode</code></a> objects.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="InitializerContext.html#getRexBuilder()">getRexBuilder</a></code> in interface <code><a href="InitializerContext.html" title="interface in org.apache.calcite.sql2rel">InitializerContext</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SqlRexContext.html#getRexBuilder()">getRexBuilder</a></code> in interface <code><a href="SqlRexContext.html" title="interface in org.apache.calcite.sql2rel">SqlRexContext</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="validateExpression(org.apache.calcite.rel.type.RelDataType,org.apache.calcite.sql.SqlNode)"> |
| <h3>validateExpression</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></span> <span class="element-name">validateExpression</span><wbr><span class="parameters">(<a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> rowType, |
| <a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> expr)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="InitializerContext.html#validateExpression(org.apache.calcite.rel.type.RelDataType,org.apache.calcite.sql.SqlNode)">InitializerContext</a></code></span></div> |
| <div class="block">Validate the expression with a base table row type. The expression may reference the fields |
| of the row type defines.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="InitializerContext.html#validateExpression(org.apache.calcite.rel.type.RelDataType,org.apache.calcite.sql.SqlNode)">validateExpression</a></code> in interface <code><a href="InitializerContext.html" title="interface in org.apache.calcite.sql2rel">InitializerContext</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>rowType</code> - the table row type</dd> |
| <dd><code>expr</code> - the expression</dd> |
| <dt>Returns:</dt> |
| <dd>a validated <code>SqlNode</code>, usually it transforms |
| from a <code>SqlUnresolvedFunction</code> to a resolved one</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSubQueryExpr(org.apache.calcite.sql.SqlCall)"> |
| <h3>getSubQueryExpr</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../rex/RexRangeRef.html" title="class in org.apache.calcite.rex">RexRangeRef</a></span> <span class="element-name">getSubQueryExpr</span><wbr><span class="parameters">(<a href="../sql/SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SqlRexContext.html#getSubQueryExpr(org.apache.calcite.sql.SqlCall)">SqlRexContext</a></code></span></div> |
| <div class="block">Returns the expression used to access a given IN or EXISTS |
| <a href="../sql/SqlSelect.html" title="class in org.apache.calcite.sql"><code>sub-query</code></a>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SqlRexContext.html#getSubQueryExpr(org.apache.calcite.sql.SqlCall)">getSubQueryExpr</a></code> in interface <code><a href="SqlRexContext.html" title="interface in org.apache.calcite.sql2rel">SqlRexContext</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>call</code> - IN or EXISTS expression</dd> |
| <dt>Returns:</dt> |
| <dd>Expression used to access current row of sub-query</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTypeFactory()"> |
| <h3>getTypeFactory</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a></span> <span class="element-name">getTypeFactory</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SqlRexContext.html#getTypeFactory()">SqlRexContext</a></code></span></div> |
| <div class="block">Returns the type factory.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SqlRexContext.html#getTypeFactory()">getTypeFactory</a></code> in interface <code><a href="SqlRexContext.html" title="interface in org.apache.calcite.sql2rel">SqlRexContext</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getInitializerExpressionFactory()"> |
| <h3>getInitializerExpressionFactory</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="InitializerExpressionFactory.html" title="interface in org.apache.calcite.sql2rel">InitializerExpressionFactory</a></span> <span class="element-name">getInitializerExpressionFactory</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SqlRexContext.html#getInitializerExpressionFactory()">SqlRexContext</a></code></span></div> |
| <div class="block">Returns the factory which supplies default values for INSERT, UPDATE, and |
| NEW.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SqlRexContext.html#getInitializerExpressionFactory()">getInitializerExpressionFactory</a></code> in interface <code><a href="SqlRexContext.html" title="interface in org.apache.calcite.sql2rel">SqlRexContext</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getValidator()"> |
| <h3>getValidator</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../sql/validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a></span> <span class="element-name">getValidator</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SqlRexContext.html#getValidator()">SqlRexContext</a></code></span></div> |
| <div class="block">Returns the validator.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SqlRexContext.html#getValidator()">getValidator</a></code> in interface <code><a href="SqlRexContext.html" title="interface in org.apache.calcite.sql2rel">SqlRexContext</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertLiteral(org.apache.calcite.sql.SqlLiteral)"> |
| <h3>convertLiteral</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></span> <span class="element-name">convertLiteral</span><wbr><span class="parameters">(<a href="../sql/SqlLiteral.html" title="class in org.apache.calcite.sql">SqlLiteral</a> literal)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SqlRexContext.html#convertLiteral(org.apache.calcite.sql.SqlLiteral)">SqlRexContext</a></code></span></div> |
| <div class="block">Converts a literal.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SqlRexContext.html#convertLiteral(org.apache.calcite.sql.SqlLiteral)">convertLiteral</a></code> in interface <code><a href="SqlRexContext.html" title="interface in org.apache.calcite.sql2rel">SqlRexContext</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertInterval(org.apache.calcite.sql.SqlIntervalQualifier)"> |
| <h3>convertInterval</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></span> <span class="element-name">convertInterval</span><wbr><span class="parameters">(<a href="../sql/SqlIntervalQualifier.html" title="class in org.apache.calcite.sql">SqlIntervalQualifier</a> intervalQualifier)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="visit(org.apache.calcite.sql.SqlLiteral)"> |
| <h3>visit</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></span> <span class="element-name">visit</span><wbr><span class="parameters">(<a href="../sql/SqlLiteral.html" title="class in org.apache.calcite.sql">SqlLiteral</a> literal)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../sql/util/SqlVisitor.html#visit(org.apache.calcite.sql.SqlLiteral)">SqlVisitor</a></code></span></div> |
| <div class="block">Visits a literal.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../sql/util/SqlVisitor.html#visit(org.apache.calcite.sql.SqlLiteral)">visit</a></code> in interface <code><a href="../sql/util/SqlVisitor.html" title="interface in org.apache.calcite.sql.util">SqlVisitor</a><<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>literal</code> - Literal</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../sql/SqlLiteral.html#accept(org.apache.calcite.sql.util.SqlVisitor)"><code>SqlLiteral.accept(SqlVisitor)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="visit(org.apache.calcite.sql.SqlCall)"> |
| <h3>visit</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></span> <span class="element-name">visit</span><wbr><span class="parameters">(<a href="../sql/SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../sql/util/SqlVisitor.html#visit(org.apache.calcite.sql.SqlCall)">SqlVisitor</a></code></span></div> |
| <div class="block">Visits a call to a <a href="../sql/SqlOperator.html" title="class in org.apache.calcite.sql"><code>SqlOperator</code></a>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../sql/util/SqlVisitor.html#visit(org.apache.calcite.sql.SqlCall)">visit</a></code> in interface <code><a href="../sql/util/SqlVisitor.html" title="interface in org.apache.calcite.sql.util">SqlVisitor</a><<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>call</code> - Call</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../sql/SqlCall.html#accept(org.apache.calcite.sql.util.SqlVisitor)"><code>SqlCall.accept(SqlVisitor)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="visit(org.apache.calcite.sql.SqlNodeList)"> |
| <h3>visit</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></span> <span class="element-name">visit</span><wbr><span class="parameters">(<a href="../sql/SqlNodeList.html" title="class in org.apache.calcite.sql">SqlNodeList</a> nodeList)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../sql/util/SqlVisitor.html#visit(org.apache.calcite.sql.SqlNodeList)">SqlVisitor</a></code></span></div> |
| <div class="block">Visits a list of <a href="../sql/SqlNode.html" title="class in org.apache.calcite.sql"><code>SqlNode</code></a> objects.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../sql/util/SqlVisitor.html#visit(org.apache.calcite.sql.SqlNodeList)">visit</a></code> in interface <code><a href="../sql/util/SqlVisitor.html" title="interface in org.apache.calcite.sql.util">SqlVisitor</a><<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>nodeList</code> - list of nodes</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../sql/SqlNodeList.html#accept(org.apache.calcite.sql.util.SqlVisitor)"><code>SqlNodeList.accept(SqlVisitor)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="visit(org.apache.calcite.sql.SqlIdentifier)"> |
| <h3>visit</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></span> <span class="element-name">visit</span><wbr><span class="parameters">(<a href="../sql/SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a> id)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../sql/util/SqlVisitor.html#visit(org.apache.calcite.sql.SqlIdentifier)">SqlVisitor</a></code></span></div> |
| <div class="block">Visits an identifier.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../sql/util/SqlVisitor.html#visit(org.apache.calcite.sql.SqlIdentifier)">visit</a></code> in interface <code><a href="../sql/util/SqlVisitor.html" title="interface in org.apache.calcite.sql.util">SqlVisitor</a><<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>id</code> - identifier</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="../sql/SqlIdentifier.html#accept(org.apache.calcite.sql.util.SqlVisitor)"><code>SqlIdentifier.accept(SqlVisitor)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="visit(org.apache.calcite.sql.SqlDataTypeSpec)"> |
| <h3>visit</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></span> <span class="element-name">visit</span><wbr><span class="parameters">(<a href="../sql/SqlDataTypeSpec.html" title="class in org.apache.calcite.sql">SqlDataTypeSpec</a> type)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../sql/util/SqlVisitor.html#visit(org.apache.calcite.sql.SqlDataTypeSpec)">SqlVisitor</a></code></span></div> |
| <div class="block">Visits a datatype specification.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../sql/util/SqlVisitor.html#visit(org.apache.calcite.sql.SqlDataTypeSpec)">visit</a></code> in interface <code><a href="../sql/util/SqlVisitor.html" title="interface in org.apache.calcite.sql.util">SqlVisitor</a><<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>type</code> - datatype specification</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="../sql/SqlDataTypeSpec.html#accept(org.apache.calcite.sql.util.SqlVisitor)"><code>SqlDataTypeSpec.accept(SqlVisitor)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="visit(org.apache.calcite.sql.SqlDynamicParam)"> |
| <h3>visit</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></span> <span class="element-name">visit</span><wbr><span class="parameters">(<a href="../sql/SqlDynamicParam.html" title="class in org.apache.calcite.sql">SqlDynamicParam</a> param)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../sql/util/SqlVisitor.html#visit(org.apache.calcite.sql.SqlDynamicParam)">SqlVisitor</a></code></span></div> |
| <div class="block">Visits a dynamic parameter.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../sql/util/SqlVisitor.html#visit(org.apache.calcite.sql.SqlDynamicParam)">visit</a></code> in interface <code><a href="../sql/util/SqlVisitor.html" title="interface in org.apache.calcite.sql.util">SqlVisitor</a><<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>param</code> - Dynamic parameter</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="../sql/SqlDynamicParam.html#accept(org.apache.calcite.sql.util.SqlVisitor)"><code>SqlDynamicParam.accept(SqlVisitor)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="visit(org.apache.calcite.sql.SqlIntervalQualifier)"> |
| <h3>visit</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></span> <span class="element-name">visit</span><wbr><span class="parameters">(<a href="../sql/SqlIntervalQualifier.html" title="class in org.apache.calcite.sql">SqlIntervalQualifier</a> intervalQualifier)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../sql/util/SqlVisitor.html#visit(org.apache.calcite.sql.SqlIntervalQualifier)">SqlVisitor</a></code></span></div> |
| <div class="block">Visits an interval qualifier.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../sql/util/SqlVisitor.html#visit(org.apache.calcite.sql.SqlIntervalQualifier)">visit</a></code> in interface <code><a href="../sql/util/SqlVisitor.html" title="interface in org.apache.calcite.sql.util">SqlVisitor</a><<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>intervalQualifier</code> - Interval qualifier</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="../sql/SqlIntervalQualifier.html#accept(org.apache.calcite.sql.util.SqlVisitor)"><code>SqlIntervalQualifier.accept(SqlVisitor)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getColumnMonotonicities()"> |
| <h3>getColumnMonotonicities</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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><<a href="../sql/validate/SqlMonotonicity.html" title="enum in org.apache.calcite.sql.validate">SqlMonotonicity</a>></span> <span class="element-name">getColumnMonotonicities</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
