mirror of
https://github.com/berkeleydb/je.git
synced 2024-11-15 09:46:25 +00:00
1667 lines
94 KiB
HTML
1667 lines
94 KiB
HTML
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||
|
|
<!-- NewPage -->
|
||
|
|
<html lang="en">
|
||
|
|
<head>
|
||
|
|
<!-- Generated by javadoc (1.8.0_151) on Tue Oct 31 17:36:46 EDT 2017 -->
|
||
|
|
<title>EntityCursor (Oracle - Berkeley DB Java Edition API)</title>
|
||
|
|
<meta name="date" content="2017-10-31">
|
||
|
|
<link rel="stylesheet" type="text/css" href="../../../style.css" title="Style">
|
||
|
|
<script type="text/javascript" src="../../../script.js"></script>
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<script type="text/javascript"><!--
|
||
|
|
try {
|
||
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
||
|
|
parent.document.title="EntityCursor (Oracle - Berkeley DB Java Edition API)";
|
||
|
|
}
|
||
|
|
}
|
||
|
|
catch(err) {
|
||
|
|
}
|
||
|
|
//-->
|
||
|
|
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6};
|
||
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
|
||
|
|
var altColor = "altColor";
|
||
|
|
var rowColor = "rowColor";
|
||
|
|
var tableTab = "tableTab";
|
||
|
|
var activeTableTab = "activeTableTab";
|
||
|
|
</script>
|
||
|
|
<noscript>
|
||
|
|
<div>JavaScript is disabled on your browser.</div>
|
||
|
|
</noscript>
|
||
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
||
|
|
<div class="topNav"><a name="navbar.top">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
||
|
|
<a name="navbar.top.firstrow">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="navList" title="Navigation">
|
||
|
|
<li><a href="../../../overview-summary.html">Overview</a></li>
|
||
|
|
<li><a href="package-summary.html">Package</a></li>
|
||
|
|
<li class="navBarCell1Rev">Class</li>
|
||
|
|
<li><a href="class-use/EntityCursor.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"><b>Berkeley DB Java Edition</b><br><font size=\"-1\"> version 7.5.11</font>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="subNav">
|
||
|
|
<ul class="navList">
|
||
|
|
<li>Prev Class</li>
|
||
|
|
<li><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist"><span class="typeNameLink">Next Class</span></a></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="navList">
|
||
|
|
<li><a href="../../../index.html?com/sleepycat/persist/EntityCursor.html" target="_top">Frames</a></li>
|
||
|
|
<li><a href="EntityCursor.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">com.sleepycat.persist</div>
|
||
|
|
<h2 title="Interface EntityCursor" class="title">Interface EntityCursor<V></h2>
|
||
|
|
</div>
|
||
|
|
<div class="contentContainer">
|
||
|
|
<div class="description">
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<dl>
|
||
|
|
<dt>All Superinterfaces:</dt>
|
||
|
|
<dd>java.lang.AutoCloseable, java.io.Closeable, <a href="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</a><V>, java.lang.Iterable<V></dd>
|
||
|
|
</dl>
|
||
|
|
<hr>
|
||
|
|
<br>
|
||
|
|
<pre>public interface <span class="typeNameLabel">EntityCursor<V></span>
|
||
|
|
extends <a href="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</a><V></pre>
|
||
|
|
<div class="block">Traverses entity values or key values and allows deleting or updating the
|
||
|
|
entity at the current cursor position. The value type (V) is either an
|
||
|
|
entity class or a key class, depending on how the cursor was opened.
|
||
|
|
|
||
|
|
<p><code>EntityCursor</code> objects are <em>not</em> thread-safe. Cursors
|
||
|
|
should be opened, used and closed by a single thread.</p>
|
||
|
|
|
||
|
|
<p>Cursors are opened using the <a href="../../../com/sleepycat/persist/EntityIndex.html#keys--"><code>EntityIndex.keys()</code></a> and <a href="../../../com/sleepycat/persist/EntityIndex.html#entities--"><code>EntityIndex.entities()</code></a> family of methods. These methods are available for
|
||
|
|
objects of any class that implements <a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist"><code>EntityIndex</code></a>: <a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><code>PrimaryIndex</code></a>, <a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="class in com.sleepycat.persist"><code>SecondaryIndex</code></a>, and the indices returned by <a href="../../../com/sleepycat/persist/SecondaryIndex.html#keysIndex"><code>SecondaryIndex.keysIndex</code></a> and <a href="../../../com/sleepycat/persist/SecondaryIndex.html#subIndex-SK-"><code>SecondaryIndex.subIndex(SK)</code></a>. A <a href="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist"><code>ForwardCursor</code></a>, which implements a subset of cursor operations, is also
|
||
|
|
available via the <a href="../../../com/sleepycat/persist/EntityJoin.html#keys--"><code>EntityJoin.keys()</code></a> and <a href="../../../com/sleepycat/persist/EntityJoin.html#entities--"><code>EntityJoin.entities()</code></a>
|
||
|
|
methods.</p>
|
||
|
|
|
||
|
|
<p>Values are always returned by a cursor in key order, where the key is
|
||
|
|
defined by the underlying <a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist"><code>EntityIndex</code></a>. For example, a cursor on a
|
||
|
|
<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="class in com.sleepycat.persist"><code>SecondaryIndex</code></a> returns values ordered by secondary key, while an
|
||
|
|
index on a <a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><code>PrimaryIndex</code></a> or a <a href="../../../com/sleepycat/persist/SecondaryIndex.html#subIndex-SK-"><code>SecondaryIndex.subIndex(SK)</code></a> returns
|
||
|
|
values ordered by primary key.</p>
|
||
|
|
|
||
|
|
<p><em>WARNING:</em> Cursors must always be closed to prevent resource leaks
|
||
|
|
which could lead to the index becoming unusable or cause an
|
||
|
|
<code>OutOfMemoryError</code>. To ensure that a cursor is closed in the
|
||
|
|
face of exceptions, call <a href="../../../com/sleepycat/persist/EntityCursor.html#close--"><code>close()</code></a> in a finally block. For example,
|
||
|
|
the following code traverses all Employee entities and closes the cursor
|
||
|
|
whether or not an exception occurs:</p>
|
||
|
|
|
||
|
|
<pre class="code">
|
||
|
|
@Entity
|
||
|
|
class Employee {
|
||
|
|
|
||
|
|
@PrimaryKey
|
||
|
|
long id;
|
||
|
|
|
||
|
|
@SecondaryKey(relate=MANY_TO_ONE)
|
||
|
|
String department;
|
||
|
|
|
||
|
|
String name;
|
||
|
|
|
||
|
|
private Employee() {}
|
||
|
|
}
|
||
|
|
|
||
|
|
EntityStore store = ...
|
||
|
|
|
||
|
|
<code>PrimaryIndex<Long, Employee></code> primaryIndex =
|
||
|
|
store.getPrimaryIndex(Long.class, Employee.class);
|
||
|
|
|
||
|
|
<code>EntityCursor<Employee></code> cursor = primaryIndex.entities();
|
||
|
|
try {
|
||
|
|
for (Employee entity = cursor.first();
|
||
|
|
entity != null;
|
||
|
|
entity = cursor.next()) {
|
||
|
|
// Do something with the entity...
|
||
|
|
}
|
||
|
|
} finally {
|
||
|
|
cursor.close();
|
||
|
|
}</pre>
|
||
|
|
|
||
|
|
<h3>Initializing the Cursor Position</h3>
|
||
|
|
|
||
|
|
<p>When it is opened, a cursor is not initially positioned on any value; in
|
||
|
|
other words, it is uninitialized. Most methods in this interface initialize
|
||
|
|
the cursor position but certain methods, for example, <a href="../../../com/sleepycat/persist/EntityCursor.html#current--"><code>current()</code></a> and
|
||
|
|
<a href="../../../com/sleepycat/persist/EntityCursor.html#delete--"><code>delete()</code></a>, throw <code>IllegalStateException</code> when called for an
|
||
|
|
uninitialized cursor.</p>
|
||
|
|
|
||
|
|
<p>Note that the <a href="../../../com/sleepycat/persist/EntityCursor.html#next--"><code>next()</code></a> and <a href="../../../com/sleepycat/persist/EntityCursor.html#prev--"><code>prev()</code></a> methods return the first or
|
||
|
|
last value respectively for an uninitialized cursor. This allows the loop
|
||
|
|
in the example above to be rewritten as follows:</p>
|
||
|
|
|
||
|
|
<pre class="code">
|
||
|
|
<code>EntityCursor<Employee></code> cursor = primaryIndex.entities();
|
||
|
|
try {
|
||
|
|
Employee entity;
|
||
|
|
while ((entity = cursor.next()) != null) {
|
||
|
|
// Do something with the entity...
|
||
|
|
}
|
||
|
|
} finally {
|
||
|
|
cursor.close();
|
||
|
|
}</pre>
|
||
|
|
|
||
|
|
<h3>Cursors and Iterators</h3>
|
||
|
|
|
||
|
|
<p>The <a href="../../../com/sleepycat/persist/EntityCursor.html#iterator--"><code>iterator()</code></a> method can be used to return a standard Java <code>Iterator</code> that returns the same values that the cursor returns. For
|
||
|
|
example:</p>
|
||
|
|
|
||
|
|
<pre class="code">
|
||
|
|
<code>EntityCursor<Employee></code> cursor = primaryIndex.entities();
|
||
|
|
try {
|
||
|
|
<code>Iterator<Employee></code> i = cursor.iterator();
|
||
|
|
while (i.hasNext()) {
|
||
|
|
Employee entity = i.next();
|
||
|
|
// Do something with the entity...
|
||
|
|
}
|
||
|
|
} finally {
|
||
|
|
cursor.close();
|
||
|
|
}</pre>
|
||
|
|
|
||
|
|
<p>The <code>Iterable</code> interface is also extended by <a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist"><code>EntityCursor</code></a>
|
||
|
|
to allow using the cursor as the target of a Java "foreach" statement:</p>
|
||
|
|
|
||
|
|
<pre class="code">
|
||
|
|
<code>EntityCursor<Employee></code> cursor = primaryIndex.entities();
|
||
|
|
try {
|
||
|
|
for (Employee entity : cursor) {
|
||
|
|
// Do something with the entity...
|
||
|
|
}
|
||
|
|
} finally {
|
||
|
|
cursor.close();
|
||
|
|
}</pre>
|
||
|
|
|
||
|
|
<p>The iterator uses the cursor directly, so any changes to the cursor
|
||
|
|
position impact the iterator and vice versa. The iterator advances the
|
||
|
|
cursor by calling <a href="../../../com/sleepycat/persist/EntityCursor.html#next--"><code>next()</code></a> when <code>Iterator.hasNext()</code> or <code>Iterator.next()</code> is called. Because of this interaction, to keep things
|
||
|
|
simple it is best not to mix the use of an <code>EntityCursor</code>
|
||
|
|
<code>Iterator</code> with the use of the <code>EntityCursor</code> traversal methods
|
||
|
|
such as <a href="../../../com/sleepycat/persist/EntityCursor.html#next--"><code>next()</code></a>, for a single <code>EntityCursor</code> object.</p>
|
||
|
|
|
||
|
|
<h3>Key Ranges</h3>
|
||
|
|
|
||
|
|
<p>A key range may be specified when opening the cursor, to restrict the
|
||
|
|
key range of the cursor to a subset of the complete range of keys in the
|
||
|
|
index. A <code>fromKey</code> and/or <code>toKey</code> parameter may be specified
|
||
|
|
when calling <a href="../../../com/sleepycat/persist/EntityIndex.html#keys-K-boolean-K-boolean-"><code>EntityIndex.keys(Object,boolean,Object,boolean)</code></a> or
|
||
|
|
<a href="../../../com/sleepycat/persist/EntityIndex.html#entities-K-boolean-K-boolean-"><code>EntityIndex.entities(Object,boolean,Object,boolean)</code></a>. The key
|
||
|
|
arguments may be specified as inclusive or exclusive values.</p>
|
||
|
|
|
||
|
|
<p>Whenever a cursor with a key range is moved, the key range bounds will be
|
||
|
|
checked, and the cursor will never be positioned outside the range. The
|
||
|
|
<a href="../../../com/sleepycat/persist/EntityCursor.html#first--"><code>first()</code></a> cursor value is the first existing value in the range, and
|
||
|
|
the <a href="../../../com/sleepycat/persist/EntityCursor.html#last--"><code>last()</code></a> cursor value is the last existing value in the range. For
|
||
|
|
example, the following code traverses Employee entities with keys from 100
|
||
|
|
(inclusive) to 200 (exclusive):</p>
|
||
|
|
|
||
|
|
<pre class="code">
|
||
|
|
<code>EntityCursor<Employee></code> cursor = primaryIndex.entities(100, true, 200, false);
|
||
|
|
try {
|
||
|
|
for (Employee entity : cursor) {
|
||
|
|
// Do something with the entity...
|
||
|
|
}
|
||
|
|
} finally {
|
||
|
|
cursor.close();
|
||
|
|
}</pre>
|
||
|
|
|
||
|
|
<h3>Duplicate Keys</h3>
|
||
|
|
|
||
|
|
<p>When using a cursor for a <a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="class in com.sleepycat.persist"><code>SecondaryIndex</code></a>, the keys in the index
|
||
|
|
may be non-unique (duplicates) if <a href="../../../com/sleepycat/persist/model/SecondaryKey.html#relate--"><code>SecondaryKey.relate()</code></a> is <a href="../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_ONE"><code>MANY_TO_ONE</code></a> or <a href="../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_MANY"><code>MANY_TO_MANY</code></a>. For example, a <code>MANY_TO_ONE</code> <code>Employee.department</code> secondary key is non-unique because there are multiple
|
||
|
|
Employee entities with the same department key value. The <a href="../../../com/sleepycat/persist/EntityCursor.html#nextDup--"><code>nextDup()</code></a>,
|
||
|
|
<a href="../../../com/sleepycat/persist/EntityCursor.html#prevDup--"><code>prevDup()</code></a>, <a href="../../../com/sleepycat/persist/EntityCursor.html#nextNoDup--"><code>nextNoDup()</code></a> and <a href="../../../com/sleepycat/persist/EntityCursor.html#prevNoDup--"><code>prevNoDup()</code></a> methods may be
|
||
|
|
used to control how non-unique keys are returned by the cursor.</p>
|
||
|
|
|
||
|
|
<p><a href="../../../com/sleepycat/persist/EntityCursor.html#nextDup--"><code>nextDup()</code></a> and <a href="../../../com/sleepycat/persist/EntityCursor.html#prevDup--"><code>prevDup()</code></a> return the next or previous value
|
||
|
|
only if it has the same key as the current value, and null is returned when
|
||
|
|
a different key is encountered. For example, these methods can be used to
|
||
|
|
return all employees in a given department.</p>
|
||
|
|
|
||
|
|
<p><a href="../../../com/sleepycat/persist/EntityCursor.html#nextNoDup--"><code>nextNoDup()</code></a> and <a href="../../../com/sleepycat/persist/EntityCursor.html#prevNoDup--"><code>prevNoDup()</code></a> return the next or previous
|
||
|
|
value with a unique key, skipping over values that have the same key. For
|
||
|
|
example, these methods can be used to return the first employee in each
|
||
|
|
department.</p>
|
||
|
|
|
||
|
|
<p>For example, the following code will find the first employee in each
|
||
|
|
department with <a href="../../../com/sleepycat/persist/EntityCursor.html#nextNoDup--"><code>nextNoDup()</code></a> until it finds a department name that
|
||
|
|
matches a particular regular expression. For each matching department it
|
||
|
|
will find all employees in that department using <a href="../../../com/sleepycat/persist/EntityCursor.html#nextDup--"><code>nextDup()</code></a>.</p>
|
||
|
|
|
||
|
|
<pre class="code">
|
||
|
|
<code>SecondaryIndex<String, Long, Employee></code> secondaryIndex =
|
||
|
|
store.getSecondaryIndex(primaryIndex, String.class, "department");
|
||
|
|
|
||
|
|
String regex = ...;
|
||
|
|
<code>EntityCursor<Employee></code> cursor = secondaryIndex.entities();
|
||
|
|
try {
|
||
|
|
for (Employee entity = cursor.first();
|
||
|
|
entity != null;
|
||
|
|
entity = cursor.nextNoDup()) {
|
||
|
|
if (entity.department.matches(regex)) {
|
||
|
|
while (entity != null) {
|
||
|
|
// Do something with the matching entities...
|
||
|
|
entity = cursor.nextDup();
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
} finally {
|
||
|
|
cursor.close();
|
||
|
|
}</pre>
|
||
|
|
|
||
|
|
<h3>Updating and Deleting Entities with a Cursor</h3>
|
||
|
|
|
||
|
|
<p>The <a href="../../../com/sleepycat/persist/EntityCursor.html#update-V-"><code>update(V)</code></a> and <a href="../../../com/sleepycat/persist/EntityCursor.html#delete--"><code>delete()</code></a> methods operate on the entity at
|
||
|
|
the current cursor position. Cursors on any type of index may be used to
|
||
|
|
delete entities. For example, the following code deletes all employees in
|
||
|
|
departments which have names that match a particular regular expression:</p>
|
||
|
|
|
||
|
|
<pre class="code">
|
||
|
|
<code>SecondaryIndex<String, Long, Employee></code> secondaryIndex =
|
||
|
|
store.getSecondaryIndex(primaryIndex, String.class, "department");
|
||
|
|
|
||
|
|
String regex = ...;
|
||
|
|
<code>EntityCursor<Employee></code> cursor = secondaryIndex.entities();
|
||
|
|
try {
|
||
|
|
for (Employee entity = cursor.first();
|
||
|
|
entity != null;
|
||
|
|
entity = cursor.nextNoDup()) {
|
||
|
|
if (entity.department.matches(regex)) {
|
||
|
|
while (entity != null) {
|
||
|
|
cursor.delete();
|
||
|
|
entity = cursor.nextDup();
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
} finally {
|
||
|
|
cursor.close();
|
||
|
|
}</pre>
|
||
|
|
|
||
|
|
<p>Note that the cursor can be moved to the next (or previous) value after
|
||
|
|
deleting the entity at the current position. This is an important property
|
||
|
|
of cursors, since without it you would not be able to easily delete while
|
||
|
|
processing multiple values with a cursor. A cursor positioned on a deleted
|
||
|
|
entity is in a special state. In this state, <a href="../../../com/sleepycat/persist/EntityCursor.html#current--"><code>current()</code></a> will return
|
||
|
|
null, <a href="../../../com/sleepycat/persist/EntityCursor.html#delete--"><code>delete()</code></a> will return false, and <a href="../../../com/sleepycat/persist/EntityCursor.html#update-V-"><code>update(V)</code></a> will return
|
||
|
|
false.</p>
|
||
|
|
|
||
|
|
<p>The <a href="../../../com/sleepycat/persist/EntityCursor.html#update-V-"><code>update(V)</code></a> method is supported only if the value type is an
|
||
|
|
entity class (not a key class) and the underlying index is a <a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><code>PrimaryIndex</code></a>; in other words, for a cursor returned by one of the <code>BasicIndex.entities()</code> methods. For example, the following code changes all
|
||
|
|
employee names to uppercase:</p>
|
||
|
|
|
||
|
|
<pre class="code">
|
||
|
|
<code>EntityCursor<Employee></code> cursor = primaryIndex.entities();
|
||
|
|
try {
|
||
|
|
for (Employee entity = cursor.first();
|
||
|
|
entity != null;
|
||
|
|
entity = cursor.next()) {
|
||
|
|
entity.name = entity.name.toUpperCase();
|
||
|
|
cursor.update(entity);
|
||
|
|
}
|
||
|
|
} finally {
|
||
|
|
cursor.close();
|
||
|
|
}</pre></div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="simpleTagLabel">Author:</span></dt>
|
||
|
|
<dd>Mark Hayes</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="summary">
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList"><a name="method.summary">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<h3>Method Summary</h3>
|
||
|
|
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
||
|
|
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
|
||
|
|
<tr>
|
||
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
||
|
|
<th class="colLast" scope="col">Method and Description</th>
|
||
|
|
</tr>
|
||
|
|
<tr id="i0" class="altColor">
|
||
|
|
<td class="colFirst"><code>void</code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityCursor.html#close--">close</a></span>()</code>
|
||
|
|
<div class="block">Closes the cursor.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i1" class="rowColor">
|
||
|
|
<td class="colFirst"><code>int</code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityCursor.html#count--">count</a></span>()</code>
|
||
|
|
<div class="block">Returns the number of values (duplicates) for the key at the cursor
|
||
|
|
position, or returns zero if all values for the key have been deleted.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i2" class="altColor">
|
||
|
|
<td class="colFirst"><code>long</code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityCursor.html#countEstimate--">countEstimate</a></span>()</code>
|
||
|
|
<div class="block">Returns a rough estimate of the number of values (duplicates) for the
|
||
|
|
key at the cursor position, or returns zero if all values for the key
|
||
|
|
have been deleted.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i3" class="rowColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityCursor.html#current--">current</a></span>()</code>
|
||
|
|
<div class="block">Returns the value at the cursor position, or null if the value at the
|
||
|
|
cursor position has been deleted.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i4" class="altColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityCursor.html#current-com.sleepycat.je.LockMode-">current</a></span>(<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</code>
|
||
|
|
<div class="block">Returns the value at the cursor position, or null if the value at the
|
||
|
|
cursor position has been deleted.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i5" class="rowColor">
|
||
|
|
<td class="colFirst"><code>boolean</code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityCursor.html#delete--">delete</a></span>()</code>
|
||
|
|
<div class="block">Deletes the entity at the cursor position.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i6" class="altColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/OperationResult.html" title="class in com.sleepycat.je">OperationResult</a></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityCursor.html#delete-com.sleepycat.je.WriteOptions-">delete</a></span>(<a href="../../../com/sleepycat/je/WriteOptions.html" title="class in com.sleepycat.je">WriteOptions</a> options)</code>
|
||
|
|
<div class="block">Deletes the entity at the cursor position, using a WriteOptions
|
||
|
|
parameter and returning an OperationResult.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i7" class="rowColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><<a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a>></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityCursor.html#dup--">dup</a></span>()</code>
|
||
|
|
<div class="block">Duplicates the cursor at the cursor position.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i8" class="altColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityCursor.html#first--">first</a></span>()</code>
|
||
|
|
<div class="block">Moves the cursor to the first value and returns it, or returns null if
|
||
|
|
the cursor range is empty.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i9" class="rowColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityCursor.html#first-com.sleepycat.je.LockMode-">first</a></span>(<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</code>
|
||
|
|
<div class="block">Moves the cursor to the first value and returns it, or returns null if
|
||
|
|
the cursor range is empty.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i10" class="altColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityResult.html" title="class in com.sleepycat.persist">EntityResult</a><<a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a>></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityCursor.html#get-com.sleepycat.je.Get-com.sleepycat.je.ReadOptions-">get</a></span>(<a href="../../../com/sleepycat/je/Get.html" title="enum in com.sleepycat.je">Get</a> getType,
|
||
|
|
<a href="../../../com/sleepycat/je/ReadOptions.html" title="class in com.sleepycat.je">ReadOptions</a> options)</code>
|
||
|
|
<div class="block">Moves the cursor according to the specified <a href="../../../com/sleepycat/je/Get.html" title="enum in com.sleepycat.je"><code>Get</code></a> type and returns
|
||
|
|
the value at the updated position.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i11" class="rowColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/CacheMode.html" title="enum in com.sleepycat.je">CacheMode</a></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityCursor.html#getCacheMode--">getCacheMode</a></span>()</code>
|
||
|
|
<div class="block">Returns the default <code>CacheMode</code> used for subsequent operations
|
||
|
|
performed using this cursor.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i12" class="altColor">
|
||
|
|
<td class="colFirst"><code>java.util.Iterator<<a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a>></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityCursor.html#iterator--">iterator</a></span>()</code>
|
||
|
|
<div class="block">Returns an iterator over the key range, starting with the value
|
||
|
|
following the current position or at the first value if the cursor is
|
||
|
|
uninitialized.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i13" class="rowColor">
|
||
|
|
<td class="colFirst"><code>java.util.Iterator<<a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a>></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityCursor.html#iterator-com.sleepycat.je.LockMode-">iterator</a></span>(<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</code>
|
||
|
|
<div class="block">Returns an iterator over the key range, starting with the value
|
||
|
|
following the current position or at the first value if the cursor is
|
||
|
|
uninitialized.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i14" class="altColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityCursor.html#last--">last</a></span>()</code>
|
||
|
|
<div class="block">Moves the cursor to the last value and returns it, or returns null if
|
||
|
|
the cursor range is empty.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i15" class="rowColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityCursor.html#last-com.sleepycat.je.LockMode-">last</a></span>(<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</code>
|
||
|
|
<div class="block">Moves the cursor to the last value and returns it, or returns null if
|
||
|
|
the cursor range is empty.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i16" class="altColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityCursor.html#next--">next</a></span>()</code>
|
||
|
|
<div class="block">Moves the cursor to the next value and returns it, or returns null
|
||
|
|
if there are no more values in the cursor range.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i17" class="rowColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityCursor.html#next-com.sleepycat.je.LockMode-">next</a></span>(<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</code>
|
||
|
|
<div class="block">Moves the cursor to the next value and returns it, or returns null
|
||
|
|
if there are no more values in the cursor range.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i18" class="altColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityCursor.html#nextDup--">nextDup</a></span>()</code>
|
||
|
|
<div class="block">Moves the cursor to the next value with the same key (duplicate) and
|
||
|
|
returns it, or returns null if no more values are present for the key at
|
||
|
|
the current position.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i19" class="rowColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityCursor.html#nextDup-com.sleepycat.je.LockMode-">nextDup</a></span>(<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</code>
|
||
|
|
<div class="block">Moves the cursor to the next value with the same key (duplicate) and
|
||
|
|
returns it, or returns null if no more values are present for the key at
|
||
|
|
the current position.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i20" class="altColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityCursor.html#nextNoDup--">nextNoDup</a></span>()</code>
|
||
|
|
<div class="block">Moves the cursor to the next value with a different key and returns it,
|
||
|
|
or returns null if there are no more unique keys in the cursor range.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i21" class="rowColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityCursor.html#nextNoDup-com.sleepycat.je.LockMode-">nextNoDup</a></span>(<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</code>
|
||
|
|
<div class="block">Moves the cursor to the next value with a different key and returns it,
|
||
|
|
or returns null if there are no more unique keys in the cursor range.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i22" class="altColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityCursor.html#prev--">prev</a></span>()</code>
|
||
|
|
<div class="block">Moves the cursor to the previous value and returns it, or returns null
|
||
|
|
if there are no preceding values in the cursor range.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i23" class="rowColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityCursor.html#prev-com.sleepycat.je.LockMode-">prev</a></span>(<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</code>
|
||
|
|
<div class="block">Moves the cursor to the previous value and returns it, or returns null
|
||
|
|
if there are no preceding values in the cursor range.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i24" class="altColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityCursor.html#prevDup--">prevDup</a></span>()</code>
|
||
|
|
<div class="block">Moves the cursor to the previous value with the same key (duplicate) and
|
||
|
|
returns it, or returns null if no preceding values are present for the
|
||
|
|
key at the current position.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i25" class="rowColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityCursor.html#prevDup-com.sleepycat.je.LockMode-">prevDup</a></span>(<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</code>
|
||
|
|
<div class="block">Moves the cursor to the previous value with the same key (duplicate) and
|
||
|
|
returns it, or returns null if no preceding values are present for the
|
||
|
|
key at the current position.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i26" class="altColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityCursor.html#prevNoDup--">prevNoDup</a></span>()</code>
|
||
|
|
<div class="block">Moves the cursor to the preceding value with a different key and returns
|
||
|
|
it, or returns null if there are no preceding unique keys in the cursor
|
||
|
|
range.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i27" class="rowColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityCursor.html#prevNoDup-com.sleepycat.je.LockMode-">prevNoDup</a></span>(<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</code>
|
||
|
|
<div class="block">Moves the cursor to the preceding value with a different key and returns
|
||
|
|
it, or returns null if there are no preceding unique keys in the cursor
|
||
|
|
range.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i28" class="altColor">
|
||
|
|
<td class="colFirst"><code>void</code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityCursor.html#setCacheMode-com.sleepycat.je.CacheMode-">setCacheMode</a></span>(<a href="../../../com/sleepycat/je/CacheMode.html" title="enum in com.sleepycat.je">CacheMode</a> cacheMode)</code>
|
||
|
|
<div class="block">Changes the <code>CacheMode</code> default used for subsequent operations
|
||
|
|
performed using this cursor.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i29" class="rowColor">
|
||
|
|
<td class="colFirst"><code>boolean</code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityCursor.html#update-V-">update</a></span>(<a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> entity)</code>
|
||
|
|
<div class="block">Replaces the entity at the cursor position with the given entity.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i30" class="altColor">
|
||
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/OperationResult.html" title="class in com.sleepycat.je">OperationResult</a></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/EntityCursor.html#update-V-com.sleepycat.je.WriteOptions-">update</a></span>(<a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> entity,
|
||
|
|
<a href="../../../com/sleepycat/je/WriteOptions.html" title="class in com.sleepycat.je">WriteOptions</a> options)</code>
|
||
|
|
<div class="block">Replaces the entity at the cursor position with the given entity,
|
||
|
|
using a WriteOptions parameter and returning an OperationResult.</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.Iterable</h3>
|
||
|
|
<code>forEach, spliterator</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="first--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>first</h4>
|
||
|
|
<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> first()
|
||
|
|
throws <a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></pre>
|
||
|
|
<div class="block">Moves the cursor to the first value and returns it, or returns null if
|
||
|
|
the cursor range is empty.
|
||
|
|
|
||
|
|
<p><a href="../../../com/sleepycat/je/LockMode.html#DEFAULT"><code>LockMode.DEFAULT</code></a> is used implicitly.</p></div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the first value, or null if the cursor range is empty.
|
||
|
|
|
||
|
|
<!-- begin JE only --></dd>
|
||
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
|
href="../je/OperationFailureException.html#readFailures">Read Operation
|
||
|
|
Failures</a> occurs.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
|
environment-wide failure occurs.
|
||
|
|
<!-- end JE only --></dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></code> - the base class for all BDB exceptions.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="first-com.sleepycat.je.LockMode-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>first</h4>
|
||
|
|
<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> first(<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)
|
||
|
|
throws <a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></pre>
|
||
|
|
<div class="block">Moves the cursor to the first value and returns it, or returns null if
|
||
|
|
the cursor range is empty.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
|
<dd><code>lockMode</code> - the lock mode to use for this operation, or null to
|
||
|
|
use <a href="../../../com/sleepycat/je/LockMode.html#DEFAULT"><code>LockMode.DEFAULT</code></a>.</dd>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the first value, or null if the cursor range is empty.
|
||
|
|
|
||
|
|
<!-- begin JE only --></dd>
|
||
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
|
href="../je/OperationFailureException.html#readFailures">Read Operation
|
||
|
|
Failures</a> occurs.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
|
environment-wide failure occurs.
|
||
|
|
<!-- end JE only --></dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></code> - the base class for all BDB exceptions.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="last--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>last</h4>
|
||
|
|
<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> last()
|
||
|
|
throws <a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></pre>
|
||
|
|
<div class="block">Moves the cursor to the last value and returns it, or returns null if
|
||
|
|
the cursor range is empty.
|
||
|
|
|
||
|
|
<p><a href="../../../com/sleepycat/je/LockMode.html#DEFAULT"><code>LockMode.DEFAULT</code></a> is used implicitly.</p></div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the last value, or null if the cursor range is empty.
|
||
|
|
|
||
|
|
<!-- begin JE only --></dd>
|
||
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
|
href="../je/OperationFailureException.html#readFailures">Read Operation
|
||
|
|
Failures</a> occurs.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
|
environment-wide failure occurs.
|
||
|
|
<!-- end JE only --></dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></code> - the base class for all BDB exceptions.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="last-com.sleepycat.je.LockMode-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>last</h4>
|
||
|
|
<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> last(<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)
|
||
|
|
throws <a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></pre>
|
||
|
|
<div class="block">Moves the cursor to the last value and returns it, or returns null if
|
||
|
|
the cursor range is empty.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
|
<dd><code>lockMode</code> - the lock mode to use for this operation, or null to
|
||
|
|
use <a href="../../../com/sleepycat/je/LockMode.html#DEFAULT"><code>LockMode.DEFAULT</code></a>.</dd>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the last value, or null if the cursor range is empty.
|
||
|
|
|
||
|
|
<!-- begin JE only --></dd>
|
||
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
|
href="../je/OperationFailureException.html#readFailures">Read Operation
|
||
|
|
Failures</a> occurs.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
|
environment-wide failure occurs.
|
||
|
|
<!-- end JE only --></dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></code> - the base class for all BDB exceptions.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="next--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>next</h4>
|
||
|
|
<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> next()
|
||
|
|
throws <a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></pre>
|
||
|
|
<div class="block">Moves the cursor to the next value and returns it, or returns null
|
||
|
|
if there are no more values in the cursor range. If the cursor is
|
||
|
|
uninitialized, this method is equivalent to <a href="../../../com/sleepycat/persist/EntityCursor.html#first--"><code>first()</code></a>.
|
||
|
|
|
||
|
|
<p><a href="../../../com/sleepycat/je/LockMode.html#DEFAULT"><code>LockMode.DEFAULT</code></a> is used implicitly.</p></div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/persist/ForwardCursor.html#next--">next</a></code> in interface <code><a href="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</a><<a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a>></code></dd>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the next value, or null if there are no more values in the
|
||
|
|
cursor range.
|
||
|
|
|
||
|
|
<!-- begin JE only --></dd>
|
||
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
|
href="../je/OperationFailureException.html#readFailures">Read Operation
|
||
|
|
Failures</a> occurs.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
|
environment-wide failure occurs.
|
||
|
|
<!-- end JE only --></dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></code> - the base class for all BDB exceptions.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="next-com.sleepycat.je.LockMode-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>next</h4>
|
||
|
|
<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> next(<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)
|
||
|
|
throws <a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></pre>
|
||
|
|
<div class="block">Moves the cursor to the next value and returns it, or returns null
|
||
|
|
if there are no more values in the cursor range. If the cursor is
|
||
|
|
uninitialized, this method is equivalent to <a href="../../../com/sleepycat/persist/EntityCursor.html#first--"><code>first()</code></a>.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/persist/ForwardCursor.html#next-com.sleepycat.je.LockMode-">next</a></code> in interface <code><a href="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</a><<a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a>></code></dd>
|
||
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
|
<dd><code>lockMode</code> - the lock mode to use for this operation, or null to
|
||
|
|
use <a href="../../../com/sleepycat/je/LockMode.html#DEFAULT"><code>LockMode.DEFAULT</code></a>.</dd>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the next value, or null if there are no more values in the
|
||
|
|
cursor range.
|
||
|
|
|
||
|
|
<!-- begin JE only --></dd>
|
||
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
|
href="../je/OperationFailureException.html#readFailures">Read Operation
|
||
|
|
Failures</a> occurs.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
|
environment-wide failure occurs.
|
||
|
|
<!-- end JE only --></dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></code> - the base class for all BDB exceptions.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="nextDup--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>nextDup</h4>
|
||
|
|
<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> nextDup()
|
||
|
|
throws <a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></pre>
|
||
|
|
<div class="block">Moves the cursor to the next value with the same key (duplicate) and
|
||
|
|
returns it, or returns null if no more values are present for the key at
|
||
|
|
the current position.
|
||
|
|
|
||
|
|
<p><a href="../../../com/sleepycat/je/LockMode.html#DEFAULT"><code>LockMode.DEFAULT</code></a> is used implicitly.</p></div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the next value with the same key, or null if no more values are
|
||
|
|
present for the key at the current position.</dd>
|
||
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
|
<dd><code>java.lang.IllegalStateException</code> - if the cursor is uninitialized.
|
||
|
|
|
||
|
|
<!-- begin JE only --></dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
|
href="../je/OperationFailureException.html#readFailures">Read Operation
|
||
|
|
Failures</a> occurs.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
|
environment-wide failure occurs.
|
||
|
|
<!-- end JE only --></dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></code> - the base class for all BDB exceptions.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="nextDup-com.sleepycat.je.LockMode-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>nextDup</h4>
|
||
|
|
<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> nextDup(<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)
|
||
|
|
throws <a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></pre>
|
||
|
|
<div class="block">Moves the cursor to the next value with the same key (duplicate) and
|
||
|
|
returns it, or returns null if no more values are present for the key at
|
||
|
|
the current position.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
|
<dd><code>lockMode</code> - the lock mode to use for this operation, or null to
|
||
|
|
use <a href="../../../com/sleepycat/je/LockMode.html#DEFAULT"><code>LockMode.DEFAULT</code></a>.</dd>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the next value with the same key, or null if no more values are
|
||
|
|
present for the key at the current position.</dd>
|
||
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
|
<dd><code>java.lang.IllegalStateException</code> - if the cursor is uninitialized.
|
||
|
|
|
||
|
|
<!-- begin JE only --></dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
|
href="../je/OperationFailureException.html#readFailures">Read Operation
|
||
|
|
Failures</a> occurs.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
|
environment-wide failure occurs.
|
||
|
|
<!-- end JE only --></dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></code> - the base class for all BDB exceptions.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="nextNoDup--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>nextNoDup</h4>
|
||
|
|
<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> nextNoDup()
|
||
|
|
throws <a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></pre>
|
||
|
|
<div class="block">Moves the cursor to the next value with a different key and returns it,
|
||
|
|
or returns null if there are no more unique keys in the cursor range.
|
||
|
|
If the cursor is uninitialized, this method is equivalent to <a href="../../../com/sleepycat/persist/EntityCursor.html#first--"><code>first()</code></a>.
|
||
|
|
|
||
|
|
<p><a href="../../../com/sleepycat/je/LockMode.html#DEFAULT"><code>LockMode.DEFAULT</code></a> is used implicitly.</p></div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the next value with a different key, or null if there are no
|
||
|
|
more unique keys in the cursor range.
|
||
|
|
|
||
|
|
<!-- begin JE only --></dd>
|
||
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
|
href="../je/OperationFailureException.html#readFailures">Read Operation
|
||
|
|
Failures</a> occurs.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
|
environment-wide failure occurs.
|
||
|
|
<!-- end JE only --></dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></code> - the base class for all BDB exceptions.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="nextNoDup-com.sleepycat.je.LockMode-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>nextNoDup</h4>
|
||
|
|
<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> nextNoDup(<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)
|
||
|
|
throws <a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></pre>
|
||
|
|
<div class="block">Moves the cursor to the next value with a different key and returns it,
|
||
|
|
or returns null if there are no more unique keys in the cursor range.
|
||
|
|
If the cursor is uninitialized, this method is equivalent to <a href="../../../com/sleepycat/persist/EntityCursor.html#first--"><code>first()</code></a>.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
|
<dd><code>lockMode</code> - the lock mode to use for this operation, or null to
|
||
|
|
use <a href="../../../com/sleepycat/je/LockMode.html#DEFAULT"><code>LockMode.DEFAULT</code></a>.</dd>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the next value with a different key, or null if there are no
|
||
|
|
more unique keys in the cursor range.
|
||
|
|
|
||
|
|
<!-- begin JE only --></dd>
|
||
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
|
href="../je/OperationFailureException.html#readFailures">Read Operation
|
||
|
|
Failures</a> occurs.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
|
environment-wide failure occurs.
|
||
|
|
<!-- end JE only --></dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></code> - the base class for all BDB exceptions.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="prev--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>prev</h4>
|
||
|
|
<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> prev()
|
||
|
|
throws <a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></pre>
|
||
|
|
<div class="block">Moves the cursor to the previous value and returns it, or returns null
|
||
|
|
if there are no preceding values in the cursor range. If the cursor is
|
||
|
|
uninitialized, this method is equivalent to <a href="../../../com/sleepycat/persist/EntityCursor.html#last--"><code>last()</code></a>.
|
||
|
|
|
||
|
|
<p><a href="../../../com/sleepycat/je/LockMode.html#DEFAULT"><code>LockMode.DEFAULT</code></a> is used implicitly.</p></div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the previous value, or null if there are no preceding values in
|
||
|
|
the cursor range.
|
||
|
|
|
||
|
|
<!-- begin JE only --></dd>
|
||
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
|
href="../je/OperationFailureException.html#readFailures">Read Operation
|
||
|
|
Failures</a> occurs.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
|
environment-wide failure occurs.
|
||
|
|
<!-- end JE only --></dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></code> - the base class for all BDB exceptions.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="prev-com.sleepycat.je.LockMode-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>prev</h4>
|
||
|
|
<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> prev(<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)
|
||
|
|
throws <a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></pre>
|
||
|
|
<div class="block">Moves the cursor to the previous value and returns it, or returns null
|
||
|
|
if there are no preceding values in the cursor range. If the cursor is
|
||
|
|
uninitialized, this method is equivalent to <a href="../../../com/sleepycat/persist/EntityCursor.html#last--"><code>last()</code></a>.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
|
<dd><code>lockMode</code> - the lock mode to use for this operation, or null to
|
||
|
|
use <a href="../../../com/sleepycat/je/LockMode.html#DEFAULT"><code>LockMode.DEFAULT</code></a>.</dd>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the previous value, or null if there are no preceding values in
|
||
|
|
the cursor range.
|
||
|
|
|
||
|
|
<!-- begin JE only --></dd>
|
||
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
|
href="../je/OperationFailureException.html#readFailures">Read Operation
|
||
|
|
Failures</a> occurs.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
|
environment-wide failure occurs.
|
||
|
|
<!-- end JE only --></dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></code> - the base class for all BDB exceptions.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="prevDup--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>prevDup</h4>
|
||
|
|
<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> prevDup()
|
||
|
|
throws <a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></pre>
|
||
|
|
<div class="block">Moves the cursor to the previous value with the same key (duplicate) and
|
||
|
|
returns it, or returns null if no preceding values are present for the
|
||
|
|
key at the current position.
|
||
|
|
|
||
|
|
<p><a href="../../../com/sleepycat/je/LockMode.html#DEFAULT"><code>LockMode.DEFAULT</code></a> is used implicitly.</p></div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the previous value with the same key, or null if no preceding
|
||
|
|
values are present for the key at the current position.</dd>
|
||
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
|
<dd><code>java.lang.IllegalStateException</code> - if the cursor is uninitialized.
|
||
|
|
|
||
|
|
<!-- begin JE only --></dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
|
href="../je/OperationFailureException.html#readFailures">Read Operation
|
||
|
|
Failures</a> occurs.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
|
environment-wide failure occurs.
|
||
|
|
<!-- end JE only --></dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></code> - the base class for all BDB exceptions.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="prevDup-com.sleepycat.je.LockMode-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>prevDup</h4>
|
||
|
|
<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> prevDup(<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)
|
||
|
|
throws <a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></pre>
|
||
|
|
<div class="block">Moves the cursor to the previous value with the same key (duplicate) and
|
||
|
|
returns it, or returns null if no preceding values are present for the
|
||
|
|
key at the current position.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
|
<dd><code>lockMode</code> - the lock mode to use for this operation, or null to
|
||
|
|
use <a href="../../../com/sleepycat/je/LockMode.html#DEFAULT"><code>LockMode.DEFAULT</code></a>.</dd>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the previous value with the same key, or null if no preceding
|
||
|
|
values are present for the key at the current position.</dd>
|
||
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
|
<dd><code>java.lang.IllegalStateException</code> - if the cursor is uninitialized.
|
||
|
|
|
||
|
|
<!-- begin JE only --></dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
|
href="../je/OperationFailureException.html#readFailures">Read Operation
|
||
|
|
Failures</a> occurs.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
|
environment-wide failure occurs.
|
||
|
|
<!-- end JE only --></dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></code> - the base class for all BDB exceptions.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="prevNoDup--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>prevNoDup</h4>
|
||
|
|
<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> prevNoDup()
|
||
|
|
throws <a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></pre>
|
||
|
|
<div class="block">Moves the cursor to the preceding value with a different key and returns
|
||
|
|
it, or returns null if there are no preceding unique keys in the cursor
|
||
|
|
range. If the cursor is uninitialized, this method is equivalent to
|
||
|
|
<a href="../../../com/sleepycat/persist/EntityCursor.html#last--"><code>last()</code></a>.
|
||
|
|
|
||
|
|
<p><a href="../../../com/sleepycat/je/LockMode.html#DEFAULT"><code>LockMode.DEFAULT</code></a> is used implicitly.</p></div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the previous value with a different key, or null if there are no
|
||
|
|
preceding unique keys in the cursor range.
|
||
|
|
|
||
|
|
<!-- begin JE only --></dd>
|
||
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
|
href="../je/OperationFailureException.html#readFailures">Read Operation
|
||
|
|
Failures</a> occurs.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
|
environment-wide failure occurs.
|
||
|
|
<!-- end JE only --></dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></code> - the base class for all BDB exceptions.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="prevNoDup-com.sleepycat.je.LockMode-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>prevNoDup</h4>
|
||
|
|
<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> prevNoDup(<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)
|
||
|
|
throws <a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></pre>
|
||
|
|
<div class="block">Moves the cursor to the preceding value with a different key and returns
|
||
|
|
it, or returns null if there are no preceding unique keys in the cursor
|
||
|
|
range. If the cursor is uninitialized, this method is equivalent to
|
||
|
|
<a href="../../../com/sleepycat/persist/EntityCursor.html#last--"><code>last()</code></a>.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
|
<dd><code>lockMode</code> - the lock mode to use for this operation, or null to
|
||
|
|
use <a href="../../../com/sleepycat/je/LockMode.html#DEFAULT"><code>LockMode.DEFAULT</code></a>.</dd>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the previous value with a different key, or null if there are no
|
||
|
|
preceding unique keys in the cursor range.
|
||
|
|
|
||
|
|
<!-- begin JE only --></dd>
|
||
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
|
href="../je/OperationFailureException.html#readFailures">Read Operation
|
||
|
|
Failures</a> occurs.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
|
environment-wide failure occurs.
|
||
|
|
<!-- end JE only --></dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></code> - the base class for all BDB exceptions.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="current--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>current</h4>
|
||
|
|
<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> current()
|
||
|
|
throws <a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></pre>
|
||
|
|
<div class="block">Returns the value at the cursor position, or null if the value at the
|
||
|
|
cursor position has been deleted.
|
||
|
|
|
||
|
|
<p><a href="../../../com/sleepycat/je/LockMode.html#DEFAULT"><code>LockMode.DEFAULT</code></a> is used implicitly.</p></div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the value at the cursor position, or null if it has been
|
||
|
|
deleted.</dd>
|
||
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
|
<dd><code>java.lang.IllegalStateException</code> - if the cursor is uninitialized.
|
||
|
|
|
||
|
|
<!-- begin JE only --></dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
|
href="../je/OperationFailureException.html#readFailures">Read Operation
|
||
|
|
Failures</a> occurs.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
|
environment-wide failure occurs.
|
||
|
|
<!-- end JE only --></dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></code> - the base class for all BDB exceptions.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="current-com.sleepycat.je.LockMode-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>current</h4>
|
||
|
|
<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> current(<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)
|
||
|
|
throws <a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></pre>
|
||
|
|
<div class="block">Returns the value at the cursor position, or null if the value at the
|
||
|
|
cursor position has been deleted.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
|
<dd><code>lockMode</code> - the lock mode to use for this operation, or null to
|
||
|
|
use <a href="../../../com/sleepycat/je/LockMode.html#DEFAULT"><code>LockMode.DEFAULT</code></a>.</dd>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the value at the cursor position, or null if it has been
|
||
|
|
deleted.</dd>
|
||
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
|
<dd><code>java.lang.IllegalStateException</code> - if the cursor is uninitialized.
|
||
|
|
|
||
|
|
<!-- begin JE only --></dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
|
href="../je/OperationFailureException.html#readFailures">Read Operation
|
||
|
|
Failures</a> occurs.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
|
environment-wide failure occurs.
|
||
|
|
<!-- end JE only --></dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></code> - the base class for all BDB exceptions.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="get-com.sleepycat.je.Get-com.sleepycat.je.ReadOptions-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>get</h4>
|
||
|
|
<pre><a href="../../../com/sleepycat/persist/EntityResult.html" title="class in com.sleepycat.persist">EntityResult</a><<a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a>> get(<a href="../../../com/sleepycat/je/Get.html" title="enum in com.sleepycat.je">Get</a> getType,
|
||
|
|
<a href="../../../com/sleepycat/je/ReadOptions.html" title="class in com.sleepycat.je">ReadOptions</a> options)
|
||
|
|
throws <a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></pre>
|
||
|
|
<div class="block">Moves the cursor according to the specified <a href="../../../com/sleepycat/je/Get.html" title="enum in com.sleepycat.je"><code>Get</code></a> type and returns
|
||
|
|
the value at the updated position.
|
||
|
|
|
||
|
|
<p>The following table lists each allowed operation. Also specified is
|
||
|
|
whether the cursor must be initialized (positioned on a value) before
|
||
|
|
calling this method. See the individual <a href="../../../com/sleepycat/je/Get.html" title="enum in com.sleepycat.je"><code>Get</code></a> operations for more
|
||
|
|
information.</p>
|
||
|
|
|
||
|
|
<div><table border="1" summary="">
|
||
|
|
<tr>
|
||
|
|
<th>Get operation</th>
|
||
|
|
<th>Description</th>
|
||
|
|
<th>Cursor position<br/>must be initialized?</th>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td><a href="../../../com/sleepycat/je/Get.html#CURRENT"><code>Get.CURRENT</code></a></td>
|
||
|
|
<td>Accesses the current value.</td>
|
||
|
|
<td>yes</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td><a href="../../../com/sleepycat/je/Get.html#FIRST"><code>Get.FIRST</code></a></td>
|
||
|
|
<td>Finds the first value in the cursor range.</td>
|
||
|
|
<td>no</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td><a href="../../../com/sleepycat/je/Get.html#LAST"><code>Get.LAST</code></a></td>
|
||
|
|
<td>Finds the last value in the cursor range.</td>
|
||
|
|
<td>no</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td><a href="../../../com/sleepycat/je/Get.html#NEXT"><code>Get.NEXT</code></a></td>
|
||
|
|
<td>Moves to the next value.</td>
|
||
|
|
<td>no**</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td><a href="../../../com/sleepycat/je/Get.html#NEXT_DUP"><code>Get.NEXT_DUP</code></a></td>
|
||
|
|
<td>Moves to the next value with the same key.</td>
|
||
|
|
<td>yes</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td><a href="../../../com/sleepycat/je/Get.html#NEXT_NO_DUP"><code>Get.NEXT_NO_DUP</code></a></td>
|
||
|
|
<td>Moves to the next value with a different key.</td>
|
||
|
|
<td>no**</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td><a href="../../../com/sleepycat/je/Get.html#PREV"><code>Get.PREV</code></a></td>
|
||
|
|
<td>Moves to the previous value.</td>
|
||
|
|
<td>no**</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td><a href="../../../com/sleepycat/je/Get.html#PREV_DUP"><code>Get.PREV_DUP</code></a></td>
|
||
|
|
<td>Moves to the previous value with the same key.</td>
|
||
|
|
<td>yes</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td><a href="../../../com/sleepycat/je/Get.html#PREV_NO_DUP"><code>Get.PREV_NO_DUP</code></a></td>
|
||
|
|
<td>Moves to the previous value with a different key.</td>
|
||
|
|
<td>no**</td>
|
||
|
|
</tr>
|
||
|
|
</table></div>
|
||
|
|
|
||
|
|
<p>** - For these 'next' and 'previous' operations the cursor may be
|
||
|
|
uninitialized, in which case the cursor will be moved to the first or
|
||
|
|
last value in the cursor range, respectively.</p></div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
|
<dd><code>getType</code> - the Get operation type. Must be one of the values listed
|
||
|
|
above.</dd>
|
||
|
|
<dd><code>options</code> - the ReadOptions, or null to use default options.</dd>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the EntityResult, including the value at the new cursor
|
||
|
|
position, or null if the requested value is not present in the cursor
|
||
|
|
range.</dd>
|
||
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
|
<dd><code>java.lang.IllegalStateException</code> - if the cursor is uninitialized.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
|
href="../je/OperationFailureException.html#readFailures">Read Operation
|
||
|
|
Failures</a> occurs.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
|
environment-wide failure occurs.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></code> - the base class for all BDB exceptions.</dd>
|
||
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
||
|
|
<dd>7.0</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="count--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>count</h4>
|
||
|
|
<pre>int count()
|
||
|
|
throws <a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></pre>
|
||
|
|
<div class="block">Returns the number of values (duplicates) for the key at the cursor
|
||
|
|
position, or returns zero if all values for the key have been deleted.
|
||
|
|
Returns one or zero if the underlying index has unique keys.
|
||
|
|
|
||
|
|
<!-- begin JE only -->
|
||
|
|
<p>The cost of this method is directly proportional to the number of
|
||
|
|
values.</p>
|
||
|
|
<!-- end JE only -->
|
||
|
|
|
||
|
|
<p><a href="../../../com/sleepycat/je/LockMode.html#DEFAULT"><code>LockMode.DEFAULT</code></a> is used implicitly.</p></div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the number of duplicates, or zero if all values for the current
|
||
|
|
key have been deleted.</dd>
|
||
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
|
<dd><code>java.lang.IllegalStateException</code> - if the cursor is uninitialized.
|
||
|
|
|
||
|
|
<!-- begin JE only --></dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
|
href="../je/OperationFailureException.html#readFailures">Read Operation
|
||
|
|
Failures</a> occurs.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
|
environment-wide failure occurs.
|
||
|
|
<!-- end JE only --></dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></code> - the base class for all BDB exceptions.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="countEstimate--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>countEstimate</h4>
|
||
|
|
<pre>long countEstimate()
|
||
|
|
throws <a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></pre>
|
||
|
|
<div class="block">Returns a rough estimate of the number of values (duplicates) for the
|
||
|
|
key at the cursor position, or returns zero if all values for the key
|
||
|
|
have been deleted. Returns one or zero if the underlying index has
|
||
|
|
unique keys.
|
||
|
|
|
||
|
|
<p>If the underlying index has non-unique keys, a quick estimate of the
|
||
|
|
number of values is computed using information in the Btree. Because
|
||
|
|
the Btree is unbalanced, in some cases the estimate may be off by a
|
||
|
|
factor of two or more. The estimate is accurate when the number of
|
||
|
|
records is less than the configured <a href="../../../com/sleepycat/je/DatabaseConfig.html#setNodeMaxEntries-int-"><code>NodeMaxEntries</code></a>.</p>
|
||
|
|
|
||
|
|
<p>The cost of this method is fixed, rather than being proportional to
|
||
|
|
the number of values. Because its accuracy is variable, this method
|
||
|
|
should normally be used when accuracy is not required, such as for query
|
||
|
|
optimization, and a fixed cost operation is needed. For example, this
|
||
|
|
method is used internally for determining the index processing order in
|
||
|
|
an <a href="../../../com/sleepycat/persist/EntityJoin.html" title="class in com.sleepycat.persist"><code>EntityJoin</code></a>.</p></div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>an estimate of the count of the number of data items for the key
|
||
|
|
to which the cursor refers.</dd>
|
||
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
|
<dd><code>java.lang.IllegalStateException</code> - if the cursor is uninitialized.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
|
href="../je/OperationFailureException.html#readFailures">Read Operation
|
||
|
|
Failures</a> occurs.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
|
environment-wide failure occurs.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></code> - the base class for all BDB exceptions.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="iterator--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>iterator</h4>
|
||
|
|
<pre>java.util.Iterator<<a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a>> iterator()</pre>
|
||
|
|
<div class="block">Returns an iterator over the key range, starting with the value
|
||
|
|
following the current position or at the first value if the cursor is
|
||
|
|
uninitialized.
|
||
|
|
|
||
|
|
<p><a href="../../../com/sleepycat/je/LockMode.html#DEFAULT"><code>LockMode.DEFAULT</code></a> is used implicitly.</p></div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/persist/ForwardCursor.html#iterator--">iterator</a></code> in interface <code><a href="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</a><<a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a>></code></dd>
|
||
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
||
|
|
<dd><code>iterator</code> in interface <code>java.lang.Iterable<<a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a>></code></dd>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the iterator.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="iterator-com.sleepycat.je.LockMode-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>iterator</h4>
|
||
|
|
<pre>java.util.Iterator<<a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a>> iterator(<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</pre>
|
||
|
|
<div class="block">Returns an iterator over the key range, starting with the value
|
||
|
|
following the current position or at the first value if the cursor is
|
||
|
|
uninitialized.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/persist/ForwardCursor.html#iterator-com.sleepycat.je.LockMode-">iterator</a></code> in interface <code><a href="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</a><<a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a>></code></dd>
|
||
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
|
<dd><code>lockMode</code> - the lock mode to use for all operations performed
|
||
|
|
using the iterator, or null to use <a href="../../../com/sleepycat/je/LockMode.html#DEFAULT"><code>LockMode.DEFAULT</code></a>.</dd>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the iterator.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="update-java.lang.Object-">
|
||
|
|
<!-- -->
|
||
|
|
</a><a name="update-V-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>update</h4>
|
||
|
|
<pre>boolean update(<a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> entity)
|
||
|
|
throws <a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></pre>
|
||
|
|
<div class="block">Replaces the entity at the cursor position with the given entity.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
|
<dd><code>entity</code> - the entity to replace the entity at the current position.</dd>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>true if successful or false if the entity at the current
|
||
|
|
position was previously deleted.</dd>
|
||
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
|
<dd><code>java.lang.IllegalStateException</code> - if the cursor is uninitialized.</dd>
|
||
|
|
<dd><code>java.lang.UnsupportedOperationException</code> - if the index is read only or if
|
||
|
|
the value type is not an entity type.
|
||
|
|
|
||
|
|
<!-- begin JE only --></dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/DuplicateDataException.html" title="class in com.sleepycat.je">DuplicateDataException</a></code> - if the old and new data are not equal
|
||
|
|
according to the configured duplicate comparator or default comparator.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
|
href="../je/OperationFailureException.html#writeFailures">Write
|
||
|
|
Operation Failures</a> occurs.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
|
environment-wide failure occurs.
|
||
|
|
<!-- end JE only --></dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></code> - the base class for all BDB exceptions.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="update-java.lang.Object-com.sleepycat.je.WriteOptions-">
|
||
|
|
<!-- -->
|
||
|
|
</a><a name="update-V-com.sleepycat.je.WriteOptions-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>update</h4>
|
||
|
|
<pre><a href="../../../com/sleepycat/je/OperationResult.html" title="class in com.sleepycat.je">OperationResult</a> update(<a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a> entity,
|
||
|
|
<a href="../../../com/sleepycat/je/WriteOptions.html" title="class in com.sleepycat.je">WriteOptions</a> options)
|
||
|
|
throws <a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></pre>
|
||
|
|
<div class="block">Replaces the entity at the cursor position with the given entity,
|
||
|
|
using a WriteOptions parameter and returning an OperationResult.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
|
<dd><code>entity</code> - the entity to replace the entity at the current position.</dd>
|
||
|
|
<dd><code>options</code> - the WriteOptions, or null to use default options.</dd>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the OperationResult if successful or null if the entity at the
|
||
|
|
current position was previously deleted.</dd>
|
||
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
|
<dd><code>java.lang.IllegalStateException</code> - if the cursor is uninitialized.</dd>
|
||
|
|
<dd><code>java.lang.UnsupportedOperationException</code> - if the index is read only or if
|
||
|
|
the value type is not an entity type.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/DuplicateDataException.html" title="class in com.sleepycat.je">DuplicateDataException</a></code> - if the old and new data are not equal
|
||
|
|
according to the configured duplicate comparator or default comparator.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
|
href="../je/OperationFailureException.html#writeFailures">Write
|
||
|
|
Operation Failures</a> occurs.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
|
environment-wide failure occurs.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></code> - the base class for all BDB exceptions.</dd>
|
||
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
||
|
|
<dd>7.0</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="delete--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>delete</h4>
|
||
|
|
<pre>boolean delete()
|
||
|
|
throws <a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></pre>
|
||
|
|
<div class="block">Deletes the entity at the cursor position.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>true if successful or false if the entity at the current
|
||
|
|
position has been deleted.
|
||
|
|
|
||
|
|
<!-- begin JE only --></dd>
|
||
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
|
<dd><code>java.lang.IllegalStateException</code> - if the cursor is uninitialized.</dd>
|
||
|
|
<dd><code>java.lang.UnsupportedOperationException</code> - if the index is read only.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
|
href="../je/OperationFailureException.html#writeFailures">Write
|
||
|
|
Operation Failures</a> occurs.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
|
environment-wide failure occurs.
|
||
|
|
<!-- end JE only --></dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></code> - the base class for all BDB exceptions.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="delete-com.sleepycat.je.WriteOptions-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>delete</h4>
|
||
|
|
<pre><a href="../../../com/sleepycat/je/OperationResult.html" title="class in com.sleepycat.je">OperationResult</a> delete(<a href="../../../com/sleepycat/je/WriteOptions.html" title="class in com.sleepycat.je">WriteOptions</a> options)
|
||
|
|
throws <a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></pre>
|
||
|
|
<div class="block">Deletes the entity at the cursor position, using a WriteOptions
|
||
|
|
parameter and returning an OperationResult.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the OperationResult if successful or null if the entity at the
|
||
|
|
current position was previously deleted.</dd>
|
||
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
|
<dd><code>java.lang.IllegalStateException</code> - if the cursor is uninitialized.</dd>
|
||
|
|
<dd><code>java.lang.UnsupportedOperationException</code> - if the index is read only.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/OperationFailureException.html" title="class in com.sleepycat.je">OperationFailureException</a></code> - if one of the <a
|
||
|
|
href="../je/OperationFailureException.html#writeFailures">Write
|
||
|
|
Operation Failures</a> occurs.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/EnvironmentFailureException.html" title="class in com.sleepycat.je">EnvironmentFailureException</a></code> - if an unexpected, internal or
|
||
|
|
environment-wide failure occurs.</dd>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></code> - the base class for all BDB exceptions.</dd>
|
||
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
||
|
|
<dd>7.0</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="dup--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>dup</h4>
|
||
|
|
<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><<a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a>> dup()
|
||
|
|
throws <a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></pre>
|
||
|
|
<div class="block">Duplicates the cursor at the cursor position. The returned cursor will
|
||
|
|
be initially positioned at the same position as this current cursor, and
|
||
|
|
will inherit this cursor's <a href="../../../com/sleepycat/je/Transaction.html" title="class in com.sleepycat.je"><code>Transaction</code></a> and <a href="../../../com/sleepycat/je/CursorConfig.html" title="class in com.sleepycat.je"><code>CursorConfig</code></a>.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the duplicated cursor.</dd>
|
||
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></code> - the base class for all BDB exceptions.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="close--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>close</h4>
|
||
|
|
<pre>void close()
|
||
|
|
throws <a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></pre>
|
||
|
|
<div class="block">Closes the cursor.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
||
|
|
<dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd>
|
||
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
||
|
|
<dd><code>close</code> in interface <code>java.io.Closeable</code></dd>
|
||
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/persist/ForwardCursor.html#close--">close</a></code> in interface <code><a href="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</a><<a href="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</a>></code></dd>
|
||
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
|
|
<dd><code><a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je">DatabaseException</a></code> - the base class for all BDB exceptions.</dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="setCacheMode-com.sleepycat.je.CacheMode-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>setCacheMode</h4>
|
||
|
|
<pre>void setCacheMode(<a href="../../../com/sleepycat/je/CacheMode.html" title="enum in com.sleepycat.je">CacheMode</a> cacheMode)</pre>
|
||
|
|
<div class="block">Changes the <code>CacheMode</code> default used for subsequent operations
|
||
|
|
performed using this cursor. For a newly opened cursor, the default is
|
||
|
|
<a href="../../../com/sleepycat/je/CacheMode.html#DEFAULT"><code>CacheMode.DEFAULT</code></a>. Note that the default is always overridden by
|
||
|
|
a non-null cache mode that is specified via <a href="../../../com/sleepycat/je/ReadOptions.html" title="class in com.sleepycat.je"><code>ReadOptions</code></a> or
|
||
|
|
<a href="../../../com/sleepycat/je/WriteOptions.html" title="class in com.sleepycat.je"><code>WriteOptions</code></a>.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
|
<dd><code>cacheMode</code> - is the default <code>CacheMode</code> used for subsequent
|
||
|
|
operations using this cursor, or null to configure the Database or
|
||
|
|
Environment default.</dd>
|
||
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
||
|
|
<dd><a href="../../../com/sleepycat/je/CacheMode.html" title="enum in com.sleepycat.je"><code>CacheMode</code></a></dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="getCacheMode--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockListLast">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>getCacheMode</h4>
|
||
|
|
<pre><a href="../../../com/sleepycat/je/CacheMode.html" title="enum in com.sleepycat.je">CacheMode</a> getCacheMode()</pre>
|
||
|
|
<div class="block">Returns the default <code>CacheMode</code> used for subsequent operations
|
||
|
|
performed using this cursor. If <a href="../../../com/sleepycat/persist/EntityCursor.html#setCacheMode-com.sleepycat.je.CacheMode-"><code>setCacheMode(com.sleepycat.je.CacheMode)</code></a> has not been
|
||
|
|
called with a non-null value, the configured Database or Environment
|
||
|
|
default is returned.</div>
|
||
|
|
<dl>
|
||
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
|
<dd>the <code>CacheMode</code> default used for subsequent operations
|
||
|
|
using this cursor.</dd>
|
||
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
||
|
|
<dd><a href="../../../com/sleepycat/je/CacheMode.html" title="enum in com.sleepycat.je"><code>CacheMode</code></a></dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
||
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||
|
|
<div class="bottomNav"><a name="navbar.bottom">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
||
|
|
<a name="navbar.bottom.firstrow">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="navList" title="Navigation">
|
||
|
|
<li><a href="../../../overview-summary.html">Overview</a></li>
|
||
|
|
<li><a href="package-summary.html">Package</a></li>
|
||
|
|
<li class="navBarCell1Rev">Class</li>
|
||
|
|
<li><a href="class-use/EntityCursor.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"><b>Berkeley DB Java Edition</b><br><font size=\"-1\"> version 7.5.11</font>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="subNav">
|
||
|
|
<ul class="navList">
|
||
|
|
<li>Prev Class</li>
|
||
|
|
<li><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist"><span class="typeNameLink">Next Class</span></a></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="navList">
|
||
|
|
<li><a href="../../../index.html?com/sleepycat/persist/EntityCursor.html" target="_top">Frames</a></li>
|
||
|
|
<li><a href="EntityCursor.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><font size=1>Copyright (c) 2002, 2017 Oracle and/or its affiliates. All rights reserved.</font> </small></p>
|
||
|
|
</body>
|
||
|
|
</html>
|