blob: 8c410ecb8158355dca8a07fda77701d6c6d97673 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>RexCallBinding (Apache Calcite API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="RexCallBinding (Apache Calcite API)";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/RexCallBinding.html">Use</a></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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.calcite.rex</a></div>
<h2 title="Class RexCallBinding" class="title">Class RexCallBinding</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">org.apache.calcite.sql.SqlOperatorBinding</a></li>
<li>
<ul class="inheritance">
<li>org.apache.calcite.rex.RexCallBinding</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="RexCallBinding.RexCastCallBinding.html" title="class in org.apache.calcite.rex">RexCallBinding.RexCastCallBinding</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">RexCallBinding</span>
extends <a href="../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></pre>
<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>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="RexCallBinding.RexCastCallBinding.html" title="class in org.apache.calcite.rex">RexCallBinding.RexCastCallBinding</a></span></code></th>
<td class="colLast">
<div class="block">To be compatible with <code>SqlCall</code>, CAST needs to pretend that it
has two arguments, the second of which is the target type.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private java.util.List&lt;<a href="../rel/RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#inputCollations">inputCollations</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private java.util.List&lt;<a href="RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#operands">operands</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.apache.calcite.sql.SqlOperatorBinding">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;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></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.calcite.rel.type.RelDataTypeFactory,org.apache.calcite.sql.SqlOperator,java.util.List,java.util.List)">RexCallBinding</a></span>&#8203;(<a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a>&nbsp;typeFactory,
<a href="../sql/SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a>&nbsp;sqlOperator,
java.util.List&lt;? extends <a href="RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>&gt;&nbsp;operands,
java.util.List&lt;<a href="../rel/RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&gt;&nbsp;inputCollations)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="RexCallBinding.html" title="class in org.apache.calcite.rex">RexCallBinding</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create(org.apache.calcite.rel.type.RelDataTypeFactory,org.apache.calcite.rex.RexCall,java.util.List)">create</a></span>&#8203;(<a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a>&nbsp;typeFactory,
<a href="RexCall.html" title="class in org.apache.calcite.rex">RexCall</a>&nbsp;call,
java.util.List&lt;<a href="../rel/RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&gt;&nbsp;inputCollations)</code></th>
<td class="colLast">
<div class="block">Creates a binding of the appropriate type.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIntLiteralOperand(int)">getIntLiteralOperand</a></span>&#8203;(int&nbsp;ordinal)</code></th>
<td class="colLast">
<div class="block">Gets the integer value of a numeric literal operand.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOperandCount()">getOperandCount</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>&lt;T&gt;&nbsp;T</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOperandLiteralValue(int,java.lang.Class)">getOperandLiteralValue</a></span>&#8203;(int&nbsp;ordinal,
java.lang.Class&lt;T&gt;&nbsp;clazz)</code></th>
<td class="colLast">
<div class="block">Gets the value of a literal operand.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../sql/validate/SqlMonotonicity.html" title="enum in org.apache.calcite.sql.validate">SqlMonotonicity</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOperandMonotonicity(int)">getOperandMonotonicity</a></span>&#8203;(int&nbsp;ordinal)</code></th>
<td class="colLast">
<div class="block">Gets the monotonicity of a bound operand.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOperandType(int)">getOperandType</a></span>&#8203;(int&nbsp;ordinal)</code></th>
<td class="colLast">
<div class="block">Gets the type of a bound operand.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStringLiteralOperand(int)">getStringLiteralOperand</a></span>&#8203;(int&nbsp;ordinal)</code></th>
<td class="colLast">
<div class="block">Gets the string value of a string literal operand.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isOperandLiteral(int,boolean)">isOperandLiteral</a></span>&#8203;(int&nbsp;ordinal,
boolean&nbsp;allowCast)</code></th>
<td class="colLast">
<div class="block">Determines whether an operand is a literal.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isOperandNull(int,boolean)">isOperandNull</a></span>&#8203;(int&nbsp;ordinal,
boolean&nbsp;allowCast)</code></th>
<td class="colLast">
<div class="block">Determines whether a bound operand is NULL.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../runtime/CalciteException.html" title="class in org.apache.calcite.runtime">CalciteException</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newError(org.apache.calcite.runtime.Resources.ExInst)">newError</a></span>&#8203;(<a href="../runtime/Resources.ExInst.html" title="class in org.apache.calcite.runtime">Resources.ExInst</a>&lt;<a href="../sql/validate/SqlValidatorException.html" title="class in org.apache.calcite.sql.validate">SqlValidatorException</a>&gt;&nbsp;e)</code></th>
<td class="colLast">
<div class="block">Wraps a validation error with context appropriate to this operator call.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.calcite.sql.SqlOperatorBinding">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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#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#getOperator()">getOperator</a>, <a href="../sql/SqlOperatorBinding.html#getTypeFactory()">getTypeFactory</a>, <a href="../sql/SqlOperatorBinding.html#hasFilter()">hasFilter</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="operands">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>operands</h4>
<pre>private final&nbsp;java.util.List&lt;<a href="RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>&gt; operands</pre>
</li>
</ul>
<a id="inputCollations">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>inputCollations</h4>
<pre>private final&nbsp;java.util.List&lt;<a href="../rel/RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&gt; inputCollations</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(org.apache.calcite.rel.type.RelDataTypeFactory,org.apache.calcite.sql.SqlOperator,java.util.List,java.util.List)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RexCallBinding</h4>
<pre>public&nbsp;RexCallBinding&#8203;(<a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a>&nbsp;typeFactory,
<a href="../sql/SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a>&nbsp;sqlOperator,
java.util.List&lt;? extends <a href="RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>&gt;&nbsp;operands,
java.util.List&lt;<a href="../rel/RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&gt;&nbsp;inputCollations)</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="create(org.apache.calcite.rel.type.RelDataTypeFactory,org.apache.calcite.rex.RexCall,java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre class="methodSignature">public static&nbsp;<a href="RexCallBinding.html" title="class in org.apache.calcite.rex">RexCallBinding</a>&nbsp;create&#8203;(<a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a>&nbsp;typeFactory,
<a href="RexCall.html" title="class in org.apache.calcite.rex">RexCall</a>&nbsp;call,
java.util.List&lt;<a href="../rel/RelCollation.html" title="interface in org.apache.calcite.rel">RelCollation</a>&gt;&nbsp;inputCollations)</pre>
<div class="block">Creates a binding of the appropriate type.</div>
</li>
</ul>
<a id="getStringLiteralOperand(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStringLiteralOperand</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getStringLiteralOperand&#8203;(int&nbsp;ordinal)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<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>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../sql/SqlOperatorBinding.html#getStringLiteralOperand(int)">getStringLiteralOperand</a></code>&nbsp;in class&nbsp;<code><a href="../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ordinal</code> - zero-based ordinal of operand of interest</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>string value</dd>
</dl>
</li>
</ul>
<a id="getIntLiteralOperand(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIntLiteralOperand</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getIntLiteralOperand&#8203;(int&nbsp;ordinal)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<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>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../sql/SqlOperatorBinding.html#getIntLiteralOperand(int)">getIntLiteralOperand</a></code>&nbsp;in class&nbsp;<code><a href="../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ordinal</code> - zero-based ordinal of operand of interest</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>integer value</dd>
</dl>
</li>
</ul>
<a id="getOperandLiteralValue(int,java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOperandLiteralValue</h4>
<pre class="methodSignature">public&nbsp;&lt;T&gt;&nbsp;T&nbsp;getOperandLiteralValue&#8203;(int&nbsp;ordinal,
java.lang.Class&lt;T&gt;&nbsp;clazz)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<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 <code>BigDecimal</code>.
<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>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../sql/SqlOperatorBinding.html#getOperandLiteralValue(int,java.lang.Class)">getOperandLiteralValue</a></code>&nbsp;in class&nbsp;<code><a href="../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ordinal</code> - zero-based ordinal of operand of interest</dd>
<dd><code>clazz</code> - Desired valued type</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>value of operand</dd>
</dl>
</li>
</ul>
<a id="getOperandMonotonicity(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOperandMonotonicity</h4>
<pre class="methodSignature">public&nbsp;<a href="../sql/validate/SqlMonotonicity.html" title="enum in org.apache.calcite.sql.validate">SqlMonotonicity</a>&nbsp;getOperandMonotonicity&#8203;(int&nbsp;ordinal)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<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>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../sql/SqlOperatorBinding.html#getOperandMonotonicity(int)">getOperandMonotonicity</a></code>&nbsp;in class&nbsp;<code><a href="../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ordinal</code> - zero-based ordinal of operand of interest</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>monotonicity of operand</dd>
</dl>
</li>
</ul>
<a id="isOperandNull(int,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isOperandNull</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isOperandNull&#8203;(int&nbsp;ordinal,
boolean&nbsp;allowCast)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<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>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../sql/SqlOperatorBinding.html#isOperandNull(int,boolean)">isOperandNull</a></code>&nbsp;in class&nbsp;<code><a href="../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt>
<dd>whether operand is null; false for everything except SQL
validation</dd>
</dl>
</li>
</ul>
<a id="isOperandLiteral(int,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isOperandLiteral</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isOperandLiteral&#8203;(int&nbsp;ordinal,
boolean&nbsp;allowCast)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<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>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../sql/SqlOperatorBinding.html#isOperandLiteral(int,boolean)">isOperandLiteral</a></code>&nbsp;in class&nbsp;<code><a href="../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt>
<dd>whether operand is literal</dd>
</dl>
</li>
</ul>
<a id="getOperandCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOperandCount</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getOperandCount()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../sql/SqlOperatorBinding.html#getOperandCount()">getOperandCount</a></code>&nbsp;in class&nbsp;<code><a href="../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of bound operands</dd>
</dl>
</li>
</ul>
<a id="getOperandType(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOperandType</h4>
<pre class="methodSignature">public&nbsp;<a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&nbsp;getOperandType&#8203;(int&nbsp;ordinal)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../sql/SqlOperatorBinding.html#getOperandType(int)">getOperandType</a></code>&nbsp;in class&nbsp;<code><a href="../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ordinal</code> - zero-based ordinal of operand of interest</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>bound operand type</dd>
</dl>
</li>
</ul>
<a id="newError(org.apache.calcite.runtime.Resources.ExInst)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>newError</h4>
<pre class="methodSignature">public&nbsp;<a href="../runtime/CalciteException.html" title="class in org.apache.calcite.runtime">CalciteException</a>&nbsp;newError&#8203;(<a href="../runtime/Resources.ExInst.html" title="class in org.apache.calcite.runtime">Resources.ExInst</a>&lt;<a href="../sql/validate/SqlValidatorException.html" title="class in org.apache.calcite.sql.validate">SqlValidatorException</a>&gt;&nbsp;e)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../sql/SqlOperatorBinding.html#newError(org.apache.calcite.runtime.Resources.ExInst)">newError</a></code>&nbsp;in class&nbsp;<code><a href="../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>e</code> - Validation error, not null</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Error wrapped, if possible, with positional information</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/RexCallBinding.html">Use</a></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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2012&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>