| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Extensions (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.linq4j, class: Extensions"> |
| <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":9,"i1":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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>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> |
| <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.linq4j</a></div> |
| <h1 title="Class Extensions" class="title">Class Extensions</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.linq4j.Extensions</div> |
| </div> |
| <section class="description"> |
| <hr> |
| <pre>public abstract class <span class="typeNameLabel">Extensions</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">Contains what, in LINQ.NET, would be extension methods. |
| |
| <h2>Notes on mapping from LINQ.NET to Java</h2> |
| |
| <p>We have preserved most of the API. But we've changed a few things, so that |
| the API is more typical Java API:</p> |
| |
| <ul> |
| |
| <li>Java method names start with a lower-case letter.</li> |
| |
| <li>A few methods became keywords when their first letter was converted |
| to lower case; hence |
| <a href="tree/Expressions.html#break_(org.apache.calcite.linq4j.tree.LabelTarget)"><code>Expressions.break_(org.apache.calcite.linq4j.tree.LabelTarget)</code></a></li> |
| |
| <li>We created a Java interface <a href="Enumerable.html" title="interface in org.apache.calcite.linq4j"><code>Enumerable</code></a>, similar to LINQ.NET's |
| IEnumerable. IEnumerable is built into C#, and that gives it |
| advantages: the standard collections implement it, and you can use |
| any IEnumerable in a foreach loop. We made the Java |
| <code>Enumerable</code> extend <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Iterable</code></a>, |
| so that it can be used in for-each loops. But the standard |
| collections still don't implement it. A few methods that take an |
| IEnumerable in LINQ.NET take an Iterable in LINQ4J.</li> |
| |
| <li>LINQ.NET's Dictionary interface maps to Map in Java; |
| hence, the LINQ.NET <code>ToDictionary</code> methods become |
| <code>toMap</code>.</li> |
| |
| <li>LINQ.NET's decimal type changes to BigDecimal. (A little bit unnatural, |
| since decimal is primitive and BigDecimal is not.)</li> |
| |
| <li>There is no Nullable in Java. Therefore we distinguish between methods |
| that return, say, Long (which may be null) and long. See for example |
| <a href="function/NullableLongFunction1.html" title="interface in org.apache.calcite.linq4j.function"><code>NullableLongFunction1</code></a> and |
| <a href="function/LongFunction1.html" title="interface in org.apache.calcite.linq4j.function"><code>LongFunction1</code></a>, and the |
| variants of <a href="ExtendedEnumerable.html#sum(org.apache.calcite.linq4j.function.BigDecimalFunction1)"><code>ExtendedEnumerable.sum(org.apache.calcite.linq4j.function.BigDecimalFunction1<TSource>)</code></a> that call them. |
| |
| <li>Java erases type parameters from argument types before resolving |
| overloading. Therefore similar methods have the same erasure. Methods |
| <code>averageDouble</code>, |
| <code>averageInteger</code>, |
| <code>groupByK</code>, |
| <code>selectN</code>, |
| <code>selectManyN</code>, |
| <code>skipWhileN</code>, |
| <code>sumBigDecimal</code>, |
| <code>sumNullableBigDecimal</code>, |
| <code>whereN</code> |
| have been renamed from <code>average</code>, <code>groupBy</code>, <code>max</code>, |
| <code>min</code>, <code>select</code>, <code>selectMany</code>, <code>skipWhile</code> and |
| <code>where</code> to prevent ambiguity.</li> |
| |
| <li>.NET allows <i>extension methods</i> — static methods that then |
| become, via compiler magic, a method of any object whose type is the |
| same as the first parameter of the extension method. In LINQ.NET, the |
| <code>IQueryable</code> and <code>IEnumerable</code> interfaces have many such methods. |
| In Java, those methods need to be explicitly added to the interface, and will |
| need to be implemented by every class that implements that interface. |
| We can help by implementing the methods as static methods, and by |
| providing an abstract base class that implements the extension methods |
| in the interface. Hence <a href="AbstractEnumerable.html" title="class in org.apache.calcite.linq4j"><code>AbstractEnumerable</code></a> and |
| <a href="AbstractQueryable.html" title="class in org.apache.calcite.linq4j"><code>AbstractQueryable</code></a> call methods in <a href="Extensions.html" title="class in org.apache.calcite.linq4j"><code>Extensions</code></a>.</li> |
| |
| <li>.NET Func becomes <a href="function/Function0.html" title="interface in org.apache.calcite.linq4j.function"><code>Function0</code></a>, |
| <a href="function/Function1.html" title="interface in org.apache.calcite.linq4j.function"><code>Function1</code></a>, |
| <a href="function/Function2.html" title="interface in org.apache.calcite.linq4j.function"><code>Function2</code></a>, depending |
| on the number of arguments to the function, because Java types cannot be |
| overloaded based on the number of type parameters.</li> |
| |
| <li>Types map as follows: |
| <code>Int32</code> → <code>int</code> or <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Integer</code></a>, |
| <code>Int64</code> → <code>long</code> or <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Long</code></a>, |
| <code>bool</code> → <code>boolean</code> or <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Boolean</code></a>, |
| <code>Dictionary</code> → <a href="https://docs.oracle.com/javase/9/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Map</code></a>, |
| <code>Lookup</code> → <a href="https://docs.oracle.com/javase/9/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Map</code></a> whose value type is an <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Iterable</code></a>, |
| </li> |
| |
| <li>Function types that accept primitive types in LINQ.NET have become |
| boxed types in LINQ4J. For example, a predicate function |
| <code>Func&lt;T, bool&gt;</code> becomes <code>Func1&lt;T, Boolean&gt;</code>. |
| It would be wrong to infer that the function is allowed to return null.</li> |
| |
| </ul></div> |
| </section> |
| <section class="summary"> |
| <ul class="blockList"> |
| <!-- ========== 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="t4" class="tableTab" onclick="show(8);">Concrete 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>static <T> <a href="Queryable.html" title="interface in org.apache.calcite.linq4j">Queryable</a><T></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#asQueryable(org.apache.calcite.linq4j.DefaultEnumerable)">asQueryable</a></span>​(<a href="DefaultEnumerable.html" title="class in org.apache.calcite.linq4j">DefaultEnumerable</a><T> source)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i1"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang" class="externalLink">RuntimeException</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#todo()">todo</a></span>()</code></th> |
| <td class="colLast"> </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#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</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#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</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#toString()" title="class or interface in java.lang" class="externalLink">toString</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"> |
| <!-- ============ 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="todo()">todo</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang" class="externalLink">RuntimeException</a></span> <span class="memberName">todo</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="asQueryable(org.apache.calcite.linq4j.DefaultEnumerable)">asQueryable</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="typeParameters"><T></span> <span class="returnType"><a href="Queryable.html" title="interface in org.apache.calcite.linq4j">Queryable</a><T></span> <span class="memberName">asQueryable</span>​(<span class="arguments"><a href="DefaultEnumerable.html" title="class in org.apache.calcite.linq4j">DefaultEnumerable</a><T> source)</span></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>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> |
| </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> |