| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>org.apache.calcite.linq4j.function (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.function"> |
| <meta name="generator" content="javadoc/PackageWriterImpl"> |
| <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="package-declaration"> |
| <script type="text/javascript">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 class="navBarCell1Rev">Package</li> |
| <li>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 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"> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.calcite.linq4j.function</h1> |
| </div> |
| <div class="contentContainer"> |
| <section class="packageDescription"><a id="package.description"> |
| <!-- --> |
| </a> |
| <div class="block">Contains definitions of functions and predicates.</div> |
| </section> |
| <section class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <div class="typeSummary"> |
| <table> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="BigDecimalFunction1.html" title="interface in org.apache.calcite.linq4j.function">BigDecimalFunction1</a><T0></th> |
| <td class="colLast"> |
| <div class="block">Function that takes one parameter and returns a <a href="https://docs.oracle.com/javase/9/docs/api/java/math/BigDecimal.html?is-external=true" title="class or interface in java.math" class="externalLink"><code>BigDecimal</code></a> value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="DoubleFunction1.html" title="interface in org.apache.calcite.linq4j.function">DoubleFunction1</a><T0></th> |
| <td class="colLast"> |
| <div class="block">Function that takes one parameter and returns a native <code>double</code> value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="EqualityComparer.html" title="interface in org.apache.calcite.linq4j.function">EqualityComparer</a><T></th> |
| <td class="colLast"> |
| <div class="block">Compares values for equality.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="FloatFunction1.html" title="interface in org.apache.calcite.linq4j.function">FloatFunction1</a><T0></th> |
| <td class="colLast"> |
| <div class="block">Function that takes one parameter and returns a native <code>float</code> value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Function.html" title="interface in org.apache.calcite.linq4j.function">Function</a><R></th> |
| <td class="colLast"> |
| <div class="block">Base interface for all functions.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Function0.html" title="interface in org.apache.calcite.linq4j.function">Function0</a><R></th> |
| <td class="colLast"> |
| <div class="block">Function with no parameters.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Function1.html" title="interface in org.apache.calcite.linq4j.function">Function1</a><T0,​R></th> |
| <td class="colLast"> |
| <div class="block">Function with one parameter.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Function2.html" title="interface in org.apache.calcite.linq4j.function">Function2</a><T0,​T1,​R></th> |
| <td class="colLast"> |
| <div class="block">Function with two parameters.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="IntegerFunction1.html" title="interface in org.apache.calcite.linq4j.function">IntegerFunction1</a><T0></th> |
| <td class="colLast"> |
| <div class="block">Function that takes one parameter and returns a native <code>int</code> value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="LongFunction1.html" title="interface in org.apache.calcite.linq4j.function">LongFunction1</a><T0></th> |
| <td class="colLast"> |
| <div class="block">Function that takes one parameter and returns a native <code>long</code> value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="NullableBigDecimalFunction1.html" title="interface in org.apache.calcite.linq4j.function">NullableBigDecimalFunction1</a><T0></th> |
| <td class="colLast"> |
| <div class="block">Function that takes one parameter and returns a <a href="https://docs.oracle.com/javase/9/docs/api/java/math/BigDecimal.html?is-external=true" title="class or interface in java.math" class="externalLink"><code>BigDecimal</code></a> value that |
| may be null.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="NullableDoubleFunction1.html" title="interface in org.apache.calcite.linq4j.function">NullableDoubleFunction1</a><T0></th> |
| <td class="colLast"> |
| <div class="block">Function that takes one parameter and returns a <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Double</code></a> value that |
| may be null.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="NullableFloatFunction1.html" title="interface in org.apache.calcite.linq4j.function">NullableFloatFunction1</a><T0></th> |
| <td class="colLast"> |
| <div class="block">Function that takes one parameter and returns a <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Float</code></a> value that |
| may be null.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="NullableIntegerFunction1.html" title="interface in org.apache.calcite.linq4j.function">NullableIntegerFunction1</a><T0></th> |
| <td class="colLast"> |
| <div class="block">Function that takes one parameter and returns an <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> value that |
| may be null.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="NullableLongFunction1.html" title="interface in org.apache.calcite.linq4j.function">NullableLongFunction1</a><T0></th> |
| <td class="colLast"> |
| <div class="block">Function that takes one parameter and returns a <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> value that |
| may be null.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Predicate1.html" title="interface in org.apache.calcite.linq4j.function">Predicate1</a><T0></th> |
| <td class="colLast"> |
| <div class="block">Function with one parameter returning a native <code>boolean</code> value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Predicate2.html" title="interface in org.apache.calcite.linq4j.function">Predicate2</a><T0,​T1></th> |
| <td class="colLast"> |
| <div class="block">Function with two parameters returning a native <code>boolean</code> value.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </li> |
| <li class="blockList"> |
| <div class="typeSummary"> |
| <table> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Functions.html" title="class in org.apache.calcite.linq4j.function">Functions</a></th> |
| <td class="colLast"> |
| <div class="block">Utilities relating to functions.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </li> |
| <li class="blockList"> |
| <div class="typeSummary"> |
| <table> |
| <caption><span>Annotation Types Summary</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Annotation Type</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Deterministic.html" title="annotation in org.apache.calcite.linq4j.function">Deterministic</a></th> |
| <td class="colLast"> |
| <div class="block">Specifies that function is deterministic (i.e.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Experimental.html" title="annotation in org.apache.calcite.linq4j.function">Experimental</a></th> |
| <td class="colLast"> |
| <div class="block">Annotation that indicates that a class, interface, field or method |
| is experimental, not part of the public API, and subject to change |
| or removal.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Hints.html" title="annotation in org.apache.calcite.linq4j.function">Hints</a></th> |
| <td class="colLast"> |
| <div class="block">Annotation applied to a user-defined function that gives extra metadata |
| about that function.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="NonDeterministic.html" title="annotation in org.apache.calcite.linq4j.function">NonDeterministic</a></th> |
| <td class="colLast"> |
| <div class="block">Specifies that function is NOT deterministic (i.e.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Parameter.html" title="annotation in org.apache.calcite.linq4j.function">Parameter</a></th> |
| <td class="colLast"> |
| <div class="block">Annotation that supplies metadata about a function parameter.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SemiStrict.html" title="annotation in org.apache.calcite.linq4j.function">SemiStrict</a></th> |
| <td class="colLast"> |
| <div class="block">Annotation applied to a user-defined function that indicates that |
| the function always returns null if one or more of its arguments |
| are null but also may return null at other times.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Strict.html" title="annotation in org.apache.calcite.linq4j.function">Strict</a></th> |
| <td class="colLast"> |
| <div class="block">Annotation applied to a user-defined function that indicates that |
| the function returns null if and only if one or more of its arguments |
| are null.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </li> |
| </ul> |
| </section> |
| </div> |
| </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 class="navBarCell1Rev">Package</li> |
| <li>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> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2012-2021 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
