| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>SqlOperator (Apache Calcite calcite API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.calcite.sql, class: SqlOperator"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.4.1.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.js"></script> |
| </head> |
| <body class="class-declaration"> |
| <script type="text/javascript">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":42,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":6,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":9,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":9,"i49":10,"i50":10,"i51":42,"i52":42,"i53":10,"i54":10,"i55":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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 = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flexBox"> |
| <header role="banner" class="flexHeader"> |
| <nav role="navigation"> |
| <!-- ========= 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="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"> |
| <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> |
| <div class="navListSearch"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="skipNav"><a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| </nav> |
| </header> |
| <div class="flexContent"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.calcite.sql</a></div> |
| <h1 title="Class SqlOperator" class="title">Class SqlOperator</h1> |
| </div> |
| <div class="contentContainer"> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a> |
| <div class="inheritance">org.apache.calcite.sql.SqlOperator</div> |
| </div> |
| <section class="description"> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="SqlBinaryOperator.html" title="class in org.apache.calcite.sql">SqlBinaryOperator</a></code>, <code><a href="fun/SqlCaseOperator.html" title="class in org.apache.calcite.sql.fun">SqlCaseOperator</a></code>, <code><a href="SqlDescriptorOperator.html" title="class in org.apache.calcite.sql">SqlDescriptorOperator</a></code>, <code><a href="SqlFunction.html" title="class in org.apache.calcite.sql">SqlFunction</a></code>, <code><a href="SqlJoin.SqlJoinOperator.html" title="class in org.apache.calcite.sql">SqlJoin.SqlJoinOperator</a></code>, <code><a href="SqlMatchRecognize.SqlMatchRecognizeOperator.html" title="class in org.apache.calcite.sql">SqlMatchRecognize.SqlMatchRecognizeOperator</a></code>, <code><a href="SqlPostfixOperator.html" title="class in org.apache.calcite.sql">SqlPostfixOperator</a></code>, <code><a href="SqlPrefixOperator.html" title="class in org.apache.calcite.sql">SqlPrefixOperator</a></code>, <code><a href="SqlSelectOperator.html" title="class in org.apache.calcite.sql">SqlSelectOperator</a></code>, <code><a href="SqlSnapshot.SqlSnapshotOperator.html" title="class in org.apache.calcite.sql">SqlSnapshot.SqlSnapshotOperator</a></code>, <code><a href="SqlSpecialOperator.html" title="class in org.apache.calcite.sql">SqlSpecialOperator</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public abstract class <span class="typeNameLabel">SqlOperator</span> |
| extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></pre> |
| <div class="block">A <code>SqlOperator</code> is a type of node in a SQL parse tree (it is NOT a |
| node in a SQL parse tree). It includes functions, operators such as '=', and |
| syntactic constructs such as 'case' statements. Operators may represent |
| query-level expressions (e.g. <a href="SqlSelectOperator.html" title="class in org.apache.calcite.sql"><code>SqlSelectOperator</code></a> or row-level |
| expressions (e.g. <a href="fun/SqlBetweenOperator.html" title="class in org.apache.calcite.sql.fun"><code>SqlBetweenOperator</code></a>. |
| |
| <p>Operators have <em>formal operands</em>, meaning ordered (and optionally |
| named) placeholders for the values they operate on. For example, the division |
| operator takes two operands; the first is the numerator and the second is the |
| denominator. In the context of subclass <a href="SqlFunction.html" title="class in org.apache.calcite.sql"><code>SqlFunction</code></a>, formal operands |
| are referred to as <em>parameters</em>. |
| |
| <p>When an operator is instantiated via a <a href="SqlCall.html" title="class in org.apache.calcite.sql"><code>SqlCall</code></a>, it is supplied |
| with <em>actual operands</em>. For example, in the expression <code>3 / |
| 5</code>, the literal expression <code>3</code> is the actual operand |
| corresponding to the numerator, and <code>5</code> is the actual operand |
| corresponding to the denominator. In the context of SqlFunction, actual |
| operands are referred to as <em>arguments</em> |
| |
| <p>In many cases, the formal/actual distinction is clear from context, in |
| which case we drop these qualifiers.</div> |
| </section> |
| <section class="summary"> |
| <ul class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="fieldSummary"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h2>Field Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <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> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="SqlKind.html" title="enum in org.apache.calcite.sql">SqlKind</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#kind">kind</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">See <a href="SqlKind.html" title="enum in org.apache.calcite.sql"><code>SqlKind</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#MDX_PRECEDENCE">MDX_PRECEDENCE</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Maximum precedence.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#NL">NL</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li class="blockList"> |
| <section class="constructorSummary"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h2>Constructor Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colSecond" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,org.apache.calcite.sql.SqlKind,int,boolean,org.apache.calcite.sql.type.SqlReturnTypeInference,org.apache.calcite.sql.type.SqlOperandTypeInference,org.apache.calcite.sql.type.SqlOperandTypeChecker)">SqlOperator</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, |
| <a href="SqlKind.html" title="enum in org.apache.calcite.sql">SqlKind</a> kind, |
| int prec, |
| boolean leftAssoc, |
| <a href="type/SqlReturnTypeInference.html" title="interface in org.apache.calcite.sql.type">SqlReturnTypeInference</a> returnTypeInference, |
| <a href="type/SqlOperandTypeInference.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeInference</a> operandTypeInference, |
| <a href="type/SqlOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeChecker</a> operandTypeChecker)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates an operator specifying left/right associativity.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,org.apache.calcite.sql.SqlKind,int,int,org.apache.calcite.sql.type.SqlReturnTypeInference,org.apache.calcite.sql.type.SqlOperandTypeInference,org.apache.calcite.sql.type.SqlOperandTypeChecker)">SqlOperator</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, |
| <a href="SqlKind.html" title="enum in org.apache.calcite.sql">SqlKind</a> kind, |
| int leftPrecedence, |
| int rightPrecedence, |
| <a href="type/SqlReturnTypeInference.html" title="interface in org.apache.calcite.sql.type">SqlReturnTypeInference</a> returnTypeInference, |
| <a href="type/SqlOperandTypeInference.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeInference</a> operandTypeInference, |
| <a href="type/SqlOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeChecker</a> operandTypeChecker)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates an operator.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="methodSummary"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h2>Method Summary</h2> |
| <div class="memberSummary"> |
| <div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t1" class="tableTab" onclick="show(1);">Static Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Abstract Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t6" class="tableTab" onclick="show(32);">Deprecated Methods</button></div> |
| <div id="memberSummary_tabpanel" role="tabpanel"> |
| <table aria-labelledby="t0"> |
| <thead> |
| <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> |
| </thead> |
| <tbody> |
| <tr class="altColor" id="i0"> |
| <td class="colFirst"><code><R> R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#acceptCall(org.apache.calcite.sql.util.SqlVisitor,org.apache.calcite.sql.SqlCall)">acceptCall</a></span>​(<a href="util/SqlVisitor.html" title="interface in org.apache.calcite.sql.util">SqlVisitor</a><R> visitor, |
| <a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call)</code></th> |
| <td class="colLast"> |
| <div class="block">Accepts a <a href="util/SqlVisitor.html" title="interface in org.apache.calcite.sql.util"><code>SqlVisitor</code></a>, visiting each operand of a call.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i1"> |
| <td class="colFirst"><code><R> void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#acceptCall(org.apache.calcite.sql.util.SqlVisitor,org.apache.calcite.sql.SqlCall,boolean,org.apache.calcite.sql.util.SqlBasicVisitor.ArgHandler)">acceptCall</a></span>​(<a href="util/SqlVisitor.html" title="interface in org.apache.calcite.sql.util">SqlVisitor</a><R> visitor, |
| <a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call, |
| boolean onlyExpressions, |
| <a href="util/SqlBasicVisitor.ArgHandler.html" title="interface in org.apache.calcite.sql.util">SqlBasicVisitor.ArgHandler</a><R> argHandler)</code></th> |
| <td class="colLast"> |
| <div class="block">Accepts a <a href="util/SqlVisitor.html" title="interface in org.apache.calcite.sql.util"><code>SqlVisitor</code></a>, directing an |
| <a href="util/SqlBasicVisitor.ArgHandler.html" title="interface in org.apache.calcite.sql.util"><code>SqlBasicVisitor.ArgHandler</code></a> |
| to visit an operand of a call.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <td class="colFirst"><code>protected <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="#adjustType(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.SqlCall,org.apache.calcite.rel.type.RelDataType)">adjustType</a></span>​(<a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a> validator, |
| <a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call, |
| <a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> type)</code></th> |
| <td class="colLast"> |
| <div class="block">Validates and determines coercibility and resulting collation name of |
| binary operator if needed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i3"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#allowsFraming()">allowsFraming</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether this is a window function that allows framing (i.e.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i4"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#argumentMustBeScalar(int)">argumentMustBeScalar</a></span>​(int ordinal)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether the <code>ordinal</code>th argument to this operator must |
| be scalar (as opposed to a query).</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i5"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkOperandCount(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.type.SqlOperandTypeChecker,org.apache.calcite.sql.SqlCall)">checkOperandCount</a></span>​(<a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a> validator, |
| <a href="type/SqlOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeChecker</a> argType, |
| <a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i6"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkOperandTypes(org.apache.calcite.sql.SqlCallBinding,boolean)">checkOperandTypes</a></span>​(<a href="SqlCallBinding.html" title="class in org.apache.calcite.sql">SqlCallBinding</a> callBinding, |
| boolean throwOnFailure)</code></th> |
| <td class="colLast"> |
| <div class="block">Checks that the operand values in a <a href="SqlCall.html" title="class in org.apache.calcite.sql"><code>SqlCall</code></a> to this operator are |
| valid.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i7"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#constructArgNameList(org.apache.calcite.sql.SqlCall)">constructArgNameList</a></span>​(<a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i8"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<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="#constructArgTypeList(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope,org.apache.calcite.sql.SqlCall,java.util.List,boolean)">constructArgTypeList</a></span>​(<a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a> validator, |
| <a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a> scope, |
| <a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>> args, |
| boolean convertRowArgToColumnList)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i9"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<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="#constructOperandList(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.SqlCall,java.util.List)">constructOperandList</a></span>​(<a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a> validator, |
| <a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> argNames)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i10"> |
| <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="#createCall(org.apache.calcite.sql.parser.SqlParserPos,java.util.List)">createCall</a></span>​(<a href="parser/SqlParserPos.html" title="class in org.apache.calcite.sql.parser">SqlParserPos</a> pos, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><? extends <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>> operandList)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a call to this operand with a list of operands.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i11"> |
| <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="#createCall(org.apache.calcite.sql.parser.SqlParserPos,org.apache.calcite.sql.SqlNode...)">createCall</a></span>​(<a href="parser/SqlParserPos.html" title="class in org.apache.calcite.sql.parser">SqlParserPos</a> pos, |
| <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>... operands)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a call to this operand with an array of operands.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i12"> |
| <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="#createCall(org.apache.calcite.sql.SqlLiteral,org.apache.calcite.sql.parser.SqlParserPos,org.apache.calcite.sql.SqlNode...)">createCall</a></span>​(<a href="SqlLiteral.html" title="class in org.apache.calcite.sql">SqlLiteral</a> functionQualifier, |
| <a href="parser/SqlParserPos.html" title="class in org.apache.calcite.sql.parser">SqlParserPos</a> pos, |
| <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>... operands)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a call to this operand with an array of operands.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i13"> |
| <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="#createCall(org.apache.calcite.sql.SqlNodeList)">createCall</a></span>​(<a href="SqlNodeList.html" title="class in org.apache.calcite.sql">SqlNodeList</a> nodeList)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a call to this operand with a list of operands contained in a |
| <a href="SqlNodeList.html" title="class in org.apache.calcite.sql"><code>SqlNodeList</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i14"> |
| <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="#deriveType(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope,org.apache.calcite.sql.SqlCall)">deriveType</a></span>​(<a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a> validator, |
| <a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a> scope, |
| <a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call)</code></th> |
| <td class="colLast"> |
| <div class="block">Derives the type of a call to this operator.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i15"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> obj)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i16"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAllowedSignatures()">getAllowedSignatures</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a string describing the expected operand types of a call, e.g.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i17"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAllowedSignatures(java.lang.String)">getAllowedSignatures</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> opNameToUse)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a string describing the expected operand types of a call, e.g.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i18"> |
| <td class="colFirst"><code><a href="SqlKind.html" title="enum in org.apache.calcite.sql">SqlKind</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getKind()">getKind</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i19"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLeftPrec()">getLeftPrec</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i20"> |
| <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="#getMonotonicity(org.apache.calcite.sql.SqlCall,org.apache.calcite.sql.validate.SqlValidatorScope)">getMonotonicity</a></span>​(<a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call, |
| <a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a> scope)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="#getMonotonicity(org.apache.calcite.sql.SqlOperatorBinding)"><code>getMonotonicity(SqlOperatorBinding)</code></a></div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i21"> |
| <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="#getMonotonicity(org.apache.calcite.sql.SqlOperatorBinding)">getMonotonicity</a></span>​(<a href="SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a> call)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether a call to this operator is monotonic.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i22"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getName()">getName</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i23"> |
| <td class="colFirst"><code><a href="SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNameAsId()">getNameAsId</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the fully-qualified name of this operator.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i24"> |
| <td class="colFirst"><code><a href="SqlOperandCountRange.html" title="interface in org.apache.calcite.sql">SqlOperandCountRange</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOperandCountRange()">getOperandCountRange</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a constraint on the number of operands expected by this operator.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i25"> |
| <td class="colFirst"><code><a href="type/SqlOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeChecker</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOperandTypeChecker()">getOperandTypeChecker</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i26"> |
| <td class="colFirst"><code><a href="type/SqlOperandTypeInference.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeInference</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOperandTypeInference()">getOperandTypeInference</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i27"> |
| <td class="colFirst"><code><a href="type/SqlReturnTypeInference.html" title="interface in org.apache.calcite.sql.type">SqlReturnTypeInference</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReturnTypeInference()">getReturnTypeInference</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the return type inference strategy for this operator, or null if |
| return type inference is implemented by a subclass override.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i28"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRightPrec()">getRightPrec</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i29"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSignatureTemplate(int)">getSignatureTemplate</a></span>​(int operandsCount)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a template describing how the operator signature is to be built.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i30"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Supplier</a><<a href="../plan/Strong.Policy.html" title="enum in org.apache.calcite.plan">Strong.Policy</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStrongPolicyInference()">getStrongPolicyInference</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the <a href="../plan/Strong.Policy.html" title="enum in org.apache.calcite.plan"><code>Strong.Policy</code></a> strategy for this operator, or null if |
| there is no particular strategy, in which case this policy will be deducted |
| from the operator's <a href="SqlKind.html" title="enum in org.apache.calcite.sql"><code>SqlKind</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i31"> |
| <td class="colFirst"><code>abstract <a href="SqlSyntax.html" title="enum in org.apache.calcite.sql">SqlSyntax</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSyntax()">getSyntax</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the syntactic type of this operator, never null.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i32"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i33"> |
| <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="#inferReturnType(org.apache.calcite.rel.type.RelDataTypeFactory,java.util.List)">inferReturnType</a></span>​(<a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a> typeFactory, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>> operandTypes)</code></th> |
| <td class="colLast"> |
| <div class="block">Infers the type of a call to this operator with a given set of operand |
| types.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i34"> |
| <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="#inferReturnType(org.apache.calcite.sql.SqlOperatorBinding)">inferReturnType</a></span>​(<a href="SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a> opBinding)</code></th> |
| <td class="colLast"> |
| <div class="block">Infers the return type of an invocation of this operator; only called |
| after the number and types of operands have already been validated.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i35"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAggregator()">isAggregator</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether this operator is an aggregate function.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i36"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isDeterministic()">isDeterministic</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether a call to this operator is guaranteed to always return |
| the same result given the same operands; true is assumed by default.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i37"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isDynamicFunction()">isDynamicFunction</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether it is unsafe to cache query plans referencing this |
| operator; false is assumed by default.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i38"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isGroup()">isGroup</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether this is a group function.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i39"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isGroupAuxiliary()">isGroupAuxiliary</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether this is an group auxiliary function.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i40"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isName(java.lang.String,boolean)">isName</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> testName, |
| boolean caseSensitive)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i41"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSymmetrical()">isSymmetrical</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether a call to this operator is not sensitive to the operands input order.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i42"> |
| <td class="colFirst"><code>protected static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#leftPrec(int,boolean)">leftPrec</a></span>​(int prec, |
| boolean leftAssoc)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i43"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#preValidateCall(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope,org.apache.calcite.sql.SqlCall)">preValidateCall</a></span>​(<a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a> validator, |
| <a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a> scope, |
| <a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call)</code></th> |
| <td class="colLast"> |
| <div class="block">Receives notification that validation of a call to this operator is |
| beginning.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i44"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#requiresDecimalExpansion()">requiresDecimalExpansion</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Method to check if call requires expansion when it has decimal operands.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i45"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#requiresOrder()">requiresOrder</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether this is a window function that requires ordering.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i46"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#requiresOver()">requiresOver</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether this is a window function that requires an OVER clause.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i47"> |
| <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="#rewriteCall(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.SqlCall)">rewriteCall</a></span>​(<a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a> validator, |
| <a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call)</code></th> |
| <td class="colLast"> |
| <div class="block">Rewrites a call to this operator.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i48"> |
| <td class="colFirst"><code>protected static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rightPrec(int,boolean)">rightPrec</a></span>​(int prec, |
| boolean leftAssoc)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i49"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i50"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unparse(org.apache.calcite.sql.SqlWriter,org.apache.calcite.sql.SqlCall,int,int)">unparse</a></span>​(<a href="SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a> writer, |
| <a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call, |
| int leftPrec, |
| int rightPrec)</code></th> |
| <td class="colLast"> |
| <div class="block">Writes a SQL representation of a call to this operator to a writer, |
| including parentheses if the operators on either side are of greater |
| precedence.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i51"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unparseListClause(org.apache.calcite.sql.SqlWriter,org.apache.calcite.sql.SqlNode)">unparseListClause</a></span>​(<a href="SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a> writer, |
| <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> clause)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i52"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unparseListClause(org.apache.calcite.sql.SqlWriter,org.apache.calcite.sql.SqlNode,org.apache.calcite.sql.SqlKind)">unparseListClause</a></span>​(<a href="SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a> writer, |
| <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> clause, |
| <a href="SqlKind.html" title="enum in org.apache.calcite.sql">SqlKind</a> sepKind)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i53"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validateCall(org.apache.calcite.sql.SqlCall,org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope,org.apache.calcite.sql.validate.SqlValidatorScope)">validateCall</a></span>​(<a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call, |
| <a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a> validator, |
| <a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a> scope, |
| <a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a> operandScope)</code></th> |
| <td class="colLast"> |
| <div class="block">Validates a call to this operator.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i54"> |
| <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="#validateOperands(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope,org.apache.calcite.sql.SqlCall)">validateOperands</a></span>​(<a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a> validator, |
| <a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a> scope, |
| <a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call)</code></th> |
| <td class="colLast"> |
| <div class="block">Validates the operands of a call, inferring the return type in the |
| process.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i55"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validRexOperands(int,org.apache.calcite.util.Litmus)">validRexOperands</a></span>​(int count, |
| <a href="../util/Litmus.html" title="interface in org.apache.calcite.util">Litmus</a> litmus)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether the given operands are valid.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li class="blockList"> |
| <section class="fieldDetails"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h2>Field Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="NL">NL</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static final</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></span> <span class="memberName">NL</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="MDX_PRECEDENCE">MDX_PRECEDENCE</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static final</span> <span class="returnType">int</span> <span class="memberName">MDX_PRECEDENCE</span></div> |
| <div class="block">Maximum precedence.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.calcite.sql.SqlOperator.MDX_PRECEDENCE">Constant Field Values</a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="kind">kind</a></h3> |
| <div class="memberSignature"><span class="modifiers">public final</span> <span class="returnType"><a href="SqlKind.html" title="enum in org.apache.calcite.sql">SqlKind</a></span> <span class="memberName">kind</span></div> |
| <div class="block">See <a href="SqlKind.html" title="enum in org.apache.calcite.sql"><code>SqlKind</code></a>. It's possible to have a name that doesn't match the |
| kind</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li class="blockList"> |
| <section class="constructorDetails"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h2>Constructor Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="<init>(java.lang.String,org.apache.calcite.sql.SqlKind,int,int,org.apache.calcite.sql.type.SqlReturnTypeInference,org.apache.calcite.sql.type.SqlOperandTypeInference,org.apache.calcite.sql.type.SqlOperandTypeChecker)">SqlOperator</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="memberName">SqlOperator</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, |
| <a href="SqlKind.html" title="enum in org.apache.calcite.sql">SqlKind</a> kind, |
| int leftPrecedence, |
| int rightPrecedence, |
| <a href="type/SqlReturnTypeInference.html" title="interface in org.apache.calcite.sql.type">SqlReturnTypeInference</a> returnTypeInference, |
| <a href="type/SqlOperandTypeInference.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeInference</a> operandTypeInference, |
| <a href="type/SqlOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeChecker</a> operandTypeChecker)</span></div> |
| <div class="block">Creates an operator.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="<init>(java.lang.String,org.apache.calcite.sql.SqlKind,int,boolean,org.apache.calcite.sql.type.SqlReturnTypeInference,org.apache.calcite.sql.type.SqlOperandTypeInference,org.apache.calcite.sql.type.SqlOperandTypeChecker)">SqlOperator</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="memberName">SqlOperator</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, |
| <a href="SqlKind.html" title="enum in org.apache.calcite.sql">SqlKind</a> kind, |
| int prec, |
| boolean leftAssoc, |
| <a href="type/SqlReturnTypeInference.html" title="interface in org.apache.calcite.sql.type">SqlReturnTypeInference</a> returnTypeInference, |
| <a href="type/SqlOperandTypeInference.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeInference</a> operandTypeInference, |
| <a href="type/SqlOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeChecker</a> operandTypeChecker)</span></div> |
| <div class="block">Creates an operator specifying left/right associativity.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li class="blockList"> |
| <section class="methodDetails"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h2>Method Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="leftPrec(int,boolean)">leftPrec</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected static</span> <span class="returnType">int</span> <span class="memberName">leftPrec</span>​(<span class="arguments">int prec, |
| boolean leftAssoc)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="rightPrec(int,boolean)">rightPrec</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected static</span> <span class="returnType">int</span> <span class="memberName">rightPrec</span>​(<span class="arguments">int prec, |
| boolean leftAssoc)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getOperandTypeChecker()">getOperandTypeChecker</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="type/SqlOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeChecker</a></span> <span class="memberName">getOperandTypeChecker</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getOperandCountRange()">getOperandCountRange</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="SqlOperandCountRange.html" title="interface in org.apache.calcite.sql">SqlOperandCountRange</a></span> <span class="memberName">getOperandCountRange</span>()</div> |
| <div class="block">Returns a constraint on the number of operands expected by this operator. |
| Subclasses may override this method; when they don't, the range is |
| derived from the <a href="type/SqlOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type"><code>SqlOperandTypeChecker</code></a> associated with this |
| operator.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>acceptable range</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getName()">getName</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></span> <span class="memberName">getName</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getNameAsId()">getNameAsId</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="SqlIdentifier.html" title="class in org.apache.calcite.sql">SqlIdentifier</a></span> <span class="memberName">getNameAsId</span>()</div> |
| <div class="block">Returns the fully-qualified name of this operator.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getKind()">getKind</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="SqlKind.html" title="enum in org.apache.calcite.sql">SqlKind</a></span> <span class="memberName">getKind</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toString()">toString</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></span> <span class="memberName">toString</span>()</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getLeftPrec()">getLeftPrec</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">int</span> <span class="memberName">getLeftPrec</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getRightPrec()">getRightPrec</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">int</span> <span class="memberName">getRightPrec</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getSyntax()">getSyntax</a></h3> |
| <div class="memberSignature"><span class="modifiers">public abstract</span> <span class="returnType"><a href="SqlSyntax.html" title="enum in org.apache.calcite.sql">SqlSyntax</a></span> <span class="memberName">getSyntax</span>()</div> |
| <div class="block">Returns the syntactic type of this operator, never null.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="createCall(org.apache.calcite.sql.SqlLiteral,org.apache.calcite.sql.parser.SqlParserPos,org.apache.calcite.sql.SqlNode...)">createCall</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a></span> <span class="memberName">createCall</span>​(<span class="arguments"><a href="SqlLiteral.html" title="class in org.apache.calcite.sql">SqlLiteral</a> functionQualifier, |
| <a href="parser/SqlParserPos.html" title="class in org.apache.calcite.sql.parser">SqlParserPos</a> pos, |
| <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>... operands)</span></div> |
| <div class="block">Creates a call to this operand with an array of operands. |
| |
| <p>The position of the resulting call is the union of the <code> |
| pos</code> and the positions of all of the operands.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>functionQualifier</code> - function qualifier (e.g. "DISTINCT"), may be</dd> |
| <dd><code>pos</code> - parser position of the identifier of the call</dd> |
| <dd><code>operands</code> - array of operands</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="createCall(org.apache.calcite.sql.parser.SqlParserPos,org.apache.calcite.sql.SqlNode...)">createCall</a></h3> |
| <div class="memberSignature"><span class="modifiers">public final</span> <span class="returnType"><a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a></span> <span class="memberName">createCall</span>​(<span class="arguments"><a href="parser/SqlParserPos.html" title="class in org.apache.calcite.sql.parser">SqlParserPos</a> pos, |
| <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>... operands)</span></div> |
| <div class="block">Creates a call to this operand with an array of operands. |
| |
| <p>The position of the resulting call is the union of the <code> |
| pos</code> and the positions of all of the operands.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pos</code> - Parser position</dd> |
| <dd><code>operands</code> - List of arguments</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>call to this operator</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="createCall(org.apache.calcite.sql.SqlNodeList)">createCall</a></h3> |
| <div class="memberSignature"><span class="modifiers">public final</span> <span class="returnType"><a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a></span> <span class="memberName">createCall</span>​(<span class="arguments"><a href="SqlNodeList.html" title="class in org.apache.calcite.sql">SqlNodeList</a> nodeList)</span></div> |
| <div class="block">Creates a call to this operand with a list of operands contained in a |
| <a href="SqlNodeList.html" title="class in org.apache.calcite.sql"><code>SqlNodeList</code></a>. |
| |
| <p>The position of the resulting call inferred from the SqlNodeList.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>nodeList</code> - List of arguments</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>call to this operator</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="createCall(org.apache.calcite.sql.parser.SqlParserPos,java.util.List)">createCall</a></h3> |
| <div class="memberSignature"><span class="modifiers">public final</span> <span class="returnType"><a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a></span> <span class="memberName">createCall</span>​(<span class="arguments"><a href="parser/SqlParserPos.html" title="class in org.apache.calcite.sql.parser">SqlParserPos</a> pos, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><? extends <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>> operandList)</span></div> |
| <div class="block">Creates a call to this operand with a list of operands. |
| |
| <p>The position of the resulting call is the union of the <code> |
| pos</code> and the positions of all of the operands.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="rewriteCall(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.SqlCall)">rewriteCall</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a></span> <span class="memberName">rewriteCall</span>​(<span class="arguments"><a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a> validator, |
| <a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call)</span></div> |
| <div class="block">Rewrites a call to this operator. Some operators are implemented as |
| trivial rewrites (e.g. NULLIF becomes CASE). However, we don't do this at |
| createCall time because we want to preserve the original SQL syntax as |
| much as possible; instead, we do this before the call is validated (so |
| the trivial operator doesn't need its own implementation of type |
| derivation methods). The default implementation is to just return the |
| original call without any rewrite.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>validator</code> - Validator</dd> |
| <dd><code>call</code> - Call to be rewritten</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>rewritten call</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="unparse(org.apache.calcite.sql.SqlWriter,org.apache.calcite.sql.SqlCall,int,int)">unparse</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">unparse</span>​(<span class="arguments"><a href="SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a> writer, |
| <a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call, |
| int leftPrec, |
| int rightPrec)</span></div> |
| <div class="block">Writes a SQL representation of a call to this operator to a writer, |
| including parentheses if the operators on either side are of greater |
| precedence. |
| |
| <p>The default implementation of this method delegates to |
| <a href="SqlSyntax.html#unparse(org.apache.calcite.sql.SqlWriter,org.apache.calcite.sql.SqlOperator,org.apache.calcite.sql.SqlCall,int,int)"><code>SqlSyntax.unparse(org.apache.calcite.sql.SqlWriter, org.apache.calcite.sql.SqlOperator, org.apache.calcite.sql.SqlCall, int, int)</code></a>.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="unparseListClause(org.apache.calcite.sql.SqlWriter,org.apache.calcite.sql.SqlNode)">unparseListClause</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">unparseListClause</span>​(<span class="arguments"><a href="SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a> writer, |
| <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> clause)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="unparseListClause(org.apache.calcite.sql.SqlWriter,org.apache.calcite.sql.SqlNode,org.apache.calcite.sql.SqlKind)">unparseListClause</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">unparseListClause</span>​(<span class="arguments"><a href="SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a> writer, |
| <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> clause, |
| <a href="SqlKind.html" title="enum in org.apache.calcite.sql">SqlKind</a> sepKind)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="equals(java.lang.Object)">equals</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">equals</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> obj)</span></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a></code> in class <code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="isName(java.lang.String,boolean)">isName</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">isName</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> testName, |
| boolean caseSensitive)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="hashCode()">hashCode</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">int</span> <span class="memberName">hashCode</span>()</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a></code> in class <code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="validateCall(org.apache.calcite.sql.SqlCall,org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope,org.apache.calcite.sql.validate.SqlValidatorScope)">validateCall</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">validateCall</span>​(<span class="arguments"><a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call, |
| <a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a> validator, |
| <a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a> scope, |
| <a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a> operandScope)</span></div> |
| <div class="block">Validates a call to this operator. |
| |
| <p>This method should not perform type-derivation or perform validation |
| related related to types. That is done later, by |
| <a href="#deriveType(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope,org.apache.calcite.sql.SqlCall)"><code>deriveType(SqlValidator, SqlValidatorScope, SqlCall)</code></a>. This method |
| should focus on structural validation. |
| |
| <p>A typical implementation of this method first validates the operands, |
| then performs some operator-specific logic. The default implementation |
| just validates the operands. |
| |
| <p>This method is the default implementation of <a href="SqlCall.html#validate(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope)"><code>SqlCall.validate(org.apache.calcite.sql.validate.SqlValidator, org.apache.calcite.sql.validate.SqlValidatorScope)</code></a>; |
| but note that some sub-classes of <a href="SqlCall.html" title="class in org.apache.calcite.sql"><code>SqlCall</code></a> never call this method.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>call</code> - the call to this operator</dd> |
| <dd><code>validator</code> - the active validator</dd> |
| <dd><code>scope</code> - validator scope</dd> |
| <dd><code>operandScope</code> - validator scope in which to validate operands to this |
| call; usually equal to scope, but not always because |
| some operators introduce new scopes</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="SqlNode.html#validateExpr(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope)"><code>SqlNode.validateExpr(SqlValidator, SqlValidatorScope)</code></a>, |
| <a href="#deriveType(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope,org.apache.calcite.sql.SqlCall)"><code>deriveType(SqlValidator, SqlValidatorScope, SqlCall)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="validateOperands(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope,org.apache.calcite.sql.SqlCall)">validateOperands</a></h3> |
| <div class="memberSignature"><span class="modifiers">public final</span> <span class="returnType"><a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="memberName">validateOperands</span>​(<span class="arguments"><a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a> validator, |
| <a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a> scope, |
| <a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call)</span></div> |
| <div class="block">Validates the operands of a call, inferring the return type in the |
| process.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>validator</code> - active validator</dd> |
| <dd><code>scope</code> - validation scope</dd> |
| <dd><code>call</code> - call to be validated</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>inferred type</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="preValidateCall(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope,org.apache.calcite.sql.SqlCall)">preValidateCall</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">preValidateCall</span>​(<span class="arguments"><a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a> validator, |
| <a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a> scope, |
| <a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call)</span></div> |
| <div class="block">Receives notification that validation of a call to this operator is |
| beginning. Subclasses can supply custom behavior; default implementation |
| does nothing.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>validator</code> - invoking validator</dd> |
| <dd><code>scope</code> - validation scope</dd> |
| <dd><code>call</code> - the call being validated</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="inferReturnType(org.apache.calcite.sql.SqlOperatorBinding)">inferReturnType</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="memberName">inferReturnType</span>​(<span class="arguments"><a href="SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a> opBinding)</span></div> |
| <div class="block">Infers the return type of an invocation of this operator; only called |
| after the number and types of operands have already been validated. |
| Subclasses must either override this method or supply an instance of |
| <a href="type/SqlReturnTypeInference.html" title="interface in org.apache.calcite.sql.type"><code>SqlReturnTypeInference</code></a> to the constructor.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>opBinding</code> - description of invocation (not necessarily a |
| <a href="SqlCall.html" title="class in org.apache.calcite.sql"><code>SqlCall</code></a>)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>inferred return type</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="deriveType(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope,org.apache.calcite.sql.SqlCall)">deriveType</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="memberName">deriveType</span>​(<span class="arguments"><a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a> validator, |
| <a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a> scope, |
| <a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call)</span></div> |
| <div class="block">Derives the type of a call to this operator. |
| |
| <p>This method is an intrinsic part of the validation process so, unlike |
| <a href="#inferReturnType(org.apache.calcite.sql.SqlOperatorBinding)"><code>inferReturnType(org.apache.calcite.sql.SqlOperatorBinding)</code></a>, specific operators would not typically override |
| this method.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>validator</code> - Validator</dd> |
| <dd><code>scope</code> - Scope of validation</dd> |
| <dd><code>call</code> - Call to this operator</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Type of call</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="constructArgNameList(org.apache.calcite.sql.SqlCall)">constructArgNameList</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>></span> <span class="memberName">constructArgNameList</span>​(<span class="arguments"><a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="constructOperandList(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.SqlCall,java.util.List)">constructOperandList</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>></span> <span class="memberName">constructOperandList</span>​(<span class="arguments"><a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a> validator, |
| <a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> argNames)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="constructArgTypeList(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.validate.SqlValidatorScope,org.apache.calcite.sql.SqlCall,java.util.List,boolean)">constructArgTypeList</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>></span> <span class="memberName">constructArgTypeList</span>​(<span class="arguments"><a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a> validator, |
| <a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a> scope, |
| <a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a>> args, |
| boolean convertRowArgToColumnList)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="adjustType(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.SqlCall,org.apache.calcite.rel.type.RelDataType)">adjustType</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="memberName">adjustType</span>​(<span class="arguments"><a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a> validator, |
| <a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call, |
| <a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> type)</span></div> |
| <div class="block">Validates and determines coercibility and resulting collation name of |
| binary operator if needed.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="inferReturnType(org.apache.calcite.rel.type.RelDataTypeFactory,java.util.List)">inferReturnType</a></h3> |
| <div class="memberSignature"><span class="modifiers">public final</span> <span class="returnType"><a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="memberName">inferReturnType</span>​(<span class="arguments"><a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a> typeFactory, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>> operandTypes)</span></div> |
| <div class="block">Infers the type of a call to this operator with a given set of operand |
| types. Shorthand for <a href="#inferReturnType(org.apache.calcite.sql.SqlOperatorBinding)"><code>inferReturnType(SqlOperatorBinding)</code></a>.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="checkOperandTypes(org.apache.calcite.sql.SqlCallBinding,boolean)">checkOperandTypes</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">checkOperandTypes</span>​(<span class="arguments"><a href="SqlCallBinding.html" title="class in org.apache.calcite.sql">SqlCallBinding</a> callBinding, |
| boolean throwOnFailure)</span></div> |
| <div class="block">Checks that the operand values in a <a href="SqlCall.html" title="class in org.apache.calcite.sql"><code>SqlCall</code></a> to this operator are |
| valid. Subclasses must either override this method or supply an instance |
| of <a href="type/SqlOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type"><code>SqlOperandTypeChecker</code></a> to the constructor.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>callBinding</code> - description of call</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> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="checkOperandCount(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.type.SqlOperandTypeChecker,org.apache.calcite.sql.SqlCall)">checkOperandCount</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">checkOperandCount</span>​(<span class="arguments"><a href="validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate">SqlValidator</a> validator, |
| <a href="type/SqlOperandTypeChecker.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeChecker</a> argType, |
| <a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="validRexOperands(int,org.apache.calcite.util.Litmus)">validRexOperands</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">validRexOperands</span>​(<span class="arguments">int count, |
| <a href="../util/Litmus.html" title="interface in org.apache.calcite.util">Litmus</a> litmus)</span></div> |
| <div class="block">Returns whether the given operands are valid. If not valid and |
| <code>fail</code>, throws an assertion error. |
| |
| <p>Similar to <a href="#checkOperandCount(org.apache.calcite.sql.validate.SqlValidator,org.apache.calcite.sql.type.SqlOperandTypeChecker,org.apache.calcite.sql.SqlCall)"><code>checkOperandCount(org.apache.calcite.sql.validate.SqlValidator, org.apache.calcite.sql.type.SqlOperandTypeChecker, org.apache.calcite.sql.SqlCall)</code></a>, but some operators may have |
| different valid operands in <a href="SqlNode.html" title="class in org.apache.calcite.sql"><code>SqlNode</code></a> and <code>RexNode</code> formats |
| (some examples are CAST and AND), and this method throws internal errors, |
| not user errors.</p></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getSignatureTemplate(int)">getSignatureTemplate</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></span> <span class="memberName">getSignatureTemplate</span>​(<span class="arguments">int operandsCount)</span></div> |
| <div class="block">Returns a template describing how the operator signature is to be built. |
| E.g for the binary + operator the template looks like "{1} {0} {2}" {0} |
| is the operator, subsequent numbers are operands.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>operandsCount</code> - is used with functions that can take a variable |
| number of operands</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>signature template, or null to indicate that a default template |
| will suffice</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getAllowedSignatures()">getAllowedSignatures</a></h3> |
| <div class="memberSignature"><span class="modifiers">public final</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></span> <span class="memberName">getAllowedSignatures</span>()</div> |
| <div class="block">Returns a string describing the expected operand types of a call, e.g. |
| "SUBSTR(VARCHAR, INTEGER, INTEGER)".</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getAllowedSignatures(java.lang.String)">getAllowedSignatures</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></span> <span class="memberName">getAllowedSignatures</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> opNameToUse)</span></div> |
| <div class="block">Returns a string describing the expected operand types of a call, e.g. |
| "SUBSTRING(VARCHAR, INTEGER, INTEGER)" where the name (SUBSTRING in this |
| example) can be replaced by a specified name.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getOperandTypeInference()">getOperandTypeInference</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="type/SqlOperandTypeInference.html" title="interface in org.apache.calcite.sql.type">SqlOperandTypeInference</a></span> <span class="memberName">getOperandTypeInference</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="isAggregator()">isAggregator</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">isAggregator</span>()</div> |
| <div class="block">Returns whether this operator is an aggregate function. By default, |
| subclass type is used (an instance of SqlAggFunction is assumed to be an |
| aggregator; anything else is not). |
| |
| <p>Per SQL:2011, there are <dfn>aggregate functions</dfn> and |
| <dfn>window functions</dfn>. |
| Every aggregate function (e.g. SUM) is also a window function. |
| There are window functions that are not aggregate functions, e.g. RANK, |
| NTILE, LEAD, FIRST_VALUE.</p> |
| |
| <p>Collectively, aggregate and window functions are called <dfn>analytic |
| functions</dfn>. Despite its name, this method returns true for every |
| analytic function.</p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether this operator is an analytic function (aggregate function |
| or window function)</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#requiresOrder()"><code>requiresOrder()</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="requiresOver()">requiresOver</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">requiresOver</span>()</div> |
| <div class="block">Returns whether this is a window function that requires an OVER clause. |
| |
| <p>For example, returns true for <code>RANK</code>, <code>DENSE_RANK</code> and |
| other ranking functions; returns false for <code>SUM</code>, <code>COUNT</code>, |
| <code>MIN</code>, <code>MAX</code>, <code>AVG</code> (they can be used as non-window |
| aggregate functions). |
| |
| <p>If <code>requiresOver</code> returns true, then <a href="#isAggregator()"><code>isAggregator()</code></a> must |
| also return true.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#allowsFraming()"><code>allowsFraming()</code></a>, |
| <a href="#requiresOrder()"><code>requiresOrder()</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="requiresOrder()">requiresOrder</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">requiresOrder</span>()</div> |
| <div class="block">Returns whether this is a window function that requires ordering. |
| |
| <p>Per SQL:2011, 2, 6.10: "If <ntile function>, <lead or lag |
| function>, RANK or DENSE_RANK is specified, then the window ordering |
| clause shall be present."</p></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#isAggregator()"><code>isAggregator()</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="allowsFraming()">allowsFraming</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">allowsFraming</span>()</div> |
| <div class="block">Returns whether this is a window function that allows framing (i.e. a |
| ROWS or RANGE clause in the window specification).</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="isGroup()">isGroup</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">isGroup</span>()</div> |
| <div class="block">Returns whether this is a group function. |
| |
| <p>Group functions can only appear in the GROUP BY clause. |
| |
| <p>Examples are <code>HOP</code>, <code>TUMBLE</code>, <code>SESSION</code>. |
| |
| <p>Group functions have auxiliary functions, e.g. <code>HOP_START</code>, but |
| these are not group functions.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="isGroupAuxiliary()">isGroupAuxiliary</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">isGroupAuxiliary</span>()</div> |
| <div class="block">Returns whether this is an group auxiliary function. |
| |
| <p>Examples are <code>HOP_START</code> and <code>HOP_END</code> (both auxiliary to |
| <code>HOP</code>).</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#isGroup()"><code>isGroup()</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="acceptCall(org.apache.calcite.sql.util.SqlVisitor,org.apache.calcite.sql.SqlCall)">acceptCall</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="typeParameters"><R></span> <span class="returnType">R</span> <span class="memberName">acceptCall</span>​(<span class="arguments"><a href="util/SqlVisitor.html" title="interface in org.apache.calcite.sql.util">SqlVisitor</a><R> visitor, |
| <a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call)</span></div> |
| <div class="block">Accepts a <a href="util/SqlVisitor.html" title="interface in org.apache.calcite.sql.util"><code>SqlVisitor</code></a>, visiting each operand of a call. Returns |
| null.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>visitor</code> - Visitor</dd> |
| <dd><code>call</code> - Call to visit</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="acceptCall(org.apache.calcite.sql.util.SqlVisitor,org.apache.calcite.sql.SqlCall,boolean,org.apache.calcite.sql.util.SqlBasicVisitor.ArgHandler)">acceptCall</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="typeParameters"><R></span> <span class="returnType">void</span> <span class="memberName">acceptCall</span>​(<span class="arguments"><a href="util/SqlVisitor.html" title="interface in org.apache.calcite.sql.util">SqlVisitor</a><R> visitor, |
| <a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call, |
| boolean onlyExpressions, |
| <a href="util/SqlBasicVisitor.ArgHandler.html" title="interface in org.apache.calcite.sql.util">SqlBasicVisitor.ArgHandler</a><R> argHandler)</span></div> |
| <div class="block">Accepts a <a href="util/SqlVisitor.html" title="interface in org.apache.calcite.sql.util"><code>SqlVisitor</code></a>, directing an |
| <a href="util/SqlBasicVisitor.ArgHandler.html" title="interface in org.apache.calcite.sql.util"><code>SqlBasicVisitor.ArgHandler</code></a> |
| to visit an operand of a call. |
| |
| <p>The argument handler allows fine control about how the operands are |
| visited, and how the results are combined.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>visitor</code> - Visitor</dd> |
| <dd><code>call</code> - Call to visit</dd> |
| <dd><code>onlyExpressions</code> - If true, ignores operands which are not |
| expressions. For example, in the call to the |
| <code>AS</code> operator</dd> |
| <dd><code>argHandler</code> - Called for each operand</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getReturnTypeInference()">getReturnTypeInference</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="type/SqlReturnTypeInference.html" title="interface in org.apache.calcite.sql.type">SqlReturnTypeInference</a></span> <span class="memberName">getReturnTypeInference</span>()</div> |
| <div class="block">Returns the return type inference strategy for this operator, or null if |
| return type inference is implemented by a subclass override.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getStrongPolicyInference()">getStrongPolicyInference</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Supplier</a><<a href="../plan/Strong.Policy.html" title="enum in org.apache.calcite.plan">Strong.Policy</a>></span> <span class="memberName">getStrongPolicyInference</span>()</div> |
| <div class="block">Returns the <a href="../plan/Strong.Policy.html" title="enum in org.apache.calcite.plan"><code>Strong.Policy</code></a> strategy for this operator, or null if |
| there is no particular strategy, in which case this policy will be deducted |
| from the operator's <a href="SqlKind.html" title="enum in org.apache.calcite.sql"><code>SqlKind</code></a>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../plan/Strong.html" title="class in org.apache.calcite.plan"><code>Strong</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getMonotonicity(org.apache.calcite.sql.SqlCall,org.apache.calcite.sql.validate.SqlValidatorScope)">getMonotonicity</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="returnType"><a href="validate/SqlMonotonicity.html" title="enum in org.apache.calcite.sql.validate">SqlMonotonicity</a></span> <span class="memberName">getMonotonicity</span>​(<span class="arguments"><a href="SqlCall.html" title="class in org.apache.calcite.sql">SqlCall</a> call, |
| <a href="validate/SqlValidatorScope.html" title="interface in org.apache.calcite.sql.validate">SqlValidatorScope</a> scope)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">Use <a href="#getMonotonicity(org.apache.calcite.sql.SqlOperatorBinding)"><code>getMonotonicity(SqlOperatorBinding)</code></a></div> |
| </div> |
| <div class="block">Returns whether this operator is monotonic. |
| |
| <p>Default implementation returns <a href="validate/SqlMonotonicity.html#NOT_MONOTONIC"><code>SqlMonotonicity.NOT_MONOTONIC</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>call</code> - Call to this operator</dd> |
| <dd><code>scope</code> - Scope in which the call occurs</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getMonotonicity(org.apache.calcite.sql.SqlOperatorBinding)">getMonotonicity</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="validate/SqlMonotonicity.html" title="enum in org.apache.calcite.sql.validate">SqlMonotonicity</a></span> <span class="memberName">getMonotonicity</span>​(<span class="arguments"><a href="SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a> call)</span></div> |
| <div class="block">Returns whether a call to this operator is monotonic. |
| |
| <p>Default implementation returns <a href="validate/SqlMonotonicity.html#NOT_MONOTONIC"><code>SqlMonotonicity.NOT_MONOTONIC</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>call</code> - Call to this operator with particular arguments and information |
| about the monotonicity of the arguments</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="isDeterministic()">isDeterministic</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">isDeterministic</span>()</div> |
| <div class="block">Returns whether a call to this operator is guaranteed to always return |
| the same result given the same operands; true is assumed by default.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="isSymmetrical()">isSymmetrical</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">isSymmetrical</span>()</div> |
| <div class="block">Returns whether a call to this operator is not sensitive to the operands input order. |
| An operator is symmetrical if the call returns the same result when |
| the operands are shuffled. |
| |
| <p>By default, returns true for <a href="SqlKind.html#SYMMETRICAL"><code>SqlKind.SYMMETRICAL</code></a>.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="isDynamicFunction()">isDynamicFunction</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">isDynamicFunction</span>()</div> |
| <div class="block">Returns whether it is unsafe to cache query plans referencing this |
| operator; false is assumed by default.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="requiresDecimalExpansion()">requiresDecimalExpansion</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">requiresDecimalExpansion</span>()</div> |
| <div class="block">Method to check if call requires expansion when it has decimal operands. |
| The default implementation is to return true.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="argumentMustBeScalar(int)">argumentMustBeScalar</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">argumentMustBeScalar</span>​(<span class="arguments">int ordinal)</span></div> |
| <div class="block">Returns whether the <code>ordinal</code>th argument to this operator must |
| be scalar (as opposed to a query). |
| |
| <p>If true (the default), the validator will attempt to convert the |
| argument into a scalar sub-query, which must have one column and return at |
| most one row. |
| |
| <p>Operators such as <code>SELECT</code> and <code>EXISTS</code> override |
| this method.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <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="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"> |
| <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> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |