| <!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 Mon Jan 27 16:42:31 PST 2020 --> |
| <title>NodeStats (Apache Beam 2.20.0-SNAPSHOT)</title> |
| <meta name="date" content="2020-01-27"> |
| <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="NodeStats (Apache Beam 2.20.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":6,"i3":6,"i4":6,"i5":10,"i6":10,"i7":10,"i8":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/planner/BeamRuleSets.html" title="class in org.apache.beam.sdk.extensions.sql.impl.planner"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/planner/NodeStatsMetadata.html" title="interface in org.apache.beam.sdk.extensions.sql.impl.planner"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../index.html?org/apache/beam/sdk/extensions/sql/impl/planner/NodeStats.html" target="_top">Frames</a></li> |
| <li><a href="NodeStats.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.planner</div> |
| <h2 title="Class NodeStats" class="title">Class NodeStats</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.planner.NodeStats</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">NodeStats</span> |
| extends java.lang.Object</pre> |
| <div class="block">This is a utility class to represent rowCount, rate and window.</div> |
| </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"> </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/planner/NodeStats.html" title="class in org.apache.beam.sdk.extensions.sql.impl.planner">NodeStats</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/planner/NodeStats.html#UNKNOWN">UNKNOWN</a></span></code> |
| <div class="block">Returns an instance with all values set to INFINITY.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/planner/NodeStats.html#NodeStats--">NodeStats</a></span>()</code> </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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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/planner/NodeStats.html" title="class in org.apache.beam.sdk.extensions.sql.impl.planner">NodeStats</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/planner/NodeStats.html#create-double-">create</a></span>(double rowCount)</code> |
| <div class="block">It creates an instance with rate=0 and window=rowCount for bounded sources.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/planner/NodeStats.html" title="class in org.apache.beam.sdk.extensions.sql.impl.planner">NodeStats</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/planner/NodeStats.html#create-double-double-double-">create</a></span>(double rowCount, |
| double rate, |
| double window)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>abstract double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/planner/NodeStats.html#getRate--">getRate</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>abstract double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/planner/NodeStats.html#getRowCount--">getRowCount</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>abstract double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/planner/NodeStats.html#getWindow--">getWindow</a></span>()</code> |
| <div class="block">This method returns the number of tuples in each window.</div> |
| </td> |
| </tr> |
| <tr id="i5" 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/planner/NodeStats.html#isUnknown--">isUnknown</a></span>()</code> |
| <div class="block">If any of the values for rowCount, rate or window is infinite, it returns true.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/planner/NodeStats.html" title="class in org.apache.beam.sdk.extensions.sql.impl.planner">NodeStats</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/planner/NodeStats.html#minus-org.apache.beam.sdk.extensions.sql.impl.planner.NodeStats-">minus</a></span>(<a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/planner/NodeStats.html" title="class in org.apache.beam.sdk.extensions.sql.impl.planner">NodeStats</a> that)</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/planner/NodeStats.html" title="class in org.apache.beam.sdk.extensions.sql.impl.planner">NodeStats</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/planner/NodeStats.html#multiply-double-">multiply</a></span>(double factor)</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/planner/NodeStats.html" title="class in org.apache.beam.sdk.extensions.sql.impl.planner">NodeStats</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/planner/NodeStats.html#plus-org.apache.beam.sdk.extensions.sql.impl.planner.NodeStats-">plus</a></span>(<a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/planner/NodeStats.html" title="class in org.apache.beam.sdk.extensions.sql.impl.planner">NodeStats</a> that)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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="blockListLast"> |
| <li class="blockList"> |
| <h4>UNKNOWN</h4> |
| <pre>public static final <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/planner/NodeStats.html" title="class in org.apache.beam.sdk.extensions.sql.impl.planner">NodeStats</a> UNKNOWN</pre> |
| <div class="block">Returns an instance with all values set to INFINITY. This will be only used when the node is |
| not a BeamRelNode and we don't have an estimation implementation for it in the metadata |
| handler. In this case we return INFINITE and it will be propagated up in the estimates.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="NodeStats--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>NodeStats</h4> |
| <pre>public NodeStats()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getRowCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRowCount</h4> |
| <pre>public abstract double getRowCount()</pre> |
| </li> |
| </ul> |
| <a name="getRate--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRate</h4> |
| <pre>public abstract double getRate()</pre> |
| </li> |
| </ul> |
| <a name="getWindow--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWindow</h4> |
| <pre>public abstract double getWindow()</pre> |
| <div class="block">This method returns the number of tuples in each window. It is different than the windowing |
| notion of Beam.</div> |
| </li> |
| </ul> |
| <a name="create-double-double-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>public static <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/planner/NodeStats.html" title="class in org.apache.beam.sdk.extensions.sql.impl.planner">NodeStats</a> create(double rowCount, |
| double rate, |
| double window)</pre> |
| </li> |
| </ul> |
| <a name="create-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>public static <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/planner/NodeStats.html" title="class in org.apache.beam.sdk.extensions.sql.impl.planner">NodeStats</a> create(double rowCount)</pre> |
| <div class="block">It creates an instance with rate=0 and window=rowCount for bounded sources.</div> |
| </li> |
| </ul> |
| <a name="isUnknown--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isUnknown</h4> |
| <pre>public boolean isUnknown()</pre> |
| <div class="block">If any of the values for rowCount, rate or window is infinite, it returns true.</div> |
| </li> |
| </ul> |
| <a name="multiply-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>multiply</h4> |
| <pre>public <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/planner/NodeStats.html" title="class in org.apache.beam.sdk.extensions.sql.impl.planner">NodeStats</a> multiply(double factor)</pre> |
| </li> |
| </ul> |
| <a name="plus-org.apache.beam.sdk.extensions.sql.impl.planner.NodeStats-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>plus</h4> |
| <pre>public <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/planner/NodeStats.html" title="class in org.apache.beam.sdk.extensions.sql.impl.planner">NodeStats</a> plus(<a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/planner/NodeStats.html" title="class in org.apache.beam.sdk.extensions.sql.impl.planner">NodeStats</a> that)</pre> |
| </li> |
| </ul> |
| <a name="minus-org.apache.beam.sdk.extensions.sql.impl.planner.NodeStats-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>minus</h4> |
| <pre>public <a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/planner/NodeStats.html" title="class in org.apache.beam.sdk.extensions.sql.impl.planner">NodeStats</a> minus(<a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/planner/NodeStats.html" title="class in org.apache.beam.sdk.extensions.sql.impl.planner">NodeStats</a> that)</pre> |
| </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/planner/BeamRuleSets.html" title="class in org.apache.beam.sdk.extensions.sql.impl.planner"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../../../org/apache/beam/sdk/extensions/sql/impl/planner/NodeStatsMetadata.html" title="interface in org.apache.beam.sdk.extensions.sql.impl.planner"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../../index.html?org/apache/beam/sdk/extensions/sql/impl/planner/NodeStats.html" target="_top">Frames</a></li> |
| <li><a href="NodeStats.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
