| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>SqlOperatorBinding (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="SqlOperatorBinding (Apache Calcite API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":42,"i5":6,"i6":42,"i7":10,"i8":10,"i9":6,"i10":10,"i11":42,"i12":10,"i13":10,"i14":10,"i15":10,"i16":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/SqlOperatorBinding.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 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: </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="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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"> </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> <a href="package-summary.html">org.apache.calcite.sql</a></div> |
| <h2 title="Class SqlOperatorBinding" class="title">Class SqlOperatorBinding</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.calcite.sql.SqlOperatorBinding</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="../rel/core/Aggregate.AggCallBinding.html" title="class in org.apache.calcite.rel.core">Aggregate.AggCallBinding</a></code>, <code><a href="ExplicitOperatorBinding.html" title="class in org.apache.calcite.sql">ExplicitOperatorBinding</a></code>, <code><a href="../rex/RexCallBinding.html" title="class in org.apache.calcite.rex">RexCallBinding</a></code>, <code><a href="SqlCallBinding.html" title="class in org.apache.calcite.sql">SqlCallBinding</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public abstract class <span class="typeNameLabel">SqlOperatorBinding</span> |
| extends java.lang.Object</pre> |
| <div class="block"><code>SqlOperatorBinding</code> represents the binding of an |
| <a href="SqlOperator.html" title="class in org.apache.calcite.sql"><code>SqlOperator</code></a> to actual operands, along with any additional information |
| required to validate those operands if needed.</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"> </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="SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sqlOperator">sqlOperator</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#typeFactory">typeFactory</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </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"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colSecond" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.calcite.rel.type.RelDataTypeFactory,org.apache.calcite.sql.SqlOperator)">SqlOperatorBinding</a></span>​(<a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a> typeFactory, |
| <a href="SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a> sqlOperator)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a SqlOperatorBinding.</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </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>java.util.List<<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="#collectOperandTypes()">collectOperandTypes</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Collects the types of the bound operands into a list.</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>​(int ordinal, |
| java.lang.String paramName, |
| java.util.List<java.lang.String> 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>​(int 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>​(int ordinal)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>abstract int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOperandCount()">getOperandCount</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.lang.Comparable</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOperandLiteralValue(int)">getOperandLiteralValue</a></span>​(int ordinal)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOperandLiteralValue(int,java.lang.Class)">getOperandLiteralValue</a></span>​(int ordinal, |
| java.lang.Class<T> clazz)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the value of a literal operand.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <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>​(int ordinal)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the monotonicity of a bound operand.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>abstract <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>​(int ordinal)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the type of a bound operand.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOperator()">getOperator</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <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>​(int ordinal)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTypeFactory()">getTypeFactory</a></span>()</code></th> |
| <td class="colLast"> </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="#hasFilter()">hasFilter</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether the operator is an aggregate function with a filter.</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="#isOperandLiteral(int,boolean)">isOperandLiteral</a></span>​(int ordinal, |
| boolean allowCast)</code></th> |
| <td class="colLast"> |
| <div class="block">Determines whether an operand is a literal.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isOperandNull(int,boolean)">isOperandNull</a></span>​(int ordinal, |
| boolean allowCast)</code></th> |
| <td class="colLast"> |
| <div class="block">Determines whether a bound operand is NULL.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>abstract <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>​(<a href="../runtime/Resources.ExInst.html" title="class in org.apache.calcite.runtime">Resources.ExInst</a><<a href="validate/SqlValidatorException.html" title="class in org.apache.calcite.sql.validate">SqlValidatorException</a>> 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.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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="typeFactory"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>typeFactory</h4> |
| <pre>protected final <a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a> typeFactory</pre> |
| </li> |
| </ul> |
| <a id="sqlOperator"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>sqlOperator</h4> |
| <pre>private final <a href="SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a> sqlOperator</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="<init>(org.apache.calcite.rel.type.RelDataTypeFactory,org.apache.calcite.sql.SqlOperator)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SqlOperatorBinding</h4> |
| <pre>protected SqlOperatorBinding​(<a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a> typeFactory, |
| <a href="SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a> sqlOperator)</pre> |
| <div class="block">Creates a SqlOperatorBinding.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>typeFactory</code> - Type factory</dd> |
| <dd><code>sqlOperator</code> - Operator which is subject of this call</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 int getGroupCount()</pre> |
| <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> |
| </li> |
| </ul> |
| <a id="hasFilter()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasFilter</h4> |
| <pre class="methodSignature">public boolean hasFilter()</pre> |
| <div class="block">Returns whether the operator is an aggregate function with a filter.</div> |
| </li> |
| </ul> |
| <a id="getOperator()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOperator</h4> |
| <pre class="methodSignature">public <a href="SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a> getOperator()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>bound operator</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getTypeFactory()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTypeFactory</h4> |
| <pre class="methodSignature">public <a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a> getTypeFactory()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>factory for type creation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getStringLiteralOperand(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStringLiteralOperand</h4> |
| <pre class="methodSignature">@Deprecated |
| public java.lang.String getStringLiteralOperand​(int ordinal)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Gets the string value of a string literal operand.</div> |
| <dl> |
| <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">@Deprecated |
| public int getIntLiteralOperand​(int ordinal)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Gets the integer value of a numeric literal operand.</div> |
| <dl> |
| <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 <T> T getOperandLiteralValue​(int ordinal, |
| java.lang.Class<T> clazz)</pre> |
| <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="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="getOperandLiteralValue(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOperandLiteralValue</h4> |
| <pre class="methodSignature">@Deprecated |
| public java.lang.Comparable getOperandLiteralValue​(int ordinal)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </li> |
| </ul> |
| <a id="isOperandNull(int,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isOperandNull</h4> |
| <pre class="methodSignature">public boolean isOperandNull​(int ordinal, |
| boolean allowCast)</pre> |
| <div class="block">Determines whether a bound operand is NULL. |
| |
| <p>This is only relevant for SQL validation.</div> |
| <dl> |
| <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 boolean isOperandLiteral​(int ordinal, |
| boolean allowCast)</pre> |
| <div class="block">Determines whether an operand is a literal.</div> |
| <dl> |
| <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 abstract int getOperandCount()</pre> |
| <dl> |
| <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 abstract <a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> getOperandType​(int ordinal)</pre> |
| <div class="block">Gets the type of a bound operand.</div> |
| <dl> |
| <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="getOperandMonotonicity(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOperandMonotonicity</h4> |
| <pre class="methodSignature">public <a href="validate/SqlMonotonicity.html" title="enum in org.apache.calcite.sql.validate">SqlMonotonicity</a> getOperandMonotonicity​(int ordinal)</pre> |
| <div class="block">Gets the monotonicity of a bound operand.</div> |
| <dl> |
| <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="collectOperandTypes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>collectOperandTypes</h4> |
| <pre class="methodSignature">public java.util.List<<a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>> collectOperandTypes()</pre> |
| <div class="block">Collects the types of the bound operands into a list.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>collected list</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCursorOperand(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCursorOperand</h4> |
| <pre class="methodSignature">public <a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> getCursorOperand​(int ordinal)</pre> |
| <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="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 java.lang.String getColumnListParamInfo​(int ordinal, |
| java.lang.String paramName, |
| java.util.List<java.lang.String> columnList)</pre> |
| <div class="block">Retrieves information about a column list parameter.</div> |
| <dl> |
| <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="blockListLast"> |
| <li class="blockList"> |
| <h4>newError</h4> |
| <pre class="methodSignature">public abstract <a href="../runtime/CalciteException.html" title="class in org.apache.calcite.runtime">CalciteException</a> newError​(<a href="../runtime/Resources.ExInst.html" title="class in org.apache.calcite.runtime">Resources.ExInst</a><<a href="validate/SqlValidatorException.html" title="class in org.apache.calcite.sql.validate">SqlValidatorException</a>> e)</pre> |
| <div class="block">Wraps a validation error with context appropriate to this operator call.</div> |
| <dl> |
| <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/SqlOperatorBinding.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 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: </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="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 2012–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |