blob: f03740a292436784756002440d941c397d2cd7ef [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ZetaSqlScalarFunctionImpl (Apache Beam 2.38.0-SNAPSHOT)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ZetaSqlScalarFunctionImpl (Apache Beam 2.38.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../../overview-summary.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>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/zetasql/translation/UserFunctionDefinitions.JavaScalarFunction.html" title="class in org.apache.beam.sdk.extensions.sql.zetasql.translation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/beam/sdk/extensions/sql/zetasql/translation/ZetaSqlScalarFunctionImpl.html" target="_top">Frames</a></li>
<li><a href="ZetaSqlScalarFunctionImpl.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.classes.inherited.from.class.org.apache.beam.sdk.extensions.sql.impl.UdfImplReflectiveFunctionBase">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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.beam.sdk.extensions.sql.zetasql.translation</div>
<h2 title="Class ZetaSqlScalarFunctionImpl" class="title">Class ZetaSqlScalarFunctionImpl</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/UdfImplReflectiveFunctionBase.html" title="class in org.apache.beam.sdk.extensions.sql.impl">org.apache.beam.sdk.extensions.sql.impl.UdfImplReflectiveFunctionBase</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/ScalarFunctionImpl.html" title="class in org.apache.beam.sdk.extensions.sql.impl">org.apache.beam.sdk.extensions.sql.impl.ScalarFunctionImpl</a></li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.extensions.sql.zetasql.translation.ZetaSqlScalarFunctionImpl</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>org.apache.beam.vendor.calcite.v1_28_0.org.apache.calcite.schema.Function, org.apache.beam.vendor.calcite.v1_28_0.org.apache.calcite.schema.ImplementableFunction, org.apache.beam.vendor.calcite.v1_28_0.org.apache.calcite.schema.ScalarFunction</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">ZetaSqlScalarFunctionImpl</span>
extends <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/ScalarFunctionImpl.html" title="class in org.apache.beam.sdk.extensions.sql.impl">ScalarFunctionImpl</a></pre>
<div class="block">ZetaSQL-specific extension to <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/ScalarFunctionImpl.html" title="class in org.apache.beam.sdk.extensions.sql.impl"><code>ScalarFunctionImpl</code></a>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.beam.sdk.extensions.sql.impl.UdfImplReflectiveFunctionBase">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.apache.beam.sdk.extensions.sql.impl.<a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/UdfImplReflectiveFunctionBase.html" title="class in org.apache.beam.sdk.extensions.sql.impl">UdfImplReflectiveFunctionBase</a></h3>
<code><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/UdfImplReflectiveFunctionBase.ParameterListBuilder.html" title="class in org.apache.beam.sdk.extensions.sql.impl">UdfImplReflectiveFunctionBase.ParameterListBuilder</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/zetasql/translation/ZetaSqlScalarFunctionImpl.html#functionGroup">functionGroup</a></span></code>
<div class="block">ZetaSQL function group identifier.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.beam.sdk.extensions.sql.impl.UdfImplReflectiveFunctionBase">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.beam.sdk.extensions.sql.impl.<a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/UdfImplReflectiveFunctionBase.html" title="class in org.apache.beam.sdk.extensions.sql.impl">UdfImplReflectiveFunctionBase</a></h3>
<code><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/UdfImplReflectiveFunctionBase.html#method">method</a>, <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/UdfImplReflectiveFunctionBase.html#parameters">parameters</a></code></li>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static org.apache.beam.vendor.calcite.v1_28_0.org.apache.calcite.schema.Function</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/zetasql/translation/ZetaSqlScalarFunctionImpl.html#create-java.lang.Class-java.lang.String-java.lang.String-java.lang.String-">create</a></span>(java.lang.Class&lt;?&gt;&nbsp;clazz,
java.lang.String&nbsp;methodName,
java.lang.String&nbsp;functionGroup,
java.lang.String&nbsp;jarPath)</code>
<div class="block">Creates <code>Function</code> from
given class.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static org.apache.beam.vendor.calcite.v1_28_0.org.apache.calcite.schema.Function</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/zetasql/translation/ZetaSqlScalarFunctionImpl.html#create-java.lang.reflect.Method-java.lang.String-java.lang.String-">create</a></span>(java.lang.reflect.Method&nbsp;method,
java.lang.String&nbsp;functionGroup,
java.lang.String&nbsp;jarPath)</code>
<div class="block">Creates <code>Function</code> from
given method.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.extensions.sql.impl.ScalarFunctionImpl">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.beam.sdk.extensions.sql.impl.<a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/ScalarFunctionImpl.html" title="class in org.apache.beam.sdk.extensions.sql.impl">ScalarFunctionImpl</a></h3>
<code><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/ScalarFunctionImpl.html#create-java.lang.reflect.Method-">create</a>, <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/ScalarFunctionImpl.html#create-java.lang.reflect.Method-java.lang.String-">create</a>, <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/ScalarFunctionImpl.html#createAll-java.lang.Class-">createAll</a>, <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/ScalarFunctionImpl.html#createImplementor-java.lang.reflect.Method-">createImplementor</a>, <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/ScalarFunctionImpl.html#getImplementor--">getImplementor</a>, <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/ScalarFunctionImpl.html#getJarPath--">getJarPath</a>, <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/ScalarFunctionImpl.html#getReturnType-org.apache.beam.vendor.calcite.v1_28_0.org.apache.calcite.rel.type.RelDataTypeFactory-">getReturnType</a>, <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/ScalarFunctionImpl.html#getReturnType-org.apache.beam.vendor.calcite.v1_28_0.org.apache.calcite.rel.type.RelDataTypeFactory-org.apache.beam.vendor.calcite.v1_28_0.org.apache.calcite.sql.SqlOperatorBinding-">getReturnType</a>, <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/ScalarFunctionImpl.html#validateMethod-java.lang.reflect.Method-">validateMethod</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.extensions.sql.impl.UdfImplReflectiveFunctionBase">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.beam.sdk.extensions.sql.impl.<a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/UdfImplReflectiveFunctionBase.html" title="class in org.apache.beam.sdk.extensions.sql.impl">UdfImplReflectiveFunctionBase</a></h3>
<code><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/UdfImplReflectiveFunctionBase.html#builder--">builder</a>, <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/UdfImplReflectiveFunctionBase.html#getParameters--">getParameters</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.vendor.calcite.v1_28_0.org.apache.calcite.schema.Function">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.beam.vendor.calcite.v1_28_0.org.apache.calcite.schema.Function</h3>
<code>getParameters</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="functionGroup">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>functionGroup</h4>
<pre>public final&nbsp;java.lang.String functionGroup</pre>
<div class="block">ZetaSQL function group identifier. Different function groups may have divergent translation
paths.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="create-java.lang.Class-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre>public static&nbsp;org.apache.beam.vendor.calcite.v1_28_0.org.apache.calcite.schema.Function&nbsp;create(java.lang.Class&lt;?&gt;&nbsp;clazz,
java.lang.String&nbsp;methodName,
java.lang.String&nbsp;functionGroup,
java.lang.String&nbsp;jarPath)</pre>
<div class="block">Creates <code>Function</code> 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>
<dd><code>functionGroup</code> - ZetaSQL function group identifier. Different function groups may have
divergent translation paths.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>created <code>ScalarFunction</code> or null</dd>
</dl>
</li>
</ul>
<a name="create-java.lang.reflect.Method-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>create</h4>
<pre>public static&nbsp;org.apache.beam.vendor.calcite.v1_28_0.org.apache.calcite.schema.Function&nbsp;create(java.lang.reflect.Method&nbsp;method,
java.lang.String&nbsp;functionGroup,
java.lang.String&nbsp;jarPath)</pre>
<div class="block">Creates <code>Function</code> 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>
<dd><code>functionGroup</code> - ZetaSQL function group identifier. Different function groups may have
divergent translation paths.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>created <code>Function</code> or null</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../../overview-summary.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>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/zetasql/translation/UserFunctionDefinitions.JavaScalarFunction.html" title="class in org.apache.beam.sdk.extensions.sql.zetasql.translation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../index.html?org/apache/beam/sdk/extensions/sql/zetasql/translation/ZetaSqlScalarFunctionImpl.html" target="_top">Frames</a></li>
<li><a href="ZetaSqlScalarFunctionImpl.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.classes.inherited.from.class.org.apache.beam.sdk.extensions.sql.impl.UdfImplReflectiveFunctionBase">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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>