blob: 7eeeabd9b730b1f24ac70e45a22de916eca2ad62 [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 -->
<title>NamedAggregators.State (Apache Beam 2.38.0-SNAPSHOT)</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="NamedAggregators.State (Apache Beam 2.38.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/runners/spark/aggregators/NamedAggregators.html" title="class in org.apache.beam.runners.spark.aggregators"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregatorsAccumulator.html" title="class in org.apache.beam.runners.spark.aggregators"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html" target="_top">Frames</a></li>
<li><a href="NamedAggregators.State.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>Field&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>Field&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.runners.spark.aggregators</div>
<h2 title="Interface NamedAggregators.State" class="title">Interface NamedAggregators.State&lt;InputT,InterT,OutputT&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>InputT</code> - Input data type</dd>
<dd><code>InterT</code> - Intermediate data type (useful for averages)</dd>
<dd><code>OutputT</code> - Output data type</dd>
</dl>
<dl>
<dt>All Superinterfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.html" title="class in org.apache.beam.runners.spark.aggregators">NamedAggregators</a></dd>
</dl>
<hr>
<br>
<pre>public static interface <span class="typeNameLabel">NamedAggregators.State&lt;InputT,InterT,OutputT&gt;</span>
extends java.io.Serializable</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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><a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html" title="type parameter in NamedAggregators.State">InterT</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html#current--">current</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms">Combine.CombineFn</a>&lt;<a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html" title="type parameter in NamedAggregators.State">InputT</a>,<a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html" title="type parameter in NamedAggregators.State">InterT</a>,<a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html" title="type parameter in NamedAggregators.State">OutputT</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html#getCombineFn--">getCombineFn</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html" title="interface in org.apache.beam.runners.spark.aggregators">NamedAggregators.State</a>&lt;<a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html" title="type parameter in NamedAggregators.State">InputT</a>,<a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html" title="type parameter in NamedAggregators.State">InterT</a>,<a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html" title="type parameter in NamedAggregators.State">OutputT</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html#merge-org.apache.beam.runners.spark.aggregators.NamedAggregators.State-">merge</a></span>(<a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html" title="interface in org.apache.beam.runners.spark.aggregators">NamedAggregators.State</a>&lt;<a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html" title="type parameter in NamedAggregators.State">InputT</a>,<a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html" title="type parameter in NamedAggregators.State">InterT</a>,<a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html" title="type parameter in NamedAggregators.State">OutputT</a>&gt;&nbsp;other)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html" title="type parameter in NamedAggregators.State">OutputT</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html#render--">render</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html#update-InputT-">update</a></span>(<a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html" title="type parameter in NamedAggregators.State">InputT</a>&nbsp;element)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="update-java.lang.Object-">
<!-- -->
</a><a name="update-InputT-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>update</h4>
<pre>void&nbsp;update(<a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html" title="type parameter in NamedAggregators.State">InputT</a>&nbsp;element)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>element</code> - new element to update state</dd>
</dl>
</li>
</ul>
<a name="merge-org.apache.beam.runners.spark.aggregators.NamedAggregators.State-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>merge</h4>
<pre><a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html" title="interface in org.apache.beam.runners.spark.aggregators">NamedAggregators.State</a>&lt;<a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html" title="type parameter in NamedAggregators.State">InputT</a>,<a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html" title="type parameter in NamedAggregators.State">InterT</a>,<a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html" title="type parameter in NamedAggregators.State">OutputT</a>&gt;&nbsp;merge(<a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html" title="interface in org.apache.beam.runners.spark.aggregators">NamedAggregators.State</a>&lt;<a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html" title="type parameter in NamedAggregators.State">InputT</a>,<a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html" title="type parameter in NamedAggregators.State">InterT</a>,<a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html" title="type parameter in NamedAggregators.State">OutputT</a>&gt;&nbsp;other)</pre>
</li>
</ul>
<a name="current--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>current</h4>
<pre><a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html" title="type parameter in NamedAggregators.State">InterT</a>&nbsp;current()</pre>
</li>
</ul>
<a name="render--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>render</h4>
<pre><a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html" title="type parameter in NamedAggregators.State">OutputT</a>&nbsp;render()</pre>
</li>
</ul>
<a name="getCombineFn--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getCombineFn</h4>
<pre><a href="../../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms">Combine.CombineFn</a>&lt;<a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html" title="type parameter in NamedAggregators.State">InputT</a>,<a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html" title="type parameter in NamedAggregators.State">InterT</a>,<a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html" title="type parameter in NamedAggregators.State">OutputT</a>&gt;&nbsp;getCombineFn()</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/runners/spark/aggregators/NamedAggregators.html" title="class in org.apache.beam.runners.spark.aggregators"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/beam/runners/spark/aggregators/NamedAggregatorsAccumulator.html" title="class in org.apache.beam.runners.spark.aggregators"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/runners/spark/aggregators/NamedAggregators.State.html" target="_top">Frames</a></li>
<li><a href="NamedAggregators.State.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>Field&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>Field&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>