| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Compiler (Apache Calcite API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Compiler (Apache Calcite API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Compiler.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.calcite.interpreter</a></div> |
| <h2 title="Interface Compiler" class="title">Interface Compiler</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="Interpreter.CompilerImpl.html" title="class in org.apache.calcite.interpreter">Interpreter.CompilerImpl</a></code>, <code><a href="Nodes.CoreCompiler.html" title="class in org.apache.calcite.interpreter">Nodes.CoreCompiler</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">Compiler</span></pre> |
| <div class="block">Context while converting a tree of <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a> to a program |
| that can be run by an <a href="Interpreter.html" title="class in org.apache.calcite.interpreter"><code>Interpreter</code></a>.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../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="#combinedRowType(java.util.List)">combinedRowType</a></span>​(java.util.List<<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> inputs)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="Scalar.html" title="interface in org.apache.calcite.interpreter">Scalar</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#compile(java.util.List,org.apache.calcite.rel.type.RelDataType)">compile</a></span>​(java.util.List<<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>> nodes, |
| <a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> inputRowType)</code></th> |
| <td class="colLast"> |
| <div class="block">Compiles an expression to an executable form.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="Context.html" title="class in org.apache.calcite.interpreter">Context</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createContext()">createContext</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#enumerable(org.apache.calcite.rel.RelNode,org.apache.calcite.linq4j.Enumerable)">enumerable</a></span>​(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| <a href="../linq4j/Enumerable.html" title="interface in org.apache.calcite.linq4j">Enumerable</a><<a href="Row.html" title="class in org.apache.calcite.interpreter">Row</a>> rowEnumerable)</code></th> |
| <td class="colLast"> |
| <div class="block">Tells the interpreter that a given relational expression wishes to |
| give its output as an enumerable.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../DataContext.html" title="interface in org.apache.calcite">DataContext</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDataContext()">getDataContext</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="Sink.html" title="interface in org.apache.calcite.interpreter">Sink</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sink(org.apache.calcite.rel.RelNode)">sink</a></span>​(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a Sink for a relational expression to write into.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="Source.html" title="interface in org.apache.calcite.interpreter">Source</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#source(org.apache.calcite.rel.RelNode,int)">source</a></span>​(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| int ordinal)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="compile(java.util.List,org.apache.calcite.rel.type.RelDataType)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>compile</h4> |
| <pre class="methodSignature"><a href="Scalar.html" title="interface in org.apache.calcite.interpreter">Scalar</a> compile​(java.util.List<<a href="../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>> nodes, |
| <a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> inputRowType)</pre> |
| <div class="block">Compiles an expression to an executable form.</div> |
| </li> |
| </ul> |
| <a id="combinedRowType(java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>combinedRowType</h4> |
| <pre class="methodSignature"><a href="../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a> combinedRowType​(java.util.List<<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>> inputs)</pre> |
| </li> |
| </ul> |
| <a id="source(org.apache.calcite.rel.RelNode,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>source</h4> |
| <pre class="methodSignature"><a href="Source.html" title="interface in org.apache.calcite.interpreter">Source</a> source​(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| int ordinal)</pre> |
| </li> |
| </ul> |
| <a id="sink(org.apache.calcite.rel.RelNode)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sink</h4> |
| <pre class="methodSignature"><a href="Sink.html" title="interface in org.apache.calcite.interpreter">Sink</a> sink​(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel)</pre> |
| <div class="block">Creates a Sink for a relational expression to write into. |
| |
| <p>This method is generally called from the constructor of a <a href="Node.html" title="interface in org.apache.calcite.interpreter"><code>Node</code></a>. |
| But a constructor could instead call |
| <a href="#enumerable(org.apache.calcite.rel.RelNode,org.apache.calcite.linq4j.Enumerable)"><code>enumerable(RelNode, Enumerable)</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rel</code> - Relational expression</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Sink</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="enumerable(org.apache.calcite.rel.RelNode,org.apache.calcite.linq4j.Enumerable)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>enumerable</h4> |
| <pre class="methodSignature">void enumerable​(<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> rel, |
| <a href="../linq4j/Enumerable.html" title="interface in org.apache.calcite.linq4j">Enumerable</a><<a href="Row.html" title="class in org.apache.calcite.interpreter">Row</a>> rowEnumerable)</pre> |
| <div class="block">Tells the interpreter that a given relational expression wishes to |
| give its output as an enumerable. |
| |
| <p>This is as opposed to the norm, where a relational expression calls |
| <a href="#sink(org.apache.calcite.rel.RelNode)"><code>sink(RelNode)</code></a>, then its <a href="Node.html#run()"><code>Node.run()</code></a> method writes into that |
| sink.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rel</code> - Relational expression</dd> |
| <dd><code>rowEnumerable</code> - Contents of relational expression</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDataContext()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDataContext</h4> |
| <pre class="methodSignature"><a href="../DataContext.html" title="interface in org.apache.calcite">DataContext</a> getDataContext()</pre> |
| </li> |
| </ul> |
| <a id="createContext()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>createContext</h4> |
| <pre class="methodSignature"><a href="Context.html" title="class in org.apache.calcite.interpreter">Context</a> createContext()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Compiler.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2012–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |