Google Git
Sign in
apache / incubator-retired-gearpump-site / b1f8f45c651eb06f35685187224db1fb2c81a8de / . / releases / latest / api / java / io / gearpump / streaming / dsl / KVStream.html
blob: 3c2eece4c384b60ad4daa391e0e069c97791b2a9 [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 (version 1.7.0_67) on Thu Feb 04 13:28:39 CST 2016 -->
<title>KVStream</title>
<meta name="date" content="2016-02-04">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="KVStream";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="../../../../io/gearpump/streaming/dsl/CollectionDataSource.html" title="class in io.gearpump.streaming.dsl"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../io/gearpump/streaming/dsl/LoggerSink.html" title="class in io.gearpump.streaming.dsl"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?io/gearpump/streaming/dsl/KVStream.html" target="_top">Frames</a></li>
<li><a href="KVStream.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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">io.gearpump.streaming.dsl</div>
<h2 title="Class KVStream" class="title">Class KVStream&lt;K,V&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>io.gearpump.streaming.dsl.KVStream&lt;K,V&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">KVStream&lt;K,V&gt;</span>
extends java.lang.Object</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../io/gearpump/streaming/dsl/KVStream.html#KVStream(io.gearpump.streaming.dsl.Stream)">KVStream</a></strong>(<a href="../../../../io/gearpump/streaming/dsl/Stream.html" title="class in io.gearpump.streaming.dsl">Stream</a>&lt;scala.Tuple2&lt;<a href="../../../../io/gearpump/streaming/dsl/KVStream.html" title="type parameter in KVStream">K</a>,<a href="../../../../io/gearpump/streaming/dsl/KVStream.html" title="type parameter in KVStream">V</a>&gt;&gt;&nbsp;stream)</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../io/gearpump/streaming/dsl/Stream.html" title="class in io.gearpump.streaming.dsl">Stream</a>&lt;scala.Tuple2&lt;<a href="../../../../io/gearpump/streaming/dsl/KVStream.html" title="type parameter in KVStream">K</a>,<a href="../../../../io/gearpump/streaming/dsl/KVStream.html" title="type parameter in KVStream">V</a>&gt;&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/dsl/KVStream.html#groupByKey(int)">groupByKey</a></strong>(int&nbsp;parallism)</code>
<div class="block">Apply to Stream[Tuple2[K,V}
Group by the key of a KV tuple
For (key, value) will groupby key</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../io/gearpump/streaming/dsl/Stream.html" title="class in io.gearpump.streaming.dsl">Stream</a>&lt;scala.Tuple2&lt;<a href="../../../../io/gearpump/streaming/dsl/KVStream.html" title="type parameter in KVStream">K</a>,<a href="../../../../io/gearpump/streaming/dsl/KVStream.html" title="type parameter in KVStream">V</a>&gt;&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../io/gearpump/streaming/dsl/KVStream.html#sum(scala.math.Numeric)">sum</a></strong>(scala.math.Numeric&lt;<a href="../../../../io/gearpump/streaming/dsl/KVStream.html" title="type parameter in KVStream">V</a>&gt;&nbsp;numeric)</code>
<div class="block">Sum the value of the tuples</div>
</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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="KVStream(io.gearpump.streaming.dsl.Stream)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>KVStream</h4>
<pre>public&nbsp;KVStream(<a href="../../../../io/gearpump/streaming/dsl/Stream.html" title="class in io.gearpump.streaming.dsl">Stream</a>&lt;scala.Tuple2&lt;<a href="../../../../io/gearpump/streaming/dsl/KVStream.html" title="type parameter in KVStream">K</a>,<a href="../../../../io/gearpump/streaming/dsl/KVStream.html" title="type parameter in KVStream">V</a>&gt;&gt;&nbsp;stream)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="groupByKey(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>groupByKey</h4>
<pre>public&nbsp;<a href="../../../../io/gearpump/streaming/dsl/Stream.html" title="class in io.gearpump.streaming.dsl">Stream</a>&lt;scala.Tuple2&lt;<a href="../../../../io/gearpump/streaming/dsl/KVStream.html" title="type parameter in KVStream">K</a>,<a href="../../../../io/gearpump/streaming/dsl/KVStream.html" title="type parameter in KVStream">V</a>&gt;&gt;&nbsp;groupByKey(int&nbsp;parallism)</pre>
<div class="block">Apply to Stream[Tuple2[K,V}
Group by the key of a KV tuple
For (key, value) will groupby key</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parallelism</code> - the parallelism for this operation</dd><dd><code>parallism</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>the new KV stream</dd></dl>
</li>
</ul>
<a name="sum(scala.math.Numeric)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>sum</h4>
<pre>public&nbsp;<a href="../../../../io/gearpump/streaming/dsl/Stream.html" title="class in io.gearpump.streaming.dsl">Stream</a>&lt;scala.Tuple2&lt;<a href="../../../../io/gearpump/streaming/dsl/KVStream.html" title="type parameter in KVStream">K</a>,<a href="../../../../io/gearpump/streaming/dsl/KVStream.html" title="type parameter in KVStream">V</a>&gt;&gt;&nbsp;sum(scala.math.Numeric&lt;<a href="../../../../io/gearpump/streaming/dsl/KVStream.html" title="type parameter in KVStream">V</a>&gt;&nbsp;numeric)</pre>
<div class="block">Sum the value of the tuples
<p>
Apply to Stream[Tuple2[K,V}, V must be of type Number
<p>
For input (key, value1), (key, value2), will generate (key, value1 + value2)</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>numeric</code> - the numeric operations</dd>
<dt><span class="strong">Returns:</span></dt><dd>the sum stream</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="../../../../io/gearpump/streaming/dsl/CollectionDataSource.html" title="class in io.gearpump.streaming.dsl"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../io/gearpump/streaming/dsl/LoggerSink.html" title="class in io.gearpump.streaming.dsl"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?io/gearpump/streaming/dsl/KVStream.html" target="_top">Frames</a></li>
<li><a href="KVStream.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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>