2142 lines
153 KiB
HTML
2142 lines
153 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>SecondaryCursor (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="SecondaryCursor (Oracle - Berkeley DB Java Edition API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var methods = {"i0":10,"i1":10,"i2":10,"i3":42,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10};
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/SecondaryCursor.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><a href="../../../com/sleepycat/je/SecondaryConstraintException.html" title="class in com.sleepycat.je"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../../com/sleepycat/je/SecondaryDatabase.html" title="class in com.sleepycat.je"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../index.html?com/sleepycat/je/SecondaryCursor.html" target="_top">Frames</a></li>
|
|
<li><a href="SecondaryCursor.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.je</div>
|
|
<h2 title="Class SecondaryCursor" class="title">Class SecondaryCursor</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li>java.lang.Object</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li><a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je">com.sleepycat.je.Cursor</a></li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>com.sleepycat.je.SecondaryCursor</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd><a href="../../../com/sleepycat/je/ForwardCursor.html" title="interface in com.sleepycat.je">ForwardCursor</a>, java.io.Closeable, java.lang.AutoCloseable</dd>
|
|
</dl>
|
|
<hr>
|
|
<br>
|
|
<pre>public class <span class="typeNameLabel">SecondaryCursor</span>
|
|
extends <a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je">Cursor</a></pre>
|
|
<div class="block">A database cursor for a secondary database. Cursors are not thread safe and
|
|
the application is responsible for coordinating any multithreaded access to
|
|
a single cursor object.
|
|
|
|
<p>Secondary cursors are returned by <a href="../../../com/sleepycat/je/SecondaryDatabase.html#openCursor-com.sleepycat.je.Transaction-com.sleepycat.je.CursorConfig-"><code>SecondaryDatabase.openCursor</code></a> and <a href="../../../com/sleepycat/je/SecondaryDatabase.html#openSecondaryCursor-com.sleepycat.je.Transaction-com.sleepycat.je.CursorConfig-"><code>SecondaryDatabase.openSecondaryCursor</code></a>. The distinguishing characteristics
|
|
of a secondary cursor are:</p>
|
|
|
|
<ul> <li>Direct calls to <code>put()</code> methods on a secondary cursor
|
|
are prohibited.
|
|
|
|
<li>The <a href="../../../com/sleepycat/je/SecondaryCursor.html#delete-com.sleepycat.je.WriteOptions-"><code>delete(com.sleepycat.je.WriteOptions)</code></a> method of a secondary cursor will delete the primary
|
|
record and as well as all its associated secondary records.
|
|
|
|
<li>Calls to all get methods will return the data from the associated
|
|
primary database.
|
|
|
|
<li>Additional get method signatures are provided to return the primary key
|
|
in an additional pKey parameter.
|
|
|
|
<li>Calls to <a href="../../../com/sleepycat/je/SecondaryCursor.html#dup-boolean-"><code>dup(boolean)</code></a> will return a <a href="../../../com/sleepycat/je/SecondaryCursor.html" title="class in com.sleepycat.je"><code>SecondaryCursor</code></a>.
|
|
|
|
</ul>
|
|
|
|
<p>To obtain a secondary cursor with default attributes:</p>
|
|
|
|
<blockquote><pre>
|
|
SecondaryCursor cursor = myDb.openSecondaryCursor(txn, null);
|
|
</pre></blockquote>
|
|
|
|
<p>To customize the attributes of a cursor, use a CursorConfig object.</p>
|
|
|
|
<blockquote><pre>
|
|
CursorConfig config = new CursorConfig();
|
|
config.setReadUncommitted(true);
|
|
SecondaryCursor cursor = myDb.openSecondaryCursor(txn, config);
|
|
</pre></blockquote></div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Summary</h3>
|
|
<table class="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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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><a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#delete--">delete</a></span>()</code>
|
|
<div class="block">Delete the record to which the cursor refers from the primary database
|
|
and all secondary indices.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<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/je/SecondaryCursor.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">Delete the record to which the cursor refers from the primary database
|
|
and all secondary indices.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/SecondaryCursor.html" title="class in com.sleepycat.je">SecondaryCursor</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#dup-boolean-">dup</a></span>(boolean samePosition)</code>
|
|
<div class="block">Returns a new <code>SecondaryCursor</code> for the same transaction as
|
|
the original cursor.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/SecondaryCursor.html" title="class in com.sleepycat.je">SecondaryCursor</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#dupSecondary-boolean-">dupSecondary</a></span>(boolean samePosition)</code>
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="block"><span class="deprecationComment">As of JE 4.0.13, replaced by <a href="../../../com/sleepycat/je/Cursor.html#dup-boolean-"><code>Cursor.dup(boolean)</code></a>.</p></span></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i4" 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/je/SecondaryCursor.html#get-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.Get-com.sleepycat.je.ReadOptions-">get</a></span>(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> pKey,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<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 to a record according to the specified <a href="../../../com/sleepycat/je/Get.html" title="enum in com.sleepycat.je"><code>Get</code></a>
|
|
type.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i5" class="rowColor">
|
|
<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/je/SecondaryCursor.html#get-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.Get-com.sleepycat.je.ReadOptions-">get</a></span>(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<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 to a record according to the specified <a href="../../../com/sleepycat/je/Get.html" title="enum in com.sleepycat.je"><code>Get</code></a>
|
|
type.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i6" class="altColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#getCurrent-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getCurrent</a></span>(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> pKey,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</code>
|
|
<div class="block">Returns the key/data pair to which the cursor refers.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i7" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#getCurrent-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getCurrent</a></span>(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</code>
|
|
<div class="block">Returns the key/data pair to which the cursor refers.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i8" class="altColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/SecondaryDatabase.html" title="class in com.sleepycat.je">SecondaryDatabase</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#getDatabase--">getDatabase</a></span>()</code>
|
|
<div class="block">Returns the Database handle associated with this Cursor.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i9" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#getFirst-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getFirst</a></span>(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> pKey,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</code>
|
|
<div class="block">Move the cursor to the first key/data pair of the database, and return
|
|
that pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i10" class="altColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#getFirst-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getFirst</a></span>(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<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 key/data pair of the database, and returns
|
|
that pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i11" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#getLast-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getLast</a></span>(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> pKey,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</code>
|
|
<div class="block">Move the cursor to the last key/data pair of the database, and return
|
|
that pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i12" class="altColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#getLast-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getLast</a></span>(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<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 key/data pair of the database, and returns
|
|
that pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i13" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#getNext-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getNext</a></span>(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> pKey,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</code>
|
|
<div class="block">Move the cursor to the next key/data pair and return that pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i14" class="altColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#getNext-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getNext</a></span>(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<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 key/data pair and returns that pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i15" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#getNextDup-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getNextDup</a></span>(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> pKey,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</code>
|
|
<div class="block">If the next key/data pair of the database is a duplicate data record for
|
|
the current key/data pair, move the cursor to the next key/data pair of
|
|
the database and return that pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i16" class="altColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#getNextDup-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getNextDup</a></span>(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</code>
|
|
<div class="block">If the next key/data pair of the database is a duplicate data record for
|
|
the current key/data pair, moves the cursor to the next key/data pair of
|
|
the database and returns that pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i17" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#getNextNoDup-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getNextNoDup</a></span>(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> pKey,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</code>
|
|
<div class="block">Move the cursor to the next non-duplicate key/data pair and return that
|
|
pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i18" class="altColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#getNextNoDup-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getNextNoDup</a></span>(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<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 non-duplicate key/data pair and returns
|
|
that pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i19" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#getPrev-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getPrev</a></span>(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> pKey,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</code>
|
|
<div class="block">Move the cursor to the previous key/data pair and return that pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i20" class="altColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#getPrev-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getPrev</a></span>(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<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 key/data pair and returns that pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i21" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#getPrevDup-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getPrevDup</a></span>(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> pKey,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</code>
|
|
<div class="block">If the previous key/data pair of the database is a duplicate data record
|
|
for the current key/data pair, move the cursor to the previous key/data
|
|
pair of the database and return that pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i22" class="altColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#getPrevDup-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getPrevDup</a></span>(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</code>
|
|
<div class="block">If the previous key/data pair of the database is a duplicate data record
|
|
for the current key/data pair, moves the cursor to the previous key/data
|
|
pair of the database and returns that pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i23" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#getPrevNoDup-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getPrevNoDup</a></span>(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> pKey,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</code>
|
|
<div class="block">Move the cursor to the previous non-duplicate key/data pair and return
|
|
that pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i24" class="altColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#getPrevNoDup-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getPrevNoDup</a></span>(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<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 non-duplicate key/data pair and returns
|
|
that pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i25" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/Database.html" title="class in com.sleepycat.je">Database</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#getPrimaryDatabase--">getPrimaryDatabase</a></span>()</code>
|
|
<div class="block">Returns the primary <a href="../../../com/sleepycat/je/Database.html" title="class in com.sleepycat.je"><code>Database</code></a>
|
|
associated with this cursor.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i26" class="altColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#getSearchBoth-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getSearchBoth</a></span>(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> pKey,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</code>
|
|
<div class="block">Move the cursor to the specified secondary and primary key, where both
|
|
the primary and secondary key items must match.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i27" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#getSearchBoth-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getSearchBoth</a></span>(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</code>
|
|
<div class="block">This operation is not allowed with this method signature.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i28" class="altColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#getSearchBothRange-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getSearchBothRange</a></span>(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> pKey,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</code>
|
|
<div class="block">Move the cursor to the specified secondary key and closest matching
|
|
primary key of the database.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i29" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#getSearchBothRange-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getSearchBothRange</a></span>(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</code>
|
|
<div class="block">This operation is not allowed with this method signature.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i30" class="altColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#getSearchKey-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getSearchKey</a></span>(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> pKey,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</code>
|
|
<div class="block">Move the cursor to the given key of the database, and return the datum
|
|
associated with the given key.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i31" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#getSearchKey-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getSearchKey</a></span>(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<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 given key of the database, and returns the datum
|
|
associated with the given key.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i32" class="altColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#getSearchKeyRange-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getSearchKeyRange</a></span>(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> pKey,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</code>
|
|
<div class="block">Move the cursor to the closest matching key of the database, and return
|
|
the data item associated with the matching key.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i33" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#getSearchKeyRange-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getSearchKeyRange</a></span>(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<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 closest matching key of the database, and
|
|
returns the data item associated with the matching key.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i34" class="altColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#put-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-">put</a></span>(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data)</code>
|
|
<div class="block">This operation is not allowed on a secondary cursor.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i35" class="rowColor">
|
|
<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/je/SecondaryCursor.html#put-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.Put-com.sleepycat.je.WriteOptions-">put</a></span>(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/Put.html" title="enum in com.sleepycat.je">Put</a> putType,
|
|
<a href="../../../com/sleepycat/je/WriteOptions.html" title="class in com.sleepycat.je">WriteOptions</a> options)</code>
|
|
<div class="block">This operation is not allowed on a secondary cursor.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i36" class="altColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#putCurrent-com.sleepycat.je.DatabaseEntry-">putCurrent</a></span>(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data)</code>
|
|
<div class="block">This operation is not allowed on a secondary cursor.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i37" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#putNoDupData-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-">putNoDupData</a></span>(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data)</code>
|
|
<div class="block">This operation is not allowed on a secondary cursor.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i38" class="altColor">
|
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/SecondaryCursor.html#putNoOverwrite-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-">putNoOverwrite</a></span>(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data)</code>
|
|
<div class="block">This operation is not allowed on a secondary cursor.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods.inherited.from.class.com.sleepycat.je.Cursor">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class com.sleepycat.je.<a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je">Cursor</a></h3>
|
|
<code><a href="../../../com/sleepycat/je/Cursor.html#close--">close</a>, <a href="../../../com/sleepycat/je/Cursor.html#count--">count</a>, <a href="../../../com/sleepycat/je/Cursor.html#countEstimate--">countEstimate</a>, <a href="../../../com/sleepycat/je/Cursor.html#getCacheMode--">getCacheMode</a>, <a href="../../../com/sleepycat/je/Cursor.html#getConfig--">getConfig</a>, <a href="../../../com/sleepycat/je/Cursor.html#setCacheMode-com.sleepycat.je.CacheMode-">setCacheMode</a>, <a href="../../../com/sleepycat/je/Cursor.html#skipNext-long-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">skipNext</a>, <a href="../../../com/sleepycat/je/Cursor.html#skipPrev-long-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">skipPrev</a></code></li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.lang.Object</h3>
|
|
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="getDatabase--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getDatabase</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/SecondaryDatabase.html" title="class in com.sleepycat.je">SecondaryDatabase</a> getDatabase()</pre>
|
|
<div class="block">Returns the Database handle associated with this Cursor.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="../../../com/sleepycat/je/ForwardCursor.html#getDatabase--">getDatabase</a></code> in interface <code><a href="../../../com/sleepycat/je/ForwardCursor.html" title="interface in com.sleepycat.je">ForwardCursor</a></code></dd>
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|
<dd><code><a href="../../../com/sleepycat/je/Cursor.html#getDatabase--">getDatabase</a></code> in class <code><a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je">Cursor</a></code></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The Database handle associated with this Cursor.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getPrimaryDatabase--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPrimaryDatabase</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/Database.html" title="class in com.sleepycat.je">Database</a> getPrimaryDatabase()</pre>
|
|
<div class="block">Returns the primary <a href="../../../com/sleepycat/je/Database.html" title="class in com.sleepycat.je"><code>Database</code></a>
|
|
associated with this cursor.
|
|
|
|
<p>Calling this method is the equivalent of the following
|
|
expression:</p>
|
|
|
|
<blockquote><pre>
|
|
getDatabase().getPrimaryDatabase()
|
|
</pre></blockquote></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The primary <a href="../../../com/sleepycat/je/Database.html" title="class in com.sleepycat.je"><code>Database</code></a>
|
|
associated with this cursor.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="dup-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>dup</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/SecondaryCursor.html" title="class in com.sleepycat.je">SecondaryCursor</a> dup(boolean samePosition)</pre>
|
|
<div class="block">Returns a new <code>SecondaryCursor</code> for the same transaction as
|
|
the original cursor.
|
|
|
|
<!-- inherit other javadoc from overridden method --></div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|
<dd><code><a href="../../../com/sleepycat/je/Cursor.html#dup-boolean-">dup</a></code> in class <code><a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je">Cursor</a></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>samePosition</code> - If true, the newly created cursor is initialized
|
|
to refer to the same position in the database as the original cursor
|
|
(if any) and hold the same locks (if any). If false, or the original
|
|
cursor does not hold a database position and locks, the returned
|
|
cursor is uninitialized and will behave like a newly created cursor.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>A new cursor with the same transaction and locker ID as the
|
|
original cursor.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="dupSecondary-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>dupSecondary</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/SecondaryCursor.html" title="class in com.sleepycat.je">SecondaryCursor</a> dupSecondary(boolean samePosition)</pre>
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">As of JE 4.0.13, replaced by <a href="../../../com/sleepycat/je/Cursor.html#dup-boolean-"><code>Cursor.dup(boolean)</code></a>.</p></span></div>
|
|
<div class="block">Returns a new copy of the cursor as a <code>SecondaryCursor</code>.
|
|
|
|
<p>Calling this method is the equivalent of calling <a href="../../../com/sleepycat/je/SecondaryCursor.html#dup-boolean-"><code>dup(boolean)</code></a> and
|
|
casting the result to <a href="../../../com/sleepycat/je/SecondaryCursor.html" title="class in com.sleepycat.je"><code>SecondaryCursor</code></a>.</p></div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../../../com/sleepycat/je/SecondaryCursor.html#dup-boolean-"><code>dup(boolean)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="delete-com.sleepycat.je.WriteOptions-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>delete</h4>
|
|
<pre>public <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)</pre>
|
|
<div class="block">Delete the record to which the cursor refers from the primary database
|
|
and all secondary indices.
|
|
|
|
<p>This method behaves as if <a href="../../../com/sleepycat/je/Database.html#delete-com.sleepycat.je.Transaction-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.WriteOptions-"><code>Database.delete(Transaction,
|
|
DatabaseEntry, WriteOptions)</code></a> were called for the primary database,
|
|
using the primary key associated with this cursor position.</p>
|
|
|
|
<p>The cursor position is unchanged after a delete, and subsequent calls
|
|
to cursor functions expecting the cursor to refer to an existing record
|
|
will fail.</p>
|
|
|
|
<p>WARNING: Unlike read operations using a SecondaryCursor, write
|
|
operations like this one are deadlock-prone.</p>
|
|
|
|
<!-- inherit other javadoc from overridden method --></div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|
<dd><code><a href="../../../com/sleepycat/je/Cursor.html#delete-com.sleepycat.je.WriteOptions-">delete</a></code> in class <code><a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je">Cursor</a></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>options</code> - the WriteOptions, or null to use default options.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the OperationResult if the record is deleted, else null if the
|
|
record at the cursor position has already been deleted.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="delete--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>delete</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a> delete()</pre>
|
|
<div class="block">Delete the record to which the cursor refers from the primary database
|
|
and all secondary indices.
|
|
|
|
<p>This method behaves as if <a href="../../../com/sleepycat/je/Database.html#delete-com.sleepycat.je.Transaction-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.WriteOptions-"><code>Database.delete(Transaction,
|
|
DatabaseEntry, WriteOptions)</code></a> were called for the primary database,
|
|
using the primary key associated with this cursor position.</p>
|
|
|
|
<p>The cursor position is unchanged after a delete, and subsequent calls
|
|
to cursor functions expecting the cursor to refer to an existing record
|
|
will fail.</p>
|
|
|
|
<p>Calling this method is equivalent to calling <a href="../../../com/sleepycat/je/SecondaryCursor.html#delete-com.sleepycat.je.WriteOptions-"><code>delete(WriteOptions)</code></a>.</p>
|
|
|
|
<!-- inherit other javadoc from overridden method --></div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|
<dd><code><a href="../../../com/sleepycat/je/Cursor.html#delete--">delete</a></code> in class <code><a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je">Cursor</a></code></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="../../../com/sleepycat/je/OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the record at the cursor position has
|
|
already been deleted; otherwise, <a href="../../../com/sleepycat/je/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="put-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.Put-com.sleepycat.je.WriteOptions-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>put</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationResult.html" title="class in com.sleepycat.je">OperationResult</a> put(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/Put.html" title="enum in com.sleepycat.je">Put</a> putType,
|
|
<a href="../../../com/sleepycat/je/WriteOptions.html" title="class in com.sleepycat.je">WriteOptions</a> options)</pre>
|
|
<div class="block">This operation is not allowed on a secondary cursor. <code>UnsupportedOperationException</code> will always be thrown by this method.
|
|
The corresponding method on the primary cursor should be used instead.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|
<dd><code><a href="../../../com/sleepycat/je/Cursor.html#put-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.Put-com.sleepycat.je.WriteOptions-">put</a></code> in class <code><a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je">Cursor</a></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key used as
|
|
<a href="DatabaseEntry.html#inParam">input</a>. Must be null when
|
|
putType is <code>Put.CURRENT</code>.</dd>
|
|
<dd><code>data</code> - the data used as
|
|
<a href="DatabaseEntry.html#inParam">input</a>. May be partial only when
|
|
putType is <code>Put.CURRENT</code>.</dd>
|
|
<dd><code>putType</code> - the Put operation type. May not be null.</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 the record is written, else null.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="put-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>put</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a> put(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data)</pre>
|
|
<div class="block">This operation is not allowed on a secondary cursor. <code>UnsupportedOperationException</code> will always be thrown by this method.
|
|
The corresponding method on the primary cursor should be used instead.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|
<dd><code><a href="../../../com/sleepycat/je/Cursor.html#put-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-">put</a></code> in class <code><a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je">Cursor</a></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key used as
|
|
<a href="DatabaseEntry.html#inParam">input</a>..</dd>
|
|
<dd><code>data</code> - the data used as
|
|
<a href="DatabaseEntry.html#inParam">input</a>.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="../../../com/sleepycat/je/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="putNoOverwrite-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>putNoOverwrite</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a> putNoOverwrite(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data)</pre>
|
|
<div class="block">This operation is not allowed on a secondary cursor. <code>UnsupportedOperationException</code> will always be thrown by this method.
|
|
The corresponding method on the primary cursor should be used instead.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|
<dd><code><a href="../../../com/sleepycat/je/Cursor.html#putNoOverwrite-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-">putNoOverwrite</a></code> in class <code><a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je">Cursor</a></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key used as
|
|
<a href="DatabaseEntry.html#inParam">input</a>..</dd>
|
|
<dd><code>data</code> - the data used as
|
|
<a href="DatabaseEntry.html#inParam">input</a>.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="../../../com/sleepycat/je/OperationStatus.html#KEYEXIST"><code>OperationStatus.KEYEXIST</code></a> if the key already appears in the database,
|
|
else <a href="../../../com/sleepycat/je/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="putNoDupData-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>putNoDupData</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a> putNoDupData(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data)</pre>
|
|
<div class="block">This operation is not allowed on a secondary cursor. <code>UnsupportedOperationException</code> will always be thrown by this method.
|
|
The corresponding method on the primary cursor should be used instead.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|
<dd><code><a href="../../../com/sleepycat/je/Cursor.html#putNoDupData-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-">putNoDupData</a></code> in class <code><a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je">Cursor</a></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key used as
|
|
<a href="DatabaseEntry.html#inParam">input</a>..</dd>
|
|
<dd><code>data</code> - the data used as
|
|
<a href="DatabaseEntry.html#inParam">input</a>.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="../../../com/sleepycat/je/OperationStatus.html#KEYEXIST"><code>OperationStatus.KEYEXIST</code></a> if the key/data pair already appears in the
|
|
database, else <a href="../../../com/sleepycat/je/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="putCurrent-com.sleepycat.je.DatabaseEntry-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>putCurrent</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a> putCurrent(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data)</pre>
|
|
<div class="block">This operation is not allowed on a secondary cursor. <code>UnsupportedOperationException</code> will always be thrown by this method.
|
|
The corresponding method on the primary cursor should be used instead.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|
<dd><code><a href="../../../com/sleepycat/je/Cursor.html#putCurrent-com.sleepycat.je.DatabaseEntry-">putCurrent</a></code> in class <code><a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je">Cursor</a></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>data</code> - the data used as
|
|
<a href="DatabaseEntry.html#inParam">input</a>.
|
|
A <a href="Cursor.html#partialEntry">partial data item</a> may be
|
|
specified to optimize for partial data update.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="../../../com/sleepycat/je/OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the key/pair at the cursor position has
|
|
been deleted; otherwise, <a href="../../../com/sleepycat/je/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="get-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.Get-com.sleepycat.je.ReadOptions-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>get</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationResult.html" title="class in com.sleepycat.je">OperationResult</a> get(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<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)</pre>
|
|
<div class="block">Moves the cursor to a record according to the specified <a href="../../../com/sleepycat/je/Get.html" title="enum in com.sleepycat.je"><code>Get</code></a>
|
|
type.
|
|
|
|
<p>The difference between this method and the method it overrides in
|
|
<a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je"><code>Cursor</code></a> is that the key here is defined as the secondary
|
|
records's key, and the data is defined as the primary record's data.
|
|
In addition, two operations are not supported by this method:
|
|
<a href="../../../com/sleepycat/je/Get.html#SEARCH_BOTH"><code>Get.SEARCH_BOTH</code></a> and <a href="../../../com/sleepycat/je/Get.html#SEARCH_BOTH_GTE"><code>Get.SEARCH_BOTH_GTE</code></a>.</p></div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="../../../com/sleepycat/je/ForwardCursor.html#get-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.Get-com.sleepycat.je.ReadOptions-">get</a></code> in interface <code><a href="../../../com/sleepycat/je/ForwardCursor.html" title="interface in com.sleepycat.je">ForwardCursor</a></code></dd>
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|
<dd><code><a href="../../../com/sleepycat/je/Cursor.html#get-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.Get-com.sleepycat.je.ReadOptions-">get</a></code> in class <code><a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je">Cursor</a></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key input or output parameter, depending on getType.</dd>
|
|
<dd><code>data</code> - the data input or output parameter, depending on getType.</dd>
|
|
<dd><code>getType</code> - the Get operation type. May not be null.</dd>
|
|
<dd><code>options</code> - the ReadOptions, or null to use default options.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the OperationResult if the record requested is found, else null.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="get-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.Get-com.sleepycat.je.ReadOptions-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>get</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationResult.html" title="class in com.sleepycat.je">OperationResult</a> get(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> pKey,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<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)</pre>
|
|
<div class="block">Moves the cursor to a record according to the specified <a href="../../../com/sleepycat/je/Get.html" title="enum in com.sleepycat.je"><code>Get</code></a>
|
|
type.
|
|
|
|
<p>If the operation succeeds, the record at the resulting cursor
|
|
position will be locked according to the <a href="../../../com/sleepycat/je/ReadOptions.html#getLockMode--"><code>lock mode</code></a> specified, the key, primary key,
|
|
and/or data will be returned via the (non-null) DatabaseEntry
|
|
parameters, and a non-null OperationResult will be returned. If the
|
|
operation fails because the record requested is not found, null is
|
|
returned.</p>
|
|
|
|
<p>The following table lists each allowed operation and whether the key,
|
|
pKey and data parameters are <a href="DatabaseEntry.html#params">input
|
|
or output parameters</a>. Also specified is whether the cursor must be
|
|
initialized (positioned on a record) 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>'key' parameter</th>
|
|
<th>'pKey' parameter</th>
|
|
<th>'data' parameter</th>
|
|
<th>Cursor position<br/>must be initialized?</th>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="../../../com/sleepycat/je/Get.html#SEARCH"><code>Get.SEARCH</code></a></td>
|
|
<td>Searches using an exact match by key.</td>
|
|
<td><a href="DatabaseEntry.html#inParam">input</a></td>
|
|
<td><a href="DatabaseEntry.html#outParam">output</a></td>
|
|
<td><a href="DatabaseEntry.html#outParam">output</a></td>
|
|
<td>no</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="../../../com/sleepycat/je/Get.html#SEARCH_BOTH"><code>Get.SEARCH_BOTH</code></a></td>
|
|
<td>Searches using an exact match by key and pKey.</td>
|
|
<td><a href="DatabaseEntry.html#inParam">input</a></td>
|
|
<td><a href="DatabaseEntry.html#inParam">input</a></td>
|
|
<td><a href="DatabaseEntry.html#outParam">output</a></td>
|
|
<td>no</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="../../../com/sleepycat/je/Get.html#SEARCH_GTE"><code>Get.SEARCH_GTE</code></a></td>
|
|
<td>Searches using a GTE match by key.</td>
|
|
<td><a href="DatabaseEntry.html#inParam">input/output</a></td>
|
|
<td><a href="DatabaseEntry.html#outParam">output</a></td>
|
|
<td><a href="DatabaseEntry.html#outParam">output</a></td>
|
|
<td>no</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="../../../com/sleepycat/je/Get.html#SEARCH_BOTH_GTE"><code>Get.SEARCH_BOTH_GTE</code></a></td>
|
|
<td>Searches using an exact match by key and a GTE match by pKey.</td>
|
|
<td><a href="DatabaseEntry.html#inParam">input</a></td>
|
|
<td><a href="DatabaseEntry.html#inParam">input/output</a></td>
|
|
<td><a href="DatabaseEntry.html#outParam">output</a></td>
|
|
<td>no</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="../../../com/sleepycat/je/Get.html#CURRENT"><code>Get.CURRENT</code></a></td>
|
|
<td>Accesses the current record</td>
|
|
<td><a href="DatabaseEntry.html#outParam">output</a></td>
|
|
<td><a href="DatabaseEntry.html#outParam">output</a></td>
|
|
<td><a href="DatabaseEntry.html#outParam">output</a></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 record in the database.</td>
|
|
<td><a href="DatabaseEntry.html#outParam">output</a></td>
|
|
<td><a href="DatabaseEntry.html#outParam">output</a></td>
|
|
<td><a href="DatabaseEntry.html#outParam">output</a></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 record in the database.</td>
|
|
<td><a href="DatabaseEntry.html#outParam">output</a></td>
|
|
<td><a href="DatabaseEntry.html#outParam">output</a></td>
|
|
<td><a href="DatabaseEntry.html#outParam">output</a></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 record.</td>
|
|
<td><a href="DatabaseEntry.html#outParam">output</a></td>
|
|
<td><a href="DatabaseEntry.html#outParam">output</a></td>
|
|
<td><a href="DatabaseEntry.html#outParam">output</a></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 record with the same key.</td>
|
|
<td><a href="DatabaseEntry.html#outParam">output</a></td>
|
|
<td><a href="DatabaseEntry.html#outParam">output</a></td>
|
|
<td><a href="DatabaseEntry.html#outParam">output</a></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 record with a different key.</td>
|
|
<td><a href="DatabaseEntry.html#outParam">output</a></td>
|
|
<td><a href="DatabaseEntry.html#outParam">output</a></td>
|
|
<td><a href="DatabaseEntry.html#outParam">output</a></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 record.</td>
|
|
<td><a href="DatabaseEntry.html#outParam">output</a></td>
|
|
<td><a href="DatabaseEntry.html#outParam">output</a></td>
|
|
<td><a href="DatabaseEntry.html#outParam">output</a></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 record with the same key.</td>
|
|
<td><a href="DatabaseEntry.html#outParam">output</a></td>
|
|
<td><a href="DatabaseEntry.html#outParam">output</a></td>
|
|
<td><a href="DatabaseEntry.html#outParam">output</a></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 record with a different key.</td>
|
|
<td><a href="DatabaseEntry.html#outParam">output</a></td>
|
|
<td><a href="DatabaseEntry.html#outParam">output</a></td>
|
|
<td><a href="DatabaseEntry.html#outParam">output</a></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 record, respectively.</p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the secondary key input or output parameter, depending on
|
|
getType.</dd>
|
|
<dd><code>pKey</code> - the primary key input or output parameter, depending on
|
|
getType.</dd>
|
|
<dd><code>data</code> - the primary data output parameter.</dd>
|
|
<dd><code>getType</code> - the Get operation type. May not be null.</dd>
|
|
<dd><code>options</code> - the ReadOptions, or null to use default options.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the OperationResult if the record requested is found, else null.</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="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>java.lang.IllegalStateException</code> - if the cursor or database has been closed,
|
|
the cursor is uninitialized (not positioned on a record) and this is not
|
|
permitted (see above), or the non-transactional cursor was created in a
|
|
different thread.</dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter is specified.
|
|
This includes passing a null getType, a null input key/pKey parameter,
|
|
an input key/pKey parameter with a null data array, a partial key/pKey
|
|
input parameter, and specifying a <a href="../../../com/sleepycat/je/ReadOptions.html#getLockMode--"><code>lock mode</code></a> of READ_COMMITTED.</dd>
|
|
<dt><span class="simpleTagLabel">Since:</span></dt>
|
|
<dd>7.0</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getCurrent-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCurrent</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a> getCurrent(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</pre>
|
|
<div class="block">Returns the key/data pair to which the cursor refers.
|
|
|
|
<p>Calling this method is equivalent to calling <a href="../../../com/sleepycat/je/Cursor.html#get-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.Get-com.sleepycat.je.ReadOptions-"><code>Cursor.get(DatabaseEntry, DatabaseEntry, Get, ReadOptions)</code></a> with
|
|
<a href="../../../com/sleepycat/je/Get.html#CURRENT"><code>Get.CURRENT</code></a>.</p>
|
|
|
|
The difference between this method and the method it overrides in
|
|
<a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je"><code>Cursor</code></a> is that the key here is defined as the secondary
|
|
records's key, and the data is defined as the primary record's data.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="../../../com/sleepycat/je/ForwardCursor.html#getCurrent-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getCurrent</a></code> in interface <code><a href="../../../com/sleepycat/je/ForwardCursor.html" title="interface in com.sleepycat.je">ForwardCursor</a></code></dd>
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|
<dd><code><a href="../../../com/sleepycat/je/Cursor.html#getCurrent-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getCurrent</a></code> in class <code><a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je">Cursor</a></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key returned as
|
|
<a href="DatabaseEntry.html#outParam">output</a>.</dd>
|
|
<dd><code>data</code> - the data returned as
|
|
<a href="DatabaseEntry.html#outParam">output</a>.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are
|
|
used. <a href="../../../com/sleepycat/je/LockMode.html#READ_COMMITTED"><code>LockMode.READ_COMMITTED</code></a> is not allowed.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="../../../com/sleepycat/je/OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the key/pair at the cursor position has
|
|
been deleted; otherwise, <a href="../../../com/sleepycat/je/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getCurrent-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCurrent</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a> getCurrent(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> pKey,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</pre>
|
|
<div class="block">Returns the key/data pair to which the cursor refers.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the secondary key returned as output. Its byte array does
|
|
not need to be initialized by the caller.</dd>
|
|
<dd><code>pKey</code> - the primary key returned as output. Its byte array does not
|
|
need to be initialized by the caller.</dd>
|
|
<dd><code>data</code> - the primary data returned as output. Its byte array does
|
|
not need to be initialized by the caller.
|
|
A <a href="Cursor.html#partialEntry">partial data item</a> may be
|
|
specified to optimize for key only or partial data retrieval.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are
|
|
used. <a href="../../../com/sleepycat/je/LockMode.html#READ_COMMITTED"><code>LockMode.READ_COMMITTED</code></a> is not allowed.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="../../../com/sleepycat/je/OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the key/pair at the cursor position has
|
|
been deleted; otherwise, <a href="../../../com/sleepycat/je/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</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="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>java.lang.IllegalStateException</code> - if the cursor or database has been closed,
|
|
or the cursor is uninitialized (not positioned on a record), or the
|
|
non-transactional cursor was created in a different thread.</dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter is specified,
|
|
for example, if a DatabaseEntry parameter is null or does not contain a
|
|
required non-null byte array.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getFirst-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getFirst</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a> getFirst(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</pre>
|
|
<div class="block">Moves the cursor to the first key/data pair of the database, and returns
|
|
that pair. If the first key has duplicate values, the first data item
|
|
in the set of duplicates is returned.
|
|
|
|
<p>Calling this method is equivalent to calling <a href="../../../com/sleepycat/je/Cursor.html#get-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.Get-com.sleepycat.je.ReadOptions-"><code>Cursor.get(DatabaseEntry, DatabaseEntry, Get, ReadOptions)</code></a> with
|
|
<a href="../../../com/sleepycat/je/Get.html#FIRST"><code>Get.FIRST</code></a>.</p>
|
|
|
|
The difference between this method and the method it overrides in
|
|
<a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je"><code>Cursor</code></a> is that the key here is defined as the secondary
|
|
records's key, and the data is defined as the primary record's data.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|
<dd><code><a href="../../../com/sleepycat/je/Cursor.html#getFirst-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getFirst</a></code> in class <code><a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je">Cursor</a></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key returned as
|
|
<a href="DatabaseEntry.html#outParam">output</a>.</dd>
|
|
<dd><code>data</code> - the data returned as
|
|
<a href="DatabaseEntry.html#outParam">output</a>.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are
|
|
used. <a href="../../../com/sleepycat/je/LockMode.html#READ_COMMITTED"><code>LockMode.READ_COMMITTED</code></a> is not allowed.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="../../../com/sleepycat/je/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found;
|
|
otherwise, <a href="../../../com/sleepycat/je/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getFirst-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getFirst</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a> getFirst(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> pKey,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</pre>
|
|
<div class="block">Move the cursor to the first key/data pair of the database, and return
|
|
that pair. If the first key has duplicate values, the first data item
|
|
in the set of duplicates is returned.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the secondary key returned as output. Its byte array does
|
|
not need to be initialized by the caller.</dd>
|
|
<dd><code>pKey</code> - the primary key returned as output. Its byte array does not
|
|
need to be initialized by the caller.</dd>
|
|
<dd><code>data</code> - the primary data returned as output. Its byte array does
|
|
not need to be initialized by the caller.
|
|
A <a href="Cursor.html#partialEntry">partial data item</a> may be
|
|
specified to optimize for key only or partial data retrieval.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are
|
|
used. <a href="../../../com/sleepycat/je/LockMode.html#READ_COMMITTED"><code>LockMode.READ_COMMITTED</code></a> is not allowed.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="../../../com/sleepycat/je/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found;
|
|
otherwise, <a href="../../../com/sleepycat/je/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</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="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>java.lang.IllegalStateException</code> - if the cursor or database has been closed,
|
|
or the non-transactional cursor was created in a different thread.</dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter is specified,
|
|
for example, if a DatabaseEntry parameter is null or does not contain a
|
|
required non-null byte array.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getLast-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLast</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a> getLast(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</pre>
|
|
<div class="block">Moves the cursor to the last key/data pair of the database, and returns
|
|
that pair. If the last key has duplicate values, the last data item in
|
|
the set of duplicates is returned.
|
|
|
|
<p>Calling this method is equivalent to calling <a href="../../../com/sleepycat/je/Cursor.html#get-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.Get-com.sleepycat.je.ReadOptions-"><code>Cursor.get(DatabaseEntry, DatabaseEntry, Get, ReadOptions)</code></a> with
|
|
<a href="../../../com/sleepycat/je/Get.html#LAST"><code>Get.LAST</code></a>.</p>
|
|
|
|
The difference between this method and the method it overrides in
|
|
<a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je"><code>Cursor</code></a> is that the key here is defined as the secondary
|
|
records's key, and the data is defined as the primary record's data.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|
<dd><code><a href="../../../com/sleepycat/je/Cursor.html#getLast-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getLast</a></code> in class <code><a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je">Cursor</a></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key returned as
|
|
<a href="DatabaseEntry.html#outParam">output</a>.</dd>
|
|
<dd><code>data</code> - the data returned as
|
|
<a href="DatabaseEntry.html#outParam">output</a>.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are
|
|
used. <a href="../../../com/sleepycat/je/LockMode.html#READ_COMMITTED"><code>LockMode.READ_COMMITTED</code></a> is not allowed.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="../../../com/sleepycat/je/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found;
|
|
otherwise, <a href="../../../com/sleepycat/je/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getLast-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLast</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a> getLast(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> pKey,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</pre>
|
|
<div class="block">Move the cursor to the last key/data pair of the database, and return
|
|
that pair. If the last key has duplicate values, the last data item in
|
|
the set of duplicates is returned.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the secondary key returned as output. Its byte array does
|
|
not need to be initialized by the caller.</dd>
|
|
<dd><code>pKey</code> - the primary key returned as output. Its byte array does not
|
|
need to be initialized by the caller.</dd>
|
|
<dd><code>data</code> - the primary data returned as output. Its byte array does
|
|
not need to be initialized by the caller.
|
|
A <a href="Cursor.html#partialEntry">partial data item</a> may be
|
|
specified to optimize for key only or partial data retrieval.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are
|
|
used. <a href="../../../com/sleepycat/je/LockMode.html#READ_COMMITTED"><code>LockMode.READ_COMMITTED</code></a> is not allowed.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="../../../com/sleepycat/je/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found;
|
|
otherwise, <a href="../../../com/sleepycat/je/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</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="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>java.lang.IllegalStateException</code> - if the cursor or database has been closed,
|
|
or the non-transactional cursor was created in a different thread.</dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter is specified,
|
|
for example, if a DatabaseEntry parameter is null or does not contain a
|
|
required non-null byte array.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getNext-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getNext</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a> getNext(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</pre>
|
|
<div class="block">Moves the cursor to the next key/data pair and returns that pair.
|
|
|
|
<p>Calling this method is equivalent to calling <a href="../../../com/sleepycat/je/Cursor.html#get-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.Get-com.sleepycat.je.ReadOptions-"><code>Cursor.get(DatabaseEntry, DatabaseEntry, Get, ReadOptions)</code></a> with
|
|
<a href="../../../com/sleepycat/je/Get.html#NEXT"><code>Get.NEXT</code></a>.</p>
|
|
|
|
<p>If the cursor is not yet initialized, move the cursor to the first
|
|
key/data pair of the database, and return that pair. Otherwise, the
|
|
cursor is moved to the next key/data pair of the database, and that pair
|
|
is returned. In the presence of duplicate key values, the value of the
|
|
key may not change.</p>
|
|
|
|
The difference between this method and the method it overrides in
|
|
<a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je"><code>Cursor</code></a> is that the key here is defined as the secondary
|
|
records's key, and the data is defined as the primary record's data.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="../../../com/sleepycat/je/ForwardCursor.html#getNext-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getNext</a></code> in interface <code><a href="../../../com/sleepycat/je/ForwardCursor.html" title="interface in com.sleepycat.je">ForwardCursor</a></code></dd>
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|
<dd><code><a href="../../../com/sleepycat/je/Cursor.html#getNext-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getNext</a></code> in class <code><a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je">Cursor</a></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key returned as
|
|
<a href="DatabaseEntry.html#outParam">output</a>.</dd>
|
|
<dd><code>data</code> - the data returned as
|
|
<a href="DatabaseEntry.html#outParam">output</a>.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are
|
|
used. <a href="../../../com/sleepycat/je/LockMode.html#READ_COMMITTED"><code>LockMode.READ_COMMITTED</code></a> is not allowed.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="../../../com/sleepycat/je/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found;
|
|
otherwise, <a href="../../../com/sleepycat/je/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getNext-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getNext</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a> getNext(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> pKey,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</pre>
|
|
<div class="block">Move the cursor to the next key/data pair and return that pair. If the
|
|
matching key has duplicate values, the first data item in the set of
|
|
duplicates is returned.
|
|
|
|
<p>If the cursor is not yet initialized, move the cursor to the first
|
|
key/data pair of the database, and return that pair. Otherwise, the
|
|
cursor is moved to the next key/data pair of the database, and that pair
|
|
is returned. In the presence of duplicate key values, the value of the
|
|
key may not change.</p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the secondary key returned as output. Its byte array does
|
|
not need to be initialized by the caller.</dd>
|
|
<dd><code>pKey</code> - the primary key returned as output. Its byte array does not
|
|
need to be initialized by the caller.</dd>
|
|
<dd><code>data</code> - the primary data returned as output. Its byte array does
|
|
not need to be initialized by the caller.
|
|
A <a href="Cursor.html#partialEntry">partial data item</a> may be
|
|
specified to optimize for key only or partial data retrieval.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are
|
|
used. <a href="../../../com/sleepycat/je/LockMode.html#READ_COMMITTED"><code>LockMode.READ_COMMITTED</code></a> is not allowed.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="../../../com/sleepycat/je/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found;
|
|
otherwise, <a href="../../../com/sleepycat/je/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</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="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>java.lang.IllegalStateException</code> - if the cursor or database has been closed,
|
|
or the non-transactional cursor was created in a different thread.</dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter is specified,
|
|
for example, if a DatabaseEntry parameter is null or does not contain a
|
|
required non-null byte array.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getNextDup-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getNextDup</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a> getNextDup(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</pre>
|
|
<div class="block">If the next key/data pair of the database is a duplicate data record for
|
|
the current key/data pair, moves the cursor to the next key/data pair of
|
|
the database and returns that pair.
|
|
|
|
<p>Calling this method is equivalent to calling <a href="../../../com/sleepycat/je/Cursor.html#get-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.Get-com.sleepycat.je.ReadOptions-"><code>Cursor.get(DatabaseEntry, DatabaseEntry, Get, ReadOptions)</code></a> with
|
|
<a href="../../../com/sleepycat/je/Get.html#NEXT_DUP"><code>Get.NEXT_DUP</code></a>.</p>
|
|
|
|
The difference between this method and the method it overrides in
|
|
<a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je"><code>Cursor</code></a> is that the key here is defined as the secondary
|
|
records's key, and the data is defined as the primary record's data.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|
<dd><code><a href="../../../com/sleepycat/je/Cursor.html#getNextDup-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getNextDup</a></code> in class <code><a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je">Cursor</a></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key returned as
|
|
<a href="DatabaseEntry.html#outParam">output</a>.</dd>
|
|
<dd><code>data</code> - the data returned as
|
|
<a href="DatabaseEntry.html#outParam">output</a>.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are
|
|
used. <a href="../../../com/sleepycat/je/LockMode.html#READ_COMMITTED"><code>LockMode.READ_COMMITTED</code></a> is not allowed.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="../../../com/sleepycat/je/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found;
|
|
otherwise, <a href="../../../com/sleepycat/je/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getNextDup-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getNextDup</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a> getNextDup(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> pKey,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</pre>
|
|
<div class="block">If the next key/data pair of the database is a duplicate data record for
|
|
the current key/data pair, move the cursor to the next key/data pair of
|
|
the database and return that pair.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the secondary key returned as output. Its byte array does
|
|
not need to be initialized by the caller.</dd>
|
|
<dd><code>pKey</code> - the primary key returned as output. Its byte array does not
|
|
need to be initialized by the caller.</dd>
|
|
<dd><code>data</code> - the primary data returned as output. Its byte array does
|
|
not need to be initialized by the caller.
|
|
A <a href="Cursor.html#partialEntry">partial data item</a> may be
|
|
specified to optimize for key only or partial data retrieval.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are
|
|
used. <a href="../../../com/sleepycat/je/LockMode.html#READ_COMMITTED"><code>LockMode.READ_COMMITTED</code></a> is not allowed.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="../../../com/sleepycat/je/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found;
|
|
otherwise, <a href="../../../com/sleepycat/je/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</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="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>java.lang.IllegalStateException</code> - if the cursor or database has been closed,
|
|
or the cursor is uninitialized (not positioned on a record), or the
|
|
non-transactional cursor was created in a different thread.</dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter is specified,
|
|
for example, if a DatabaseEntry parameter is null or does not contain a
|
|
required non-null byte array.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getNextNoDup-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getNextNoDup</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a> getNextNoDup(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</pre>
|
|
<div class="block">Moves the cursor to the next non-duplicate key/data pair and returns
|
|
that pair. If the matching key has duplicate values, the first data
|
|
item in the set of duplicates is returned.
|
|
|
|
<p>Calling this method is equivalent to calling <a href="../../../com/sleepycat/je/Cursor.html#get-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.Get-com.sleepycat.je.ReadOptions-"><code>Cursor.get(DatabaseEntry, DatabaseEntry, Get, ReadOptions)</code></a> with
|
|
<a href="../../../com/sleepycat/je/Get.html#NEXT_NO_DUP"><code>Get.NEXT_NO_DUP</code></a>.</p>
|
|
|
|
<p>If the cursor is not yet initialized, move the cursor to the first
|
|
key/data pair of the database, and return that pair. Otherwise, the
|
|
cursor is moved to the next non-duplicate key of the database, and that
|
|
key/data pair is returned.</p>
|
|
|
|
The difference between this method and the method it overrides in
|
|
<a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je"><code>Cursor</code></a> is that the key here is defined as the secondary
|
|
records's key, and the data is defined as the primary record's data.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|
<dd><code><a href="../../../com/sleepycat/je/Cursor.html#getNextNoDup-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getNextNoDup</a></code> in class <code><a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je">Cursor</a></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key returned as
|
|
<a href="DatabaseEntry.html#outParam">output</a>.</dd>
|
|
<dd><code>data</code> - the data returned as
|
|
<a href="DatabaseEntry.html#outParam">output</a>.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are
|
|
used. <a href="../../../com/sleepycat/je/LockMode.html#READ_COMMITTED"><code>LockMode.READ_COMMITTED</code></a> is not allowed.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="../../../com/sleepycat/je/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found;
|
|
otherwise, <a href="../../../com/sleepycat/je/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getNextNoDup-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getNextNoDup</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a> getNextNoDup(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> pKey,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</pre>
|
|
<div class="block">Move the cursor to the next non-duplicate key/data pair and return that
|
|
pair. If the matching key has duplicate values, the first data item in
|
|
the set of duplicates is returned.
|
|
|
|
<p>If the cursor is not yet initialized, move the cursor to the first
|
|
key/data pair of the database, and return that pair. Otherwise, the
|
|
cursor is moved to the next non-duplicate key of the database, and that
|
|
key/data pair is returned.</p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the secondary key returned as output. Its byte array does
|
|
not need to be initialized by the caller.</dd>
|
|
<dd><code>pKey</code> - the primary key returned as output. Its byte array does not
|
|
need to be initialized by the caller.</dd>
|
|
<dd><code>data</code> - the primary data returned as output. Its byte array does
|
|
not need to be initialized by the caller.
|
|
A <a href="Cursor.html#partialEntry">partial data item</a> may be
|
|
specified to optimize for key only or partial data retrieval.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are
|
|
used. <a href="../../../com/sleepycat/je/LockMode.html#READ_COMMITTED"><code>LockMode.READ_COMMITTED</code></a> is not allowed.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="../../../com/sleepycat/je/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found;
|
|
otherwise, <a href="../../../com/sleepycat/je/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</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="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>java.lang.IllegalStateException</code> - if the cursor or database has been closed,
|
|
or the non-transactional cursor was created in a different thread.</dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter is specified,
|
|
for example, if a DatabaseEntry parameter is null or does not contain a
|
|
required non-null byte array.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getPrev-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPrev</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a> getPrev(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</pre>
|
|
<div class="block">Moves the cursor to the previous key/data pair and returns that pair.
|
|
|
|
<p>Calling this method is equivalent to calling <a href="../../../com/sleepycat/je/Cursor.html#get-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.Get-com.sleepycat.je.ReadOptions-"><code>Cursor.get(DatabaseEntry, DatabaseEntry, Get, ReadOptions)</code></a> with
|
|
<a href="../../../com/sleepycat/je/Get.html#PREV"><code>Get.PREV</code></a>.</p>
|
|
|
|
<p>If the cursor is not yet initialized, move the cursor to the last
|
|
key/data pair of the database, and return that pair. Otherwise, the
|
|
cursor is moved to the previous key/data pair of the database, and that
|
|
pair is returned. In the presence of duplicate key values, the value of
|
|
the key may not change.</p>
|
|
|
|
The difference between this method and the method it overrides in
|
|
<a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je"><code>Cursor</code></a> is that the key here is defined as the secondary
|
|
records's key, and the data is defined as the primary record's data.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|
<dd><code><a href="../../../com/sleepycat/je/Cursor.html#getPrev-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getPrev</a></code> in class <code><a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je">Cursor</a></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key returned as
|
|
<a href="DatabaseEntry.html#outParam">output</a>.</dd>
|
|
<dd><code>data</code> - the data returned as
|
|
<a href="DatabaseEntry.html#outParam">output</a>.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are
|
|
used. <a href="../../../com/sleepycat/je/LockMode.html#READ_COMMITTED"><code>LockMode.READ_COMMITTED</code></a> is not allowed.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="../../../com/sleepycat/je/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found;
|
|
otherwise, <a href="../../../com/sleepycat/je/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getPrev-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPrev</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a> getPrev(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> pKey,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</pre>
|
|
<div class="block">Move the cursor to the previous key/data pair and return that pair. If
|
|
the matching key has duplicate values, the last data item in the set of
|
|
duplicates is returned.
|
|
|
|
<p>If the cursor is not yet initialized, move the cursor to the last
|
|
key/data pair of the database, and return that pair. Otherwise, the
|
|
cursor is moved to the previous key/data pair of the database, and that
|
|
pair is returned. In the presence of duplicate key values, the value of
|
|
the key may not change.</p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the secondary key returned as output. Its byte array does
|
|
not need to be initialized by the caller.</dd>
|
|
<dd><code>pKey</code> - the primary key returned as output. Its byte array does not
|
|
need to be initialized by the caller.</dd>
|
|
<dd><code>data</code> - the primary data returned as output. Its byte array does
|
|
not need to be initialized by the caller.
|
|
A <a href="Cursor.html#partialEntry">partial data item</a> may be
|
|
specified to optimize for key only or partial data retrieval.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are
|
|
used. <a href="../../../com/sleepycat/je/LockMode.html#READ_COMMITTED"><code>LockMode.READ_COMMITTED</code></a> is not allowed.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="../../../com/sleepycat/je/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found;
|
|
otherwise, <a href="../../../com/sleepycat/je/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</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="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>java.lang.IllegalStateException</code> - if the cursor or database has been closed,
|
|
or the non-transactional cursor was created in a different thread.</dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter is specified,
|
|
for example, if a DatabaseEntry parameter is null or does not contain a
|
|
required non-null byte array.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getPrevDup-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPrevDup</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a> getPrevDup(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</pre>
|
|
<div class="block">If the previous key/data pair of the database is a duplicate data record
|
|
for the current key/data pair, moves the cursor to the previous key/data
|
|
pair of the database and returns that pair.
|
|
|
|
<p>Calling this method is equivalent to calling <a href="../../../com/sleepycat/je/Cursor.html#get-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.Get-com.sleepycat.je.ReadOptions-"><code>Cursor.get(DatabaseEntry, DatabaseEntry, Get, ReadOptions)</code></a> with
|
|
<a href="../../../com/sleepycat/je/Get.html#PREV_DUP"><code>Get.PREV_DUP</code></a>.</p>
|
|
|
|
The difference between this method and the method it overrides in
|
|
<a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je"><code>Cursor</code></a> is that the key here is defined as the secondary
|
|
records's key, and the data is defined as the primary record's data.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|
<dd><code><a href="../../../com/sleepycat/je/Cursor.html#getPrevDup-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getPrevDup</a></code> in class <code><a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je">Cursor</a></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key returned as
|
|
<a href="DatabaseEntry.html#outParam">output</a>.</dd>
|
|
<dd><code>data</code> - the data returned as
|
|
<a href="DatabaseEntry.html#outParam">output</a>.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are
|
|
used. <a href="../../../com/sleepycat/je/LockMode.html#READ_COMMITTED"><code>LockMode.READ_COMMITTED</code></a> is not allowed.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="../../../com/sleepycat/je/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found;
|
|
otherwise, <a href="../../../com/sleepycat/je/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getPrevDup-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPrevDup</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a> getPrevDup(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> pKey,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</pre>
|
|
<div class="block">If the previous key/data pair of the database is a duplicate data record
|
|
for the current key/data pair, move the cursor to the previous key/data
|
|
pair of the database and return that pair.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the secondary key returned as output. Its byte array does
|
|
not need to be initialized by the caller.</dd>
|
|
<dd><code>pKey</code> - the primary key returned as output. Its byte array does not
|
|
need to be initialized by the caller.</dd>
|
|
<dd><code>data</code> - the primary data returned as output. Its byte array does
|
|
not need to be initialized by the caller.
|
|
A <a href="Cursor.html#partialEntry">partial data item</a> may be
|
|
specified to optimize for key only or partial data retrieval.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are
|
|
used. <a href="../../../com/sleepycat/je/LockMode.html#READ_COMMITTED"><code>LockMode.READ_COMMITTED</code></a> is not allowed.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="../../../com/sleepycat/je/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found;
|
|
otherwise, <a href="../../../com/sleepycat/je/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</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="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>java.lang.IllegalStateException</code> - if the cursor or database has been closed,
|
|
or the cursor is uninitialized (not positioned on a record), or the
|
|
non-transactional cursor was created in a different thread.</dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter is specified,
|
|
for example, if a DatabaseEntry parameter is null or does not contain a
|
|
required non-null byte array.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getPrevNoDup-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPrevNoDup</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a> getPrevNoDup(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</pre>
|
|
<div class="block">Moves the cursor to the previous non-duplicate key/data pair and returns
|
|
that pair. If the matching key has duplicate values, the last data item
|
|
in the set of duplicates is returned.
|
|
|
|
<p>Calling this method is equivalent to calling <a href="../../../com/sleepycat/je/Cursor.html#get-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.Get-com.sleepycat.je.ReadOptions-"><code>Cursor.get(DatabaseEntry, DatabaseEntry, Get, ReadOptions)</code></a> with
|
|
<a href="../../../com/sleepycat/je/Get.html#PREV_NO_DUP"><code>Get.PREV_NO_DUP</code></a>.</p>
|
|
|
|
<p>If the cursor is not yet initialized, move the cursor to the last
|
|
key/data pair of the database, and return that pair. Otherwise, the
|
|
cursor is moved to the previous non-duplicate key of the database, and
|
|
that key/data pair is returned.</p>
|
|
|
|
The difference between this method and the method it overrides in
|
|
<a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je"><code>Cursor</code></a> is that the key here is defined as the secondary
|
|
records's key, and the data is defined as the primary record's data.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|
<dd><code><a href="../../../com/sleepycat/je/Cursor.html#getPrevNoDup-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getPrevNoDup</a></code> in class <code><a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je">Cursor</a></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key returned as
|
|
<a href="DatabaseEntry.html#outParam">output</a>.</dd>
|
|
<dd><code>data</code> - the data returned as
|
|
<a href="DatabaseEntry.html#outParam">output</a>.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are
|
|
used. <a href="../../../com/sleepycat/je/LockMode.html#READ_COMMITTED"><code>LockMode.READ_COMMITTED</code></a> is not allowed.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="../../../com/sleepycat/je/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found;
|
|
otherwise, <a href="../../../com/sleepycat/je/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getPrevNoDup-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPrevNoDup</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a> getPrevNoDup(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> pKey,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</pre>
|
|
<div class="block">Move the cursor to the previous non-duplicate key/data pair and return
|
|
that pair. If the matching key has duplicate values, the last data item
|
|
in the set of duplicates is returned.
|
|
|
|
<p>If the cursor is not yet initialized, move the cursor to the last
|
|
key/data pair of the database, and return that pair. Otherwise, the
|
|
cursor is moved to the previous non-duplicate key of the database, and
|
|
that key/data pair is returned.</p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the secondary key returned as output. Its byte array does
|
|
not need to be initialized by the caller.</dd>
|
|
<dd><code>pKey</code> - the primary key returned as output. Its byte array does not
|
|
need to be initialized by the caller.</dd>
|
|
<dd><code>data</code> - the primary data returned as output. Its byte array does
|
|
not need to be initialized by the caller.
|
|
A <a href="Cursor.html#partialEntry">partial data item</a> may be
|
|
specified to optimize for key only or partial data retrieval.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are
|
|
used. <a href="../../../com/sleepycat/je/LockMode.html#READ_COMMITTED"><code>LockMode.READ_COMMITTED</code></a> is not allowed.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="../../../com/sleepycat/je/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found;
|
|
otherwise, <a href="../../../com/sleepycat/je/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</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="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>java.lang.IllegalStateException</code> - if the cursor or database has been closed,
|
|
or the non-transactional cursor was created in a different thread.</dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter is specified,
|
|
for example, if a DatabaseEntry parameter is null or does not contain a
|
|
required non-null byte array.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getSearchKey-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSearchKey</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a> getSearchKey(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</pre>
|
|
<div class="block">Moves the cursor to the given key of the database, and returns the datum
|
|
associated with the given key. If the matching key has duplicate
|
|
values, the first data item in the set of duplicates is returned.
|
|
|
|
<p>Calling this method is equivalent to calling <a href="../../../com/sleepycat/je/Cursor.html#get-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.Get-com.sleepycat.je.ReadOptions-"><code>Cursor.get(DatabaseEntry, DatabaseEntry, Get, ReadOptions)</code></a> with
|
|
<a href="../../../com/sleepycat/je/Get.html#SEARCH"><code>Get.SEARCH</code></a>.</p>
|
|
|
|
The difference between this method and the method it overrides in
|
|
<a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je"><code>Cursor</code></a> is that the key here is defined as the secondary
|
|
records's key, and the data is defined as the primary record's data.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|
<dd><code><a href="../../../com/sleepycat/je/Cursor.html#getSearchKey-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getSearchKey</a></code> in class <code><a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je">Cursor</a></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key used as
|
|
<a href="DatabaseEntry.html#inParam">input</a>.</dd>
|
|
<dd><code>data</code> - the data returned as
|
|
<a href="DatabaseEntry.html#outParam">output</a>.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are
|
|
used. <a href="../../../com/sleepycat/je/LockMode.html#READ_COMMITTED"><code>LockMode.READ_COMMITTED</code></a> is not allowed.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="../../../com/sleepycat/je/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found;
|
|
otherwise, <a href="../../../com/sleepycat/je/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getSearchKey-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSearchKey</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a> getSearchKey(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> pKey,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</pre>
|
|
<div class="block">Move the cursor to the given key of the database, and return the datum
|
|
associated with the given key. If the matching key has duplicate
|
|
values, the first data item in the set of duplicates is returned.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the secondary key used as input. It must be initialized with
|
|
a non-null byte array by the caller.</dd>
|
|
<dd><code>pKey</code> - the primary key returned as output. Its byte array does not
|
|
need to be initialized by the caller.</dd>
|
|
<dd><code>data</code> - the primary data returned as output. Its byte array does
|
|
not need to be initialized by the caller.
|
|
A <a href="Cursor.html#partialEntry">partial data item</a> may be
|
|
specified to optimize for key only or partial data retrieval.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are
|
|
used. <a href="../../../com/sleepycat/je/LockMode.html#READ_COMMITTED"><code>LockMode.READ_COMMITTED</code></a> is not allowed.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="../../../com/sleepycat/je/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found;
|
|
otherwise, <a href="../../../com/sleepycat/je/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</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="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>java.lang.IllegalStateException</code> - if the cursor or database has been closed,
|
|
or the non-transactional cursor was created in a different thread.</dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter is specified,
|
|
for example, if a DatabaseEntry parameter is null or does not contain a
|
|
required non-null byte array.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getSearchKeyRange-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSearchKeyRange</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a> getSearchKeyRange(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</pre>
|
|
<div class="block">Moves the cursor to the closest matching key of the database, and
|
|
returns the data item associated with the matching key. If the matching
|
|
key has duplicate values, the first data item in the set of duplicates
|
|
is returned.
|
|
|
|
<p>Calling this method is equivalent to calling <a href="../../../com/sleepycat/je/Cursor.html#get-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.Get-com.sleepycat.je.ReadOptions-"><code>Cursor.get(DatabaseEntry, DatabaseEntry, Get, ReadOptions)</code></a> with
|
|
<a href="../../../com/sleepycat/je/Get.html#SEARCH_GTE"><code>Get.SEARCH_GTE</code></a>.</p>
|
|
|
|
<p>The returned key/data pair is for the smallest key greater than or
|
|
equal to the specified key (as determined by the key comparison
|
|
function), permitting partial key matches and range searches.</p>
|
|
|
|
The difference between this method and the method it overrides in
|
|
<a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je"><code>Cursor</code></a> is that the key here is defined as the secondary
|
|
records's key, and the data is defined as the primary record's data.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|
<dd><code><a href="../../../com/sleepycat/je/Cursor.html#getSearchKeyRange-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getSearchKeyRange</a></code> in class <code><a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je">Cursor</a></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key used as
|
|
<a href="DatabaseEntry.html#inParam">input</a> and returned as output.</dd>
|
|
<dd><code>data</code> - the data returned as
|
|
<a href="DatabaseEntry.html#outParam">output</a>.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes
|
|
are used. <a href="../../../com/sleepycat/je/LockMode.html#READ_COMMITTED"><code>LockMode.READ_COMMITTED</code></a> is not allowed.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="../../../com/sleepycat/je/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found;
|
|
otherwise, <a href="../../../com/sleepycat/je/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getSearchKeyRange-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSearchKeyRange</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a> getSearchKeyRange(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> pKey,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</pre>
|
|
<div class="block">Move the cursor to the closest matching key of the database, and return
|
|
the data item associated with the matching key. If the matching key has
|
|
duplicate values, the first data item in the set of duplicates is
|
|
returned.
|
|
|
|
<p>The returned key/data pair is for the smallest key greater than or
|
|
equal to the specified key (as determined by the key comparison
|
|
function), permitting partial key matches and range searches.</p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the secondary key used as input and returned as output. It
|
|
must be initialized with a non-null byte array by the caller.</dd>
|
|
<dd><code>pKey</code> - the primary key returned as output. Its byte array does not
|
|
need to be initialized by the caller.</dd>
|
|
<dd><code>data</code> - the primary data returned as output. Its byte array does
|
|
not need to be initialized by the caller.
|
|
A <a href="Cursor.html#partialEntry">partial data item</a> may be
|
|
specified to optimize for key only or partial data retrieval.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are
|
|
used. <a href="../../../com/sleepycat/je/LockMode.html#READ_COMMITTED"><code>LockMode.READ_COMMITTED</code></a> is not allowed.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="../../../com/sleepycat/je/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found;
|
|
otherwise, <a href="../../../com/sleepycat/je/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</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="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>java.lang.IllegalStateException</code> - if the cursor or database has been closed,
|
|
or the non-transactional cursor was created in a different thread.</dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter is specified,
|
|
for example, if a DatabaseEntry parameter is null or does not contain a
|
|
required non-null byte array.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getSearchBoth-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSearchBoth</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a> getSearchBoth(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</pre>
|
|
<div class="block">This operation is not allowed with this method signature. <code>UnsupportedOperationException</code> will always be thrown by this method.
|
|
The corresponding method with the <code>pKey</code> parameter should be
|
|
used instead.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|
<dd><code><a href="../../../com/sleepycat/je/Cursor.html#getSearchBoth-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getSearchBoth</a></code> in class <code><a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je">Cursor</a></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key used as
|
|
<a href="DatabaseEntry.html#inParam">input</a>.</dd>
|
|
<dd><code>data</code> - the data used as
|
|
<a href="DatabaseEntry.html#inParam">input</a>.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are
|
|
used. <a href="../../../com/sleepycat/je/LockMode.html#READ_COMMITTED"><code>LockMode.READ_COMMITTED</code></a> is not allowed.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="../../../com/sleepycat/je/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found;
|
|
otherwise, <a href="../../../com/sleepycat/je/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getSearchBoth-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSearchBoth</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a> getSearchBoth(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> pKey,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</pre>
|
|
<div class="block">Move the cursor to the specified secondary and primary key, where both
|
|
the primary and secondary key items must match.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the secondary key used as input. It must be initialized with
|
|
a non-null byte array by the caller.</dd>
|
|
<dd><code>pKey</code> - the primary key used as input. It must be initialized with
|
|
a non-null byte array by the caller.</dd>
|
|
<dd><code>data</code> - the primary data returned as output. Its byte array does
|
|
not need to be initialized by the caller.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are
|
|
used. <a href="../../../com/sleepycat/je/LockMode.html#READ_COMMITTED"><code>LockMode.READ_COMMITTED</code></a> is not allowed.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="../../../com/sleepycat/je/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found;
|
|
otherwise, <a href="../../../com/sleepycat/je/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</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="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>java.lang.IllegalStateException</code> - if the cursor or database has been closed,
|
|
or the non-transactional cursor was created in a different thread.</dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter is specified,
|
|
for example, if a DatabaseEntry parameter is null or does not contain a
|
|
required non-null byte array.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getSearchBothRange-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSearchBothRange</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a> getSearchBothRange(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</pre>
|
|
<div class="block">This operation is not allowed with this method signature. <code>UnsupportedOperationException</code> will always be thrown by this method.
|
|
The corresponding method with the <code>pKey</code> parameter should be
|
|
used instead.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|
<dd><code><a href="../../../com/sleepycat/je/Cursor.html#getSearchBothRange-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">getSearchBothRange</a></code> in class <code><a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je">Cursor</a></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key used as
|
|
<a href="DatabaseEntry.html#inParam">input</a>.</dd>
|
|
<dd><code>data</code> - the data used as
|
|
<a href="DatabaseEntry.html#inParam">input</a> and returned as output.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are
|
|
used. <a href="../../../com/sleepycat/je/LockMode.html#READ_COMMITTED"><code>LockMode.READ_COMMITTED</code></a> is not allowed.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="../../../com/sleepycat/je/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found;
|
|
otherwise, <a href="../../../com/sleepycat/je/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getSearchBothRange-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>getSearchBothRange</h4>
|
|
<pre>public <a href="../../../com/sleepycat/je/OperationStatus.html" title="enum in com.sleepycat.je">OperationStatus</a> getSearchBothRange(<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> key,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> pKey,
|
|
<a href="../../../com/sleepycat/je/DatabaseEntry.html" title="class in com.sleepycat.je">DatabaseEntry</a> data,
|
|
<a href="../../../com/sleepycat/je/LockMode.html" title="enum in com.sleepycat.je">LockMode</a> lockMode)</pre>
|
|
<div class="block">Move the cursor to the specified secondary key and closest matching
|
|
primary key of the database.
|
|
|
|
<p>In the case of any database supporting sorted duplicate sets, the
|
|
returned key/data pair is for the smallest primary key greater than or
|
|
equal to the specified primary key (as determined by the key comparison
|
|
function), permitting partial matches and range searches in duplicate
|
|
data sets.</p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the secondary key used as input. It must be initialized with
|
|
a non-null byte array by the caller.</dd>
|
|
<dd><code>pKey</code> - the primary key used as input and returned as output. It
|
|
must be initialized with a non-null byte array by the caller.</dd>
|
|
<dd><code>data</code> - the primary data returned as output. Its byte array does
|
|
not need to be initialized by the caller.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are
|
|
used. <a href="../../../com/sleepycat/je/LockMode.html#READ_COMMITTED"><code>LockMode.READ_COMMITTED</code></a> is not allowed.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="../../../com/sleepycat/je/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found;
|
|
otherwise, <a href="../../../com/sleepycat/je/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</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="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>java.lang.IllegalStateException</code> - if the cursor or database has been closed,
|
|
or the non-transactional cursor was created in a different thread.</dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter is specified,
|
|
for example, if a DatabaseEntry parameter is null or does not contain a
|
|
required non-null byte array.</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/SecondaryCursor.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><a href="../../../com/sleepycat/je/SecondaryConstraintException.html" title="class in com.sleepycat.je"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../../com/sleepycat/je/SecondaryDatabase.html" title="class in com.sleepycat.je"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../index.html?com/sleepycat/je/SecondaryCursor.html" target="_top">Frames</a></li>
|
|
<li><a href="SecondaryCursor.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>
|