blob: 9cc458d9d0a586c835d61572dde723b335c0d80c [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ScalarFunctionImpl (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.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.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,"i2":41,"i3":9,"i4":9,"i5":10,"i6":10,"i7":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.calcite.schema.impl</a></div>
<h1 title="Class ScalarFunctionImpl" class="title">Class ScalarFunctionImpl</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"><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="description">
<dl>
<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>
<pre>public class <span class="typeNameLabel">ScalarFunctionImpl</span>
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></pre>
<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="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li class="blockList">
<section class="nestedClassSummary"><a id="nested.class.summary">
<!-- -->
</a>
<h2>Nested Class Summary</h2>
<div class="inheritedList">
<h2>Nested classes/interfaces inherited from class&nbsp;org.apache.calcite.schema.impl.<a href="ReflectiveFunctionBase.html" title="class in org.apache.calcite.schema.impl">ReflectiveFunctionBase</a></h2>
<a id="nested.classes.inherited.from.class.org.apache.calcite.schema.impl.ReflectiveFunctionBase">
<!-- -->
</a><code><a href="ReflectiveFunctionBase.ParameterListBuilder.html" title="class in org.apache.calcite.schema.impl">ReflectiveFunctionBase.ParameterListBuilder</a></code></div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== -->
<li class="blockList">
<section class="fieldSummary"><a id="field.summary">
<!-- -->
</a>
<h2>Field Summary</h2>
<div class="inheritedList">
<h3>Fields inherited from class&nbsp;org.apache.calcite.schema.impl.<a href="ReflectiveFunctionBase.html" title="class in org.apache.calcite.schema.impl">ReflectiveFunctionBase</a></h3>
<a id="fields.inherited.from.class.org.apache.calcite.schema.impl.ReflectiveFunctionBase">
<!-- -->
</a><code><a href="ReflectiveFunctionBase.html#method">method</a>, <a href="ReflectiveFunctionBase.html#parameters">parameters</a></code></div>
</section>
</li>
<!-- ========== 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="t2" class="tableTab" onclick="show(2);">Instance 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><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t6" class="tableTab" onclick="show(32);">Deprecated 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 @Nullable <a href="../ScalarFunction.html" title="interface in org.apache.calcite.schema">ScalarFunction</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create(java.lang.Class,java.lang.String)">create</a></span>&#8203;(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;?&gt;&nbsp;clazz,
<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;methodName)</code></th>
<td class="colLast">
<div class="block">Creates <a href="../ScalarFunction.html" title="interface in org.apache.calcite.schema"><code>ScalarFunction</code></a> from given class.</div>
</td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code>static <a href="../ScalarFunction.html" title="interface in org.apache.calcite.schema">ScalarFunction</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create(java.lang.reflect.Method)">create</a></span>&#8203;(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/reflect/Method.html?is-external=true" title="class or interface in java.lang.reflect" class="externalLink">Method</a>&nbsp;method)</code></th>
<td class="colLast">
<div class="block">Creates <a href="../ScalarFunction.html" title="interface in org.apache.calcite.schema"><code>ScalarFunction</code></a> from given method.</div>
</td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code>static com.google.common.collect.ImmutableMultimap&lt;<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="../ScalarFunction.html" title="interface in org.apache.calcite.schema">ScalarFunction</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createAll(java.lang.Class)">createAll</a></span>&#8203;(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;?&gt;&nbsp;clazz)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code>static <a href="../ScalarFunction.html" title="interface in org.apache.calcite.schema">ScalarFunction</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createUnsafe(java.lang.reflect.Method)">createUnsafe</a></span>&#8203;(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/reflect/Method.html?is-external=true" title="class or interface in java.lang.reflect" class="externalLink">Method</a>&nbsp;method)</code></th>
<td class="colLast">
<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>
</td>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><code>static com.google.common.collect.ImmutableMultimap&lt;<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="../Function.html" title="interface in org.apache.calcite.schema">Function</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#functions(java.lang.Class)">functions</a></span>&#8203;(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;?&gt;&nbsp;clazz)</code></th>
<td class="colLast">
<div class="block">Returns a map of all functions based on the methods in a given class.</div>
</td>
</tr>
<tr class="rowColor" id="i5">
<td class="colFirst"><code><a href="../../adapter/enumerable/CallImplementor.html" title="interface in org.apache.calcite.adapter.enumerable">CallImplementor</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getImplementor()">getImplementor</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns implementor that translates the function to linq4j expression.</div>
</td>
</tr>
<tr class="altColor" id="i6">
<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="#getReturnType(org.apache.calcite.rel.type.RelDataTypeFactory)">getReturnType</a></span>&#8203;(<a href="../../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a>&nbsp;typeFactory)</code></th>
<td class="colLast">
<div class="block">Returns the return type of this function, constructed using the given
type factory.</div>
</td>
</tr>
<tr class="rowColor" id="i7">
<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="#getReturnType(org.apache.calcite.rel.type.RelDataTypeFactory,org.apache.calcite.sql.SqlOperatorBinding)">getReturnType</a></span>&#8203;(<a href="../../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a>&nbsp;typeFactory,
<a href="../../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a>&nbsp;opBinding)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="inheritedList">
<h3>Methods inherited from class&nbsp;org.apache.calcite.schema.impl.<a href="ReflectiveFunctionBase.html" title="class in org.apache.calcite.schema.impl">ReflectiveFunctionBase</a></h3>
<a id="methods.inherited.from.class.org.apache.calcite.schema.impl.ReflectiveFunctionBase">
<!-- -->
</a><code><a href="ReflectiveFunctionBase.html#builder()">builder</a>, <a href="ReflectiveFunctionBase.html#getParameters()">getParameters</a></code></div>
<div class="inheritedList">
<h3>Methods inherited from class&nbsp;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>
<div class="inheritedList">
<h3>Methods inherited from interface&nbsp;org.apache.calcite.schema.<a href="../Function.html" title="interface in org.apache.calcite.schema">Function</a></h3>
<a id="methods.inherited.from.class.org.apache.calcite.schema.Function">
<!-- -->
</a><code><a href="../Function.html#getParameters()">getParameters</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="createAll(java.lang.Class)">createAll</a></h3>
<div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a>
</span><span class="modifiers">public static</span>&nbsp;<span class="returnType">com.google.common.collect.ImmutableMultimap&lt;<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="../ScalarFunction.html" title="interface in org.apache.calcite.schema">ScalarFunction</a>&gt;</span>&nbsp;<span class="memberName">createAll</span>&#8203;(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;?&gt;&nbsp;clazz)</span></div>
<div class="deprecationBlock"><span class="deprecatedLabel">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 class="blockList">
<section class="detail">
<h3><a id="functions(java.lang.Class)">functions</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType">com.google.common.collect.ImmutableMultimap&lt;<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="../Function.html" title="interface in org.apache.calcite.schema">Function</a>&gt;</span>&nbsp;<span class="memberName">functions</span>&#8203;(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;?&gt;&nbsp;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 class="blockList">
<section class="detail">
<h3><a id="create(java.lang.Class,java.lang.String)">create</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType">@Nullable <a href="../ScalarFunction.html" title="interface in org.apache.calcite.schema">ScalarFunction</a></span>&nbsp;<span class="memberName">create</span>&#8203;(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;?&gt;&nbsp;clazz,
<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;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>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clazz</code> - class that is used to implement the function</dd>
<dd><code>methodName</code> - Method name (typically "eval")</dd>
<dt><span class="returnLabel">Returns:</span></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 class="blockList">
<section class="detail">
<h3><a id="create(java.lang.reflect.Method)">create</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType"><a href="../ScalarFunction.html" title="interface in org.apache.calcite.schema">ScalarFunction</a></span>&nbsp;<span class="memberName">create</span>&#8203;(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/reflect/Method.html?is-external=true" title="class or interface in java.lang.reflect" class="externalLink">Method</a>&nbsp;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>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>method</code> - method that is used to implement the function</dd>
<dt><span class="returnLabel">Returns:</span></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 class="blockList">
<section class="detail">
<h3><a id="createUnsafe(java.lang.reflect.Method)">createUnsafe</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType"><a href="../ScalarFunction.html" title="interface in org.apache.calcite.schema">ScalarFunction</a></span>&nbsp;<span class="memberName">createUnsafe</span>&#8203;(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/reflect/Method.html?is-external=true" title="class or interface in java.lang.reflect" class="externalLink">Method</a>&nbsp;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>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>method</code> - method that is used to implement the function</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getReturnType(org.apache.calcite.rel.type.RelDataTypeFactory)">getReturnType</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span>&nbsp;<span class="memberName">getReturnType</span>&#8203;(<span class="arguments"><a href="../../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a>&nbsp;typeFactory)</span></div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../ScalarFunction.html#getReturnType(org.apache.calcite.rel.type.RelDataTypeFactory)">getReturnType</a></code>&nbsp;in interface&nbsp;<code><a href="../ScalarFunction.html" title="interface in org.apache.calcite.schema">ScalarFunction</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>typeFactory</code> - Type factory</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getImplementor()">getImplementor</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="../../adapter/enumerable/CallImplementor.html" title="interface in org.apache.calcite.adapter.enumerable">CallImplementor</a></span>&nbsp;<span class="memberName">getImplementor</span>()</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../ImplementableFunction.html#getImplementor()">getImplementor</a></code>&nbsp;in interface&nbsp;<code><a href="../ImplementableFunction.html" title="interface in org.apache.calcite.schema">ImplementableFunction</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>implementor that translates the function to linq4j expression.</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getReturnType(org.apache.calcite.rel.type.RelDataTypeFactory,org.apache.calcite.sql.SqlOperatorBinding)">getReturnType</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></span>&nbsp;<span class="memberName">getReturnType</span>&#8203;(<span class="arguments"><a href="../../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a>&nbsp;typeFactory,
<a href="../../sql/SqlOperatorBinding.html" title="class in org.apache.calcite.sql">SqlOperatorBinding</a>&nbsp;opBinding)</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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &copy; 2012-2021 Apache Software Foundation. All Rights Reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>