| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <META NAME="ROBOTS" CONTENT="NOINDEX"> |
| <link rel="canonical" href="https://ignite.apache.org/releases/1.0.0-rc3/javadoc/org/apache/ignite/streamer/StreamerWindow.html" /> |
| <!-- Generated by javadoc (version 1.7.0_21) on Tue Mar 24 10:27:31 MSK 2015 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>StreamerWindow (Ignite 1.0.0-RC3)</title> |
| <meta name="date" content="2015-03-24"> |
| <link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style"> |
| <link rel='shortcut icon' href='http://gridgain.com/wp-content/uploads/2014/09/favicon.ico'/> |
| <link type='text/css' rel='stylesheet' href='http://gridgain.com/wp-content/plugins/syntaxhighlighter/syntaxhighlighter3/styles/shCore.css'/> |
| <link type='text/css' rel='stylesheet' href='http://gridgain.com/wp-content/plugins/syntaxhighlighter/syntaxhighlighter3/styles/shThemeDefault.css'/> |
| <script type='text/javascript' src='http://gridgain.com/wp-content/plugins/syntaxhighlighter/syntaxhighlighter3/scripts/shCore.js'></script> |
| <script type='text/javascript' src='http://gridgain.com/wp-content/plugins/syntaxhighlighter/syntaxhighlighter3/scripts/shLegacy.js'></script> |
| <script type='text/javascript' src='http://gridgain.com/wp-content/plugins/syntaxhighlighter/syntaxhighlighter3/scripts/shBrushJava.js'></script> |
| <script type='text/javascript' src='http://gridgain.com/wp-content/plugins/syntaxhighlighter/syntaxhighlighter3/scripts/shBrushPlain.js'></script> |
| <script type='text/javascript' src='http://gridgain.com/wp-content/plugins/syntaxhighlighter/syntaxhighlighter3/scripts/shBrushJScript.js'></script> |
| <script type='text/javascript' src='http://gridgain.com/wp-content/plugins/syntaxhighlighter/syntaxhighlighter3/scripts/shBrushBash.js'></script> |
| <script type='text/javascript' src='http://gridgain.com/wp-content/plugins/syntaxhighlighter/syntaxhighlighter3/scripts/shBrushXml.js'></script> |
| <script type='text/javascript' src='http://gridgain.com/wp-content/plugins/syntaxhighlighter/syntaxhighlighter3/scripts/shBrushScala.js'></script> |
| <script type='text/javascript' src='http://gridgain.com/wp-content/plugins/syntaxhighlighter/syntaxhighlighter3/scripts/shBrushGroovy.js'></script> |
| |
| <script> |
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ |
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), |
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) |
| })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); |
| |
| ga('create', 'UA-61232409-1', 'auto'); |
| ga('send', 'pageview'); |
| |
| </script></head> |
| |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="StreamerWindow (Ignite 1.0.0-RC3)"; |
| } |
| //--> |
| </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="class-use/StreamerWindow.html">Use</a></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 class="aboutLanguage"><em>Apache Ignite - In-Memory Data Fabric</em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/ignite/streamer/StreamerStageMetrics.html" title="interface in org.apache.ignite.streamer"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/ignite/streamer/StreamerWindowMBean.html" title="interface in org.apache.ignite.streamer"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/ignite/streamer/StreamerWindow.html" target="_top">Frames</a></li> |
| <li><a href="StreamerWindow.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.ignite.streamer</div> |
| <h2 title="Interface StreamerWindow" class="title">Interface StreamerWindow<span class='angle_bracket'><</span>E<span class='angle_bracket'>></span></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><span class='angle_bracket'><</span>E<span class='angle_bracket'>></span></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/ignite/streamer/window/StreamerBoundedSizeBatchWindow.html" title="class in org.apache.ignite.streamer.window">StreamerBoundedSizeBatchWindow</a>, <a href="../../../../org/apache/ignite/streamer/window/StreamerBoundedSizeSortedWindow.html" title="class in org.apache.ignite.streamer.window">StreamerBoundedSizeSortedWindow</a>, <a href="../../../../org/apache/ignite/streamer/window/StreamerBoundedSizeWindow.html" title="class in org.apache.ignite.streamer.window">StreamerBoundedSizeWindow</a>, <a href="../../../../org/apache/ignite/streamer/window/StreamerBoundedTimeBatchWindow.html" title="class in org.apache.ignite.streamer.window">StreamerBoundedTimeBatchWindow</a>, <a href="../../../../org/apache/ignite/streamer/window/StreamerBoundedTimeWindow.html" title="class in org.apache.ignite.streamer.window">StreamerBoundedTimeWindow</a>, <a href="../../../../org/apache/ignite/streamer/window/StreamerUnboundedWindow.html" title="class in org.apache.ignite.streamer.window">StreamerUnboundedWindow</a>, <a href="../../../../org/apache/ignite/streamer/window/StreamerWindowAdapter.html" title="class in org.apache.ignite.streamer.window">StreamerWindowAdapter</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">StreamerWindow<span class='angle_bracket'><</span>E<span class='angle_bracket'>></span></span> |
| extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><span class='angle_bracket'><</span>E<span class='angle_bracket'>></span></pre> |
| <div class="block">Streamer rolling window. Rolling windows allow new event to come in, as well as automatically |
| evicting obsolete events on the other side. Windows allow to query into specific time-frame |
| or specific sample size of the events. With windows, you can answer questions like "What |
| are my top 10 best selling products over last 24 hours?", or "Who are my top 10 users out of |
| last 1,000,000 users who logged in?" |
| <p> |
| Ignite comes with following rolling windows implementations out of the box: |
| <ul> |
| <li><a href="../../../../org/apache/ignite/streamer/window/StreamerUnboundedWindow.html" title="class in org.apache.ignite.streamer.window"><code>StreamerUnboundedWindow</code></a></li> |
| <li><a href="../../../../org/apache/ignite/streamer/window/StreamerBoundedSizeWindow.html" title="class in org.apache.ignite.streamer.window"><code>StreamerBoundedSizeWindow</code></a></li> |
| <li><a href="../../../../org/apache/ignite/streamer/window/StreamerBoundedSizeBatchWindow.html" title="class in org.apache.ignite.streamer.window"><code>StreamerBoundedSizeBatchWindow</code></a></li> |
| <li><a href="../../../../org/apache/ignite/streamer/window/StreamerBoundedSizeSortedWindow.html" title="class in org.apache.ignite.streamer.window"><code>StreamerBoundedSizeSortedWindow</code></a></li> |
| <li><a href="../../../../org/apache/ignite/streamer/window/StreamerBoundedTimeWindow.html" title="class in org.apache.ignite.streamer.window"><code>StreamerBoundedTimeWindow</code></a></li> |
| <li><a href="../../../../org/apache/ignite/streamer/window/StreamerBoundedTimeBatchWindow.html" title="class in org.apache.ignite.streamer.window"><code>StreamerBoundedTimeBatchWindow</code></a></li> |
| </ul> |
| <p> |
| Streamer window is configured via <a href="../../../../org/apache/ignite/streamer/StreamerConfiguration.html#getWindows()"><code>StreamerConfiguration.getWindows()</code></a> method.</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="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>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html#clearEvicted()">clearEvicted</a></strong>()</code> |
| <div class="block">Clears all evicted entries.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html" title="type parameter in StreamerWindow">E</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html#dequeue()">dequeue</a></strong>()</code> |
| <div class="block">Dequeues last element from windows.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'><</span><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html" title="type parameter in StreamerWindow">E</a><span class='angle_bracket'>></span></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html#dequeue(int)">dequeue</a></strong>(int cnt)</code> |
| <div class="block">Dequeues up to <code>cnt</code> elements from window.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'><</span><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html" title="type parameter in StreamerWindow">E</a><span class='angle_bracket'>></span></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html#dequeueAll()">dequeueAll</a></strong>()</code> |
| <div class="block">Dequeues all elements from window.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html#enqueue(E...)">enqueue</a></strong>(<a href="../../../../org/apache/ignite/streamer/StreamerWindow.html" title="type parameter in StreamerWindow">E</a>... evts)</code> |
| <div class="block">Adds events to window.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html#enqueue(E)">enqueue</a></strong>(<a href="../../../../org/apache/ignite/streamer/StreamerWindow.html" title="type parameter in StreamerWindow">E</a> evt)</code> |
| <div class="block">Adds single event to window.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html#enqueueAll(java.util.Collection)">enqueueAll</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'><</span><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html" title="type parameter in StreamerWindow">E</a><span class='angle_bracket'>></span> evts)</code> |
| <div class="block">Adds all events to window.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html#evictionQueueSize()">evictionQueueSize</a></strong>()</code> |
| <div class="block">Gets number of entries available for eviction.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><span class='angle_bracket'><</span>K,V<span class='angle_bracket'>></span> <a href="../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="interface in org.apache.ignite.streamer.index">StreamerIndex</a><span class='angle_bracket'><</span><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html" title="type parameter in StreamerWindow">E</a>,K,V<span class='angle_bracket'>></span></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html#index()">index</a></strong>()</code> |
| <div class="block">Gets default index, if default index is not configured then |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang"><code>IllegalArgumentException</code></a> will be thrown.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><span class='angle_bracket'><</span>K,V<span class='angle_bracket'>></span> <a href="../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="interface in org.apache.ignite.streamer.index">StreamerIndex</a><span class='angle_bracket'><</span><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html" title="type parameter in StreamerWindow">E</a>,K,V<span class='angle_bracket'>></span></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html#index(java.lang.String)">index</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Gets index by name, if not index with such name was configured then |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang"><code>IllegalArgumentException</code></a> will be thrown.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'><</span><a href="../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="interface in org.apache.ignite.streamer.index">StreamerIndex</a><span class='angle_bracket'><</span><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html" title="type parameter in StreamerWindow">E</a>,?,?<span class='angle_bracket'>></span><span class='angle_bracket'>></span></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html#indexes()">indexes</a></strong>()</code> |
| <div class="block">Gets all indexes configured for this window.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html#name()">name</a></strong>()</code> |
| <div class="block">Gets window name.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html" title="type parameter in StreamerWindow">E</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html#pollEvicted()">pollEvicted</a></strong>()</code> |
| <div class="block">If window supports eviction, this method will return next evicted element.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'><</span><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html" title="type parameter in StreamerWindow">E</a><span class='angle_bracket'>></span></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html#pollEvicted(int)">pollEvicted</a></strong>(int cnt)</code> |
| <div class="block">If window supports eviction, this method will return up to <code>cnt</code> evicted elements.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'><</span><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html" title="type parameter in StreamerWindow">E</a><span class='angle_bracket'>></span></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html#pollEvictedAll()">pollEvictedAll</a></strong>()</code> |
| <div class="block">If window supports eviction, this method will return all available evicted elements.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'><</span><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html" title="type parameter in StreamerWindow">E</a><span class='angle_bracket'>></span></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html#pollEvictedBatch()">pollEvictedBatch</a></strong>()</code> |
| <div class="block">If window supports batch eviction, this method will poll next evicted batch from window.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html#reset()">reset</a></strong>()</code> |
| <div class="block">Resets window.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html#size()">size</a></strong>()</code> |
| <div class="block">Gets number of events currently stored in window.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'><</span><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html" title="type parameter in StreamerWindow">E</a><span class='angle_bracket'>></span></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html#snapshot(boolean)">snapshot</a></strong>(boolean includeIvicted)</code> |
| <div class="block">Create window snapshot.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Iterable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a></h3> |
| <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true#iterator()" title="class or interface in java.lang">iterator</a></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="name()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>name</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name()</pre> |
| <div class="block">Gets window name.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Window name.</dd></dl> |
| </li> |
| </ul> |
| <a name="index()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>index</h4> |
| <pre><span class='angle_bracket'><</span>K,V<span class='angle_bracket'>></span> <a href="../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="interface in org.apache.ignite.streamer.index">StreamerIndex</a><span class='angle_bracket'><</span><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html" title="type parameter in StreamerWindow">E</a>,K,V<span class='angle_bracket'>></span> index()</pre> |
| <div class="block">Gets default index, if default index is not configured then |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang"><code>IllegalArgumentException</code></a> will be thrown.</div> |
| <dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>K</code> - Type of the index key.</dd><dd><code>V</code> - Type of the index value.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Index with default name.</dd></dl> |
| </li> |
| </ul> |
| <a name="index(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>index</h4> |
| <pre><span class='angle_bracket'><</span>K,V<span class='angle_bracket'>></span> <a href="../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="interface in org.apache.ignite.streamer.index">StreamerIndex</a><span class='angle_bracket'><</span><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html" title="type parameter in StreamerWindow">E</a>,K,V<span class='angle_bracket'>></span> index(@Nullable |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block">Gets index by name, if not index with such name was configured then |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang"><code>IllegalArgumentException</code></a> will be thrown.</div> |
| <dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>K</code> - Type of the index key.</dd><dd><code>V</code> - Type of the index value.</dd><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Name of the index, if <code>null</code> then analogous to <a href="../../../../org/apache/ignite/streamer/StreamerWindow.html#index()"><code>index()</code></a>.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Index with a given name.</dd></dl> |
| </li> |
| </ul> |
| <a name="indexes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>indexes</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'><</span><a href="../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="interface in org.apache.ignite.streamer.index">StreamerIndex</a><span class='angle_bracket'><</span><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html" title="type parameter in StreamerWindow">E</a>,?,?<span class='angle_bracket'>></span><span class='angle_bracket'>></span> indexes()</pre> |
| <div class="block">Gets all indexes configured for this window.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>All indexes configured for this window or empty collection, if no |
| indexes were configured.</dd></dl> |
| </li> |
| </ul> |
| <a name="reset()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reset</h4> |
| <pre>void reset()</pre> |
| <div class="block">Resets window. Usually will clear all events from window.</div> |
| </li> |
| </ul> |
| <a name="size()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>size</h4> |
| <pre>int size()</pre> |
| <div class="block">Gets number of events currently stored in window.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Current size of the window.</dd></dl> |
| </li> |
| </ul> |
| <a name="evictionQueueSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>evictionQueueSize</h4> |
| <pre>int evictionQueueSize()</pre> |
| <div class="block">Gets number of entries available for eviction.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Number of entries available for eviction.</dd></dl> |
| </li> |
| </ul> |
| <a name="enqueue(java.lang.Object)"> |
| <!-- --> |
| </a><a name="enqueue(E)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>enqueue</h4> |
| <pre>boolean enqueue(<a href="../../../../org/apache/ignite/streamer/StreamerWindow.html" title="type parameter in StreamerWindow">E</a> evt) |
| throws <a href="../../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></pre> |
| <div class="block">Adds single event to window.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>evt</code> - Event to add.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd><code>True</code> if event was added.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></code> - If index update failed.</dd></dl> |
| </li> |
| </ul> |
| <a name="enqueue(java.lang.Object[])"> |
| <!-- --> |
| </a><a name="enqueue(E...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>enqueue</h4> |
| <pre>boolean enqueue(<a href="../../../../org/apache/ignite/streamer/StreamerWindow.html" title="type parameter in StreamerWindow">E</a>... evts) |
| throws <a href="../../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></pre> |
| <div class="block">Adds events to window.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>evts</code> - Events to add.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd><code></code></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></code> - If index update failed.</dd></dl> |
| </li> |
| </ul> |
| <a name="enqueueAll(java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>enqueueAll</h4> |
| <pre>boolean enqueueAll(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'><</span><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html" title="type parameter in StreamerWindow">E</a><span class='angle_bracket'>></span> evts) |
| throws <a href="../../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></pre> |
| <div class="block">Adds all events to window.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>evts</code> - Collection of events to add.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd><code>True</code> if all events were added, <code>false</code> if at |
| least 1 event was skipped.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></code> - If index update failed.</dd></dl> |
| </li> |
| </ul> |
| <a name="dequeue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dequeue</h4> |
| <pre>@Nullable |
| <a href="../../../../org/apache/ignite/streamer/StreamerWindow.html" title="type parameter in StreamerWindow">E</a> dequeue() |
| throws <a href="../../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></pre> |
| <div class="block">Dequeues last element from windows. Will return <code>null</code> if window is empty.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Dequeued element.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></code> - If index update failed.</dd></dl> |
| </li> |
| </ul> |
| <a name="dequeue(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dequeue</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'><</span><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html" title="type parameter in StreamerWindow">E</a><span class='angle_bracket'>></span> dequeue(int cnt) |
| throws <a href="../../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></pre> |
| <div class="block">Dequeues up to <code>cnt</code> elements from window. If current window size is less than <code>cnt</code>, |
| will dequeue all elements from window.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>cnt</code> - Count to dequeue.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Collection of dequeued elements.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></code> - If index update failed.</dd></dl> |
| </li> |
| </ul> |
| <a name="dequeueAll()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dequeueAll</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'><</span><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html" title="type parameter in StreamerWindow">E</a><span class='angle_bracket'>></span> dequeueAll() |
| throws <a href="../../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></pre> |
| <div class="block">Dequeues all elements from window.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Collection of dequeued elements.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></code> - If index update failed.</dd></dl> |
| </li> |
| </ul> |
| <a name="pollEvicted()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pollEvicted</h4> |
| <pre>@Nullable |
| <a href="../../../../org/apache/ignite/streamer/StreamerWindow.html" title="type parameter in StreamerWindow">E</a> pollEvicted() |
| throws <a href="../../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></pre> |
| <div class="block">If window supports eviction, this method will return next evicted element.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Polls and returns next evicted event or <code>null</code> if eviction queue is empty or if |
| window does not support eviction.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></code> - If index update failed.</dd></dl> |
| </li> |
| </ul> |
| <a name="pollEvicted(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pollEvicted</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'><</span><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html" title="type parameter in StreamerWindow">E</a><span class='angle_bracket'>></span> pollEvicted(int cnt) |
| throws <a href="../../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></pre> |
| <div class="block">If window supports eviction, this method will return up to <code>cnt</code> evicted elements.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>cnt</code> - Number of elements to evict.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Collection of evicted elements.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></code> - If index update failed.</dd></dl> |
| </li> |
| </ul> |
| <a name="pollEvictedBatch()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pollEvictedBatch</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'><</span><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html" title="type parameter in StreamerWindow">E</a><span class='angle_bracket'>></span> pollEvictedBatch() |
| throws <a href="../../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></pre> |
| <div class="block">If window supports batch eviction, this method will poll next evicted batch from window. |
| If windows does not support batch eviction but supports eviction, will return collection of single |
| last evicted element. |
| If window does not support eviction, will return empty collection.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Next evicted batch.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></code> - If index update failed.</dd></dl> |
| </li> |
| </ul> |
| <a name="pollEvictedAll()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pollEvictedAll</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'><</span><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html" title="type parameter in StreamerWindow">E</a><span class='angle_bracket'>></span> pollEvictedAll() |
| throws <a href="../../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></pre> |
| <div class="block">If window supports eviction, this method will return all available evicted elements.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>Collection of evicted elements.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></code> - If index update failed.</dd></dl> |
| </li> |
| </ul> |
| <a name="clearEvicted()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearEvicted</h4> |
| <pre>void clearEvicted() |
| throws <a href="../../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></pre> |
| <div class="block">Clears all evicted entries.</div> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></code> - If index update failed.</dd></dl> |
| </li> |
| </ul> |
| <a name="snapshot(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>snapshot</h4> |
| <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><span class='angle_bracket'><</span><a href="../../../../org/apache/ignite/streamer/StreamerWindow.html" title="type parameter in StreamerWindow">E</a><span class='angle_bracket'>></span> snapshot(boolean includeIvicted)</pre> |
| <div class="block">Create window snapshot. Evicted entries are not included.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>includeIvicted</code> - Whether to include evicted entries or not.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>Window snapshot.</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="class-use/StreamerWindow.html">Use</a></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 class="aboutLanguage"><em>Apache Ignite - In-Memory Data Fabric</em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/ignite/streamer/StreamerStageMetrics.html" title="interface in org.apache.ignite.streamer"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/ignite/streamer/StreamerWindowMBean.html" title="interface in org.apache.ignite.streamer"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/ignite/streamer/StreamerWindow.html" target="_top">Frames</a></li> |
| <li><a href="StreamerWindow.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 ======= --> |
| <p class="legalCopy"><small><table width="100%" border="0" cellspacing=0 cellpadding=0 style="padding: 5px"> <tr> <td> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <a target=_blank href="https://incubator.apache.org/projects/ignite.html"><nobr>2015 Copyright © Apache Software Foundation</nobr></a> </td> </tr> </tbody> </table> </td> <td width="100%" align="right" valign="center"> <a href="https://twitter.com/ApacheIgnite" class="twitter-follow-button" data-show-count="false" data-size="large">Follow @ApacheIgnite</a> <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script> </td> </tr> <tr> <td colspan="2" valign="top" align="left"> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <b>Apache Ignite Fabric</b> </td> <td>: ver. <strong>1.0.0-RC3</strong> </td> </tr> <tr style="padding: 0; margin: 0"> <td> <b>Release Date</b> </td> <td>: March 24 2015 </td> </tr> </tbody> </table> </td> </tr> </table></small></p> |
| <!--FOOTER--><script type='text/javascript'>SyntaxHighlighter.all();dp.SyntaxHighlighter.HighlightAll('code');</script> |
| </body> |
| |
| </html> |
