Added: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/operators/windows/AccumulationMode.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/operators/windows/AccumulationMode.html?rev=1784062&view=auto ============================================================================== --- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/operators/windows/AccumulationMode.html (added) +++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/operators/windows/AccumulationMode.html Wed Feb 22 21:01:21 2017 @@ -0,0 +1,348 @@ +<!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_74) on Wed Feb 22 13:00:21 PST 2017 --> +<title>AccumulationMode (samza-api 0.13.0-SNAPSHOT API)</title> +<meta name="date" content="2017-02-22"> +<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="AccumulationMode (samza-api 0.13.0-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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>Prev Class</li> +<li><a href="../../../../../org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/samza/operators/windows/AccumulationMode.html" target="_top">Frames</a></li> +<li><a href="AccumulationMode.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="#enum.constant.summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum.constant.detail">Enum Constants</a> | </li> +<li>Field | </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.samza.operators.windows</div> +<h2 title="Enum AccumulationMode" class="title">Enum AccumulationMode</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Enum<<a href="../../../../../org/apache/samza/operators/windows/AccumulationMode.html" title="enum in org.apache.samza.operators.windows">AccumulationMode</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.samza.operators.windows.AccumulationMode</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../../../org/apache/samza/operators/windows/AccumulationMode.html" title="enum in org.apache.samza.operators.windows">AccumulationMode</a>></dd> +</dl> +<hr> +<br> +<pre>public enum <span class="typeNameLabel">AccumulationMode</span> +extends java.lang.Enum<<a href="../../../../../org/apache/samza/operators/windows/AccumulationMode.html" title="enum in org.apache.samza.operators.windows">AccumulationMode</a>></pre> +<div class="block">Specifies how a <a href="../../../../../org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><code>Window</code></a> should process its previously emitted <a href="../../../../../org/apache/samza/operators/windows/WindowPane.html" title="class in org.apache.samza.operators.windows"><code>WindowPane</code></a>s. + + <p> There are two types of <a href="../../../../../org/apache/samza/operators/windows/AccumulationMode.html" title="enum in org.apache.samza.operators.windows"><code>AccumulationMode</code></a>s: + <ul> + <li> ACCUMULATING: Specifies that window panes should include all messages collected for the window (key) so far, even if they were + included in previously emitted window panes. + <li> DISCARDING: Specifies that window panes should only include messages collected for this window (key) since the last emitted + window pane. + </ul></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum.constant.summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/operators/windows/AccumulationMode.html#ACCUMULATING">ACCUMULATING</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/operators/windows/AccumulationMode.html#DISCARDING">DISCARDING</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="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/samza/operators/windows/AccumulationMode.html" title="enum in org.apache.samza.operators.windows">AccumulationMode</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/operators/windows/AccumulationMode.html#valueOf-java.lang.String-">valueOf</a></span>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/samza/operators/windows/AccumulationMode.html" title="enum in org.apache.samza.operators.windows">AccumulationMode</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/operators/windows/AccumulationMode.html#values--">values</a></span>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Enum</h3> +<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> +</ul> +<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>getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum.constant.detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="ACCUMULATING"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ACCUMULATING</h4> +<pre>public static final <a href="../../../../../org/apache/samza/operators/windows/AccumulationMode.html" title="enum in org.apache.samza.operators.windows">AccumulationMode</a> ACCUMULATING</pre> +</li> +</ul> +<a name="DISCARDING"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DISCARDING</h4> +<pre>public static final <a href="../../../../../org/apache/samza/operators/windows/AccumulationMode.html" title="enum in org.apache.samza.operators.windows">AccumulationMode</a> DISCARDING</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../../../org/apache/samza/operators/windows/AccumulationMode.html" title="enum in org.apache.samza.operators.windows">AccumulationMode</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (AccumulationMode c : AccumulationMode.values()) + System.out.println(c); +</pre></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an array containing the constants of this enum type, in the order they are declared</dd> +</dl> +</li> +</ul> +<a name="valueOf-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../../org/apache/samza/operators/windows/AccumulationMode.html" title="enum in org.apache.samza.operators.windows">AccumulationMode</a> valueOf(java.lang.String name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the enum constant with the specified name</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd> +<dd><code>java.lang.NullPointerException</code> - if the argument is null</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>Prev Class</li> +<li><a href="../../../../../org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/samza/operators/windows/AccumulationMode.html" target="_top">Frames</a></li> +<li><a href="AccumulationMode.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="#enum.constant.summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum.constant.detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
Added: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/operators/windows/Window.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/operators/windows/Window.html?rev=1784062&view=auto ============================================================================== --- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/operators/windows/Window.html (added) +++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/operators/windows/Window.html Wed Feb 22 21:01:21 2017 @@ -0,0 +1,335 @@ +<!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_74) on Wed Feb 22 13:00:21 PST 2017 --> +<title>Window (samza-api 0.13.0-SNAPSHOT API)</title> +<meta name="date" content="2017-02-22"> +<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="Window (samza-api 0.13.0-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":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/samza/operators/windows/AccumulationMode.html" title="enum in org.apache.samza.operators.windows"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/samza/operators/windows/WindowKey.html" title="class in org.apache.samza.operators.windows"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/samza/operators/windows/Window.html" target="_top">Frames</a></li> +<li><a href="Window.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>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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.samza.operators.windows</div> +<h2 title="Interface Window" class="title">Interface Window<M,K,WV></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>M</code> - the type of the input message</dd> +<dd><code>K</code> - the type of the key in the message in this <a href="../../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a>.</dd> +<dd><code>WV</code> - the type of the value in the <a href="../../../../../org/apache/samza/operators/windows/WindowPane.html" title="class in org.apache.samza.operators.windows"><code>WindowPane</code></a>.</dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../org/apache/samza/operators/windows/internal/WindowInternal.html" title="class in org.apache.samza.operators.windows.internal">WindowInternal</a></dd> +</dl> +<hr> +<br> +<pre><a href="../../../../../org/apache/samza/annotation/InterfaceStability.Unstable.html" title="annotation in org.apache.samza.annotation">@InterfaceStability.Unstable</a> +public interface <span class="typeNameLabel">Window<M,K,WV></span></pre> +<div class="block">Groups incoming messages in the <a href="../../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> into finite + windows for processing. + + <p> A window is uniquely identified by its <a href="../../../../../org/apache/samza/operators/windows/WindowKey.html" title="class in org.apache.samza.operators.windows"><code>WindowKey</code></a>. A window can have one or more associated <a href="../../../../../org/apache/samza/operators/triggers/Trigger.html" title="interface in org.apache.samza.operators.triggers"><code>Trigger</code></a>s + that determine when results from the <a href="../../../../../org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><code>Window</code></a> are emitted. + + <p> Each emitted result contains one or more messages in the window and is called a <a href="../../../../../org/apache/samza/operators/windows/WindowPane.html" title="class in org.apache.samza.operators.windows"><code>WindowPane</code></a>. + A pane can include all messages collected for the window so far or only the new messages + since the last emitted pane. (as determined by the <a href="../../../../../org/apache/samza/operators/windows/AccumulationMode.html" title="enum in org.apache.samza.operators.windows"><code>AccumulationMode</code></a>) + + <p> A window can have early triggers that allow emitting <a href="../../../../../org/apache/samza/operators/windows/WindowPane.html" title="class in org.apache.samza.operators.windows"><code>WindowPane</code></a>s speculatively before all data for the window + has arrived or late triggers that allow handling of late data arrivals. + + <p> A <a href="../../../../../org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><code>Window</code></a> is defined as "keyed" when the incoming <a href="../../../../../org/apache/samza/operators/MessageStream.html" title="interface in org.apache.samza.operators"><code>MessageStream</code></a> is first + partitioned based on the provided key, and windowing is applied on the partitioned stream. + + window wk1 (with its triggers) + +--------------------------------+ + ------------+--------+-----------+ + | | | | + | pane 1 |pane2 | pane3 | + +-----------+--------+-----------+ + + ----------------------------------- +incoming message stream ------+ + ----------------------------------- + window wk2 + +---------------------+---------+ + | pane 1| pane 2 | pane 3 | + | | | | + +---------+-----------+---------+ + + window wk3 + +----------+-----------+---------+ + | | | | + | pane 1 | pane 2 | pane 3| + | | | | + +----------+-----------+---------+ + + + <p> Use the <a href="../../../../../org/apache/samza/operators/windows/Windows.html" title="class in org.apache.samza.operators.windows"><code>Windows</code></a> APIs to create various windows and the <a href="../../../../../org/apache/samza/operators/triggers/Triggers.html" title="class in org.apache.samza.operators.triggers"><code>Triggers</code></a> + APIs to create triggers.</div> +</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"> </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></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/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows">Window</a><<a href="../../../../../org/apache/samza/operators/windows/Window.html" title="type parameter in Window">M</a>,<a href="../../../../../org/apache/samza/operators/windows/Window.html" title="type parameter in Window">K</a>,<a href="../../../../../org/apache/samza/operators/windows/Window.html" title="type parameter in Window">WV</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/operators/windows/Window.html#setAccumulationMode-org.apache.samza.operators.windows.AccumulationMode-">setAccumulationMode</a></span>(<a href="../../../../../org/apache/samza/operators/windows/AccumulationMode.html" title="enum in org.apache.samza.operators.windows">AccumulationMode</a> mode)</code> +<div class="block">Specify how a <a href="../../../../../org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><code>Window</code></a> should process its previously emitted <a href="../../../../../org/apache/samza/operators/windows/WindowPane.html" title="class in org.apache.samza.operators.windows"><code>WindowPane</code></a>s.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows">Window</a><<a href="../../../../../org/apache/samza/operators/windows/Window.html" title="type parameter in Window">M</a>,<a href="../../../../../org/apache/samza/operators/windows/Window.html" title="type parameter in Window">K</a>,<a href="../../../../../org/apache/samza/operators/windows/Window.html" title="type parameter in Window">WV</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/operators/windows/Window.html#setEarlyTrigger-org.apache.samza.operators.triggers.Trigger-">setEarlyTrigger</a></span>(<a href="../../../../../org/apache/samza/operators/triggers/Trigger.html" title="interface in org.apache.samza.operators.triggers">Trigger</a><<a href="../../../../../org/apache/samza/operators/windows/Window.html" title="type parameter in Window">M</a>> trigger)</code> +<div class="block">Set the early triggers for this <a href="../../../../../org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><code>Window</code></a>.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows">Window</a><<a href="../../../../../org/apache/samza/operators/windows/Window.html" title="type parameter in Window">M</a>,<a href="../../../../../org/apache/samza/operators/windows/Window.html" title="type parameter in Window">K</a>,<a href="../../../../../org/apache/samza/operators/windows/Window.html" title="type parameter in Window">WV</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/operators/windows/Window.html#setLateTrigger-org.apache.samza.operators.triggers.Trigger-">setLateTrigger</a></span>(<a href="../../../../../org/apache/samza/operators/triggers/Trigger.html" title="interface in org.apache.samza.operators.triggers">Trigger</a><<a href="../../../../../org/apache/samza/operators/windows/Window.html" title="type parameter in Window">M</a>> trigger)</code> +<div class="block">Set the late triggers for this <a href="../../../../../org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><code>Window</code></a>.</div> +</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="setEarlyTrigger-org.apache.samza.operators.triggers.Trigger-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setEarlyTrigger</h4> +<pre><a href="../../../../../org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows">Window</a><<a href="../../../../../org/apache/samza/operators/windows/Window.html" title="type parameter in Window">M</a>,<a href="../../../../../org/apache/samza/operators/windows/Window.html" title="type parameter in Window">K</a>,<a href="../../../../../org/apache/samza/operators/windows/Window.html" title="type parameter in Window">WV</a>> setEarlyTrigger(<a href="../../../../../org/apache/samza/operators/triggers/Trigger.html" title="interface in org.apache.samza.operators.triggers">Trigger</a><<a href="../../../../../org/apache/samza/operators/windows/Window.html" title="type parameter in Window">M</a>> trigger)</pre> +<div class="block">Set the early triggers for this <a href="../../../../../org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><code>Window</code></a>. + <p>Use the <a href="../../../../../org/apache/samza/operators/triggers/Triggers.html" title="class in org.apache.samza.operators.triggers"><code>Triggers</code></a> APIs to create instances of <a href="../../../../../org/apache/samza/operators/triggers/Trigger.html" title="interface in org.apache.samza.operators.triggers"><code>Trigger</code></a></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>trigger</code> - the early trigger</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the <a href="../../../../../org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><code>Window</code></a> function with the early trigger</dd> +</dl> +</li> +</ul> +<a name="setLateTrigger-org.apache.samza.operators.triggers.Trigger-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLateTrigger</h4> +<pre><a href="../../../../../org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows">Window</a><<a href="../../../../../org/apache/samza/operators/windows/Window.html" title="type parameter in Window">M</a>,<a href="../../../../../org/apache/samza/operators/windows/Window.html" title="type parameter in Window">K</a>,<a href="../../../../../org/apache/samza/operators/windows/Window.html" title="type parameter in Window">WV</a>> setLateTrigger(<a href="../../../../../org/apache/samza/operators/triggers/Trigger.html" title="interface in org.apache.samza.operators.triggers">Trigger</a><<a href="../../../../../org/apache/samza/operators/windows/Window.html" title="type parameter in Window">M</a>> trigger)</pre> +<div class="block">Set the late triggers for this <a href="../../../../../org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><code>Window</code></a>. + <p>Use the <a href="../../../../../org/apache/samza/operators/triggers/Triggers.html" title="class in org.apache.samza.operators.triggers"><code>Triggers</code></a> APIs to create instances of <a href="../../../../../org/apache/samza/operators/triggers/Trigger.html" title="interface in org.apache.samza.operators.triggers"><code>Trigger</code></a></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>trigger</code> - the late trigger</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the <a href="../../../../../org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><code>Window</code></a> function with the late trigger</dd> +</dl> +</li> +</ul> +<a name="setAccumulationMode-org.apache.samza.operators.windows.AccumulationMode-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setAccumulationMode</h4> +<pre><a href="../../../../../org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows">Window</a><<a href="../../../../../org/apache/samza/operators/windows/Window.html" title="type parameter in Window">M</a>,<a href="../../../../../org/apache/samza/operators/windows/Window.html" title="type parameter in Window">K</a>,<a href="../../../../../org/apache/samza/operators/windows/Window.html" title="type parameter in Window">WV</a>> setAccumulationMode(<a href="../../../../../org/apache/samza/operators/windows/AccumulationMode.html" title="enum in org.apache.samza.operators.windows">AccumulationMode</a> mode)</pre> +<div class="block">Specify how a <a href="../../../../../org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><code>Window</code></a> should process its previously emitted <a href="../../../../../org/apache/samza/operators/windows/WindowPane.html" title="class in org.apache.samza.operators.windows"><code>WindowPane</code></a>s. + + <p> There are two types of <a href="../../../../../org/apache/samza/operators/windows/AccumulationMode.html" title="enum in org.apache.samza.operators.windows"><code>AccumulationMode</code></a>s: + <ul> + <li> ACCUMULATING: Specifies that window panes should include all messages collected for the window (key) so far, even if they were + included in previously emitted window panes. + <li> DISCARDING: Specifies that window panes should only include messages collected for this window (key) since the last emitted + window pane. + </ul></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>mode</code> - the accumulation mode</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the <a href="../../../../../org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><code>Window</code></a> function with the specified <a href="../../../../../org/apache/samza/operators/windows/AccumulationMode.html" title="enum in org.apache.samza.operators.windows"><code>AccumulationMode</code></a>.</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/samza/operators/windows/AccumulationMode.html" title="enum in org.apache.samza.operators.windows"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/samza/operators/windows/WindowKey.html" title="class in org.apache.samza.operators.windows"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/samza/operators/windows/Window.html" target="_top">Frames</a></li> +<li><a href="Window.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>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> Added: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/operators/windows/WindowKey.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/operators/windows/WindowKey.html?rev=1784062&view=auto ============================================================================== --- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/operators/windows/WindowKey.html (added) +++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/operators/windows/WindowKey.html Wed Feb 22 21:01:21 2017 @@ -0,0 +1,309 @@ +<!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_74) on Wed Feb 22 13:00:21 PST 2017 --> +<title>WindowKey (samza-api 0.13.0-SNAPSHOT API)</title> +<meta name="date" content="2017-02-22"> +<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="WindowKey (samza-api 0.13.0-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10}; +var tabs = {65535:["t0","All 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/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/samza/operators/windows/WindowPane.html" title="class in org.apache.samza.operators.windows"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/samza/operators/windows/WindowKey.html" target="_top">Frames</a></li> +<li><a href="WindowKey.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>Field | </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>Field | </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.samza.operators.windows</div> +<h2 title="Class WindowKey" class="title">Class WindowKey<K></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.samza.operators.windows.WindowKey<K></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>K</code> - the type of the key in the incoming message. + Windows that are not keyed have a <code>Void</code> key type.</dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">WindowKey<K></span> +extends java.lang.Object</pre> +<div class="block">Key for a <a href="../../../../../org/apache/samza/operators/windows/WindowPane.html" title="class in org.apache.samza.operators.windows"><code>WindowPane</code></a> emitted from a <a href="../../../../../org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><code>Window</code></a>.</div> +</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="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/samza/operators/windows/WindowKey.html#WindowKey-K-java.lang.String-">WindowKey</a></span>(<a href="../../../../../org/apache/samza/operators/windows/WindowKey.html" title="type parameter in WindowKey">K</a> key, + java.lang.String windowId)</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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><a href="../../../../../org/apache/samza/operators/windows/WindowKey.html" title="type parameter in WindowKey">K</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/operators/windows/WindowKey.html#getKey--">getKey</a></span>()</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/operators/windows/WindowKey.html#getPaneId--">getPaneId</a></span>()</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/operators/windows/WindowKey.html#toString--">toString</a></span>()</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, 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="WindowKey-java.lang.Object-java.lang.String-"> +<!-- --> +</a><a name="WindowKey-K-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>WindowKey</h4> +<pre>public WindowKey(<a href="../../../../../org/apache/samza/operators/windows/WindowKey.html" title="type parameter in WindowKey">K</a> key, + java.lang.String windowId)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getKey--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getKey</h4> +<pre>public <a href="../../../../../org/apache/samza/operators/windows/WindowKey.html" title="type parameter in WindowKey">K</a> getKey()</pre> +</li> +</ul> +<a name="getPaneId--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPaneId</h4> +<pre>public java.lang.String getPaneId()</pre> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>toString</code> in class <code>java.lang.Object</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/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/samza/operators/windows/WindowPane.html" title="class in org.apache.samza.operators.windows"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/samza/operators/windows/WindowKey.html" target="_top">Frames</a></li> +<li><a href="WindowKey.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>Field | </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>Field | </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> Added: samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/operators/windows/WindowPane.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/operators/windows/WindowPane.html?rev=1784062&view=auto ============================================================================== --- samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/operators/windows/WindowPane.html (added) +++ samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/operators/windows/WindowPane.html Wed Feb 22 21:01:21 2017 @@ -0,0 +1,271 @@ +<!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_74) on Wed Feb 22 13:00:21 PST 2017 --> +<title>WindowPane (samza-api 0.13.0-SNAPSHOT API)</title> +<meta name="date" content="2017-02-22"> +<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="WindowPane (samza-api 0.13.0-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":9}; +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/samza/operators/windows/WindowKey.html" title="class in org.apache.samza.operators.windows"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/samza/operators/windows/Windows.html" title="class in org.apache.samza.operators.windows"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/samza/operators/windows/WindowPane.html" target="_top">Frames</a></li> +<li><a href="WindowPane.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>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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.samza.operators.windows</div> +<h2 title="Class WindowPane" class="title">Class WindowPane<K,V></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.samza.operators.windows.WindowPane<K,V></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>K</code> - the type of key in the window pane</dd> +<dd><code>V</code> - the type of value in the window pane.</dd> +</dl> +<hr> +<br> +<pre>public final class <span class="typeNameLabel">WindowPane<K,V></span> +extends java.lang.Object</pre> +<div class="block">Specifies the result emitted from a <a href="../../../../../org/apache/samza/operators/windows/Window.html" title="interface in org.apache.samza.operators.windows"><code>Window</code></a>.</div> +</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"> </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="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><a href="../../../../../org/apache/samza/operators/windows/WindowKey.html" title="class in org.apache.samza.operators.windows">WindowKey</a><<a href="../../../../../org/apache/samza/operators/windows/WindowPane.html" title="type parameter in WindowPane">K</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/operators/windows/WindowPane.html#getKey--">getKey</a></span>()</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/samza/operators/windows/WindowPane.html" title="type parameter in WindowPane">V</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/operators/windows/WindowPane.html#getMessage--">getMessage</a></span>()</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static <K,M> <a href="../../../../../org/apache/samza/operators/windows/WindowPane.html" title="class in org.apache.samza.operators.windows">WindowPane</a><K,M></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/operators/windows/WindowPane.html#of-org.apache.samza.operators.windows.WindowKey-M-">of</a></span>(<a href="../../../../../org/apache/samza/operators/windows/WindowKey.html" title="class in org.apache.samza.operators.windows">WindowKey</a><K> key, + M result)</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"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getMessage--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMessage</h4> +<pre>public <a href="../../../../../org/apache/samza/operators/windows/WindowPane.html" title="type parameter in WindowPane">V</a> getMessage()</pre> +</li> +</ul> +<a name="getKey--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getKey</h4> +<pre>public <a href="../../../../../org/apache/samza/operators/windows/WindowKey.html" title="class in org.apache.samza.operators.windows">WindowKey</a><<a href="../../../../../org/apache/samza/operators/windows/WindowPane.html" title="type parameter in WindowPane">K</a>> getKey()</pre> +</li> +</ul> +<a name="of-org.apache.samza.operators.windows.WindowKey-java.lang.Object-"> +<!-- --> +</a><a name="of-org.apache.samza.operators.windows.WindowKey-M-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>of</h4> +<pre>public static <K,M> <a href="../../../../../org/apache/samza/operators/windows/WindowPane.html" title="class in org.apache.samza.operators.windows">WindowPane</a><K,M> of(<a href="../../../../../org/apache/samza/operators/windows/WindowKey.html" title="class in org.apache.samza.operators.windows">WindowKey</a><K> key, + M result)</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/samza/operators/windows/WindowKey.html" title="class in org.apache.samza.operators.windows"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/samza/operators/windows/Windows.html" title="class in org.apache.samza.operators.windows"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/samza/operators/windows/WindowPane.html" target="_top">Frames</a></li> +<li><a href="WindowPane.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>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>