| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>RexCallBinding (Apache Calcite API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.calcite.rex, class: RexCallBinding"> |
| <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>Field | </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.rex</a></div> |
| <h1 title="Class RexCallBinding" class="title">Class RexCallBinding</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="../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">org.apache.calcite.sql.SqlOperatorBinding</a> |
| <div class="inheritance">org.apache.calcite.rex.RexCallBinding</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">RexCallBinding</span> |
| <span class="extends-implements">extends <a href="../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></span></div> |
| <div class="block"><code>RexCallBinding</code> implements <a href="../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql"><code>SqlOperatorBinding</code></a> by |
| referring to an underlying collection of <a href="RexNode.html" title="class in org.apache.calcite.rex"><code>RexNode</code></a> operands.</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="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.calcite.sql.SqlOperatorBinding">Fields inherited from class org.apache.calcite.sql.<a href="../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></h3> |
| <code><a href="../sql/SqlOperatorBinding.html#typeFactory">typeFactory</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.calcite.rel.type.RelDataTypeFactory,org.apache.calcite.sql.SqlOperator,java.util.List,java.util.List)" class="member-name-link">RexCallBinding</a><wbr>(<a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a> typeFactory, |
| <a href="../sql/SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a> sqlOperator, |
| <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><? extends <a href="RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>> operands, |
| <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/RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>> inputCollations)</code></div> |
| <div class="col-last even-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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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-tab1 method-summary-table-tab4"><code>static <a href="RexCallBinding.html" title="class in org.apache.calcite.rex">RexCallBinding</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#create(org.apache.calcite.rel.type.RelDataTypeFactory,org.apache.calcite.rex.RexCall,org.apache.calcite.rex.RexProgram,java.util.List)" class="member-name-link">create</a><wbr>(<a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a> typeFactory, |
| <a href="RexCall.html" title="class in org.apache.calcite.rex">RexCall</a> call, |
| @Nullable <a href="RexProgram.html" title="class in org.apache.calcite.rex">RexProgram</a> program, |
| <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/RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>> inputCollations)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a binding of the appropriate type, optionally with a program.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="RexCallBinding.html" title="class in org.apache.calcite.rex">RexCallBinding</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#create(org.apache.calcite.rel.type.RelDataTypeFactory,org.apache.calcite.rex.RexCall,java.util.List)" class="member-name-link">create</a><wbr>(<a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a> typeFactory, |
| <a href="RexCall.html" title="class in org.apache.calcite.rex">RexCall</a> call, |
| <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/RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>> inputCollations)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a binding of the appropriate type.</div> |
| </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="#getIntLiteralOperand(int)" class="member-name-link">getIntLiteralOperand</a><wbr>(int ordinal)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the integer value of a numeric literal operand.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOperandCount()" class="member-name-link">getOperandCount</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 number of bound operands.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><T> @Nullable T</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOperandLiteralValue(int,java.lang.Class)" class="member-name-link">getOperandLiteralValue</a><wbr>(int ordinal, |
| <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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the value of a literal operand.</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/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="#getOperandMonotonicity(int)" class="member-name-link">getOperandMonotonicity</a><wbr>(int ordinal)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the monotonicity of a bound operand.</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="#getOperandType(int)" class="member-name-link">getOperandType</a><wbr>(int ordinal)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the type of a bound operand.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@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></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getStringLiteralOperand(int)" class="member-name-link">getStringLiteralOperand</a><wbr>(int ordinal)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the string value of a string literal operand.</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="#isOperandLiteral(int,boolean)" class="member-name-link">isOperandLiteral</a><wbr>(int ordinal, |
| boolean allowCast)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Determines whether an operand is a literal.</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="#isOperandNull(int,boolean)" class="member-name-link">isOperandNull</a><wbr>(int ordinal, |
| boolean allowCast)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Determines whether a bound operand is NULL.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../runtime/CalciteException.html" title="class in org.apache.calcite.runtime">CalciteException</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#newError(org.apache.calcite.runtime.Resources.ExInst)" class="member-name-link">newError</a><wbr>(org.apache.calcite.runtime.Resources.ExInst<<a href="../sql/validate/SqlValidatorException.html" title="class in org.apache.calcite.sql.validate">SqlValidatorException</a>> e)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Wraps a validation error with context appropriate to this operator call.</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="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="#operands()" class="member-name-link">operands</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.sql.SqlOperatorBinding">Methods inherited from class org.apache.calcite.sql.<a href="../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></h3> |
| <code><a href="../sql/SqlOperatorBinding.html#collectOperandTypes()">collectOperandTypes</a>, <a href="../sql/SqlOperatorBinding.html#getCollationType()">getCollationType</a>, <a href="../sql/SqlOperatorBinding.html#getColumnListParamInfo(int,java.lang.String,java.util.List)">getColumnListParamInfo</a>, <a href="../sql/SqlOperatorBinding.html#getCursorOperand(int)">getCursorOperand</a>, <a href="../sql/SqlOperatorBinding.html#getGroupCount()">getGroupCount</a>, <a href="../sql/SqlOperatorBinding.html#getOperandLiteralValue(int)">getOperandLiteralValue</a>, <a href="../sql/SqlOperatorBinding.html#getOperandLiteralValue(int,org.apache.calcite.rel.type.RelDataType)">getOperandLiteralValue</a>, <a href="../sql/SqlOperatorBinding.html#getOperator()">getOperator</a>, <a href="../sql/SqlOperatorBinding.html#getTypeFactory()">getTypeFactory</a>, <a href="../sql/SqlOperatorBinding.html#hasFilter()">hasFilter</a>, <a href="../sql/SqlOperatorBinding.html#isOperandTimeFrame(int)">isOperandTimeFrame</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> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= 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.rel.type.RelDataTypeFactory,org.apache.calcite.sql.SqlOperator,java.util.List,java.util.List)"> |
| <h3>RexCallBinding</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">RexCallBinding</span><wbr><span class="parameters">(<a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a> typeFactory, |
| <a href="../sql/SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a> sqlOperator, |
| <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><? extends <a href="RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>> operands, |
| <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/RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>> inputCollations)</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="create(org.apache.calcite.rel.type.RelDataTypeFactory,org.apache.calcite.rex.RexCall,java.util.List)"> |
| <h3>create</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="RexCallBinding.html" title="class in org.apache.calcite.rex">RexCallBinding</a></span> <span class="element-name">create</span><wbr><span class="parameters">(<a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a> typeFactory, |
| <a href="RexCall.html" title="class in org.apache.calcite.rex">RexCall</a> call, |
| <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/RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>> inputCollations)</span></div> |
| <div class="block">Creates a binding of the appropriate type.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="create(org.apache.calcite.rel.type.RelDataTypeFactory,org.apache.calcite.rex.RexCall,org.apache.calcite.rex.RexProgram,java.util.List)"> |
| <h3>create</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="RexCallBinding.html" title="class in org.apache.calcite.rex">RexCallBinding</a></span> <span class="element-name">create</span><wbr><span class="parameters">(<a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a> typeFactory, |
| <a href="RexCall.html" title="class in org.apache.calcite.rex">RexCall</a> call, |
| @Nullable <a href="RexProgram.html" title="class in org.apache.calcite.rex">RexProgram</a> program, |
| <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/RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>> inputCollations)</span></div> |
| <div class="block">Creates a binding of the appropriate type, optionally with a program.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStringLiteralOperand(int)"> |
| <h3>getStringLiteralOperand</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">@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></span> <span class="element-name">getStringLiteralOperand</span><wbr><span class="parameters">(int ordinal)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../sql/SqlOperatorBinding.html#getStringLiteralOperand(int)">SqlOperatorBinding</a></code></span></div> |
| <div class="block">Gets the string value of a string literal operand.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../sql/SqlOperatorBinding.html#getStringLiteralOperand(int)">getStringLiteralOperand</a></code> in class <code><a href="../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>ordinal</code> - zero-based ordinal of operand of interest</dd> |
| <dt>Returns:</dt> |
| <dd>string value</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getIntLiteralOperand(int)"> |
| <h3>getIntLiteralOperand</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getIntLiteralOperand</span><wbr><span class="parameters">(int ordinal)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../sql/SqlOperatorBinding.html#getIntLiteralOperand(int)">SqlOperatorBinding</a></code></span></div> |
| <div class="block">Gets the integer value of a numeric literal operand.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../sql/SqlOperatorBinding.html#getIntLiteralOperand(int)">getIntLiteralOperand</a></code> in class <code><a href="../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>ordinal</code> - zero-based ordinal of operand of interest</dd> |
| <dt>Returns:</dt> |
| <dd>integer value</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOperandLiteralValue(int,java.lang.Class)"> |
| <h3>getOperandLiteralValue</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><T></span> <span class="return-type">@Nullable T</span> <span class="element-name">getOperandLiteralValue</span><wbr><span class="parameters">(int ordinal, |
| <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 class: <code><a href="../sql/SqlOperatorBinding.html#getOperandLiteralValue(int,java.lang.Class)">SqlOperatorBinding</a></code></span></div> |
| <div class="block">Gets the value of a literal operand. |
| |
| <p>Cases: |
| <ul> |
| <li>If the operand is not a literal, the value is null. |
| |
| <li>If the operand is a string literal, |
| the value will be of type <a href="../util/NlsString.html" title="class in org.apache.calcite.util"><code>NlsString</code></a>. |
| |
| <li>If the operand is a numeric literal, |
| the value will be of type <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/math/BigDecimal.html" title="class or interface in java.math" class="external-link"><code>BigDecimal</code></a>. |
| |
| <li>If the operand is an interval qualifier, |
| the value will be of type <a href="../sql/SqlIntervalQualifier.html" title="class in org.apache.calcite.sql"><code>SqlIntervalQualifier</code></a></li> |
| |
| <li>Otherwise the type is undefined, and the value may be null. |
| </ul></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../sql/SqlOperatorBinding.html#getOperandLiteralValue(int,java.lang.Class)">getOperandLiteralValue</a></code> in class <code><a href="../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>ordinal</code> - zero-based ordinal of operand of interest</dd> |
| <dd><code>clazz</code> - Desired valued type</dd> |
| <dt>Returns:</dt> |
| <dd>value of operand</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOperandMonotonicity(int)"> |
| <h3>getOperandMonotonicity</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../sql/validate/SqlMonotonicity.html" title="enum in org.apache.calcite.sql.validate">SqlMonotonicity</a></span> <span class="element-name">getOperandMonotonicity</span><wbr><span class="parameters">(int ordinal)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../sql/SqlOperatorBinding.html#getOperandMonotonicity(int)">SqlOperatorBinding</a></code></span></div> |
| <div class="block">Gets the monotonicity of a bound operand.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../sql/SqlOperatorBinding.html#getOperandMonotonicity(int)">getOperandMonotonicity</a></code> in class <code><a href="../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>ordinal</code> - zero-based ordinal of operand of interest</dd> |
| <dt>Returns:</dt> |
| <dd>monotonicity of operand</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isOperandNull(int,boolean)"> |
| <h3>isOperandNull</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isOperandNull</span><wbr><span class="parameters">(int ordinal, |
| boolean allowCast)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../sql/SqlOperatorBinding.html#isOperandNull(int,boolean)">SqlOperatorBinding</a></code></span></div> |
| <div class="block">Determines whether a bound operand is NULL. |
| |
| <p>This is only relevant for SQL validation.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../sql/SqlOperatorBinding.html#isOperandNull(int,boolean)">isOperandNull</a></code> in class <code><a href="../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>ordinal</code> - zero-based ordinal of operand of interest</dd> |
| <dd><code>allowCast</code> - whether to regard CAST(constant) as a constant</dd> |
| <dt>Returns:</dt> |
| <dd>whether operand is null; false for everything except SQL |
| validation</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isOperandLiteral(int,boolean)"> |
| <h3>isOperandLiteral</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isOperandLiteral</span><wbr><span class="parameters">(int ordinal, |
| boolean allowCast)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../sql/SqlOperatorBinding.html#isOperandLiteral(int,boolean)">SqlOperatorBinding</a></code></span></div> |
| <div class="block">Determines whether an operand is a literal.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../sql/SqlOperatorBinding.html#isOperandLiteral(int,boolean)">isOperandLiteral</a></code> in class <code><a href="../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>ordinal</code> - zero-based ordinal of operand of interest</dd> |
| <dd><code>allowCast</code> - whether to regard CAST(literal) as a literal</dd> |
| <dt>Returns:</dt> |
| <dd>whether operand is literal</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="operands()"> |
| <h3>operands</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="RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>></span> <span class="element-name">operands</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOperandCount()"> |
| <h3>getOperandCount</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getOperandCount</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../sql/SqlOperatorBinding.html#getOperandCount()">SqlOperatorBinding</a></code></span></div> |
| <div class="block">Returns the number of bound operands.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../sql/SqlOperatorBinding.html#getOperandCount()">getOperandCount</a></code> in class <code><a href="../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOperandType(int)"> |
| <h3>getOperandType</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">getOperandType</span><wbr><span class="parameters">(int ordinal)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../sql/SqlOperatorBinding.html#getOperandType(int)">SqlOperatorBinding</a></code></span></div> |
| <div class="block">Gets the type of a bound operand.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../sql/SqlOperatorBinding.html#getOperandType(int)">getOperandType</a></code> in class <code><a href="../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>ordinal</code> - zero-based ordinal of operand of interest</dd> |
| <dt>Returns:</dt> |
| <dd>bound operand type</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newError(org.apache.calcite.runtime.Resources.ExInst)"> |
| <h3>newError</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../runtime/CalciteException.html" title="class in org.apache.calcite.runtime">CalciteException</a></span> <span class="element-name">newError</span><wbr><span class="parameters">(org.apache.calcite.runtime.Resources.ExInst<<a href="../sql/validate/SqlValidatorException.html" title="class in org.apache.calcite.sql.validate">SqlValidatorException</a>> e)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../sql/SqlOperatorBinding.html#newError(org.apache.calcite.runtime.Resources.ExInst)">SqlOperatorBinding</a></code></span></div> |
| <div class="block">Wraps a validation error with context appropriate to this operator call.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../sql/SqlOperatorBinding.html#newError(org.apache.calcite.runtime.Resources.ExInst)">newError</a></code> in class <code><a href="../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>e</code> - Validation error, not null</dd> |
| <dt>Returns:</dt> |
| <dd>Error wrapped, if possible, with positional information</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> |
