Google Git
Sign in
apache / ignite-website / 8b28a1e209dc48b2c8ce46375ab5e85fdea55105 / . / releases / 1.0.0-rc3 / javadoc / org / apache / ignite / streamer / index / StreamerIndex.html
blob: 725d9cc28e3f2e707e42f2240c52edbcb1f625d1 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<META NAME="ROBOTS" CONTENT="NOINDEX">
<link rel="canonical" href="https://ignite.apache.org/releases/1.0.0-rc3/javadoc/org/apache/ignite/streamer/index/StreamerIndex.html" />
<!-- Generated by javadoc (version 1.7.0_21) on Tue Mar 24 10:27:32 MSK 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>StreamerIndex (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="StreamerIndex (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/StreamerIndex.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>Prev Class</li>
<li><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndexEntry.html" title="interface in org.apache.ignite.streamer.index"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/ignite/streamer/index/StreamerIndex.html" target="_top">Frames</a></li>
<li><a href="StreamerIndex.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.ignite.streamer.index</div>
<h2 title="Interface StreamerIndex" class="title">Interface StreamerIndex<span class='angle_bracket'>&lt;</span>E,K,V<span class='angle_bracket'>&gt;</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'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndexEntry.html" title="interface in org.apache.ignite.streamer.index">StreamerIndexEntry</a><span class='angle_bracket'>&lt;</span>E,K,V<span class='angle_bracket'>&gt;</span><span class='angle_bracket'>&gt;</span></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">StreamerIndex<span class='angle_bracket'>&lt;</span>E,K,V<span class='angle_bracket'>&gt;</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'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndexEntry.html" title="interface in org.apache.ignite.streamer.index">StreamerIndexEntry</a><span class='angle_bracket'>&lt;</span>E,K,V<span class='angle_bracket'>&gt;</span><span class='angle_bracket'>&gt;</span></pre>
<div class="block">User view on streamer index. Streamer indexes are used for fast look ups into streamer windows.
<p>
Streamer index can be accessed from <a href="../../../../../org/apache/ignite/streamer/StreamerWindow.html" title="interface in org.apache.ignite.streamer"><code>StreamerWindow</code></a> via any of the following methods:
<ul>
<li><a href="../../../../../org/apache/ignite/streamer/StreamerWindow.html#index()"><code>StreamerWindow.index()</code></a></li>
<li><a href="../../../../../org/apache/ignite/streamer/StreamerWindow.html#index(java.lang.String)"><code>StreamerWindow.index(String)</code></a></li>
<li><a href="../../../../../org/apache/ignite/streamer/StreamerWindow.html#indexes()"><code>StreamerWindow.indexes()</code></a></li>
</ul>
<p>
Indexes are created and provided for streamer windows by <a href="../../../../../org/apache/ignite/streamer/index/StreamerIndexProvider.html" title="interface in org.apache.ignite.streamer.index"><code>StreamerIndexProvider</code></a> which is
specified in streamer configuration.
<h1 class="header">Example of how to use indexes</h1>
<p>
Stock price events are streamed into the system, the stock price event is an object containing stock symbol and price.
We need to get minimum price for GOOG instrument.
<p>
Here is <a href="../../../../../org/apache/ignite/streamer/index/StreamerIndexUpdater.html" title="interface in org.apache.ignite.streamer.index"><code>StreamerIndexUpdater</code></a> that maintains index values up to date:
<pre name="code" class="java">
class StockPriceIndexUpdater implements GridStreamerIndexUpdater&lt;StockPriceEvent, String, Double&gt; {
&#64;Nullable &#64;Override public String indexKey(StockPriceEvent evt) {
return evt.getSymbol(); // Symbol is an index key.
}
&#64;Nullable &#64;Override public Double initialValue(StockPriceEvent evt, String key) {
return evt.getPrice(); // Set first event's price as an initial value.
}
&#64;Nullable &#64;Override public Double onAdded(GridStreamerIndexEntry&lt;StockPriceEvent, String, Double&gt; entry,
StockPriceEvent evt) throws IgniteCheckedException {
return Math.min(entry.value(), evt.getPrice()); // Update the minimum on new event.
}
&#64;Nullable &#64;Override
public Double onRemoved(GridStreamerIndexEntry&lt;StockPriceEvent, String, Double&gt; entry, StockPriceEvent evt) {
return entry.value(); // Leave minimum unchanged when event is evicted.
}
}
</pre>
<p>
Here is the code that queries minimum price for GOOG instrument using index:
<pre name="code" class="java">
double minGooglePrice = streamer.context().reduce(
// This closure will execute on remote nodes.
new GridClosure&lt;GridStreamerContext, Double&gt;() {
&#64;Nullable &#64;Override public Double apply(GridStreamerContext ctx) {
GridStreamerIndex&lt;StockPriceEvent, String, Double&gt; minIdx = ctx.&lt;StockPriceEvent&gt;window().index("min-price");
return minIdx.entry("GOOG").value();
}
},
new GridReducer&lt;Double, Double&gt;() {
private double minPrice = Integer.MAX_VALUE;
&#64;Override public boolean collect(Double price) {
minPrice = Math.min(minPrice, price); // Take minimum price from all nodes.
return true;
}
&#64;Override public Double reduce() {
return minPrice;
}
}
);
</pre></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">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="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'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndexEntry.html" title="interface in org.apache.ignite.streamer.index">StreamerIndexEntry</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">E</a>,<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">K</a>,<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a><span class='angle_bracket'>&gt;</span><span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html#entries(int)">entries</a></strong>(int&nbsp;cnt)</code>
<div class="block">Gets read-only collection of entries in the index.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndexEntry.html" title="interface in org.apache.ignite.streamer.index">StreamerIndexEntry</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">E</a>,<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">K</a>,<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a><span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html#entry(K)">entry</a></strong>(<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">K</a>&nbsp;key)</code>
<div class="block">Gets index entry for given key.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndexEntry.html" title="interface in org.apache.ignite.streamer.index">StreamerIndexEntry</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">E</a>,<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">K</a>,<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a><span class='angle_bracket'>&gt;</span><span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html#entrySet(boolean, V, boolean, V, boolean)">entrySet</a></strong>(boolean&nbsp;asc,
<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a>&nbsp;fromVal,
boolean&nbsp;fromIncl,
<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a>&nbsp;toVal,
boolean&nbsp;toIncl)</code>
<div class="block">Gets read-only set of index entries within given value range.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndexEntry.html" title="interface in org.apache.ignite.streamer.index">StreamerIndexEntry</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">E</a>,<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">K</a>,<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a><span class='angle_bracket'>&gt;</span><span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html#entrySet(V)">entrySet</a></strong>(<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a>&nbsp;val)</code>
<div class="block">Gets read-only set of index entries with given value.</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'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">E</a><span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html#events(boolean, V, boolean, V, boolean)">events</a></strong>(boolean&nbsp;asc,
<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a>&nbsp;fromVal,
boolean&nbsp;fromIncl,
<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a>&nbsp;toVal,
boolean&nbsp;toIncl)</code>
<div class="block">Gets read-only collection of index events.</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'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">E</a><span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html#events(int)">events</a></strong>(int&nbsp;cnt)</code>
<div class="block">Gets read-only collection of index events.</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'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">E</a><span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html#events(V)">events</a></strong>(<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a>&nbsp;val)</code>
<div class="block">Gets read-only collection of index events.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndexEntry.html" title="interface in org.apache.ignite.streamer.index">StreamerIndexEntry</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">E</a>,<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">K</a>,<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a><span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html#firstEntry()">firstEntry</a></strong>()</code>
<div class="block">Gets first entry in the index.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">K</a><span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html#keySet(boolean, V, boolean, V, boolean)">keySet</a></strong>(boolean&nbsp;asc,
<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a>&nbsp;fromVal,
boolean&nbsp;fromIncl,
<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a>&nbsp;toVal,
boolean&nbsp;toIncl)</code>
<div class="block">Gets read-only set of index keys within given value range.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">K</a><span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html#keySet(int)">keySet</a></strong>(int&nbsp;cnt)</code>
<div class="block">Gets read-only set of index keys.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">K</a><span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html#keySet(V)">keySet</a></strong>(<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a>&nbsp;val)</code>
<div class="block">Gets read-only set of index keys with given value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndexEntry.html" title="interface in org.apache.ignite.streamer.index">StreamerIndexEntry</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">E</a>,<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">K</a>,<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a><span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html#lastEntry()">lastEntry</a></strong>()</code>
<div class="block">Gets last entry in the index.</div>
</td>
</tr>
<tr class="altColor">
<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/index/StreamerIndex.html#name()">name</a></strong>()</code>
<div class="block">Index name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndexPolicy.html" title="enum in org.apache.ignite.streamer.index">StreamerIndexPolicy</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html#policy()">policy</a></strong>()</code>
<div class="block">Gets index policy.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html#size()">size</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html#sorted()">sorted</a></strong>()</code>
<div class="block">Returns <code>true</code> if index supports sorting and therefore can perform range operations.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html#unique()">unique</a></strong>()</code>
<div class="block">Gets index unique flag.</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'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a><span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html#values(boolean, V, boolean, V, boolean)">values</a></strong>(boolean&nbsp;asc,
<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a>&nbsp;fromVal,
boolean&nbsp;fromIncl,
<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a>&nbsp;toVal,
boolean&nbsp;toIncl)</code>
<div class="block">Gets read-only collection of index values within given value range.</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'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a><span class='angle_bracket'>&gt;</span></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html#values(int)">values</a></strong>(int&nbsp;cnt)</code>
<div class="block">Gets read-only collection of index values.</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&nbsp;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>@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>&nbsp;name()</pre>
<div class="block">Index name.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Index name.</dd></dl>
</li>
</ul>
<a name="unique()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unique</h4>
<pre>boolean&nbsp;unique()</pre>
<div class="block">Gets index unique flag. If index is unique then exception
will be thrown if key is already present in the index.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Index unique flag.</dd></dl>
</li>
</ul>
<a name="sorted()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sorted</h4>
<pre>boolean&nbsp;sorted()</pre>
<div class="block">Returns <code>true</code> if index supports sorting and therefore can perform range operations.
<p>
Note that sorting happens by value and not by key.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Index sorted flag.</dd></dl>
</li>
</ul>
<a name="policy()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>policy</h4>
<pre><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndexPolicy.html" title="enum in org.apache.ignite.streamer.index">StreamerIndexPolicy</a>&nbsp;policy()</pre>
<div class="block">Gets index policy.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Index policy.</dd></dl>
</li>
</ul>
<a name="size()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>size</h4>
<pre>int&nbsp;size()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>Number entries in the index.</dd></dl>
</li>
</ul>
<a name="entry(java.lang.Object)">
<!-- -->
</a><a name="entry(K)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>entry</h4>
<pre>@Nullable
<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndexEntry.html" title="interface in org.apache.ignite.streamer.index">StreamerIndexEntry</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">E</a>,<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">K</a>,<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a><span class='angle_bracket'>&gt;</span>&nbsp;entry(<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">K</a>&nbsp;key)</pre>
<div class="block">Gets index entry for given key.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - Key for which to retrieve entry.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Entry for given key, or <code>null</code> if one could not be found.</dd></dl>
</li>
</ul>
<a name="entries(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>entries</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'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndexEntry.html" title="interface in org.apache.ignite.streamer.index">StreamerIndexEntry</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">E</a>,<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">K</a>,<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a><span class='angle_bracket'>&gt;</span><span class='angle_bracket'>&gt;</span>&nbsp;entries(int&nbsp;cnt)</pre>
<div class="block">Gets read-only collection of entries in the index.
<p>
Returned collection is ordered for sorted indexes.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cnt</code> - If 0 then all entries are returned,
if positive, then returned collection contains up to <code>cnt</code> elements
(in ascending order for sorted indexes),
if negative, then returned collection contains up to <code>|cnt|</code> elements
(in descending order for sorted indexes and not supported for unsorted indexes).</dd>
<dt><span class="strong">Returns:</span></dt><dd>Collection of entries in the index.</dd></dl>
</li>
</ul>
<a name="keySet(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keySet</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">K</a><span class='angle_bracket'>&gt;</span>&nbsp;keySet(int&nbsp;cnt)</pre>
<div class="block">Gets read-only set of index keys.
<p>
Returned collection is ordered for sorted indexes.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cnt</code> - If 0 then all keys are returned,
if positive, then returned collection contains up to <code>cnt</code> elements
(in ascending order for sorted indexes),
if negative, then returned collection contains up to <code>|cnt|</code> elements
(in descending order for sorted indexes and not supported for unsorted indexes).</dd>
<dt><span class="strong">Returns:</span></dt><dd>Read-only set of index keys within given position range.</dd></dl>
</li>
</ul>
<a name="values(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>values</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'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a><span class='angle_bracket'>&gt;</span>&nbsp;values(int&nbsp;cnt)</pre>
<div class="block">Gets read-only collection of index values.
<p>
Returned collection is ordered for sorted indexes.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cnt</code> - If 0 then all values are returned,
if positive, then returned collection contains up to <code>cnt</code> elements
(in ascending order for sorted indexes),
if negative, then returned collection contains up to <code>|cnt|</code> elements
(in descending order for sorted indexes and not supported for unsorted indexes).</dd>
<dt><span class="strong">Returns:</span></dt><dd>Read-only collections of index values.</dd></dl>
</li>
</ul>
<a name="events(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>events</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'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">E</a><span class='angle_bracket'>&gt;</span>&nbsp;events(int&nbsp;cnt)</pre>
<div class="block">Gets read-only collection of index events.
<p>
For sorted indexes events are guaranteed to be grouped by corresponding values, however
the order of the events corresponding to the same value is not defined.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cnt</code> - If 0 then all values are returned,
if positive, then returned collection contains up to <code>cnt</code> elements
(in ascending order of values for sorted indexes),
if negative, then returned collection contains up to <code>|cnt|</code> elements
(in descending order of values for sorted indexes and not supported for unsorted indexes).</dd>
<dt><span class="strong">Returns:</span></dt><dd>Read-only collections of index events.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - If index is not configured to track events.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndexPolicy.html" title="enum in org.apache.ignite.streamer.index"><code>StreamerIndexPolicy</code></a></dd></dl>
</li>
</ul>
<a name="entrySet(java.lang.Object)">
<!-- -->
</a><a name="entrySet(V)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>entrySet</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndexEntry.html" title="interface in org.apache.ignite.streamer.index">StreamerIndexEntry</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">E</a>,<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">K</a>,<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a><span class='angle_bracket'>&gt;</span><span class='angle_bracket'>&gt;</span>&nbsp;entrySet(<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a>&nbsp;val)</pre>
<div class="block">Gets read-only set of index entries with given value.
<p>
This operation is only available for sorted indexes.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - Value.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Read-only set of index entries with given value.</dd></dl>
</li>
</ul>
<a name="entrySet(boolean,java.lang.Object,boolean,java.lang.Object,boolean)">
<!-- -->
</a><a name="entrySet(boolean, V, boolean, V, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>entrySet</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndexEntry.html" title="interface in org.apache.ignite.streamer.index">StreamerIndexEntry</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">E</a>,<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">K</a>,<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a><span class='angle_bracket'>&gt;</span><span class='angle_bracket'>&gt;</span>&nbsp;entrySet(boolean&nbsp;asc,
@Nullable
<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a>&nbsp;fromVal,
boolean&nbsp;fromIncl,
@Nullable
<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a>&nbsp;toVal,
boolean&nbsp;toIncl)</pre>
<div class="block">Gets read-only set of index entries within given value range.
<p>
This operation is only available for sorted indexes.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>asc</code> - <code>True</code> for ascending set.</dd><dd><code>fromVal</code> - From value, if <code>null</code>, then start from beginning.</dd><dd><code>toVal</code> - To value, if <code>null</code> then include all entries until the end.</dd><dd><code>fromIncl</code> - Whether or not left value is inclusive (ignored if <code>minVal</code> is <code>null</code>).</dd><dd><code>toIncl</code> - Whether or not right value is inclusive (ignored if <code>maxVal</code> is <code>null</code>).</dd>
<dt><span class="strong">Returns:</span></dt><dd>Read-only set of index entries within given value range.</dd></dl>
</li>
</ul>
<a name="keySet(java.lang.Object)">
<!-- -->
</a><a name="keySet(V)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keySet</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">K</a><span class='angle_bracket'>&gt;</span>&nbsp;keySet(<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a>&nbsp;val)</pre>
<div class="block">Gets read-only set of index keys with given value. Iteration order over
this set has the same order as within index.
<p>
This operation is only available for sorted indexes.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - Value.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Read-only set of index entries with given value.</dd></dl>
</li>
</ul>
<a name="keySet(boolean,java.lang.Object,boolean,java.lang.Object,boolean)">
<!-- -->
</a><a name="keySet(boolean, V, boolean, V, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keySet</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">K</a><span class='angle_bracket'>&gt;</span>&nbsp;keySet(boolean&nbsp;asc,
@Nullable
<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a>&nbsp;fromVal,
boolean&nbsp;fromIncl,
@Nullable
<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a>&nbsp;toVal,
boolean&nbsp;toIncl)</pre>
<div class="block">Gets read-only set of index keys within given value range. Iteration order over
this set has the same order as within index.
<p>
This operation is only available for sorted indexes.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>asc</code> - <code>True</code> for ascending set.</dd><dd><code>fromVal</code> - From value, if <code>null</code>, then start from beginning.</dd><dd><code>toVal</code> - To value, if <code>null</code> then include all entries until the end.</dd><dd><code>fromIncl</code> - Whether or not left value is inclusive (ignored if <code>minVal</code> is <code>null</code>).</dd><dd><code>toIncl</code> - Whether or not right value is inclusive (ignored if <code>maxVal</code> is <code>null</code>).</dd>
<dt><span class="strong">Returns:</span></dt><dd>Read-only set of index entries within given value range.</dd></dl>
</li>
</ul>
<a name="values(boolean,java.lang.Object,boolean,java.lang.Object,boolean)">
<!-- -->
</a><a name="values(boolean, V, boolean, V, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>values</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'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a><span class='angle_bracket'>&gt;</span>&nbsp;values(boolean&nbsp;asc,
@Nullable
<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a>&nbsp;fromVal,
boolean&nbsp;fromIncl,
@Nullable
<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a>&nbsp;toVal,
boolean&nbsp;toIncl)</pre>
<div class="block">Gets read-only collection of index values within given value range. Iteration order over
this collection has the same order as within index.
<p>
This operation is only available for sorted indexes.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>asc</code> - <code>True</code> for ascending set.</dd><dd><code>fromVal</code> - From value, if <code>null</code>, then start from beginning.</dd><dd><code>toVal</code> - To value, if <code>null</code> then include all entries until the end.</dd><dd><code>fromIncl</code> - Whether or not left value is inclusive (ignored if <code>minVal</code> is <code>null</code>).</dd><dd><code>toIncl</code> - Whether or not right value is inclusive (ignored if <code>maxVal</code> is <code>null</code>).</dd>
<dt><span class="strong">Returns:</span></dt><dd>Read-only set of index entries within given value range.</dd></dl>
</li>
</ul>
<a name="events(java.lang.Object)">
<!-- -->
</a><a name="events(V)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>events</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'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">E</a><span class='angle_bracket'>&gt;</span>&nbsp;events(@Nullable
<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a>&nbsp;val)</pre>
<div class="block">Gets read-only collection of index events.
<p>
This operation is only available for sorted indexes.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>val</code> - From value, if <code>null</code>, then start from beginning.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Read-only set of index entries with given value.</dd></dl>
</li>
</ul>
<a name="events(boolean,java.lang.Object,boolean,java.lang.Object,boolean)">
<!-- -->
</a><a name="events(boolean, V, boolean, V, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>events</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'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">E</a><span class='angle_bracket'>&gt;</span>&nbsp;events(boolean&nbsp;asc,
@Nullable
<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a>&nbsp;fromVal,
boolean&nbsp;fromIncl,
@Nullable
<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a>&nbsp;toVal,
boolean&nbsp;toIncl)</pre>
<div class="block">Gets read-only collection of index events.
<p>
Events are guaranteed to be sorted by corresponding values, however
the order of the events corresponding to the same value is not defined.
<p>
This operation is only available for sorted indexes.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>asc</code> - <code>True</code> for ascending set.</dd><dd><code>fromVal</code> - From value, if <code>null</code>, then start from beginning.</dd><dd><code>toVal</code> - To value, if <code>null</code> then include all entries until the end.</dd><dd><code>fromIncl</code> - Whether or not left value is inclusive (ignored if <code>minVal</code> is <code>null</code>).</dd><dd><code>toIncl</code> - Whether or not right value is inclusive (ignored if <code>maxVal</code> is <code>null</code>).</dd>
<dt><span class="strong">Returns:</span></dt><dd>Read-only set of index entries within given value range.</dd></dl>
</li>
</ul>
<a name="firstEntry()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>firstEntry</h4>
<pre>@Nullable
<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndexEntry.html" title="interface in org.apache.ignite.streamer.index">StreamerIndexEntry</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">E</a>,<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">K</a>,<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a><span class='angle_bracket'>&gt;</span>&nbsp;firstEntry()</pre>
<div class="block">Gets first entry in the index.
<p>
This operation is only available for sorted indexes.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>First entry in the index, or <code>null</code> if index is empty.</dd></dl>
</li>
</ul>
<a name="lastEntry()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>lastEntry</h4>
<pre>@Nullable
<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndexEntry.html" title="interface in org.apache.ignite.streamer.index">StreamerIndexEntry</a><span class='angle_bracket'>&lt;</span><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">E</a>,<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">K</a>,<a href="../../../../../org/apache/ignite/streamer/index/StreamerIndex.html" title="type parameter in StreamerIndex">V</a><span class='angle_bracket'>&gt;</span>&nbsp;lastEntry()</pre>
<div class="block">Gets last entry in the index.
<p>
This operation is only available for sorted indexes.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Last entry in the index, or <code>null</code> if index is empty.</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/StreamerIndex.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>Prev Class</li>
<li><a href="../../../../../org/apache/ignite/streamer/index/StreamerIndexEntry.html" title="interface in org.apache.ignite.streamer.index"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/ignite/streamer/index/StreamerIndex.html" target="_top">Frames</a></li>
<li><a href="StreamerIndex.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<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 &#169; 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>:&nbsp;&nbsp; ver. <strong>1.0.0-RC3</strong> </td> </tr> <tr style="padding: 0; margin: 0"> <td> <b>Release Date</b> </td> <td>:&nbsp;&nbsp; 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>