| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ProcedureNamespace (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.sql.validate, class: ProcedureNamespace"> |
| <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>Constr | </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>Constr | </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.sql.validate</a></div> |
| <h1 title="Class ProcedureNamespace" class="title">Class ProcedureNamespace</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.sql.validate.ProcedureNamespace</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="SqlValidatorNamespace.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorNamespace</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ProcedureNamespace</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></span></div> |
| <div class="block">Namespace whose contents are defined by the result of a call to a |
| user-defined procedure.</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>protected final @Nullable <a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#enclosingNode" class="member-name-link">enclosingNode</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected @Nullable <a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#rowType" class="member-name-link">rowType</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Type of the output row, which comprises the name and type of each output |
| column.</div> |
| </div> |
| <div class="col-first even-row-color"><code>protected @Nullable <a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#type" class="member-name-link">type</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">As <a href="#rowType"><code>rowType</code></a>, but not necessarily a struct.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected final <a href="SqlValidatorImpl.html" title="class in org.apache.calcite.sql.validate">SqlValidatorImpl</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#validator" class="member-name-link">validator</a></code></div> |
| <div class="col-last odd-row-color"> </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>protected <a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#convertToStruct(org.apache.calcite.rel.type.RelDataType)" class="member-name-link">convertToStruct</a><wbr>(<a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> type)</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>@Nullable <a href="../../rel/type/RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#field(java.lang.String)" class="member-name-link">field</a><wbr>(<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> name)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a field of a given name, or null.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="../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="#getEnclosingNode()" class="member-name-link">getEnclosingNode</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 parse tree node that at is at the root of this namespace and |
| includes all decorations.</div> |
| </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="../../util/Pair.html" title="class in org.apache.calcite.util">Pair</a><<a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>,<wbr><a href="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="#getMonotonicExprs()" class="member-name-link">getMonotonicExprs</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 a list of expressions which are monotonic in this namespace.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SqlMonotonicity.html" title="enum in org.apache.calcite.sql.validate">SqlMonotonicity</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMonotonicity(java.lang.String)" class="member-name-link">getMonotonicity</a><wbr>(<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> columnName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns whether and how a given column is sorted.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNode()" class="member-name-link">getNode</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 parse tree node at the root of this namespace.</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/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRowType()" class="member-name-link">getRowType</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 row type of this namespace, which comprises a list of names |
| and types of the output columns.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRowTypeSansSystemColumns()" class="member-name-link">getRowTypeSansSystemColumns</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 row type of this namespace, sans any system columns.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="SqlValidatorTable.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorTable</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTable()" class="member-name-link">getTable</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 underlying table, or null if there is none.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getType()" class="member-name-link">getType</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 type of this namespace.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a></code></div> |
| <div class="col-second even-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 even-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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isWrapperFor(java.lang.Class)" class="member-name-link">isWrapperFor</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> clazz)</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 this namespace implements a given interface, or wraps a |
| class which does.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="SqlValidatorNamespace.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorNamespace</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#lookupChild(java.lang.String)" class="member-name-link">lookupChild</a><wbr>(<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> name)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Looks up a child namespace of a given name.</div> |
| </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="#makeNullable()" class="member-name-link">makeNullable</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="SqlValidatorNamespace.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorNamespace</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#resolve()" class="member-name-link">resolve</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 this namespace resolves to another namespace, returns that namespace, |
| following links to the end of the chain.</div> |
| </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="#setType(org.apache.calcite.rel.type.RelDataType)" class="member-name-link">setType</a><wbr>(<a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> type)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the type of this namespace.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#supportsModality(org.apache.calcite.sql.validate.SqlModality)" class="member-name-link">supportsModality</a><wbr>(<a href="SqlModality.html" title="enum in org.apache.calcite.sql.validate">SqlModality</a> modality)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns whether this namespace is capable of giving results of the desired |
| modality.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toStruct(org.apache.calcite.rel.type.RelDataType,org.apache.calcite.sql.SqlNode)" class="member-name-link">toStruct</a><wbr>(<a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> type, |
| @Nullable <a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> unnest)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Converts a type to a struct if it is not already.</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/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#translate(java.lang.String)" class="member-name-link">translate</a><wbr>(<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> name)</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><T> T</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#unwrap(java.lang.Class)" class="member-name-link">unwrap</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns this namespace, or a wrapped namespace, cast to a particular |
| class.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#validate(org.apache.calcite.rel.type.RelDataType)" class="member-name-link">validate</a><wbr>(<a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> targetRowType)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Validates this namespace.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#validateImpl(org.apache.calcite.rel.type.RelDataType)" class="member-name-link">validateImpl</a><wbr>(<a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> targetRowType)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Validates this scope and returns the type of the records it returns.</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.sql.validate.SqlValidatorNamespace">Methods inherited from interface org.apache.calcite.sql.validate.<a href="SqlValidatorNamespace.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorNamespace</a></h3> |
| <code><a href="SqlValidatorNamespace.html#fieldExists(java.lang.String)">fieldExists</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="validator"> |
| <h3>validator</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="SqlValidatorImpl.html" title="class in org.apache.calcite.sql.validate">SqlValidatorImpl</a></span> <span class="element-name">validator</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="rowType"> |
| <h3>rowType</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">@Nullable <a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="element-name">rowType</span></div> |
| <div class="block">Type of the output row, which comprises the name and type of each output |
| column. Set on validate.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="type"> |
| <h3>type</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">@Nullable <a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="element-name">type</span></div> |
| <div class="block">As <a href="#rowType"><code>rowType</code></a>, but not necessarily a struct.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="enclosingNode"> |
| <h3>enclosingNode</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type">@Nullable <a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></span> <span class="element-name">enclosingNode</span></div> |
| </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="validateImpl(org.apache.calcite.rel.type.RelDataType)"> |
| <h3>validateImpl</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="element-name">validateImpl</span><wbr><span class="parameters">(<a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> targetRowType)</span></div> |
| <div class="block">Validates this scope and returns the type of the records it returns. |
| External users should call <a href="SqlValidatorNamespace.html#validate(org.apache.calcite.rel.type.RelDataType)"><code>SqlValidatorNamespace.validate(org.apache.calcite.rel.type.RelDataType)</code></a>, which uses the |
| <a href="#status"><code>status</code></a> field to protect against cycles.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>targetRowType</code> - Desired row type, must not be null, may be the data |
| type 'unknown'.</dd> |
| <dt>Returns:</dt> |
| <dd>record data type, never null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNode()"> |
| <h3>getNode</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">@Nullable <a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></span> <span class="element-name">getNode</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SqlValidatorNamespace.html#getNode()">SqlValidatorNamespace</a></code></span></div> |
| <div class="block">Returns the parse tree node at the root of this namespace.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>parse tree node; null for <code>TableNamespace</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="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="SqlValidatorNamespace.html#getValidator()">SqlValidatorNamespace</a></code></span></div> |
| <div class="block">Returns the validator.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SqlValidatorNamespace.html#getValidator()">getValidator</a></code> in interface <code><a href="SqlValidatorNamespace.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorNamespace</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>validator</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="validate(org.apache.calcite.rel.type.RelDataType)"> |
| <h3>validate</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">void</span> <span class="element-name">validate</span><wbr><span class="parameters">(<a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> targetRowType)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SqlValidatorNamespace.html#validate(org.apache.calcite.rel.type.RelDataType)">SqlValidatorNamespace</a></code></span></div> |
| <div class="block">Validates this namespace. |
| |
| <p>If the scope has already been validated, does nothing.</p> |
| |
| <p>Please call <a href="SqlValidatorImpl.html#validateNamespace(org.apache.calcite.sql.validate.SqlValidatorNamespace,org.apache.calcite.rel.type.RelDataType)"><code>SqlValidatorImpl.validateNamespace(org.apache.calcite.sql.validate.SqlValidatorNamespace, org.apache.calcite.rel.type.RelDataType)</code></a> rather than |
| calling this method directly.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SqlValidatorNamespace.html#validate(org.apache.calcite.rel.type.RelDataType)">validate</a></code> in interface <code><a href="SqlValidatorNamespace.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorNamespace</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>targetRowType</code> - Desired row type, must not be null, may be the data |
| type 'unknown'.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRowType()"> |
| <h3>getRowType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="element-name">getRowType</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SqlValidatorNamespace.html#getRowType()">SqlValidatorNamespace</a></code></span></div> |
| <div class="block">Returns the row type of this namespace, which comprises a list of names |
| and types of the output columns. If the scope's type has not yet been |
| derived, derives it.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SqlValidatorNamespace.html#getRowType()">getRowType</a></code> in interface <code><a href="SqlValidatorNamespace.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorNamespace</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>Row type of this namespace, never null, always a struct</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRowTypeSansSystemColumns()"> |
| <h3>getRowTypeSansSystemColumns</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="element-name">getRowTypeSansSystemColumns</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SqlValidatorNamespace.html#getRowTypeSansSystemColumns()">SqlValidatorNamespace</a></code></span></div> |
| <div class="block">Returns the row type of this namespace, sans any system columns.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SqlValidatorNamespace.html#getRowTypeSansSystemColumns()">getRowTypeSansSystemColumns</a></code> in interface <code><a href="SqlValidatorNamespace.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorNamespace</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>Row type sans system columns</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getType()"> |
| <h3>getType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="element-name">getType</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SqlValidatorNamespace.html#getType()">SqlValidatorNamespace</a></code></span></div> |
| <div class="block">Returns the type of this namespace.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SqlValidatorNamespace.html#getType()">getType</a></code> in interface <code><a href="SqlValidatorNamespace.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorNamespace</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>Row type converted to struct</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setType(org.apache.calcite.rel.type.RelDataType)"> |
| <h3>setType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setType</span><wbr><span class="parameters">(<a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> type)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SqlValidatorNamespace.html#setType(org.apache.calcite.rel.type.RelDataType)">SqlValidatorNamespace</a></code></span></div> |
| <div class="block">Sets the type of this namespace. |
| |
| <p>Allows the type for the namespace to be explicitly set, but usually is |
| called during <a href="SqlValidatorNamespace.html#validate(org.apache.calcite.rel.type.RelDataType)"><code>SqlValidatorNamespace.validate(RelDataType)</code></a>.</p> |
| |
| <p>Implicitly also sets the row type. If the type is not a struct, then |
| the row type is the type wrapped as a struct with a single column, |
| otherwise the type and row type are the same.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SqlValidatorNamespace.html#setType(org.apache.calcite.rel.type.RelDataType)">setType</a></code> in interface <code><a href="SqlValidatorNamespace.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorNamespace</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getEnclosingNode()"> |
| <h3>getEnclosingNode</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">@Nullable <a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></span> <span class="element-name">getEnclosingNode</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SqlValidatorNamespace.html#getEnclosingNode()">SqlValidatorNamespace</a></code></span></div> |
| <div class="block">Returns the parse tree node that at is at the root of this namespace and |
| includes all decorations. If there are no decorations, returns the same |
| as <a href="SqlValidatorNamespace.html#getNode()"><code>SqlValidatorNamespace.getNode()</code></a>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SqlValidatorNamespace.html#getEnclosingNode()">getEnclosingNode</a></code> in interface <code><a href="SqlValidatorNamespace.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorNamespace</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTable()"> |
| <h3>getTable</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">@Nullable <a href="SqlValidatorTable.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorTable</a></span> <span class="element-name">getTable</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SqlValidatorNamespace.html#getTable()">SqlValidatorNamespace</a></code></span></div> |
| <div class="block">Returns the underlying table, or null if there is none.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SqlValidatorNamespace.html#getTable()">getTable</a></code> in interface <code><a href="SqlValidatorNamespace.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorNamespace</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="lookupChild(java.lang.String)"> |
| <h3>lookupChild</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">@Nullable <a href="SqlValidatorNamespace.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorNamespace</a></span> <span class="element-name">lookupChild</span><wbr><span class="parameters">(<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> name)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SqlValidatorNamespace.html#lookupChild(java.lang.String)">SqlValidatorNamespace</a></code></span></div> |
| <div class="block">Looks up a child namespace of a given name. |
| |
| <p>For example, in the query <code>select e.name from emps as e</code>, |
| <code>e</code> is an <a href="IdentifierNamespace.html" title="class in org.apache.calcite.sql.validate"><code>IdentifierNamespace</code></a> which has a child <code> |
| name</code> which is a <code>FieldNamespace</code>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SqlValidatorNamespace.html#lookupChild(java.lang.String)">lookupChild</a></code> in interface <code><a href="SqlValidatorNamespace.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorNamespace</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - Name of namespace</dd> |
| <dt>Returns:</dt> |
| <dd>Namespace</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="field(java.lang.String)"> |
| <h3>field</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">@Nullable <a href="../../rel/type/RelDataTypeField.html" title="interface in org.apache.calcite.rel.type">RelDataTypeField</a></span> <span class="element-name">field</span><wbr><span class="parameters">(<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> name)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SqlValidatorNamespace.html#field(java.lang.String)">SqlValidatorNamespace</a></code></span></div> |
| <div class="block">Returns a field of a given name, or null.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SqlValidatorNamespace.html#field(java.lang.String)">field</a></code> in interface <code><a href="SqlValidatorNamespace.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorNamespace</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - Field name</dd> |
| <dt>Returns:</dt> |
| <dd>Field, or null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMonotonicExprs()"> |
| <h3>getMonotonicExprs</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="../../util/Pair.html" title="class in org.apache.calcite.util">Pair</a><<a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>,<wbr><a href="SqlMonotonicity.html" title="enum in org.apache.calcite.sql.validate">SqlMonotonicity</a>>></span> <span class="element-name">getMonotonicExprs</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SqlValidatorNamespace.html#getMonotonicExprs()">SqlValidatorNamespace</a></code></span></div> |
| <div class="block">Returns a list of expressions which are monotonic in this namespace. For |
| example, if the namespace represents a relation ordered by a column |
| called "TIMESTAMP", then the list would contain a |
| <a href="../SqlIdentifier.html" title="class in org.apache.calcite.sql"><code>SqlIdentifier</code></a> called "TIMESTAMP".</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SqlValidatorNamespace.html#getMonotonicExprs()">getMonotonicExprs</a></code> in interface <code><a href="SqlValidatorNamespace.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorNamespace</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMonotonicity(java.lang.String)"> |
| <h3>getMonotonicity</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SqlMonotonicity.html" title="enum in org.apache.calcite.sql.validate">SqlMonotonicity</a></span> <span class="element-name">getMonotonicity</span><wbr><span class="parameters">(<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> columnName)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SqlValidatorNamespace.html#getMonotonicity(java.lang.String)">SqlValidatorNamespace</a></code></span></div> |
| <div class="block">Returns whether and how a given column is sorted.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SqlValidatorNamespace.html#getMonotonicity(java.lang.String)">getMonotonicity</a></code> in interface <code><a href="SqlValidatorNamespace.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorNamespace</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="makeNullable()"> |
| <h3>makeNullable</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">makeNullable</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SqlValidatorNamespace.html#makeNullable()">makeNullable</a></code> in interface <code><a href="SqlValidatorNamespace.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorNamespace</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="translate(java.lang.String)"> |
| <h3>translate</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">translate</span><wbr><span class="parameters">(<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> name)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="resolve()"> |
| <h3>resolve</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SqlValidatorNamespace.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorNamespace</a></span> <span class="element-name">resolve</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SqlValidatorNamespace.html#resolve()">SqlValidatorNamespace</a></code></span></div> |
| <div class="block">If this namespace resolves to another namespace, returns that namespace, |
| following links to the end of the chain. |
| |
| <p>A <code>WITH</code>) clause defines table names that resolve to queries |
| (the body of the with-item). An <a href="IdentifierNamespace.html" title="class in org.apache.calcite.sql.validate"><code>IdentifierNamespace</code></a> typically |
| resolves to a <code>TableNamespace</code>.</p> |
| |
| <p>You must not call this method before <a href="SqlValidatorNamespace.html#validate(org.apache.calcite.rel.type.RelDataType)"><code>SqlValidatorNamespace.validate(RelDataType)</code></a> has |
| completed.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SqlValidatorNamespace.html#resolve()">resolve</a></code> in interface <code><a href="SqlValidatorNamespace.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorNamespace</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="supportsModality(org.apache.calcite.sql.validate.SqlModality)"> |
| <h3>supportsModality</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">supportsModality</span><wbr><span class="parameters">(<a href="SqlModality.html" title="enum in org.apache.calcite.sql.validate">SqlModality</a> modality)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SqlValidatorNamespace.html#supportsModality(org.apache.calcite.sql.validate.SqlModality)">SqlValidatorNamespace</a></code></span></div> |
| <div class="block">Returns whether this namespace is capable of giving results of the desired |
| modality. <code>true</code> means streaming, <code>false</code> means relational.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SqlValidatorNamespace.html#supportsModality(org.apache.calcite.sql.validate.SqlModality)">supportsModality</a></code> in interface <code><a href="SqlValidatorNamespace.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorNamespace</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>modality</code> - Modality</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="unwrap(java.lang.Class)"> |
| <h3>unwrap</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><T></span> <span class="return-type">T</span> <span class="element-name">unwrap</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SqlValidatorNamespace.html#unwrap(java.lang.Class)">SqlValidatorNamespace</a></code></span></div> |
| <div class="block">Returns this namespace, or a wrapped namespace, cast to a particular |
| class.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SqlValidatorNamespace.html#unwrap(java.lang.Class)">unwrap</a></code> in interface <code><a href="SqlValidatorNamespace.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorNamespace</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>clazz</code> - Desired type</dd> |
| <dt>Returns:</dt> |
| <dd>This namespace cast to desired type</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isWrapperFor(java.lang.Class)"> |
| <h3>isWrapperFor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isWrapperFor</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> clazz)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SqlValidatorNamespace.html#isWrapperFor(java.lang.Class)">SqlValidatorNamespace</a></code></span></div> |
| <div class="block">Returns whether this namespace implements a given interface, or wraps a |
| class which does.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SqlValidatorNamespace.html#isWrapperFor(java.lang.Class)">isWrapperFor</a></code> in interface <code><a href="SqlValidatorNamespace.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorNamespace</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>clazz</code> - Interface</dd> |
| <dt>Returns:</dt> |
| <dd>Whether namespace implements given interface</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="convertToStruct(org.apache.calcite.rel.type.RelDataType)"> |
| <h3>convertToStruct</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="element-name">convertToStruct</span><wbr><span class="parameters">(<a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> type)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toStruct(org.apache.calcite.rel.type.RelDataType,org.apache.calcite.sql.SqlNode)"> |
| <h3>toStruct</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="element-name">toStruct</span><wbr><span class="parameters">(<a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> type, |
| @Nullable <a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> unnest)</span></div> |
| <div class="block">Converts a type to a struct if it is not already.</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> |