blob: 37ceb0a4a2b8e7695349ad9525270e671cb6b1bc [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>SqlCallBinding (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="SqlCallBinding (Apache Calcite API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10};
var tabs = {65535:["t0","All 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/SqlCallBinding.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>Nested&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.sql</a></div>
<h2 title="Class SqlCallBinding" class="title">Class SqlCallBinding</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="SqlOperatorBinding.html" title="class in org.apache.calcite.sql">org.apache.calcite.sql.SqlOperatorBinding</a></li>
<li>
<ul class="inheritance">
<li>org.apache.calcite.sql.SqlCallBinding</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">SqlCallBinding</span>
extends <a href="SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></pre>
<div class="block"><code>SqlCallBinding</code> implements <a href="SqlOperatorBinding.html" title="class in org.apache.calcite.sql"><code>SqlOperatorBinding</code></a> by
analyzing to the operands of a <a href="SqlCall.html" title="class in org.apache.calcite.sql"><code>SqlCall</code></a> with a <a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate"><code>SqlValidator</code></a>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== 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 <a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#call">call</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static <a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_CALL">DEFAULT_CALL</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#scope">scope</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validator">validator</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="SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></h3>
<code><a href="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.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope,org.apache.calcite.sql.SqlCall)">SqlCallBinding</a></span>&#8203;(<a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a>&nbsp;validator,
<a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a>&nbsp;scope,
<a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a>&nbsp;call)</code></th>
<td class="colLast">
<div class="block">Creates a call binding.</div>
</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="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><a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCall()">getCall</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the call node.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getColumnListParamInfo(int,java.lang.String,java.util.List)">getColumnListParamInfo</a></span>&#8203;(int&nbsp;ordinal,
java.lang.String&nbsp;paramName,
java.util.List&lt;java.lang.String&gt;&nbsp;columnList)</code></th>
<td class="colLast">
<div class="block">Retrieves information about a column list parameter.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<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="#getCursorOperand(int)">getCursorOperand</a></span>&#8203;(int&nbsp;ordinal)</code></th>
<td class="colLast">
<div class="block">Returns the rowtype of the <code>ordinal</code>th operand, which is a
cursor.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGroupCount()">getGroupCount</a></span>()</code></th>
<td class="colLast">
<div class="block">If the operator call occurs in an aggregate query, returns the number of
columns in the GROUP BY clause.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<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="i5" class="rowColor">
<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="i6" class="altColor">
<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="i7" class="rowColor">
<td class="colFirst"><code><a href="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="i8" class="altColor">
<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="i9" class="rowColor">
<td class="colFirst"><code><a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getScope()">getScope</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the scope of the call.</div>
</td>
</tr>
<tr id="i10" 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="i11" class="rowColor">
<td class="colFirst"><code><a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getValidator()">getValidator</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the validator.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>private boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasAssignment()">hasAssignment</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns whether arguments have name assignment.</div>
</td>
</tr>
<tr id="i13" 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="i14" 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="i15" 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="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>
<tr id="i16" class="altColor">
<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="#newValidationError(org.apache.calcite.runtime.Resources.ExInst)">newValidationError</a></span>&#8203;(<a href="../runtime/Resources.ExInst.html" title="class in org.apache.calcite.runtime">Resources.ExInst</a>&lt;<a href="validate/SqlValidatorException.html" title="class in org.apache.calcite.sql.validate">SqlValidatorException</a>&gt;&nbsp;ex)</code></th>
<td class="colLast">
<div class="block">Constructs a new validation error for the call.</div>
</td>
</tr>
<tr id="i17" 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="#newValidationSignatureError()">newValidationSignatureError</a></span>()</code></th>
<td class="colLast">
<div class="block">Constructs a new validation signature error for the call.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#operand(int)">operand</a></span>&#8203;(int&nbsp;i)</code></th>
<td class="colLast">
<div class="block">Returns a particular operand.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#operands()">operands</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the operands to a call permuted into the same order as the
formal parameters of the function.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code><a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#permutedCall()">permutedCall</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a call that is equivalent except that arguments have been
permuted into the logical order.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>private java.util.List&lt;<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#permutedOperands(org.apache.calcite.sql.SqlCall)">permutedOperands</a></span>&#8203;(<a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a>&nbsp;call)</code></th>
<td class="colLast">
<div class="block">Returns the operands to a call permuted into the same order as the
formal parameters of the function.</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="SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></h3>
<code><a href="SqlOperatorBinding.html#collectOperandTypes()">collectOperandTypes</a>, <a href="SqlOperatorBinding.html#getOperandLiteralValue(int)">getOperandLiteralValue</a>, <a href="SqlOperatorBinding.html#getOperator()">getOperator</a>, <a href="SqlOperatorBinding.html#getTypeFactory()">getTypeFactory</a>, <a href="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="DEFAULT_CALL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_CALL</h4>
<pre>private static final&nbsp;<a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> DEFAULT_CALL</pre>
</li>
</ul>
<a id="validator">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validator</h4>
<pre>private final&nbsp;<a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a> validator</pre>
</li>
</ul>
<a id="scope">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>scope</h4>
<pre>private final&nbsp;<a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a> scope</pre>
</li>
</ul>
<a id="call">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>call</h4>
<pre>private final&nbsp;<a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call</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.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope,org.apache.calcite.sql.SqlCall)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SqlCallBinding</h4>
<pre>public&nbsp;SqlCallBinding&#8203;(<a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a>&nbsp;validator,
<a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a>&nbsp;scope,
<a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a>&nbsp;call)</pre>
<div class="block">Creates a call binding.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>validator</code> - Validator</dd>
<dd><code>scope</code> - Scope of call</dd>
<dd><code>call</code> - Call node</dd>
</dl>
</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="getGroupCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGroupCount</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getGroupCount()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SqlOperatorBinding.html#getGroupCount()">SqlOperatorBinding</a></code></span></div>
<div class="block">If the operator call occurs in an aggregate query, returns the number of
columns in the GROUP BY clause. For example, for "SELECT count(*) FROM emp
GROUP BY deptno, gender", returns 2.
<p>Returns 0 if the query is implicitly "GROUP BY ()" because of an
aggregate expression. For example, "SELECT sum(sal) FROM emp".</p>
<p>Returns -1 if the query is not an aggregate query.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="SqlOperatorBinding.html#getGroupCount()">getGroupCount</a></code>&nbsp;in class&nbsp;<code><a href="SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></code></dd>
</dl>
</li>
</ul>
<a id="getValidator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValidator</h4>
<pre class="methodSignature">public&nbsp;<a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a>&nbsp;getValidator()</pre>
<div class="block">Returns the validator.</div>
</li>
</ul>
<a id="getScope()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getScope</h4>
<pre class="methodSignature">public&nbsp;<a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a>&nbsp;getScope()</pre>
<div class="block">Returns the scope of the call.</div>
</li>
</ul>
<a id="getCall()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCall</h4>
<pre class="methodSignature">public&nbsp;<a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a>&nbsp;getCall()</pre>
<div class="block">Returns the call node.</div>
</li>
</ul>
<a id="operands()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>operands</h4>
<pre class="methodSignature">public&nbsp;java.util.List&lt;<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&gt;&nbsp;operands()</pre>
<div class="block">Returns the operands to a call permuted into the same order as the
formal parameters of the function.</div>
</li>
</ul>
<a id="hasAssignment()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasAssignment</h4>
<pre class="methodSignature">private&nbsp;boolean&nbsp;hasAssignment()</pre>
<div class="block">Returns whether arguments have name assignment.</div>
</li>
</ul>
<a id="permutedOperands(org.apache.calcite.sql.SqlCall)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>permutedOperands</h4>
<pre class="methodSignature">private&nbsp;java.util.List&lt;<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&gt;&nbsp;permutedOperands&#8203;(<a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a>&nbsp;call)</pre>
<div class="block">Returns the operands to a call permuted into the same order as the
formal parameters of the function.</div>
</li>
</ul>
<a id="operand(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>operand</h4>
<pre class="methodSignature">public&nbsp;<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>&nbsp;operand&#8203;(int&nbsp;i)</pre>
<div class="block">Returns a particular operand.</div>
</li>
</ul>
<a id="permutedCall()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>permutedCall</h4>
<pre class="methodSignature">public&nbsp;<a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a>&nbsp;permutedCall()</pre>
<div class="block">Returns a call that is equivalent except that arguments have been
permuted into the logical order. Any arguments whose default value is being
used are null.</div>
</li>
</ul>
<a id="getOperandMonotonicity(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOperandMonotonicity</h4>
<pre class="methodSignature">public&nbsp;<a href="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="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="SqlOperatorBinding.html#getOperandMonotonicity(int)">getOperandMonotonicity</a></code>&nbsp;in class&nbsp;<code><a href="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="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="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="SqlOperatorBinding.html#getStringLiteralOperand(int)">getStringLiteralOperand</a></code>&nbsp;in class&nbsp;<code><a href="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="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="SqlOperatorBinding.html#getIntLiteralOperand(int)">getIntLiteralOperand</a></code>&nbsp;in class&nbsp;<code><a href="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="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="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="SqlOperatorBinding.html#getOperandLiteralValue(int,java.lang.Class)">getOperandLiteralValue</a></code>&nbsp;in class&nbsp;<code><a href="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="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="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="SqlOperatorBinding.html#isOperandNull(int,boolean)">isOperandNull</a></code>&nbsp;in class&nbsp;<code><a href="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="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="SqlOperatorBinding.html#isOperandLiteral(int,boolean)">isOperandLiteral</a></code>&nbsp;in class&nbsp;<code><a href="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="SqlOperatorBinding.html#getOperandCount()">getOperandCount</a></code>&nbsp;in class&nbsp;<code><a href="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="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="SqlOperatorBinding.html#getOperandType(int)">getOperandType</a></code>&nbsp;in class&nbsp;<code><a href="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="getCursorOperand(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCursorOperand</h4>
<pre class="methodSignature">public&nbsp;<a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&nbsp;getCursorOperand&#8203;(int&nbsp;ordinal)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SqlOperatorBinding.html#getCursorOperand(int)">SqlOperatorBinding</a></code></span></div>
<div class="block">Returns the rowtype of the <code>ordinal</code>th operand, which is a
cursor.
<p>This is only implemented for <a href="SqlCallBinding.html" title="class in org.apache.calcite.sql"><code>SqlCallBinding</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="SqlOperatorBinding.html#getCursorOperand(int)">getCursorOperand</a></code>&nbsp;in class&nbsp;<code><a href="SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ordinal</code> - Ordinal of the operand</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Rowtype of the query underlying the cursor</dd>
</dl>
</li>
</ul>
<a id="getColumnListParamInfo(int,java.lang.String,java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColumnListParamInfo</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getColumnListParamInfo&#8203;(int&nbsp;ordinal,
java.lang.String&nbsp;paramName,
java.util.List&lt;java.lang.String&gt;&nbsp;columnList)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="SqlOperatorBinding.html#getColumnListParamInfo(int,java.lang.String,java.util.List)">SqlOperatorBinding</a></code></span></div>
<div class="block">Retrieves information about a column list parameter.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="SqlOperatorBinding.html#getColumnListParamInfo(int,java.lang.String,java.util.List)">getColumnListParamInfo</a></code>&nbsp;in class&nbsp;<code><a href="SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ordinal</code> - ordinal position of the column list parameter</dd>
<dd><code>paramName</code> - name of the column list parameter</dd>
<dd><code>columnList</code> - returns a list of the column names that are referenced
in the column list parameter</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of the parent cursor referenced by the column list
parameter if it is a column list parameter; otherwise, null is returned</dd>
</dl>
</li>
</ul>
<a id="newError(org.apache.calcite.runtime.Resources.ExInst)">
<!-- -->
</a>
<ul class="blockList">
<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="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="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="SqlOperatorBinding.html#newError(org.apache.calcite.runtime.Resources.ExInst)">newError</a></code>&nbsp;in class&nbsp;<code><a href="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>
<a id="newValidationSignatureError()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newValidationSignatureError</h4>
<pre class="methodSignature">public&nbsp;<a href="../runtime/CalciteException.html" title="class in org.apache.calcite.runtime">CalciteException</a>&nbsp;newValidationSignatureError()</pre>
<div class="block">Constructs a new validation signature error for the call.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>signature exception</dd>
</dl>
</li>
</ul>
<a id="newValidationError(org.apache.calcite.runtime.Resources.ExInst)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>newValidationError</h4>
<pre class="methodSignature">public&nbsp;<a href="../runtime/CalciteException.html" title="class in org.apache.calcite.runtime">CalciteException</a>&nbsp;newValidationError&#8203;(<a href="../runtime/Resources.ExInst.html" title="class in org.apache.calcite.runtime">Resources.ExInst</a>&lt;<a href="validate/SqlValidatorException.html" title="class in org.apache.calcite.sql.validate">SqlValidatorException</a>&gt;&nbsp;ex)</pre>
<div class="block">Constructs a new validation error for the call. (Do not use this to
construct a validation error for other nodes such as an operands.)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ex</code> - underlying exception</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>wrapped exception</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/SqlCallBinding.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>Nested&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>