blob: 188711535cbaa1c5b272dd3916954fb9366a54be [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.apache.calcite.util (Calcite 1.20.0 Test API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.calcite.util (Calcite 1.20.0 Test API)";
}
}
catch(err) {
}
//-->
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></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" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.calcite.util</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ReflectVisitorTest.CrunchableNumber.html" title="interface in org.apache.calcite.util">ReflectVisitorTest.CrunchableNumber</a></th>
<td class="colLast">
<div class="block">An interface for introducing ambiguity into the class hierarchy.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ReflectVisitorTest.DiceyNumber.html" title="interface in org.apache.calcite.util">ReflectVisitorTest.DiceyNumber</a></th>
<td class="colLast">
<div class="block">Sub-interface of <a href="ReflectVisitorTest.FudgeableNumber.html" title="interface in org.apache.calcite.util"><code>ReflectVisitorTest.FudgeableNumber</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ReflectVisitorTest.FudgeableNumber.html" title="interface in org.apache.calcite.util">ReflectVisitorTest.FudgeableNumber</a></th>
<td class="colLast">
<div class="block">An interface for introducing ambiguity into the class hierarchy.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Smalls.MyGenericAggFunction.html" title="interface in org.apache.calcite.util">Smalls.MyGenericAggFunction</a>&lt;A,&#8203;V,&#8203;R&gt;</th>
<td class="colLast">
<div class="block">A generic interface for defining user defined aggregate functions</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="BitSetsTest.html" title="class in org.apache.calcite.util">BitSetsTest</a></th>
<td class="colLast">
<div class="block">Unit test for <code>BitSets</code>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ChunkListTest.html" title="class in org.apache.calcite.util">ChunkListTest</a></th>
<td class="colLast">
<div class="block">Unit and performance test for <code>ChunkList</code>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ImmutableBitSetTest.html" title="class in org.apache.calcite.util">ImmutableBitSetTest</a></th>
<td class="colLast">
<div class="block">Unit test for <code>ImmutableBitSet</code>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="PartiallyOrderedSetTest.html" title="class in org.apache.calcite.util">PartiallyOrderedSetTest</a></th>
<td class="colLast">
<div class="block">Unit test for <code>PartiallyOrderedSet</code>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="PermutationTestCase.html" title="class in org.apache.calcite.util">PermutationTestCase</a></th>
<td class="colLast">
<div class="block">Unit test for <code>Permutation</code>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="PrecedenceClimbingParserTest.html" title="class in org.apache.calcite.util">PrecedenceClimbingParserTest</a></th>
<td class="colLast">
<div class="block">Unit test for <code>PrecedenceClimbingParser</code>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ReflectVisitorTest.html" title="class in org.apache.calcite.util">ReflectVisitorTest</a></th>
<td class="colLast">
<div class="block">ReflectVisitorTest tests <code>ReflectUtil.invokeVisitor(org.apache.calcite.util.ReflectiveVisitor, java.lang.Object, java.lang.Class, java.lang.String)</code> and
<code>ReflectiveVisitor</code> and provides a contrived example of how to use
them.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Smalls.html" title="class in org.apache.calcite.util">Smalls</a></th>
<td class="colLast">
<div class="block">Holder for various classes and functions used in tests as user-defined
functions and so forth.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Smalls.AllTypesFunction.html" title="class in org.apache.calcite.util">Smalls.AllTypesFunction</a></th>
<td class="colLast">
<div class="block">UDF class that provides user-defined functions for each data type.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Smalls.AwkwardFunction.html" title="class in org.apache.calcite.util">Smalls.AwkwardFunction</a></th>
<td class="colLast">
<div class="block">Example of a UDF class that needs to be instantiated but cannot be.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Smalls.CountArgs0Function.html" title="class in org.apache.calcite.util">Smalls.CountArgs0Function</a></th>
<td class="colLast">
<div class="block">Example of a UDF that has overloaded UDFs (same name, different args).</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Smalls.CountArgs1Function.html" title="class in org.apache.calcite.util">Smalls.CountArgs1Function</a></th>
<td class="colLast">
<div class="block">See <a href="Smalls.CountArgs0Function.html" title="class in org.apache.calcite.util"><code>Smalls.CountArgs0Function</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Smalls.CountArgs1NullableFunction.html" title="class in org.apache.calcite.util">Smalls.CountArgs1NullableFunction</a></th>
<td class="colLast">
<div class="block">See <a href="Smalls.CountArgs0Function.html" title="class in org.apache.calcite.util"><code>Smalls.CountArgs0Function</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Smalls.CountArgs2Function.html" title="class in org.apache.calcite.util">Smalls.CountArgs2Function</a></th>
<td class="colLast">
<div class="block">See <a href="Smalls.CountArgs0Function.html" title="class in org.apache.calcite.util"><code>Smalls.CountArgs0Function</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Smalls.IntString.html" title="class in org.apache.calcite.util">Smalls.IntString</a></th>
<td class="colLast">
<div class="block">Class with int and String fields.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Smalls.MazeTable.html" title="class in org.apache.calcite.util">Smalls.MazeTable</a></th>
<td class="colLast">
<div class="block">The real MazeTable may be found in example/function.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Smalls.MultipleFunction.html" title="class in org.apache.calcite.util">Smalls.MultipleFunction</a></th>
<td class="colLast">
<div class="block">UDF class that has multiple methods, some overloaded.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Smalls.MyAbcdeFunction.html" title="class in org.apache.calcite.util">Smalls.MyAbcdeFunction</a></th>
<td class="colLast">
<div class="block">Example of a UDF with named parameters, some of them optional.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Smalls.MyDeterministicPlusFunction.html" title="class in org.apache.calcite.util">Smalls.MyDeterministicPlusFunction</a></th>
<td class="colLast">
<div class="block">As <a href="Smalls.MyPlusFunction.html" title="class in org.apache.calcite.util"><code>Smalls.MyPlusFunction</code></a> but declared to be deterministic.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Smalls.MyDoubleFunction.html" title="class in org.apache.calcite.util">Smalls.MyDoubleFunction</a></th>
<td class="colLast">
<div class="block">Example of a UDF with a static <code>eval</code> method.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Smalls.MyIncrement.html" title="class in org.apache.calcite.util">Smalls.MyIncrement</a></th>
<td class="colLast">
<div class="block">User-defined function with two arguments.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Smalls.MyLeftFunction.html" title="class in org.apache.calcite.util">Smalls.MyLeftFunction</a></th>
<td class="colLast">
<div class="block">Example of a UDF with named parameters.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Smalls.MyPlusFunction.html" title="class in org.apache.calcite.util">Smalls.MyPlusFunction</a></th>
<td class="colLast">
<div class="block">Example of a UDF with a non-static <code>eval</code> method,
and named parameters.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Smalls.MyStaticSumFunction.html" title="class in org.apache.calcite.util">Smalls.MyStaticSumFunction</a></th>
<td class="colLast">
<div class="block">Example of a user-defined aggregate function (UDAF), whose methods are
static.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Smalls.MySum3.html" title="class in org.apache.calcite.util">Smalls.MySum3</a></th>
<td class="colLast">
<div class="block">Example of a user-defined aggregate function that implements a generic
interface.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Smalls.MySumFunction.html" title="class in org.apache.calcite.util">Smalls.MySumFunction</a></th>
<td class="colLast">
<div class="block">Example of a user-defined aggregate function (UDAF).</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Smalls.MyTableFunction.html" title="class in org.apache.calcite.util">Smalls.MyTableFunction</a></th>
<td class="colLast">
<div class="block">A table function that returns a <code>QueryableTable</code>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Smalls.MyThreeParamsSumFunctionWithFilter1.html" title="class in org.apache.calcite.util">Smalls.MyThreeParamsSumFunctionWithFilter1</a></th>
<td class="colLast">
<div class="block">Example of a user-defined aggregate function (UDAF), whose methods are
static.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Smalls.MyThreeParamsSumFunctionWithFilter2.html" title="class in org.apache.calcite.util">Smalls.MyThreeParamsSumFunctionWithFilter2</a></th>
<td class="colLast">
<div class="block">Example of a user-defined aggregate function (UDAF), whose methods are
static.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Smalls.MyToStringFunction.html" title="class in org.apache.calcite.util">Smalls.MyToStringFunction</a></th>
<td class="colLast">
<div class="block">Example of a non-strict UDF.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Smalls.MyTwoParamsSumFunctionFilter1.html" title="class in org.apache.calcite.util">Smalls.MyTwoParamsSumFunctionFilter1</a></th>
<td class="colLast">
<div class="block">Example of a user-defined aggregate function (UDAF).</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Smalls.MyTwoParamsSumFunctionFilter2.html" title="class in org.apache.calcite.util">Smalls.MyTwoParamsSumFunctionFilter2</a></th>
<td class="colLast">
<div class="block">Example of a user-defined aggregate function (UDAF).</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Smalls.Null4Function.html" title="class in org.apache.calcite.util">Smalls.Null4Function</a></th>
<td class="colLast">
<div class="block">Example of a semi-strict UDF.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Smalls.Null8Function.html" title="class in org.apache.calcite.util">Smalls.Null8Function</a></th>
<td class="colLast">
<div class="block">Example of a picky, semi-strict UDF.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Smalls.SimpleTableFunction.html" title="class in org.apache.calcite.util">Smalls.SimpleTableFunction</a></th>
<td class="colLast">
<div class="block">A table function that returns a <code>QueryableTable</code>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Smalls.StaticTableMacroFunction.html" title="class in org.apache.calcite.util">Smalls.StaticTableMacroFunction</a></th>
<td class="colLast">
<div class="block">User-defined table-macro function whose eval method is static.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Smalls.SumFunctionBadIAdd.html" title="class in org.apache.calcite.util">Smalls.SumFunctionBadIAdd</a></th>
<td class="colLast">
<div class="block">User-defined function.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Smalls.TableMacroFunction.html" title="class in org.apache.calcite.util">Smalls.TableMacroFunction</a></th>
<td class="colLast">
<div class="block">User-defined table-macro function.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Smalls.TableMacroFunctionWithNamedParameters.html" title="class in org.apache.calcite.util">Smalls.TableMacroFunctionWithNamedParameters</a></th>
<td class="colLast">
<div class="block">User-defined table-macro function with named and optional parameters.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Smalls.TestStaticTableFunction.html" title="class in org.apache.calcite.util">Smalls.TestStaticTableFunction</a></th>
<td class="colLast">
<div class="block">A table function that returns a <code>QueryableTable</code> via a
static method.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Smalls.WideProductSale.html" title="class in org.apache.calcite.util">Smalls.WideProductSale</a></th>
<td class="colLast">
<div class="block">Table with a lot of columns.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Smalls.WideSaleSchema.html" title="class in org.apache.calcite.util">Smalls.WideSaleSchema</a></th>
<td class="colLast">
<div class="block">Schema containing a <code>prod</code> table with a lot of columns.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SourceTest.html" title="class in org.apache.calcite.util">SourceTest</a></th>
<td class="colLast">
<div class="block">Tests for <code>Source</code>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="TestUtil.html" title="class in org.apache.calcite.util">TestUtil</a></th>
<td class="colLast">
<div class="block">Static utilities for JUnit tests.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="TestUtil.ExtraInformation.html" title="class in org.apache.calcite.util">TestUtil.ExtraInformation</a></th>
<td class="colLast">
<div class="block">This is to be used by <a href="TestUtil.html#rethrow(java.lang.Throwable,java.lang.String)"><code>TestUtil.rethrow(Throwable, String)</code></a> to add extra information via
<code>Throwable.addSuppressed(Throwable)</code>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="TestUtilTest.html" title="class in org.apache.calcite.util">TestUtilTest</a></th>
<td class="colLast">
<div class="block">Tests for TestUtil</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="UtilTest.html" title="class in org.apache.calcite.util">UtilTest</a></th>
<td class="colLast">
<div class="block">Unit test for <code>Util</code> and other classes in this package.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></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" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2012&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>