Google Git
Sign in
apache / calcite-site / aa042a0da8aed8b59d4a32d423ef3d414459189e / . / javadocAggregate / org / apache / calcite / test / MockSqlOperatorTable.html
blob: 9e84d9ab96278e0c9408e977fea007b6ca179b03 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>MockSqlOperatorTable (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.test, class: MockSqlOperatorTable">
<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:&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="sub-nav-list">
<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="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>&nbsp;<a href="package-summary.html">org.apache.calcite.test</a></div>
<h1 title="Class MockSqlOperatorTable" class="title">Class MockSqlOperatorTable</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="../sql/util/ChainedSqlOperatorTable.html" title="class in org.apache.calcite.sql.util">org.apache.calcite.sql.util.ChainedSqlOperatorTable</a>
<div class="inheritance">org.apache.calcite.test.MockSqlOperatorTable</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../sql/SqlOperatorTable.html" title="interface in org.apache.calcite.sql">SqlOperatorTable</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">MockSqlOperatorTable</span>
<span class="extends-implements">extends <a href="../sql/util/ChainedSqlOperatorTable.html" title="class in org.apache.calcite.sql.util">ChainedSqlOperatorTable</a></span></div>
<div class="block">Mock operator table for testing purposes. Contains the standard SQL operator
table, plus a list of operators.</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="caption"><span>Nested Classes</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="MockSqlOperatorTable.BadTableFunction.html" class="type-name-link" title="class in org.apache.calcite.test">MockSqlOperatorTable.BadTableFunction</a></code></div>
<div class="col-last even-row-color">
<div class="block">Another bad table function: declares itself as a table function but does
not return CURSOR.</div>
</div>
<div class="col-first odd-row-color"><code>static class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="MockSqlOperatorTable.CompositeFunction.html" class="type-name-link" title="class in org.apache.calcite.test">MockSqlOperatorTable.CompositeFunction</a></code></div>
<div class="col-last odd-row-color">
<div class="block">"COMPOSITE" user-defined scalar function.</div>
</div>
<div class="col-first even-row-color"><code>static class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="MockSqlOperatorTable.DedupFunction.html" class="type-name-link" title="class in org.apache.calcite.test">MockSqlOperatorTable.DedupFunction</a></code></div>
<div class="col-last even-row-color">
<div class="block">"DEDUP" user-defined table function.</div>
</div>
<div class="col-first odd-row-color"><code>static class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="MockSqlOperatorTable.DynamicTypeFunction.html" class="type-name-link" title="class in org.apache.calcite.test">MockSqlOperatorTable.DynamicTypeFunction</a></code></div>
<div class="col-last odd-row-color">
<div class="block">"DYNTYPE" user-defined table function.</div>
</div>
<div class="col-first even-row-color"><code>static class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="MockSqlOperatorTable.InvalidTableFunction.html" class="type-name-link" title="class in org.apache.calcite.test">MockSqlOperatorTable.InvalidTableFunction</a></code></div>
<div class="col-last even-row-color">
<div class="block">Invalid user-defined table function with multiple input tables with
row semantics.</div>
</div>
<div class="col-first odd-row-color"><code>static class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="MockSqlOperatorTable.MapFunction.html" class="type-name-link" title="class in org.apache.calcite.test">MockSqlOperatorTable.MapFunction</a></code></div>
<div class="col-last odd-row-color">
<div class="block">"MAP" user-defined function.</div>
</div>
<div class="col-first even-row-color"><code>static class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="MockSqlOperatorTable.MyAggFunc.html" class="type-name-link" title="class in org.apache.calcite.test">MockSqlOperatorTable.MyAggFunc</a></code></div>
<div class="col-last even-row-color">
<div class="block">"MYAGGFUNC" user-defined aggregate function.</div>
</div>
<div class="col-first odd-row-color"><code>static class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="MockSqlOperatorTable.MyAvgAggFunction.html" class="type-name-link" title="class in org.apache.calcite.test">MockSqlOperatorTable.MyAvgAggFunction</a></code></div>
<div class="col-last odd-row-color">
<div class="block">"MYAGG" user-defined aggregate function.</div>
</div>
<div class="col-first even-row-color"><code>static class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="MockSqlOperatorTable.MyFunction.html" class="type-name-link" title="class in org.apache.calcite.test">MockSqlOperatorTable.MyFunction</a></code></div>
<div class="col-last even-row-color">
<div class="block">"MYFUN" user-defined scalar function.</div>
</div>
<div class="col-first odd-row-color"><code>static class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="MockSqlOperatorTable.NotATableFunction.html" class="type-name-link" title="class in org.apache.calcite.test">MockSqlOperatorTable.NotATableFunction</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Not valid as a table function, even though it returns CURSOR, because
it does not implement <a href="../sql/SqlTableFunction.html" title="interface in org.apache.calcite.sql"><code>SqlTableFunction</code></a>.</div>
</div>
<div class="col-first even-row-color"><code>static class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="MockSqlOperatorTable.RampFunction.html" class="type-name-link" title="class in org.apache.calcite.test">MockSqlOperatorTable.RampFunction</a></code></div>
<div class="col-last even-row-color">
<div class="block">"RAMP" user-defined table function.</div>
</div>
<div class="col-first odd-row-color"><code>static class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="MockSqlOperatorTable.RowFunction.html" class="type-name-link" title="class in org.apache.calcite.test">MockSqlOperatorTable.RowFunction</a></code></div>
<div class="col-last odd-row-color">
<div class="block">"ROW_FUNC" user-defined table function whose return type is
row type with nullable and non-nullable fields.</div>
</div>
<div class="col-first even-row-color"><code>static class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="MockSqlOperatorTable.ScoreTableFunction.html" class="type-name-link" title="class in org.apache.calcite.test">MockSqlOperatorTable.ScoreTableFunction</a></code></div>
<div class="col-last even-row-color">
<div class="block">"Score" user-defined table function.</div>
</div>
<div class="col-first odd-row-color"><code>static class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="MockSqlOperatorTable.SimilarlityTableFunction.html" class="type-name-link" title="class in org.apache.calcite.test">MockSqlOperatorTable.SimilarlityTableFunction</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Similarity performs an analysis on two data sets, which are both tables
of two columns, treated as the x and y axes of a graph.</div>
</div>
<div class="col-first even-row-color"><code>static class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="MockSqlOperatorTable.SplitFunction.html" class="type-name-link" title="class in org.apache.calcite.test">MockSqlOperatorTable.SplitFunction</a></code></div>
<div class="col-last even-row-color">
<div class="block">"SPLIT" user-defined function.</div>
</div>
<div class="col-first odd-row-color"><code>static class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="MockSqlOperatorTable.StructuredFunction.html" class="type-name-link" title="class in org.apache.calcite.test">MockSqlOperatorTable.StructuredFunction</a></code></div>
<div class="col-last odd-row-color">
<div class="block">"STRUCTURED_FUNC" user-defined function whose return type is structured type.</div>
</div>
<div class="col-first even-row-color"><code>static class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="MockSqlOperatorTable.TopNTableFunction.html" class="type-name-link" title="class in org.apache.calcite.test">MockSqlOperatorTable.TopNTableFunction</a></code></div>
<div class="col-last even-row-color">
<div class="block">"TopN" user-defined table function.</div>
</div>
</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.sql.util.ChainedSqlOperatorTable">Fields inherited from class&nbsp;org.apache.calcite.sql.util.<a href="../sql/util/ChainedSqlOperatorTable.html" title="class in org.apache.calcite.sql.util">ChainedSqlOperatorTable</a></h3>
<code><a href="../sql/util/ChainedSqlOperatorTable.html#tableList">tableList</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></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-tab2 method-summary-table-tab4"><code><a href="MockSqlOperatorTable.html" title="class in org.apache.calcite.test">MockSqlOperatorTable</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#extend()" class="member-name-link">extend</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns this table with a few mock operators added.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="MockSqlOperatorTable.html" title="class in org.apache.calcite.test">MockSqlOperatorTable</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#of(org.apache.calcite.sql.SqlOperatorTable)" class="member-name-link">of</a><wbr>(<a href="../sql/SqlOperatorTable.html" title="interface in org.apache.calcite.sql">SqlOperatorTable</a>&nbsp;operatorTable)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Returns a mock operator table based on the given operator table.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="MockSqlOperatorTable.html" title="class in org.apache.calcite.test">MockSqlOperatorTable</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#plus(java.lang.Iterable)" class="member-name-link">plus</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a>&lt;<a href="../sql/fun/SqlLibrary.html" title="enum in org.apache.calcite.sql.fun">SqlLibrary</a>&gt;&nbsp;librarySet)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Adds a library set.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="MockSqlOperatorTable.html" title="class in org.apache.calcite.test">MockSqlOperatorTable</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#standard()" class="member-name-link">standard</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Returns the operator table that contains only the standard operators.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.calcite.sql.util.ChainedSqlOperatorTable">Methods inherited from class&nbsp;org.apache.calcite.sql.util.<a href="../sql/util/ChainedSqlOperatorTable.html" title="class in org.apache.calcite.sql.util">ChainedSqlOperatorTable</a></h3>
<code><a href="../sql/util/ChainedSqlOperatorTable.html#add(org.apache.calcite.sql.SqlOperatorTable)">add</a>, <a href="../sql/util/ChainedSqlOperatorTable.html#getOperatorList()">getOperatorList</a>, <a href="../sql/util/ChainedSqlOperatorTable.html#lookupOperatorOverloads(org.apache.calcite.sql.SqlIdentifier,org.apache.calcite.sql.SqlFunctionCategory,org.apache.calcite.sql.SqlSyntax,java.util.List,org.apache.calcite.sql.validate.SqlNameMatcher)">lookupOperatorOverloads</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;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>
</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="standard()">
<h3>standard</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="MockSqlOperatorTable.html" title="class in org.apache.calcite.test">MockSqlOperatorTable</a></span>&nbsp;<span class="element-name">standard</span>()</div>
<div class="block">Returns the operator table that contains only the standard operators.</div>
</section>
</li>
<li>
<section class="detail" id="of(org.apache.calcite.sql.SqlOperatorTable)">
<h3>of</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="MockSqlOperatorTable.html" title="class in org.apache.calcite.test">MockSqlOperatorTable</a></span>&nbsp;<span class="element-name">of</span><wbr><span class="parameters">(<a href="../sql/SqlOperatorTable.html" title="interface in org.apache.calcite.sql">SqlOperatorTable</a>&nbsp;operatorTable)</span></div>
<div class="block">Returns a mock operator table based on the given operator table.</div>
</section>
</li>
<li>
<section class="detail" id="extend()">
<h3>extend</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="MockSqlOperatorTable.html" title="class in org.apache.calcite.test">MockSqlOperatorTable</a></span>&nbsp;<span class="element-name">extend</span>()</div>
<div class="block">Returns this table with a few mock operators added.</div>
</section>
</li>
<li>
<section class="detail" id="plus(java.lang.Iterable)">
<h3>plus</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="MockSqlOperatorTable.html" title="class in org.apache.calcite.test">MockSqlOperatorTable</a></span>&nbsp;<span class="element-name">plus</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a>&lt;<a href="../sql/fun/SqlLibrary.html" title="enum in org.apache.calcite.sql.fun">SqlLibrary</a>&gt;&nbsp;librarySet)</span></div>
<div class="block">Adds a library set.</div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &copy; 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>