| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ScalarFunctionImpl (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.schema.impl, class: ScalarFunctionImpl"> |
| <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.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="class-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><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</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"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.calcite.schema.impl</a></div> |
| <h1 title="Class ScalarFunctionImpl" class="title">Class ScalarFunctionImpl</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="ReflectiveFunctionBase.html" title="class in org.apache.calcite.schema.impl">org.apache.calcite.schema.impl.ReflectiveFunctionBase</a> |
| <div class="inheritance">org.apache.calcite.schema.impl.ScalarFunctionImpl</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../Function.html" title="interface in org.apache.calcite.schema">Function</a></code>, <code><a href="../ImplementableFunction.html" title="interface in org.apache.calcite.schema">ImplementableFunction</a></code>, <code><a href="../ScalarFunction.html" title="interface in org.apache.calcite.schema">ScalarFunction</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ScalarFunctionImpl</span> |
| <span class="extends-implements">extends <a href="ReflectiveFunctionBase.html" title="class in org.apache.calcite.schema.impl">ReflectiveFunctionBase</a> |
| implements <a href="../ScalarFunction.html" title="interface in org.apache.calcite.schema">ScalarFunction</a>, <a href="../ImplementableFunction.html" title="interface in org.apache.calcite.schema">ImplementableFunction</a></span></div> |
| <div class="block">Implementation of <a href="../ScalarFunction.html" title="interface in org.apache.calcite.schema"><code>ScalarFunction</code></a>.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.calcite.schema.impl.ReflectiveFunctionBase">Nested classes/interfaces inherited from class org.apache.calcite.schema.impl.<a href="ReflectiveFunctionBase.html" title="class in org.apache.calcite.schema.impl">ReflectiveFunctionBase</a></h2> |
| <code><a href="ReflectiveFunctionBase.ParameterListBuilder.html" title="class in org.apache.calcite.schema.impl">ReflectiveFunctionBase.ParameterListBuilder</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.calcite.schema.impl.ReflectiveFunctionBase">Fields inherited from class org.apache.calcite.schema.impl.<a href="ReflectiveFunctionBase.html" title="class in org.apache.calcite.schema.impl">ReflectiveFunctionBase</a></h3> |
| <code><a href="ReflectiveFunctionBase.html#method">method</a>, <a href="ReflectiveFunctionBase.html#parameters">parameters</a></code></div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static @Nullable <a href="../ScalarFunction.html" title="interface in org.apache.calcite.schema">ScalarFunction</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#create(java.lang.Class,java.lang.String)" class="member-name-link">create</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> clazz, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> methodName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates <a href="../ScalarFunction.html" title="interface in org.apache.calcite.schema"><code>ScalarFunction</code></a> from given class.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../ScalarFunction.html" title="interface in org.apache.calcite.schema">ScalarFunction</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#create(java.lang.reflect.Method)" class="member-name-link">create</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Method.html" title="class or interface in java.lang.reflect" class="external-link">Method</a> method)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates <a href="../ScalarFunction.html" title="interface in org.apache.calcite.schema"><code>ScalarFunction</code></a> from given method.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static com.google.common.collect.ImmutableMultimap<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="../ScalarFunction.html" title="interface in org.apache.calcite.schema">ScalarFunction</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#createAll(java.lang.Class)" class="member-name-link">createAll</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> clazz)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../ScalarFunction.html" title="interface in org.apache.calcite.schema">ScalarFunction</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createUnsafe(java.lang.reflect.Method)" class="member-name-link">createUnsafe</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Method.html" title="class or interface in java.lang.reflect" class="external-link">Method</a> method)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates unsafe version of <a href="../ScalarFunction.html" title="interface in org.apache.calcite.schema"><code>ScalarFunction</code></a> from any method.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static com.google.common.collect.ImmutableMultimap<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="../Function.html" title="interface in org.apache.calcite.schema">Function</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#functions(java.lang.Class)" class="member-name-link">functions</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> clazz)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns a map of all functions based on the methods in a given class.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../adapter/enumerable/CallImplementor.html" title="interface in org.apache.calcite.adapter.enumerable">CallImplementor</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getImplementor()" class="member-name-link">getImplementor</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns implementor that translates the function to linq4j expression.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getReturnType(org.apache.calcite.rel.type.RelDataTypeFactory)" class="member-name-link">getReturnType</a><wbr>(<a href="../../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a> typeFactory)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the return type of this function, constructed using the given |
| type factory.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getReturnType(org.apache.calcite.rel.type.RelDataTypeFactory,org.apache.calcite.sql.SqlOperatorBinding)" class="member-name-link">getReturnType</a><wbr>(<a href="../../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a> typeFactory, |
| <a href="../../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a> opBinding)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.schema.impl.ReflectiveFunctionBase">Methods inherited from class org.apache.calcite.schema.impl.<a href="ReflectiveFunctionBase.html" title="class in org.apache.calcite.schema.impl">ReflectiveFunctionBase</a></h3> |
| <code><a href="ReflectiveFunctionBase.html#builder()">builder</a>, <a href="ReflectiveFunctionBase.html#getParameters()">getParameters</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.calcite.schema.Function">Methods inherited from interface org.apache.calcite.schema.<a href="../Function.html" title="interface in org.apache.calcite.schema">Function</a></h3> |
| <code><a href="../Function.html#getParameters()">getParameters</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="createAll(java.lang.Class)"> |
| <h3>createAll</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public static</span> <span class="return-type">com.google.common.collect.ImmutableMultimap<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="../ScalarFunction.html" title="interface in org.apache.calcite.schema">ScalarFunction</a>></span> <span class="element-name">createAll</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> clazz)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block">Creates <a href="../ScalarFunction.html" title="interface in org.apache.calcite.schema"><code>ScalarFunction</code></a> for each method in |
| a given class.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="functions(java.lang.Class)"> |
| <h3>functions</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">com.google.common.collect.ImmutableMultimap<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="../Function.html" title="interface in org.apache.calcite.schema">Function</a>></span> <span class="element-name">functions</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> clazz)</span></div> |
| <div class="block">Returns a map of all functions based on the methods in a given class. |
| It is keyed by method names and maps to both |
| <a href="../ScalarFunction.html" title="interface in org.apache.calcite.schema"><code>ScalarFunction</code></a> |
| and <a href="../TableFunction.html" title="interface in org.apache.calcite.schema"><code>TableFunction</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="create(java.lang.Class,java.lang.String)"> |
| <h3>create</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">@Nullable <a href="../ScalarFunction.html" title="interface in org.apache.calcite.schema">ScalarFunction</a></span> <span class="element-name">create</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> clazz, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> methodName)</span></div> |
| <div class="block">Creates <a href="../ScalarFunction.html" title="interface in org.apache.calcite.schema"><code>ScalarFunction</code></a> from given class. |
| |
| <p>If a method of the given name is not found or it does not suit, |
| returns <code>null</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>clazz</code> - class that is used to implement the function</dd> |
| <dd><code>methodName</code> - Method name (typically "eval")</dd> |
| <dt>Returns:</dt> |
| <dd>created <a href="../ScalarFunction.html" title="interface in org.apache.calcite.schema"><code>ScalarFunction</code></a> or null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="create(java.lang.reflect.Method)"> |
| <h3>create</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../ScalarFunction.html" title="interface in org.apache.calcite.schema">ScalarFunction</a></span> <span class="element-name">create</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Method.html" title="class or interface in java.lang.reflect" class="external-link">Method</a> method)</span></div> |
| <div class="block">Creates <a href="../ScalarFunction.html" title="interface in org.apache.calcite.schema"><code>ScalarFunction</code></a> from given method. |
| When <code>eval</code> method does not suit, <code>null</code> is returned.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>method</code> - method that is used to implement the function</dd> |
| <dt>Returns:</dt> |
| <dd>created <a href="../ScalarFunction.html" title="interface in org.apache.calcite.schema"><code>ScalarFunction</code></a> or null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createUnsafe(java.lang.reflect.Method)"> |
| <h3>createUnsafe</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../ScalarFunction.html" title="interface in org.apache.calcite.schema">ScalarFunction</a></span> <span class="element-name">createUnsafe</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Method.html" title="class or interface in java.lang.reflect" class="external-link">Method</a> method)</span></div> |
| <div class="block">Creates unsafe version of <a href="../ScalarFunction.html" title="interface in org.apache.calcite.schema"><code>ScalarFunction</code></a> from any method. The method |
| does not need to be static or belong to a class with default constructor. It is |
| the responsibility of the underlying engine to initialize the UDF object that |
| contain the method.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>method</code> - method that is used to implement the function</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getReturnType(org.apache.calcite.rel.type.RelDataTypeFactory)"> |
| <h3>getReturnType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="element-name">getReturnType</span><wbr><span class="parameters">(<a href="../../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a> typeFactory)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../ScalarFunction.html#getReturnType(org.apache.calcite.rel.type.RelDataTypeFactory)">ScalarFunction</a></code></span></div> |
| <div class="block">Returns the return type of this function, constructed using the given |
| type factory.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../ScalarFunction.html#getReturnType(org.apache.calcite.rel.type.RelDataTypeFactory)">getReturnType</a></code> in interface <code><a href="../ScalarFunction.html" title="interface in org.apache.calcite.schema">ScalarFunction</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>typeFactory</code> - Type factory</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getImplementor()"> |
| <h3>getImplementor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../adapter/enumerable/CallImplementor.html" title="interface in org.apache.calcite.adapter.enumerable">CallImplementor</a></span> <span class="element-name">getImplementor</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../ImplementableFunction.html#getImplementor()">ImplementableFunction</a></code></span></div> |
| <div class="block">Returns implementor that translates the function to linq4j expression.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../ImplementableFunction.html#getImplementor()">getImplementor</a></code> in interface <code><a href="../ImplementableFunction.html" title="interface in org.apache.calcite.schema">ImplementableFunction</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>implementor that translates the function to linq4j expression.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getReturnType(org.apache.calcite.rel.type.RelDataTypeFactory,org.apache.calcite.sql.SqlOperatorBinding)"> |
| <h3>getReturnType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span> <span class="element-name">getReturnType</span><wbr><span class="parameters">(<a href="../../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a> typeFactory, |
| <a href="../../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a> opBinding)</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </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> |