blob: 73a1aa5e53be503df282b9724fbfde3a4db903d4 [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 (1.8.0_181-google-v7) on Wed Aug 14 17:37:10 PDT 2019 -->
<title>BeamTableStatistics (Apache Beam 2.15.0-SNAPSHOT)</title>
<meta name="date" content="2019-08-14">
<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="BeamTableStatistics (Apache Beam 2.15.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/BeamSqlPipelineOptionsRegistrar.html" title="class in org.apache.beam.sdk.extensions.sql.impl"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/CalciteConnectionWrapper.html" title="class in org.apache.beam.sdk.extensions.sql.impl"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/beam/sdk/extensions/sql/impl/BeamTableStatistics.html" target="_top">Frames</a></li>
<li><a href="BeamTableStatistics.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.beam.sdk.extensions.sql.impl</div>
<h2 title="Class BeamTableStatistics" class="title">Class BeamTableStatistics</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.extensions.sql.impl.BeamTableStatistics</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, org.apache.calcite.schema.Statistic</dd>
</dl>
<hr>
<br>
<pre><a href="../../../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a>
<a href="../../../../../../../org/apache/beam/sdk/annotations/Internal.html" title="annotation in org.apache.beam.sdk.annotations">@Internal</a>
public class <span class="typeNameLabel">BeamTableStatistics</span>
extends java.lang.Object
implements java.io.Serializable, org.apache.calcite.schema.Statistic</pre>
<div class="block">This class stores row count statistics.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../../serialized-form.html#org.apache.beam.sdk.extensions.sql.impl.BeamTableStatistics">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/BeamTableStatistics.html" title="class in org.apache.beam.sdk.extensions.sql.impl">BeamTableStatistics</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/BeamTableStatistics.html#UNBOUNDED_UNKNOWN">UNBOUNDED_UNKNOWN</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/BeamTableStatistics.html" title="class in org.apache.beam.sdk.extensions.sql.impl">BeamTableStatistics</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/BeamTableStatistics.html#UNKNOWN">UNKNOWN</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/BeamTableStatistics.html" title="class in org.apache.beam.sdk.extensions.sql.impl">BeamTableStatistics</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/BeamTableStatistics.html#createBoundedTableStatistics-java.lang.Double-">createBoundedTableStatistics</a></span>(java.lang.Double&nbsp;rowCount)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/BeamTableStatistics.html" title="class in org.apache.beam.sdk.extensions.sql.impl">BeamTableStatistics</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/BeamTableStatistics.html#createUnboundedTableStatistics-java.lang.Double-">createUnboundedTableStatistics</a></span>(java.lang.Double&nbsp;rate)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.List&lt;org.apache.calcite.rel.RelCollation&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/BeamTableStatistics.html#getCollations--">getCollations</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>org.apache.calcite.rel.RelDistribution</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/BeamTableStatistics.html#getDistribution--">getDistribution</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.Double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/BeamTableStatistics.html#getRate--">getRate</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;org.apache.calcite.rel.RelReferentialConstraint&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/BeamTableStatistics.html#getReferentialConstraints--">getReferentialConstraints</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.Double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/BeamTableStatistics.html#getRowCount--">getRowCount</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/BeamTableStatistics.html#isKey-org.apache.calcite.util.ImmutableBitSet-">isKey</a></span>(org.apache.calcite.util.ImmutableBitSet&nbsp;columns)</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/BeamTableStatistics.html#isUnknown--">isUnknown</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="UNKNOWN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UNKNOWN</h4>
<pre>public static final&nbsp;<a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/BeamTableStatistics.html" title="class in org.apache.beam.sdk.extensions.sql.impl">BeamTableStatistics</a> UNKNOWN</pre>
</li>
</ul>
<a name="UNBOUNDED_UNKNOWN">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>UNBOUNDED_UNKNOWN</h4>
<pre>public static final&nbsp;<a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/BeamTableStatistics.html" title="class in org.apache.beam.sdk.extensions.sql.impl">BeamTableStatistics</a> UNBOUNDED_UNKNOWN</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="createBoundedTableStatistics-java.lang.Double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createBoundedTableStatistics</h4>
<pre>public static&nbsp;<a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/BeamTableStatistics.html" title="class in org.apache.beam.sdk.extensions.sql.impl">BeamTableStatistics</a>&nbsp;createBoundedTableStatistics(java.lang.Double&nbsp;rowCount)</pre>
</li>
</ul>
<a name="createUnboundedTableStatistics-java.lang.Double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createUnboundedTableStatistics</h4>
<pre>public static&nbsp;<a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/BeamTableStatistics.html" title="class in org.apache.beam.sdk.extensions.sql.impl">BeamTableStatistics</a>&nbsp;createUnboundedTableStatistics(java.lang.Double&nbsp;rate)</pre>
</li>
</ul>
<a name="getRate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRate</h4>
<pre>public&nbsp;java.lang.Double&nbsp;getRate()</pre>
</li>
</ul>
<a name="isUnknown--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isUnknown</h4>
<pre>public&nbsp;boolean&nbsp;isUnknown()</pre>
</li>
</ul>
<a name="getRowCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRowCount</h4>
<pre>public&nbsp;java.lang.Double&nbsp;getRowCount()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getRowCount</code>&nbsp;in interface&nbsp;<code>org.apache.calcite.schema.Statistic</code></dd>
</dl>
</li>
</ul>
<a name="isKey-org.apache.calcite.util.ImmutableBitSet-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isKey</h4>
<pre>public&nbsp;boolean&nbsp;isKey(org.apache.calcite.util.ImmutableBitSet&nbsp;columns)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>isKey</code>&nbsp;in interface&nbsp;<code>org.apache.calcite.schema.Statistic</code></dd>
</dl>
</li>
</ul>
<a name="getReferentialConstraints--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReferentialConstraints</h4>
<pre>public&nbsp;java.util.List&lt;org.apache.calcite.rel.RelReferentialConstraint&gt;&nbsp;getReferentialConstraints()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getReferentialConstraints</code>&nbsp;in interface&nbsp;<code>org.apache.calcite.schema.Statistic</code></dd>
</dl>
</li>
</ul>
<a name="getCollations--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCollations</h4>
<pre>public&nbsp;java.util.List&lt;org.apache.calcite.rel.RelCollation&gt;&nbsp;getCollations()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getCollations</code>&nbsp;in interface&nbsp;<code>org.apache.calcite.schema.Statistic</code></dd>
</dl>
</li>
</ul>
<a name="getDistribution--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getDistribution</h4>
<pre>public&nbsp;org.apache.calcite.rel.RelDistribution&nbsp;getDistribution()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getDistribution</code>&nbsp;in interface&nbsp;<code>org.apache.calcite.schema.Statistic</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/BeamSqlPipelineOptionsRegistrar.html" title="class in org.apache.beam.sdk.extensions.sql.impl"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/impl/CalciteConnectionWrapper.html" title="class in org.apache.beam.sdk.extensions.sql.impl"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/beam/sdk/extensions/sql/impl/BeamTableStatistics.html" target="_top">Frames</a></li>
<li><a href="BeamTableStatistics.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>