| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>FamilyOperandTypeChecker (Apache Calcite calcite API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="FamilyOperandTypeChecker (Apache Calcite calcite API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":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"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/calcite/sql/type/ExtraSqlTypes.html" title="interface in org.apache.calcite.sql.type"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/calcite/sql/type/ImplicitCastOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/calcite/sql/type/FamilyOperandTypeChecker.html" target="_top">Frames</a></li> |
| <li><a href="FamilyOperandTypeChecker.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </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>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.calcite.sql.type</div> |
| <h2 title="Class FamilyOperandTypeChecker" class="title">Class FamilyOperandTypeChecker</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.calcite.sql.type.FamilyOperandTypeChecker</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../org/apache/calcite/sql/type/ImplicitCastOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">ImplicitCastOperandTypeChecker</a>, <a href="../../../../../org/apache/calcite/sql/type/SqlOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeChecker</a>, <a href="../../../../../org/apache/calcite/sql/type/SqlSingleOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">SqlSingleOperandTypeChecker</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">FamilyOperandTypeChecker</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../../org/apache/calcite/sql/type/SqlSingleOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">SqlSingleOperandTypeChecker</a>, <a href="../../../../../org/apache/calcite/sql/type/ImplicitCastOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">ImplicitCastOperandTypeChecker</a></pre> |
| <div class="block">Operand type-checking strategy which checks operands for inclusion in type |
| families.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.calcite.sql.type.SqlOperandTypeChecker"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.calcite.sql.type.<a href="../../../../../org/apache/calcite/sql/type/SqlOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeChecker</a></h3> |
| <code><a href="../../../../../org/apache/calcite/sql/type/SqlOperandTypeChecker.Consistency.html" title="enum in org.apache.calcite.sql.type">SqlOperandTypeChecker.Consistency</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected com.google.common.collect.ImmutableList<<a href="../../../../../org/apache/calcite/sql/type/SqlTypeFamily.html" title="enum in org.apache.calcite.sql.type">SqlTypeFamily</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/type/FamilyOperandTypeChecker.html#families">families</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html?is-external=true" title="class or interface in java.util.function">Predicate</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/type/FamilyOperandTypeChecker.html#optional">optional</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/type/FamilyOperandTypeChecker.html#checkOperandTypes-org.apache.calcite.sql.SqlCallBinding-boolean-">checkOperandTypes</a></span>(<a href="../../../../../org/apache/calcite/sql/SqlCallBinding.html" title="class in org.apache.calcite.sql">SqlCallBinding</a> callBinding, |
| boolean throwOnFailure)</code> |
| <div class="block">Checks the types of all operands to an operator call.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/type/FamilyOperandTypeChecker.html#checkOperandTypesWithoutTypeCoercion-org.apache.calcite.sql.SqlCallBinding-boolean-">checkOperandTypesWithoutTypeCoercion</a></span>(<a href="../../../../../org/apache/calcite/sql/SqlCallBinding.html" title="class in org.apache.calcite.sql">SqlCallBinding</a> callBinding, |
| boolean throwOnFailure)</code> |
| <div class="block">Checks the types of an operator's all operands, but without type coercion.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/type/FamilyOperandTypeChecker.html#checkSingleOperandType-org.apache.calcite.sql.SqlCallBinding-org.apache.calcite.sql.SqlNode-int-boolean-">checkSingleOperandType</a></span>(<a href="../../../../../org/apache/calcite/sql/SqlCallBinding.html" title="class in org.apache.calcite.sql">SqlCallBinding</a> callBinding, |
| <a href="../../../../../org/apache/calcite/sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node, |
| int iFormalOperand, |
| boolean throwOnFailure)</code> |
| <div class="block">Checks the type of a single operand against a particular ordinal position |
| within a formal operator signature.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/type/FamilyOperandTypeChecker.html#getAllowedSignatures-org.apache.calcite.sql.SqlOperator-java.lang.String-">getAllowedSignatures</a></span>(<a href="../../../../../org/apache/calcite/sql/SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a> op, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> opName)</code> |
| <div class="block">Returns a string describing the allowed formal signatures of a call, e.g.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/calcite/sql/type/SqlOperandTypeChecker.Consistency.html" title="enum in org.apache.calcite.sql.type">SqlOperandTypeChecker.Consistency</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/type/FamilyOperandTypeChecker.html#getConsistency--">getConsistency</a></span>()</code> |
| <div class="block">Returns the strategy for making the arguments have consistency types.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/calcite/sql/SqlOperandCountRange.html" title="interface in org.apache.calcite.sql">SqlOperandCountRange</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/type/FamilyOperandTypeChecker.html#getOperandCountRange--">getOperandCountRange</a></span>()</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/calcite/sql/type/SqlTypeFamily.html" title="enum in org.apache.calcite.sql.type">SqlTypeFamily</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/type/FamilyOperandTypeChecker.html#getOperandSqlTypeFamily-int-">getOperandSqlTypeFamily</a></span>(int iFormalOperand)</code> |
| <div class="block">Get the operand SqlTypeFamily of formal index <code>iFormalOperand</code>.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/calcite/sql/type/FamilyOperandTypeChecker.html#isOptional-int-">isOptional</a></span>(int i)</code> |
| <div class="block">Returns whether the <code>i</code>th operand is optional.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="families"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>families</h4> |
| <pre>protected final com.google.common.collect.ImmutableList<<a href="../../../../../org/apache/calcite/sql/type/SqlTypeFamily.html" title="enum in org.apache.calcite.sql.type">SqlTypeFamily</a>> families</pre> |
| </li> |
| </ul> |
| <a name="optional"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>optional</h4> |
| <pre>protected final <a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html?is-external=true" title="class or interface in java.util.function">Predicate</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>> optional</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="isOptional-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isOptional</h4> |
| <pre>public boolean isOptional(int i)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/calcite/sql/type/SqlOperandTypeChecker.html#isOptional-int-">SqlOperandTypeChecker</a></code></span></div> |
| <div class="block">Returns whether the <code>i</code>th operand is optional.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/calcite/sql/type/SqlOperandTypeChecker.html#isOptional-int-">isOptional</a></code> in interface <code><a href="../../../../../org/apache/calcite/sql/type/SqlOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeChecker</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="checkSingleOperandType-org.apache.calcite.sql.SqlCallBinding-org.apache.calcite.sql.SqlNode-int-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkSingleOperandType</h4> |
| <pre>public boolean checkSingleOperandType(<a href="../../../../../org/apache/calcite/sql/SqlCallBinding.html" title="class in org.apache.calcite.sql">SqlCallBinding</a> callBinding, |
| <a href="../../../../../org/apache/calcite/sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node, |
| int iFormalOperand, |
| boolean throwOnFailure)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/calcite/sql/type/SqlSingleOperandTypeChecker.html#checkSingleOperandType-org.apache.calcite.sql.SqlCallBinding-org.apache.calcite.sql.SqlNode-int-boolean-">SqlSingleOperandTypeChecker</a></code></span></div> |
| <div class="block">Checks the type of a single operand against a particular ordinal position |
| within a formal operator signature. Note that the actual ordinal position |
| of the operand being checked may be <em>different</em> from the position |
| of the formal operand. |
| |
| <p>For example, when validating the actual call |
| |
| <blockquote> |
| <pre>C(X, Y, Z)</pre> |
| </blockquote> |
| |
| <p>the strategy for validating the operand Z might involve checking its |
| type against the formal signature OP(W). In this case, |
| <code>iFormalOperand</code> would be zero, even though the position of Z |
| within call C is two. |
| |
| <p>Caution that we could not(shouldn't) implement implicit type coercion for this checker, |
| implicit type coercion has side effect(modify the AST), if this single operand checker is |
| subsumed in a composite rule(OR or AND), we can not make any side effect if we |
| can not make sure that all the single operands type check are passed(with type coercion). |
| But there is an exception: only if the call has just one operand, for this case, |
| use <a href="../../../../../org/apache/calcite/sql/type/SqlOperandTypeChecker.html#checkOperandTypes-org.apache.calcite.sql.SqlCallBinding-boolean-"><code>SqlOperandTypeChecker.checkOperandTypes(org.apache.calcite.sql.SqlCallBinding, boolean)</code></a> instead.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/calcite/sql/type/SqlSingleOperandTypeChecker.html#checkSingleOperandType-org.apache.calcite.sql.SqlCallBinding-org.apache.calcite.sql.SqlNode-int-boolean-">checkSingleOperandType</a></code> in interface <code><a href="../../../../../org/apache/calcite/sql/type/SqlSingleOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">SqlSingleOperandTypeChecker</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>callBinding</code> - description of the call being checked; this is only |
| provided for context when throwing an exception; the |
| implementation should <em>NOT</em> examine the |
| operands of the call as part of the check</dd> |
| <dd><code>node</code> - the actual operand to be checked</dd> |
| <dd><code>iFormalOperand</code> - the 0-based formal operand ordinal</dd> |
| <dd><code>throwOnFailure</code> - whether to throw an exception if check fails |
| (otherwise returns false in that case)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether check succeeded</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="checkOperandTypes-org.apache.calcite.sql.SqlCallBinding-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkOperandTypes</h4> |
| <pre>public boolean checkOperandTypes(<a href="../../../../../org/apache/calcite/sql/SqlCallBinding.html" title="class in org.apache.calcite.sql">SqlCallBinding</a> callBinding, |
| boolean throwOnFailure)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/calcite/sql/type/SqlOperandTypeChecker.html#checkOperandTypes-org.apache.calcite.sql.SqlCallBinding-boolean-">SqlOperandTypeChecker</a></code></span></div> |
| <div class="block">Checks the types of all operands to an operator call.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/calcite/sql/type/SqlOperandTypeChecker.html#checkOperandTypes-org.apache.calcite.sql.SqlCallBinding-boolean-">checkOperandTypes</a></code> in interface <code><a href="../../../../../org/apache/calcite/sql/type/SqlOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeChecker</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>callBinding</code> - description of the call to be checked</dd> |
| <dd><code>throwOnFailure</code> - whether to throw an exception if check fails |
| (otherwise returns false in that case)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether check succeeded</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="checkOperandTypesWithoutTypeCoercion-org.apache.calcite.sql.SqlCallBinding-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkOperandTypesWithoutTypeCoercion</h4> |
| <pre>public boolean checkOperandTypesWithoutTypeCoercion(<a href="../../../../../org/apache/calcite/sql/SqlCallBinding.html" title="class in org.apache.calcite.sql">SqlCallBinding</a> callBinding, |
| boolean throwOnFailure)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/calcite/sql/type/ImplicitCastOperandTypeChecker.html#checkOperandTypesWithoutTypeCoercion-org.apache.calcite.sql.SqlCallBinding-boolean-">ImplicitCastOperandTypeChecker</a></code></span></div> |
| <div class="block">Checks the types of an operator's all operands, but without type coercion. |
| This is mainly used as a pre-check when this checker is included as one of the rules in |
| <a href="../../../../../org/apache/calcite/sql/type/CompositeOperandTypeChecker.html" title="class in org.apache.calcite.sql.type"><code>CompositeOperandTypeChecker</code></a> and the composite predicate is `OR`.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/calcite/sql/type/ImplicitCastOperandTypeChecker.html#checkOperandTypesWithoutTypeCoercion-org.apache.calcite.sql.SqlCallBinding-boolean-">checkOperandTypesWithoutTypeCoercion</a></code> in interface <code><a href="../../../../../org/apache/calcite/sql/type/ImplicitCastOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">ImplicitCastOperandTypeChecker</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>callBinding</code> - description of the call to be checked</dd> |
| <dd><code>throwOnFailure</code> - whether to throw an exception if check fails |
| (otherwise returns false in that case)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether check succeeded</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOperandSqlTypeFamily-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOperandSqlTypeFamily</h4> |
| <pre>public <a href="../../../../../org/apache/calcite/sql/type/SqlTypeFamily.html" title="enum in org.apache.calcite.sql.type">SqlTypeFamily</a> getOperandSqlTypeFamily(int iFormalOperand)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/calcite/sql/type/ImplicitCastOperandTypeChecker.html#getOperandSqlTypeFamily-int-">ImplicitCastOperandTypeChecker</a></code></span></div> |
| <div class="block">Get the operand SqlTypeFamily of formal index <code>iFormalOperand</code>. |
| This is mainly used to get the operand SqlTypeFamily when this checker is included as |
| one of the rules in <a href="../../../../../org/apache/calcite/sql/type/CompositeOperandTypeChecker.html" title="class in org.apache.calcite.sql.type"><code>CompositeOperandTypeChecker</code></a> and the |
| composite predicate is `SEQUENCE`.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/calcite/sql/type/ImplicitCastOperandTypeChecker.html#getOperandSqlTypeFamily-int-">getOperandSqlTypeFamily</a></code> in interface <code><a href="../../../../../org/apache/calcite/sql/type/ImplicitCastOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">ImplicitCastOperandTypeChecker</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>iFormalOperand</code> - the formal operand index.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>SqlTypeFamily of the operand.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOperandCountRange--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOperandCountRange</h4> |
| <pre>public <a href="../../../../../org/apache/calcite/sql/SqlOperandCountRange.html" title="interface in org.apache.calcite.sql">SqlOperandCountRange</a> getOperandCountRange()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/calcite/sql/type/SqlOperandTypeChecker.html#getOperandCountRange--">getOperandCountRange</a></code> in interface <code><a href="../../../../../org/apache/calcite/sql/type/SqlOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeChecker</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>range of operand counts allowed in a call</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAllowedSignatures-org.apache.calcite.sql.SqlOperator-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllowedSignatures</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getAllowedSignatures(<a href="../../../../../org/apache/calcite/sql/SqlOperator.html" title="class in org.apache.calcite.sql">SqlOperator</a> op, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> opName)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/calcite/sql/type/SqlOperandTypeChecker.html#getAllowedSignatures-org.apache.calcite.sql.SqlOperator-java.lang.String-">SqlOperandTypeChecker</a></code></span></div> |
| <div class="block">Returns a string describing the allowed formal signatures of a call, e.g. |
| "SUBSTR(VARCHAR, INTEGER, INTEGER)".</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/calcite/sql/type/SqlOperandTypeChecker.html#getAllowedSignatures-org.apache.calcite.sql.SqlOperator-java.lang.String-">getAllowedSignatures</a></code> in interface <code><a href="../../../../../org/apache/calcite/sql/type/SqlOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeChecker</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>op</code> - the operator being checked</dd> |
| <dd><code>opName</code> - name to use for the operator in case of aliasing</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>generated string</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getConsistency--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getConsistency</h4> |
| <pre>public <a href="../../../../../org/apache/calcite/sql/type/SqlOperandTypeChecker.Consistency.html" title="enum in org.apache.calcite.sql.type">SqlOperandTypeChecker.Consistency</a> getConsistency()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/calcite/sql/type/SqlOperandTypeChecker.html#getConsistency--">SqlOperandTypeChecker</a></code></span></div> |
| <div class="block">Returns the strategy for making the arguments have consistency types.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/calcite/sql/type/SqlOperandTypeChecker.html#getConsistency--">getConsistency</a></code> in interface <code><a href="../../../../../org/apache/calcite/sql/type/SqlOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeChecker</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/calcite/sql/type/ExtraSqlTypes.html" title="interface in org.apache.calcite.sql.type"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/calcite/sql/type/ImplicitCastOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/calcite/sql/type/FamilyOperandTypeChecker.html" target="_top">Frames</a></li> |
| <li><a href="FamilyOperandTypeChecker.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </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>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p> |
| </body> |
| </html> |
