| <!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.6.0_36) on Tue Nov 24 10:06:54 CST 2015 --> |
| <title>WindowState</title> |
| <meta name="date" content="2015-11-24"> |
| <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="WindowState"; |
| } |
| //--> |
| </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/state/impl/WindowConfig$.html" title="class in io.gearpump.streaming.state.impl"><span class="strong">PREV CLASS</span></a></li> |
| <li><a href="../../../../../io/gearpump/streaming/state/impl/WindowState$.html" title="class in io.gearpump.streaming.state.impl"><span class="strong">NEXT CLASS</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?io/gearpump/streaming/state/impl/WindowState.html" target="_top">FRAMES</a></li> |
| <li><a href="WindowState.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"> |
| <p class="subTitle">io.gearpump.streaming.state.impl</p> |
| <h2 title="Class WindowState" class="title">Class WindowState<T></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../io/gearpump/streaming/state/api/MonoidState.html" title="class in io.gearpump.streaming.state.api">io.gearpump.streaming.state.api.MonoidState</a><T></li> |
| <li> |
| <ul class="inheritance"> |
| <li>io.gearpump.streaming.state.impl.WindowState<T></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../io/gearpump/streaming/state/api/PersistentState.html" title="interface in io.gearpump.streaming.state.api">PersistentState</a><T></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <strong>WindowState<T></strong> |
| extends <a href="../../../../../io/gearpump/streaming/state/api/MonoidState.html" title="class in io.gearpump.streaming.state.api">MonoidState</a><T></pre> |
| <div class="block">this is a list of states, each of which is bounded by a time window |
| state of each window doesn't affect each other |
| <p> |
| WindowState requires a Algebird Group to be passed in |
| Group augments Monoid with a minus function which makes it |
| possible to undo the update by messages that have left the window</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="overviewSummary" 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><strong><a href="../../../../../io/gearpump/streaming/state/impl/WindowState.html#WindowState(io.gearpump.streaming.state.api.Group, io.gearpump.streaming.state.api.Serializer, io.gearpump.streaming.task.TaskContext, io.gearpump.streaming.state.impl.Window)">WindowState</a></strong>(<a href="../../../../../io/gearpump/streaming/state/api/Group.html" title="interface in io.gearpump.streaming.state.api">Group</a><<a href="../../../../../io/gearpump/streaming/state/impl/WindowState.html" title="type parameter in WindowState">T</a>> group, |
| <a href="../../../../../io/gearpump/streaming/state/api/Serializer.html" title="interface in io.gearpump.streaming.state.api">Serializer</a><scala.collection.immutable.TreeMap<<a href="../../../../../io/gearpump/streaming/state/impl/Interval.html" title="class in io.gearpump.streaming.state.impl">Interval</a>,<a href="../../../../../io/gearpump/streaming/state/impl/WindowState.html" title="type parameter in WindowState">T</a>>> serializer, |
| <a href="../../../../../io/gearpump/streaming/task/TaskContext.html" title="interface in io.gearpump.streaming.task">TaskContext</a> taskContext, |
| <a href="../../../../../io/gearpump/streaming/state/impl/Window.html" title="class in io.gearpump.streaming.state.impl">Window</a> window)</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </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>byte[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../io/gearpump/streaming/state/impl/WindowState.html#checkpoint()">checkpoint</a></strong>()</code> |
| <div class="block">get a binary snapshot of state |
| usually invoked by the framework</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static org.slf4j.Logger</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../io/gearpump/streaming/state/impl/WindowState.html#LOG()">LOG</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../io/gearpump/streaming/state/impl/WindowState.html#recover(long, byte[])">recover</a></strong>(long timestamp, |
| byte[] bytes)</code> |
| <div class="block">recover state to a previous checkpoint |
| usually invoked by the framework</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../io/gearpump/streaming/state/impl/WindowState.html#update(long, T)">update</a></strong>(long timestamp, |
| <a href="../../../../../io/gearpump/streaming/state/impl/WindowState.html" title="type parameter in WindowState">T</a> t)</code> |
| <div class="block">update state on a new message |
| this is invoked by user</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_io.gearpump.streaming.state.api.MonoidState"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class io.gearpump.streaming.state.api.<a href="../../../../../io/gearpump/streaming/state/api/MonoidState.html" title="class in io.gearpump.streaming.state.api">MonoidState</a></h3> |
| <code><a href="../../../../../io/gearpump/streaming/state/api/MonoidState.html#checkpointTime()">checkpointTime</a>, <a href="../../../../../io/gearpump/streaming/state/api/MonoidState.html#get()">get</a>, <a href="../../../../../io/gearpump/streaming/state/api/MonoidState.html#left()">left</a>, <a href="../../../../../io/gearpump/streaming/state/api/MonoidState.html#right()">right</a>, <a href="../../../../../io/gearpump/streaming/state/api/MonoidState.html#setNextCheckpointTime(long)">setNextCheckpointTime</a>, <a href="../../../../../io/gearpump/streaming/state/api/MonoidState.html#updateState(long, T)">updateState</a></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>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="WindowState(io.gearpump.streaming.state.api.Group, io.gearpump.streaming.state.api.Serializer, io.gearpump.streaming.task.TaskContext, io.gearpump.streaming.state.impl.Window)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>WindowState</h4> |
| <pre>public WindowState(<a href="../../../../../io/gearpump/streaming/state/api/Group.html" title="interface in io.gearpump.streaming.state.api">Group</a><<a href="../../../../../io/gearpump/streaming/state/impl/WindowState.html" title="type parameter in WindowState">T</a>> group, |
| <a href="../../../../../io/gearpump/streaming/state/api/Serializer.html" title="interface in io.gearpump.streaming.state.api">Serializer</a><scala.collection.immutable.TreeMap<<a href="../../../../../io/gearpump/streaming/state/impl/Interval.html" title="class in io.gearpump.streaming.state.impl">Interval</a>,<a href="../../../../../io/gearpump/streaming/state/impl/WindowState.html" title="type parameter in WindowState">T</a>>> serializer, |
| <a href="../../../../../io/gearpump/streaming/task/TaskContext.html" title="interface in io.gearpump.streaming.task">TaskContext</a> taskContext, |
| <a href="../../../../../io/gearpump/streaming/state/impl/Window.html" title="class in io.gearpump.streaming.state.impl">Window</a> window)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="LOG()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>LOG</h4> |
| <pre>public static org.slf4j.Logger LOG()</pre> |
| </li> |
| </ul> |
| <a name="recover(long, byte[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>recover</h4> |
| <pre>public void recover(long timestamp, |
| byte[] bytes)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../io/gearpump/streaming/state/api/PersistentState.html#recover(long, byte[])">PersistentState</a></code></strong></div> |
| <div class="block">recover state to a previous checkpoint |
| usually invoked by the framework</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>timestamp</code> - (undocumented)</dd><dd><code>bytes</code> - (undocumented)</dd></dl> |
| </li> |
| </ul> |
| <a name="update(long,java.lang.Object)"> |
| <!-- --> |
| </a><a name="update(long, T)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>update</h4> |
| <pre>public void update(long timestamp, |
| <a href="../../../../../io/gearpump/streaming/state/impl/WindowState.html" title="type parameter in WindowState">T</a> t)</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../io/gearpump/streaming/state/api/PersistentState.html#update(long, T)">PersistentState</a></code></strong></div> |
| <div class="block">update state on a new message |
| this is invoked by user</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>timestamp</code> - (undocumented)</dd><dd><code>t</code> - (undocumented)</dd></dl> |
| </li> |
| </ul> |
| <a name="checkpoint()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>checkpoint</h4> |
| <pre>public byte[] checkpoint()</pre> |
| <div class="block"><strong>Description copied from interface: <code><a href="../../../../../io/gearpump/streaming/state/api/PersistentState.html#checkpoint()">PersistentState</a></code></strong></div> |
| <div class="block">get a binary snapshot of state |
| usually invoked by the framework</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</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/state/impl/WindowConfig$.html" title="class in io.gearpump.streaming.state.impl"><span class="strong">PREV CLASS</span></a></li> |
| <li><a href="../../../../../io/gearpump/streaming/state/impl/WindowState$.html" title="class in io.gearpump.streaming.state.impl"><span class="strong">NEXT CLASS</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?io/gearpump/streaming/state/impl/WindowState.html" target="_top">FRAMES</a></li> |
| <li><a href="WindowState.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> |
