| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>OperandMetadataImpl (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.type, class: OperandMetadataImpl"> |
| <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><a href="#nested-class-summary">Nested</a> | </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>Field | </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.type</a></div> |
| <h1 title="Class OperandMetadataImpl" class="title">Class OperandMetadataImpl</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="FamilyOperandTypeChecker.html" title="class in org.apache.calcite.sql.type">org.apache.calcite.sql.type.FamilyOperandTypeChecker</a> |
| <div class="inheritance">org.apache.calcite.sql.type.OperandMetadataImpl</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="ImplicitCastOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">ImplicitCastOperandTypeChecker</a></code>, <code><a href="SqlOperandMetadata.html" title="interface in org.apache.calcite.sql.type">SqlOperandMetadata</a></code>, <code><a href="SqlOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeChecker</a></code>, <code><a href="SqlSingleOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">SqlSingleOperandTypeChecker</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">OperandMetadataImpl</span> |
| <span class="extends-implements">extends <a href="FamilyOperandTypeChecker.html" title="class in org.apache.calcite.sql.type">FamilyOperandTypeChecker</a> |
| implements <a href="SqlOperandMetadata.html" title="interface in org.apache.calcite.sql.type">SqlOperandMetadata</a></span></div> |
| <div class="block">Operand type-checking strategy user-defined functions (including user-defined |
| aggregate functions, table functions, and table macros). |
| |
| <p>UDFs have a fixed number of parameters is fixed. Per |
| <a href="SqlOperandMetadata.html" title="interface in org.apache.calcite.sql.type"><code>SqlOperandMetadata</code></a>, this interface provides the name and types of |
| each parameter.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="OperandTypes.html#operandMetadata(java.util.List,java.util.function.Function,java.util.function.IntFunction,java.util.function.Predicate)"><code>OperandTypes.operandMetadata(java.util.List<org.apache.calcite.sql.type.SqlTypeFamily>, java.util.function.Function<org.apache.calcite.rel.type.RelDataTypeFactory, java.util.List<org.apache.calcite.rel.type.RelDataType>>, java.util.function.IntFunction<java.lang.String>, java.util.function.Predicate<java.lang.Integer>)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.calcite.sql.type.SqlOperandTypeChecker">Nested classes/interfaces inherited from interface org.apache.calcite.sql.type.<a href="SqlOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeChecker</a></h2> |
| <code><a href="SqlOperandTypeChecker.Consistency.html" title="enum in org.apache.calcite.sql.type">SqlOperandTypeChecker.Consistency</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.calcite.sql.type.FamilyOperandTypeChecker">Fields inherited from class org.apache.calcite.sql.type.<a href="FamilyOperandTypeChecker.html" title="class in org.apache.calcite.sql.type">FamilyOperandTypeChecker</a></h3> |
| <code><a href="FamilyOperandTypeChecker.html#families">families</a>, <a href="FamilyOperandTypeChecker.html#optional">optional</a></code></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>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isFixedParameters()" class="member-name-link">isFixedParameters</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 whether the list of parameters is fixed-length.</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="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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#paramNames()" class="member-name-link">paramNames</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 names of the parameters.</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/util/List.html" title="class or interface in java.util" class="external-link">List</a><<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="#paramTypes(org.apache.calcite.rel.type.RelDataTypeFactory)" class="member-name-link">paramTypes</a><wbr>(<a href="../../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a> typeFactory)</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 types of the parameters.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.sql.type.FamilyOperandTypeChecker">Methods inherited from class org.apache.calcite.sql.type.<a href="FamilyOperandTypeChecker.html" title="class in org.apache.calcite.sql.type">FamilyOperandTypeChecker</a></h3> |
| <code><a href="FamilyOperandTypeChecker.html#checkOperandTypes(org.apache.calcite.sql.SqlCallBinding,boolean)">checkOperandTypes</a>, <a href="FamilyOperandTypeChecker.html#checkOperandTypesWithoutTypeCoercion(org.apache.calcite.sql.SqlCallBinding,boolean)">checkOperandTypesWithoutTypeCoercion</a>, <a href="FamilyOperandTypeChecker.html#checkSingleOperandType(org.apache.calcite.sql.SqlCallBinding,org.apache.calcite.sql.SqlNode,int,boolean)">checkSingleOperandType</a>, <a href="FamilyOperandTypeChecker.html#getAllowedSignatures(org.apache.calcite.sql.SqlOperator,java.lang.String)">getAllowedSignatures</a>, <a href="FamilyOperandTypeChecker.html#getOperandCountRange()">getOperandCountRange</a>, <a href="FamilyOperandTypeChecker.html#getOperandSqlTypeFamily(int)">getOperandSqlTypeFamily</a>, <a href="FamilyOperandTypeChecker.html#isOptional(int)">isOptional</a></code></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.type.SqlOperandTypeChecker">Methods inherited from interface org.apache.calcite.sql.type.<a href="SqlOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeChecker</a></h3> |
| <code><a href="SqlOperandTypeChecker.html#and(org.apache.calcite.sql.type.SqlOperandTypeChecker)">and</a>, <a href="SqlOperandTypeChecker.html#getAllowedSignatures(org.apache.calcite.sql.SqlOperator,java.lang.String)">getAllowedSignatures</a>, <a href="SqlOperandTypeChecker.html#getConsistency()">getConsistency</a>, <a href="SqlOperandTypeChecker.html#isOptional(int)">isOptional</a>, <a href="SqlOperandTypeChecker.html#or(org.apache.calcite.sql.type.SqlOperandTypeChecker)">or</a>, <a href="SqlOperandTypeChecker.html#typeInference()">typeInference</a>, <a href="SqlOperandTypeChecker.html#withGenerator(java.util.function.BiFunction)">withGenerator</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.sql.type.SqlSingleOperandTypeChecker">Methods inherited from interface org.apache.calcite.sql.type.<a href="SqlSingleOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">SqlSingleOperandTypeChecker</a></h3> |
| <code><a href="SqlSingleOperandTypeChecker.html#and(org.apache.calcite.sql.type.SqlSingleOperandTypeChecker)">and</a>, <a href="SqlSingleOperandTypeChecker.html#or(org.apache.calcite.sql.type.SqlSingleOperandTypeChecker)">or</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="isFixedParameters()"> |
| <h3>isFixedParameters</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isFixedParameters</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SqlOperandTypeChecker.html#isFixedParameters()">SqlOperandTypeChecker</a></code></span></div> |
| <div class="block">Returns whether the list of parameters is fixed-length. In standard SQL, |
| user-defined functions are fixed-length. |
| |
| <p>If true, the validator should expand calls, supplying a <code>DEFAULT</code> |
| value for each parameter for which an argument is not supplied.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SqlOperandTypeChecker.html#isFixedParameters()">isFixedParameters</a></code> in interface <code><a href="SqlOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeChecker</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="paramTypes(org.apache.calcite.rel.type.RelDataTypeFactory)"> |
| <h3>paramTypes</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="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>></span> <span class="element-name">paramTypes</span><wbr><span class="parameters">(<a href="../../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a> typeFactory)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SqlOperandMetadata.html#paramTypes(org.apache.calcite.rel.type.RelDataTypeFactory)">SqlOperandMetadata</a></code></span></div> |
| <div class="block">Returns the types of the parameters.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SqlOperandMetadata.html#paramTypes(org.apache.calcite.rel.type.RelDataTypeFactory)">paramTypes</a></code> in interface <code><a href="SqlOperandMetadata.html" title="interface in org.apache.calcite.sql.type">SqlOperandMetadata</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="paramNames()"> |
| <h3>paramNames</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="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">paramNames</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="SqlOperandMetadata.html#paramNames()">SqlOperandMetadata</a></code></span></div> |
| <div class="block">Returns the names of the parameters.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SqlOperandMetadata.html#paramNames()">paramNames</a></code> in interface <code><a href="SqlOperandMetadata.html" title="interface in org.apache.calcite.sql.type">SqlOperandMetadata</a></code></dd> |
| </dl> |
| </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> |
