javadocAggregate/org/apache/calcite/schema/FunctionContext.html - calcite-site - Git at Google

 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
 <title>FunctionContext (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, interface: FunctionContext">
 <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":6,"i1":6,"i2":6,"i3":6};
 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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>Nested&nbsp;|&nbsp;</li>
 <li>Field&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</a></div>
 <h1 title="Interface FunctionContext" class="title">Interface FunctionContext</h1>
 </div>
 <div class="contentContainer">
 <section class="description">
 <hr>
 <pre>public interface <span class="typeNameLabel">FunctionContext</span></pre>
 <div class="block">Information about a function call that is passed to the constructor of a
  function instance.

  <p>This may enable a function to perform work up front, during construction,
  rather than each time it is invoked. Here is an example of such a function:

  <blockquote><pre>
  class RegexMatchesFunction {
    final java.util.regex.Pattern pattern;

    public RegexMatchesFunction(FunctionContext cx) {
      String pattern = cx.argumentValueAs(String.class);
      this.compiledPattern = java.util.regex.Pattern.compile(pattern);
    }

    public boolean eval(String pattern, String s) {
      return this.compiledPattern.matches(s);
    }
  }
  </pre></blockquote>

  <p>Register it in the model as follows:

  <blockquote><pre>
    functions: [
      {
        name: 'REGEX_MATCHES',
        className: 'com.example.RegexMatchesFun'
      }
    ]
  </pre></blockquote>

  <p>and use it in a query:

  <blockquote><pre>
  SELECT empno, ename
  FROM Emp
  WHERE regex_matches('J.*ES', ename);

  +-------+--------+
  | EMPNO | ENAME  |
  +-------+--------+
  | 7900  | JAMES  |
  | 7566  | JONES  |
  +-------+--------+
  </pre></blockquote>

  <p>When executing the query, Calcite will create an instance of
  <code>RegexMatchesFunction</code> and call the <code>eval</code> method on that
  instance once per row.

  <p>If the <code>eval</code> method was static, or if the function's
  constructor had zero parameters, the <code>eval</code> method would have to call
  <code>java.util.regex.Pattern.compile(pattern)</code> to compile the pattern each
  time.

  <p>This interface is marked <a href="../linq4j/function/Experimental.html" title="annotation in org.apache.calcite.linq4j.function"><code>Experimental</code></a>, which means that we may
  change or remove methods, or the entire interface, without notice. But
  probably we will add methods over time, which will just your UDFs more
  information to work with.</div>
 </section>
 <section class="summary">
 <ul class="blockList">
 <!-- ========== 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="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="t3" class="tableTab" onclick="show(4);">Abstract 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>&lt;V&gt;&nbsp;@Nullable V</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getArgumentValueAs(int,java.lang.Class)">getArgumentValueAs</a></span>&#8203;(int&nbsp;ordinal,
 <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;V&gt;&nbsp;valueClass)</code></th>
 <td class="colLast">
 <div class="block">Returns the value of an argument to this function,
  null if the argument is the NULL literal.</div>
 </td>
 </tr>
 <tr class="rowColor" id="i1">
 <td class="colFirst"><code>int</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParameterCount()">getParameterCount</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns the number of parameters.</div>
 </td>
 </tr>
 <tr class="altColor" id="i2">
 <td class="colFirst"><code><a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTypeFactory()">getTypeFactory</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns the type factory.</div>
 </td>
 </tr>
 <tr class="rowColor" id="i3">
 <td class="colFirst"><code>boolean</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isArgumentConstant(int)">isArgumentConstant</a></span>&#8203;(int&nbsp;ordinal)</code></th>
 <td class="colLast">
 <div class="block">Returns whether the value of an argument is constant.</div>
 </td>
 </tr>
 </tbody>
 </table>
 </div>
 </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="getTypeFactory()">getTypeFactory</a></h3>
 <div class="memberSignature"><span class="returnType"><a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a></span>&nbsp;<span class="memberName">getTypeFactory</span>()</div>
 <div class="block">Returns the type factory.</div>
 </section>
 </li>
 <li class="blockList">
 <section class="detail">
 <h3><a id="getParameterCount()">getParameterCount</a></h3>
 <div class="memberSignature"><span class="returnType">int</span>&nbsp;<span class="memberName">getParameterCount</span>()</div>
 <div class="block">Returns the number of parameters.</div>
 </section>
 </li>
 <li class="blockList">
 <section class="detail">
 <h3><a id="isArgumentConstant(int)">isArgumentConstant</a></h3>
 <div class="memberSignature"><span class="returnType">boolean</span>&nbsp;<span class="memberName">isArgumentConstant</span>&#8203;(<span class="arguments">int&nbsp;ordinal)</span></div>
 <div class="block">Returns whether the value of an argument is constant.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>ordinal</code> - Argument ordinal, starting from 0</dd>
 </dl>
 </section>
 </li>
 <li class="blockList">
 <section class="detail">
 <h3><a id="getArgumentValueAs(int,java.lang.Class)">getArgumentValueAs</a></h3>
 <div class="memberSignature"><span class="typeParameters">&lt;V&gt;</span>&nbsp;<span class="returnType">@Nullable V</span>&nbsp;<span class="memberName">getArgumentValueAs</span>&#8203;(<span class="arguments">int&nbsp;ordinal,
 <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;V&gt;&nbsp;valueClass)</span></div>
 <div class="block">Returns the value of an argument to this function,
  null if the argument is the NULL literal.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>ordinal</code> - Argument ordinal, starting from 0</dd>
 <dd><code>valueClass</code> - Type of value</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/ClassCastException.html?is-external=true" title="class or interface in java.lang" class="externalLink">ClassCastException</a></code> - if argument cannot be converted to
  <code>valueClass</code></dd>
 <dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - if argument is not constant</dd>
 </dl>
 </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>Nested&nbsp;|&nbsp;</li>
 <li>Field&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>
	<!DOCTYPE HTML>
	<!-- NewPage -->
	<html lang="en">
	<head>
	<!-- Generated by javadoc -->
	<title>FunctionContext (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, interface: FunctionContext">
	<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":6,"i1":6,"i2":6,"i3":6};
	var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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: </li>
	<li>Nested \| </li>
	<li>Field \| </li>
	<li>Constr \| </li>
	<li><a href="#method.summary">Method</a></li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </li>
	<li>Constr \| </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> <a href="package-summary.html">org.apache.calcite.schema</a></div>
	<h1 title="Interface FunctionContext" class="title">Interface FunctionContext</h1>
	</div>
	<div class="contentContainer">
	<section class="description">
	<hr>
	<pre>public interface <span class="typeNameLabel">FunctionContext</span></pre>
	<div class="block">Information about a function call that is passed to the constructor of a
	function instance.

	<p>This may enable a function to perform work up front, during construction,
	rather than each time it is invoked. Here is an example of such a function:

	<blockquote><pre>
	class RegexMatchesFunction {
	final java.util.regex.Pattern pattern;

	public RegexMatchesFunction(FunctionContext cx) {
	String pattern = cx.argumentValueAs(String.class);
	this.compiledPattern = java.util.regex.Pattern.compile(pattern);
	}

	public boolean eval(String pattern, String s) {
	return this.compiledPattern.matches(s);
	}
	}
	</pre></blockquote>

	<p>Register it in the model as follows:

	<blockquote><pre>
	functions: [
	{
	name: 'REGEX_MATCHES',
	className: 'com.example.RegexMatchesFun'
	}
	]
	</pre></blockquote>

	<p>and use it in a query:

	<blockquote><pre>
	SELECT empno, ename
	FROM Emp
	WHERE regex_matches('J.*ES', ename);

	+-------+--------+
	\| EMPNO \| ENAME \|
	+-------+--------+
	\| 7900 \| JAMES \|
	\| 7566 \| JONES \|
	+-------+--------+
	</pre></blockquote>

	<p>When executing the query, Calcite will create an instance of
	<code>RegexMatchesFunction</code> and call the <code>eval</code> method on that
	instance once per row.

	<p>If the <code>eval</code> method was static, or if the function's
	constructor had zero parameters, the <code>eval</code> method would have to call
	<code>java.util.regex.Pattern.compile(pattern)</code> to compile the pattern each
	time.

	<p>This interface is marked <a href="../linq4j/function/Experimental.html" title="annotation in org.apache.calcite.linq4j.function"><code>Experimental</code></a>, which means that we may
	change or remove methods, or the entire interface, without notice. But
	probably we will add methods over time, which will just your UDFs more
	information to work with.</div>
	</section>
	<section class="summary">
	<ul class="blockList">
	<!-- ========== 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="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="t3" class="tableTab" onclick="show(4);">Abstract 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><V> @Nullable V</code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getArgumentValueAs(int,java.lang.Class)">getArgumentValueAs</a></span>(int ordinal,
	<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><V> valueClass)</code></th>
	<td class="colLast">
	<div class="block">Returns the value of an argument to this function,
	null if the argument is the NULL literal.</div>
	</td>
	</tr>
	<tr class="rowColor" id="i1">
	<td class="colFirst"><code>int</code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParameterCount()">getParameterCount</a></span>()</code></th>
	<td class="colLast">
	<div class="block">Returns the number of parameters.</div>
	</td>
	</tr>
	<tr class="altColor" id="i2">
	<td class="colFirst"><code><a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a></code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTypeFactory()">getTypeFactory</a></span>()</code></th>
	<td class="colLast">
	<div class="block">Returns the type factory.</div>
	</td>
	</tr>
	<tr class="rowColor" id="i3">
	<td class="colFirst"><code>boolean</code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isArgumentConstant(int)">isArgumentConstant</a></span>(int ordinal)</code></th>
	<td class="colLast">
	<div class="block">Returns whether the value of an argument is constant.</div>
	</td>
	</tr>
	</tbody>
	</table>
	</div>
	</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="getTypeFactory()">getTypeFactory</a></h3>
	<div class="memberSignature"><span class="returnType"><a href="../rel/type/RelDataTypeFactory.html" title="interface in org.apache.calcite.rel.type">RelDataTypeFactory</a></span> <span class="memberName">getTypeFactory</span>()</div>
	<div class="block">Returns the type factory.</div>
	</section>
	</li>
	<li class="blockList">
	<section class="detail">
	<h3><a id="getParameterCount()">getParameterCount</a></h3>
	<div class="memberSignature"><span class="returnType">int</span> <span class="memberName">getParameterCount</span>()</div>
	<div class="block">Returns the number of parameters.</div>
	</section>
	</li>
	<li class="blockList">
	<section class="detail">
	<h3><a id="isArgumentConstant(int)">isArgumentConstant</a></h3>
	<div class="memberSignature"><span class="returnType">boolean</span> <span class="memberName">isArgumentConstant</span>(<span class="arguments">int ordinal)</span></div>
	<div class="block">Returns whether the value of an argument is constant.</div>
	<dl>
	<dt><span class="paramLabel">Parameters:</span></dt>
	<dd><code>ordinal</code> - Argument ordinal, starting from 0</dd>
	</dl>
	</section>
	</li>
	<li class="blockList">
	<section class="detail">
	<h3><a id="getArgumentValueAs(int,java.lang.Class)">getArgumentValueAs</a></h3>
	<div class="memberSignature"><span class="typeParameters"><V></span> <span class="returnType">@Nullable V</span> <span class="memberName">getArgumentValueAs</span>(<span class="arguments">int ordinal,
	<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><V> valueClass)</span></div>
	<div class="block">Returns the value of an argument to this function,
	null if the argument is the NULL literal.</div>
	<dl>
	<dt><span class="paramLabel">Parameters:</span></dt>
	<dd><code>ordinal</code> - Argument ordinal, starting from 0</dd>
	<dd><code>valueClass</code> - Type of value</dd>
	<dt><span class="throwsLabel">Throws:</span></dt>
	<dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/ClassCastException.html?is-external=true" title="class or interface in java.lang" class="externalLink">ClassCastException</a></code> - if argument cannot be converted to
	<code>valueClass</code></dd>
	<dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - if argument is not constant</dd>
	</dl>
	</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: </li>
	<li>Nested \| </li>
	<li>Field \| </li>
	<li>Constr \| </li>
	<li><a href="#method.summary">Method</a></li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </li>
	<li>Constr \| </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 © 2012-2021 Apache Software Foundation. All Rights Reserved.</small></p>
	</footer>
	</div>
	</div>
	</body>
	</html>