| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>org.apache.calcite.linq4j.function (Apache Calcite API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <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.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="package-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><b>Apache Calcite</b></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li class="nav-bar-cell1-rev">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#package">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Package: </li> |
| <li><a href="#package-description">Description</a> | </li> |
| <li><a href="#related-package-summary">Related Packages</a> | </li> |
| <li><a href="#class-summary">Classes and Interfaces</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <div class="header"> |
| <h1 title="Package org.apache.calcite.linq4j.function" class="title">Package org.apache.calcite.linq4j.function</h1> |
| </div> |
| <hr> |
| <div class="package-signature">package <span class="element-name">org.apache.calcite.linq4j.function</span></div> |
| <section class="package-description" id="package-description"> |
| <div class="block">Contains definitions of functions and predicates.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <li> |
| <div id="related-package-summary"> |
| <div class="caption"><span>Related Packages</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Package</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><a href="../package-summary.html">org.apache.calcite.linq4j</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Language-integrated query for Java (linq4j) main package.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="../tree/package-summary.html">org.apache.calcite.linq4j.tree</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Object model for Java expressions.</div> |
| </div> |
| </div> |
| </div> |
| </li> |
| <li> |
| <div id="class-summary"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab7" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab7', 2)" class="table-tab">Annotation Types</button></div> |
| <div id="class-summary.tabpanel" role="tabpanel"> |
| <div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0"> |
| <div class="table-header col-first">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="BigDecimalFunction1.html" title="interface in org.apache.calcite.linq4j.function">BigDecimalFunction1</a><T0></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Function that takes one parameter and returns a <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/math/BigDecimal.html" title="class or interface in java.math" class="external-link"><code>BigDecimal</code></a> value.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab7"><a href="Deterministic.html" title="annotation in org.apache.calcite.linq4j.function">Deterministic</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab7"> |
| <div class="block">Specifies that function is deterministic (i.e.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="DoubleFunction1.html" title="interface in org.apache.calcite.linq4j.function">DoubleFunction1</a><T0></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Function that takes one parameter and returns a native <code>double</code> value.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="EqualityComparer.html" title="interface in org.apache.calcite.linq4j.function">EqualityComparer</a><T></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Compares values for equality.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab7"><a href="Experimental.html" title="annotation in org.apache.calcite.linq4j.function">Experimental</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab7"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="FloatFunction1.html" title="interface in org.apache.calcite.linq4j.function">FloatFunction1</a><T0></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Function that takes one parameter and returns a native <code>float</code> value.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="Function.html" title="interface in org.apache.calcite.linq4j.function">Function</a><R></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Base interface for all functions.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Function0.html" title="interface in org.apache.calcite.linq4j.function">Function0</a><R></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Function with no parameters.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="Function1.html" title="interface in org.apache.calcite.linq4j.function">Function1</a><T0,<wbr>R></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Function with one parameter.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Function2.html" title="interface in org.apache.calcite.linq4j.function">Function2</a><T0,<wbr>T1,<wbr>R></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Function with two parameters.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="Functions.html" title="class in org.apache.calcite.linq4j.function">Functions</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Utilities relating to functions.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab7"><a href="Hints.html" title="annotation in org.apache.calcite.linq4j.function">Hints</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab7"> |
| <div class="block">Annotation applied to a user-defined function that gives extra metadata |
| about that function.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="IntegerFunction1.html" title="interface in org.apache.calcite.linq4j.function">IntegerFunction1</a><T0></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Function that takes one parameter and returns a native <code>int</code> value.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="LongFunction1.html" title="interface in org.apache.calcite.linq4j.function">LongFunction1</a><T0></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Function that takes one parameter and returns a native <code>long</code> value.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab7"><a href="NonDeterministic.html" title="annotation in org.apache.calcite.linq4j.function">NonDeterministic</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab7"> |
| <div class="block">Specifies that function is NOT deterministic (i.e.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="NullableBigDecimalFunction1.html" title="interface in org.apache.calcite.linq4j.function">NullableBigDecimalFunction1</a><T0></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Function that takes one parameter and returns a <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/math/BigDecimal.html" title="class or interface in java.math" class="external-link"><code>BigDecimal</code></a> value that |
| may be null.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="NullableDoubleFunction1.html" title="interface in org.apache.calcite.linq4j.function">NullableDoubleFunction1</a><T0></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Function that takes one parameter and returns a <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link"><code>Double</code></a> value that |
| may be null.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="NullableFloatFunction1.html" title="interface in org.apache.calcite.linq4j.function">NullableFloatFunction1</a><T0></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Function that takes one parameter and returns a <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Float.html" title="class or interface in java.lang" class="external-link"><code>Float</code></a> value that |
| may be null.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="NullableIntegerFunction1.html" title="interface in org.apache.calcite.linq4j.function">NullableIntegerFunction1</a><T0></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Function that takes one parameter and returns an <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link"><code>Integer</code></a> value that |
| may be null.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="NullableLongFunction1.html" title="interface in org.apache.calcite.linq4j.function">NullableLongFunction1</a><T0></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Function that takes one parameter and returns a <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link"><code>Long</code></a> value that |
| may be null.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab7"><a href="Parameter.html" title="annotation in org.apache.calcite.linq4j.function">Parameter</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab7"> |
| <div class="block">Annotation that supplies metadata about a function parameter.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Predicate1.html" title="interface in org.apache.calcite.linq4j.function">Predicate1</a><T0></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Function with one parameter returning a native <code>boolean</code> value.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="Predicate2.html" title="interface in org.apache.calcite.linq4j.function">Predicate2</a><T0,<wbr>T1></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Function with two parameters returning a native <code>boolean</code> value.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab7"><a href="SemiStrict.html" title="annotation in org.apache.calcite.linq4j.function">SemiStrict</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab7"> |
| <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> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab7"><a href="Strict.html" title="annotation in org.apache.calcite.linq4j.function">Strict</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab7"> |
| <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> |
| </div> |
| </div> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </section> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
