summaryrefslogtreecommitdiff
path: root/apidocs/com/amazon/carbonado/cursor/GroupedCursor.html
diff options
context:
space:
mode:
Diffstat (limited to 'apidocs/com/amazon/carbonado/cursor/GroupedCursor.html')
-rw-r--r--apidocs/com/amazon/carbonado/cursor/GroupedCursor.html488
1 files changed, 488 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/cursor/GroupedCursor.html b/apidocs/com/amazon/carbonado/cursor/GroupedCursor.html
new file mode 100644
index 0000000..dd3c96c
--- /dev/null
+++ b/apidocs/com/amazon/carbonado/cursor/GroupedCursor.html
@@ -0,0 +1,488 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (version 1.7.0_25) on Tue Dec 03 13:53:42 PST 2013 -->
+<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
+<title>GroupedCursor (Carbonado 1.2.3 API)</title>
+<meta name="date" content="2013-12-03">
+<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="GroupedCursor (Carbonado 1.2.3 API)";
+ }
+//-->
+</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/GroupedCursor.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-files/index-1.html">Index</a></li>
+<li><a href="../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../com/amazon/carbonado/cursor/IntersectionCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?com/amazon/carbonado/cursor/GroupedCursor.html" target="_top">Frames</a></li>
+<li><a href="GroupedCursor.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method_detail">Method</a></li>
+</ul>
+</div>
+<a name="skip-navbar_top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<!-- ======== START OF CLASS DATA ======== -->
+<div class="header">
+<div class="subTitle">com.amazon.carbonado.cursor</div>
+<h2 title="Class GroupedCursor" class="title">Class GroupedCursor&lt;S,G&gt;</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">com.amazon.carbonado.cursor.AbstractCursor</a>&lt;G&gt;</li>
+<li>
+<ul class="inheritance">
+<li>com.amazon.carbonado.cursor.GroupedCursor&lt;S,G&gt;</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>S</code> - source type, can be anything</dd><dd><code>G</code> - aggregate type, can be anything</dd></dl>
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a>&lt;G&gt;</dd>
+</dl>
+<hr>
+<br>
+<pre>public abstract class <span class="strong">GroupedCursor&lt;S,G&gt;</span>
+extends <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a>&lt;G&gt;</pre>
+<div class="block">Abstract cursor for aggregation and finding distinct data. The source cursor
+ must be ordered in some fashion by the grouping properties. The arrangement of
+ properties must match, but it does not matter if they are ascending or
+ descending.</div>
+<dl><dt><span class="strong">Author:</span></dt>
+ <dd>Brian S O'Neill</dd>
+<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/cursor/SortedCursor.html" title="class in com.amazon.carbonado.cursor"><code>SortedCursor</code></a></dd></dl>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor_summary">
+<!-- -->
+</a>
+<h3>Constructor Summary</h3>
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
+<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier</th>
+<th class="colLast" scope="col">Constructor and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>protected </code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html#GroupedCursor(com.amazon.carbonado.Cursor, java.lang.Class, java.lang.String...)">GroupedCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a>&lt;<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a>&gt;&nbsp;cursor,
+ java.lang.Class&lt;<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a>&gt;&nbsp;type,
+ java.lang.String...&nbsp;groupProperties)</code>
+<div class="block">Create a GroupedCursor using properties to define the group
+ comparator.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>protected </code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html#GroupedCursor(com.amazon.carbonado.Cursor, java.util.Comparator)">GroupedCursor</a></strong>(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a>&lt;<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a>&gt;&nbsp;cursor,
+ java.util.Comparator&lt;<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a>&gt;&nbsp;groupComparator)</code>
+<div class="block">Create a GroupedCursor with an existing group comparator.</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>protected abstract void</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html#addToGroup(S)">addToGroup</a></strong>(<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a>&nbsp;groupMember)</code>
+<div class="block">This method is called when more entries are found for the current
+ group.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>protected abstract void</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html#beginGroup(S)">beginGroup</a></strong>(<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a>&nbsp;groupLeader)</code>
+<div class="block">This method is called for the first entry in a group.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html#close()">close</a></strong>()</code>
+<div class="block">Call close to release any resources being held by this cursor.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.util.Comparator&lt;<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a>&gt;</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html#comparator()">comparator</a></strong>()</code>
+<div class="block">Returns the comparator used to identify group boundaries.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>protected abstract <a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">G</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html#finishGroup()">finishGroup</a></strong>()</code>
+<div class="block">This method is called when a group is finished, and it can return an
+ aggregate.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html#hasNext()">hasNext</a></strong>()</code>
+<div class="block">Returns true if this cursor has more elements.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">G</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html#next()">next</a></strong>()</code>
+<div class="block">Returns the next element from this cursor.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html#skipNext(int)">skipNext</a></strong>(int&nbsp;amount)</code>
+<div class="block">Skips forward by the specified amount of elements, returning the actual
+ amount skipped.</div>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.cursor.AbstractCursor">
+<!-- -->
+</a>
+<h3>Methods inherited from class&nbsp;com.amazon.carbonado.cursor.<a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a></h3>
+<code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection, int)">copyInto</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList()">toList</a>, <a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#toList(int)">toList</a></code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
+<!-- -->
+</a>
+<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
+<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor_detail">
+<!-- -->
+</a>
+<h3>Constructor Detail</h3>
+<a name="GroupedCursor(com.amazon.carbonado.Cursor, java.util.Comparator)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>GroupedCursor</h4>
+<pre>protected&nbsp;GroupedCursor(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a>&lt;<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a>&gt;&nbsp;cursor,
+ java.util.Comparator&lt;<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a>&gt;&nbsp;groupComparator)</pre>
+<div class="block">Create a GroupedCursor with an existing group comparator. The comparator
+ defines the ordering of the source cursor, and it should be a partial
+ odering. If group comparator defines a total ordering, then all groups
+ have one member.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cursor</code> - source of elements which must be ordered properly</dd><dd><code>groupComparator</code> - comparator which defines ordering of source cursor</dd></dl>
+</li>
+</ul>
+<a name="GroupedCursor(com.amazon.carbonado.Cursor, java.lang.Class, java.lang.String...)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>GroupedCursor</h4>
+<pre>protected&nbsp;GroupedCursor(<a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a>&lt;<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a>&gt;&nbsp;cursor,
+ java.lang.Class&lt;<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a>&gt;&nbsp;type,
+ java.lang.String...&nbsp;groupProperties)</pre>
+<div class="block">Create a GroupedCursor using properties to define the group
+ comparator. The set of properties defines the ordering of the source
+ cursor, and it should be a partial ordering. If properties define a
+ total ordering, then all groups have one member.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cursor</code> - source of elements which must be ordered properly</dd><dd><code>type</code> - type of storable to create cursor for</dd><dd><code>groupProperties</code> - list of properties to group by</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalArgumentException</code> - if any property is null or not a member
+ of storable type</dd></dl>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="comparator()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>comparator</h4>
+<pre>public&nbsp;java.util.Comparator&lt;<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a>&gt;&nbsp;comparator()</pre>
+<div class="block">Returns the comparator used to identify group boundaries.</div>
+</li>
+</ul>
+<a name="beginGroup(java.lang.Object)">
+<!-- -->
+</a><a name="beginGroup(S)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>beginGroup</h4>
+<pre>protected abstract&nbsp;void&nbsp;beginGroup(<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a>&nbsp;groupLeader)
+ throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
+<div class="block">This method is called for the first entry in a group. This method is not
+ called again until after finishGroup is called.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>groupLeader</code> - first entry in group</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl>
+</li>
+</ul>
+<a name="addToGroup(java.lang.Object)">
+<!-- -->
+</a><a name="addToGroup(S)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>addToGroup</h4>
+<pre>protected abstract&nbsp;void&nbsp;addToGroup(<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a>&nbsp;groupMember)
+ throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
+<div class="block">This method is called when more entries are found for the current
+ group. This method is not called until after beginGroup has been
+ called. It may called multiple times until finishGroup is called.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>groupMember</code> - additional entry in group</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl>
+</li>
+</ul>
+<a name="finishGroup()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>finishGroup</h4>
+<pre>protected abstract&nbsp;<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">G</a>&nbsp;finishGroup()
+ throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
+<div class="block">This method is called when a group is finished, and it can return an
+ aggregate. Simply return null if aggregate should be filtered out.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>aggregate, or null to filter it out</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl>
+</li>
+</ul>
+<a name="close()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>close</h4>
+<pre>public&nbsp;void&nbsp;close()
+ throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
+<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../com/amazon/carbonado/Cursor.html#close()">Cursor</a></code></strong></div>
+<div class="block">Call close to release any resources being held by this cursor. Further
+ operations on this cursor will behave as if there are no results.</div>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl>
+</li>
+</ul>
+<a name="hasNext()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>hasNext</h4>
+<pre>public&nbsp;boolean&nbsp;hasNext()
+ throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
+<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../com/amazon/carbonado/Cursor.html#hasNext()">Cursor</a></code></strong></div>
+<div class="block">Returns true if this cursor has more elements. In other words, returns
+ true if <a href="../../../../com/amazon/carbonado/Cursor.html#next()"><code>next</code></a> would return an element rather than throwing
+ an exception.</div>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd></dl>
+</li>
+</ul>
+<a name="next()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>next</h4>
+<pre>public&nbsp;<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">G</a>&nbsp;next()
+ throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
+<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../com/amazon/carbonado/Cursor.html#next()">Cursor</a></code></strong></div>
+<div class="block">Returns the next element from this cursor. This method may be called
+ repeatedly to iterate through the results.</div>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</dd></dl>
+</li>
+</ul>
+<a name="skipNext(int)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>skipNext</h4>
+<pre>public&nbsp;int&nbsp;skipNext(int&nbsp;amount)
+ throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre>
+<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../com/amazon/carbonado/Cursor.html#skipNext(int)">Cursor</a></code></strong></div>
+<div class="block">Skips forward by the specified amount of elements, returning the actual
+ amount skipped. The actual amount is less than the requested amount only
+ if the end of the results was reached.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../com/amazon/carbonado/Cursor.html#skipNext(int)">skipNext</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a>&lt;<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">G</a>&gt;</code></dd>
+<dt><strong>Overrides:</strong></dt>
+<dd><code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html#skipNext(int)">skipNext</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a>&lt;<a href="../../../../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">G</a>&gt;</code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>amount</code> - maximum amount of elements to skip</dd>
+<dt><span class="strong">Returns:</span></dt><dd>actual amount skipped</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code> - if storage layer throws an exception</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/GroupedCursor.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-files/index-1.html">Index</a></li>
+<li><a href="../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../com/amazon/carbonado/cursor/FilteredCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../com/amazon/carbonado/cursor/IntersectionCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?com/amazon/carbonado/cursor/GroupedCursor.html" target="_top">Frames</a></li>
+<li><a href="GroupedCursor.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method_detail">Method</a></li>
+</ul>
+</div>
+<a name="skip-navbar_bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+<p class="legalCopy"><small>Copyright &#169; 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p>
+</body>
+</html>