blob: bb85d82e884db43a9dcfc7742b2d41f31fc6f911 [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 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.calcite.util (Calcite 1.19.0 Test API)</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="org.apache.calcite.util (Calcite 1.19.0 Test API)";
}
}
catch(err) {
}
//-->
</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 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">
<li><a href="../../../../org/apache/calcite/tools/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/calcite/util/graph/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/util/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<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" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<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">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/ReflectVisitorTest.CrunchableNumber.html" title="interface in org.apache.calcite.util">ReflectVisitorTest.CrunchableNumber</a></td>
<td class="colLast">
<div class="block">An interface for introducing ambiguity into the class hierarchy.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/ReflectVisitorTest.DiceyNumber.html" title="interface in org.apache.calcite.util">ReflectVisitorTest.DiceyNumber</a></td>
<td class="colLast">
<div class="block">Sub-interface of <a href="../../../../org/apache/calcite/util/ReflectVisitorTest.FudgeableNumber.html" title="interface in org.apache.calcite.util"><code>ReflectVisitorTest.FudgeableNumber</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/ReflectVisitorTest.FudgeableNumber.html" title="interface in org.apache.calcite.util">ReflectVisitorTest.FudgeableNumber</a></td>
<td class="colLast">
<div class="block">An interface for introducing ambiguity into the class hierarchy.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.MyGenericAggFunction.html" title="interface in org.apache.calcite.util">Smalls.MyGenericAggFunction</a>&lt;A,V,R&gt;</td>
<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" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<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">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/BitSetsTest.html" title="class in org.apache.calcite.util">BitSetsTest</a></td>
<td class="colLast">
<div class="block">Unit test for <code>BitSets</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/ChunkListTest.html" title="class in org.apache.calcite.util">ChunkListTest</a></td>
<td class="colLast">
<div class="block">Unit and performance test for <code>ChunkList</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/ImmutableBitSetTest.html" title="class in org.apache.calcite.util">ImmutableBitSetTest</a></td>
<td class="colLast">
<div class="block">Unit test for <code>ImmutableBitSet</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/PartiallyOrderedSetTest.html" title="class in org.apache.calcite.util">PartiallyOrderedSetTest</a></td>
<td class="colLast">
<div class="block">Unit test for <code>PartiallyOrderedSet</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/PermutationTestCase.html" title="class in org.apache.calcite.util">PermutationTestCase</a></td>
<td class="colLast">
<div class="block">Unit test for <code>Permutation</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/PrecedenceClimbingParserTest.html" title="class in org.apache.calcite.util">PrecedenceClimbingParserTest</a></td>
<td class="colLast">
<div class="block">Unit test for <code>PrecedenceClimbingParser</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/ReflectVisitorTest.html" title="class in org.apache.calcite.util">ReflectVisitorTest</a></td>
<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">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.html" title="class in org.apache.calcite.util">Smalls</a></td>
<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">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.AllTypesFunction.html" title="class in org.apache.calcite.util">Smalls.AllTypesFunction</a></td>
<td class="colLast">
<div class="block">UDF class that provides user-defined functions for each data type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.AwkwardFunction.html" title="class in org.apache.calcite.util">Smalls.AwkwardFunction</a></td>
<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">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.CountArgs0Function.html" title="class in org.apache.calcite.util">Smalls.CountArgs0Function</a></td>
<td class="colLast">
<div class="block">Example of a UDF that has overloaded UDFs (same name, different args).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.CountArgs1Function.html" title="class in org.apache.calcite.util">Smalls.CountArgs1Function</a></td>
<td class="colLast">
<div class="block">See <a href="../../../../org/apache/calcite/util/Smalls.CountArgs0Function.html" title="class in org.apache.calcite.util"><code>Smalls.CountArgs0Function</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.CountArgs1NullableFunction.html" title="class in org.apache.calcite.util">Smalls.CountArgs1NullableFunction</a></td>
<td class="colLast">
<div class="block">See <a href="../../../../org/apache/calcite/util/Smalls.CountArgs0Function.html" title="class in org.apache.calcite.util"><code>Smalls.CountArgs0Function</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.CountArgs2Function.html" title="class in org.apache.calcite.util">Smalls.CountArgs2Function</a></td>
<td class="colLast">
<div class="block">See <a href="../../../../org/apache/calcite/util/Smalls.CountArgs0Function.html" title="class in org.apache.calcite.util"><code>Smalls.CountArgs0Function</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.IntString.html" title="class in org.apache.calcite.util">Smalls.IntString</a></td>
<td class="colLast">
<div class="block">Class with int and String fields.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.MazeTable.html" title="class in org.apache.calcite.util">Smalls.MazeTable</a></td>
<td class="colLast">
<div class="block">The real MazeTable may be found in example/function.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.MultipleFunction.html" title="class in org.apache.calcite.util">Smalls.MultipleFunction</a></td>
<td class="colLast">
<div class="block">UDF class that has multiple methods, some overloaded.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.MyAbcdeFunction.html" title="class in org.apache.calcite.util">Smalls.MyAbcdeFunction</a></td>
<td class="colLast">
<div class="block">Example of a UDF with named parameters, some of them optional.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.MyDeterministicPlusFunction.html" title="class in org.apache.calcite.util">Smalls.MyDeterministicPlusFunction</a></td>
<td class="colLast">
<div class="block">As <a href="../../../../org/apache/calcite/util/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">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.MyDoubleFunction.html" title="class in org.apache.calcite.util">Smalls.MyDoubleFunction</a></td>
<td class="colLast">
<div class="block">Example of a UDF with a static <code>eval</code> method.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.MyIncrement.html" title="class in org.apache.calcite.util">Smalls.MyIncrement</a></td>
<td class="colLast">
<div class="block">User-defined function with two arguments.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.MyLeftFunction.html" title="class in org.apache.calcite.util">Smalls.MyLeftFunction</a></td>
<td class="colLast">
<div class="block">Example of a UDF with named parameters.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.MyPlusFunction.html" title="class in org.apache.calcite.util">Smalls.MyPlusFunction</a></td>
<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">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.MyStaticSumFunction.html" title="class in org.apache.calcite.util">Smalls.MyStaticSumFunction</a></td>
<td class="colLast">
<div class="block">Example of a user-defined aggregate function (UDAF), whose methods are
static.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.MySum3.html" title="class in org.apache.calcite.util">Smalls.MySum3</a></td>
<td class="colLast">
<div class="block">Example of a user-defined aggregate function that implements a generic
interface.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.MySumFunction.html" title="class in org.apache.calcite.util">Smalls.MySumFunction</a></td>
<td class="colLast">
<div class="block">Example of a user-defined aggregate function (UDAF).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.MyTableFunction.html" title="class in org.apache.calcite.util">Smalls.MyTableFunction</a></td>
<td class="colLast">
<div class="block">A table function that returns a <code>QueryableTable</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.MyThreeParamsSumFunctionWithFilter1.html" title="class in org.apache.calcite.util">Smalls.MyThreeParamsSumFunctionWithFilter1</a></td>
<td class="colLast">
<div class="block">Example of a user-defined aggregate function (UDAF), whose methods are
static.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.MyThreeParamsSumFunctionWithFilter2.html" title="class in org.apache.calcite.util">Smalls.MyThreeParamsSumFunctionWithFilter2</a></td>
<td class="colLast">
<div class="block">Example of a user-defined aggregate function (UDAF), whose methods are
static.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.MyToStringFunction.html" title="class in org.apache.calcite.util">Smalls.MyToStringFunction</a></td>
<td class="colLast">
<div class="block">Example of a non-strict UDF.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.MyTwoParamsSumFunctionFilter1.html" title="class in org.apache.calcite.util">Smalls.MyTwoParamsSumFunctionFilter1</a></td>
<td class="colLast">
<div class="block">Example of a user-defined aggregate function (UDAF).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.MyTwoParamsSumFunctionFilter2.html" title="class in org.apache.calcite.util">Smalls.MyTwoParamsSumFunctionFilter2</a></td>
<td class="colLast">
<div class="block">Example of a user-defined aggregate function (UDAF).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.Null4Function.html" title="class in org.apache.calcite.util">Smalls.Null4Function</a></td>
<td class="colLast">
<div class="block">Example of a semi-strict UDF.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.Null8Function.html" title="class in org.apache.calcite.util">Smalls.Null8Function</a></td>
<td class="colLast">
<div class="block">Example of a picky, semi-strict UDF.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.SimpleTableFunction.html" title="class in org.apache.calcite.util">Smalls.SimpleTableFunction</a></td>
<td class="colLast">
<div class="block">A table function that returns a <code>QueryableTable</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.StaticTableMacroFunction.html" title="class in org.apache.calcite.util">Smalls.StaticTableMacroFunction</a></td>
<td class="colLast">
<div class="block">User-defined table-macro function whose eval method is static.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.SumFunctionBadIAdd.html" title="class in org.apache.calcite.util">Smalls.SumFunctionBadIAdd</a></td>
<td class="colLast">
<div class="block">User-defined function.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.TableMacroFunction.html" title="class in org.apache.calcite.util">Smalls.TableMacroFunction</a></td>
<td class="colLast">
<div class="block">User-defined table-macro function.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.TableMacroFunctionWithNamedParameters.html" title="class in org.apache.calcite.util">Smalls.TableMacroFunctionWithNamedParameters</a></td>
<td class="colLast">
<div class="block">User-defined table-macro function with named and optional parameters.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.TestStaticTableFunction.html" title="class in org.apache.calcite.util">Smalls.TestStaticTableFunction</a></td>
<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">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.WideProductSale.html" title="class in org.apache.calcite.util">Smalls.WideProductSale</a></td>
<td class="colLast">
<div class="block">Table with a lot of columns.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/Smalls.WideSaleSchema.html" title="class in org.apache.calcite.util">Smalls.WideSaleSchema</a></td>
<td class="colLast">
<div class="block">Schema containing a <code>prod</code> table with a lot of columns.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/SourceTest.html" title="class in org.apache.calcite.util">SourceTest</a></td>
<td class="colLast">
<div class="block">Tests for <code>Source</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/TestUtil.html" title="class in org.apache.calcite.util">TestUtil</a></td>
<td class="colLast">
<div class="block">Static utilities for JUnit tests.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/TestUtil.ExtraInformation.html" title="class in org.apache.calcite.util">TestUtil.ExtraInformation</a></td>
<td class="colLast">
<div class="block">This is to be used by <a href="../../../../org/apache/calcite/util/TestUtil.html#rethrow-java.lang.Throwable-java.lang.String-"><code>TestUtil.rethrow(Throwable, String)</code></a> to add extra information via
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed-java.lang.Throwable-" title="class or interface in java.lang"><code>Throwable.addSuppressed(Throwable)</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/TestUtilTest.html" title="class in org.apache.calcite.util">TestUtilTest</a></td>
<td class="colLast">
<div class="block">Tests for TestUtil</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/util/UtilTest.html" title="class in org.apache.calcite.util">UtilTest</a></td>
<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>
<!-- ======= 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 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">
<li><a href="../../../../org/apache/calcite/tools/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/calcite/util/graph/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/util/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<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>
</body>
</html>