<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc (version 1.7.0_45) on Thu Jan 09 22:45:26 GMT 2014 --> <title>SecondaryCursor</title> <meta name="date" content="2014-01-09"> <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { parent.document.title="SecondaryCursor"; } //--> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar_top"> <!-- --> </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="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> <div class="subNav"> <ul class="navList"> <li><a href="../../../com/sleepycat/db/SecondaryConfig.html" title="class in com.sleepycat.db"><span class="strong">Prev Class</span></a></li> <li><a href="../../../com/sleepycat/db/SecondaryDatabase.html" title="class in com.sleepycat.db"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?com/sleepycat/db/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.db</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/db/Cursor.html" title="class in com.sleepycat.db">com.sleepycat.db.Cursor</a></li> <li> <ul class="inheritance"> <li>com.sleepycat.db.SecondaryCursor</li> </ul> </li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="strong">SecondaryCursor</span> extends <a href="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db">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/db/SecondaryDatabase.html#openCursor(com.sleepycat.db.Transaction, com.sleepycat.db.CursorConfig)"><code>SecondaryDatabase.openCursor</code></a> and <a href="../../../com/sleepycat/db/SecondaryDatabase.html#openSecondaryCursor(com.sleepycat.db.Transaction, com.sleepycat.db.CursorConfig)"><code>SecondaryDatabase.openSecondaryCursor</code></a>. The distinguishing characteristics of a secondary cursor are: <ul> <li>Direct calls to <code>put()</code> methods on a secondary cursor are prohibited. <li>The <a href="../../../com/sleepycat/db/Cursor.html#delete()"><code>Cursor.delete()</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/db/SecondaryCursor.html#dup(boolean)"><code>dup(boolean)</code></a> will return a <a href="../../../com/sleepycat/db/SecondaryCursor.html" title="class in com.sleepycat.db"><code>SecondaryCursor</code></a>. <li>The <a href="../../../com/sleepycat/db/SecondaryCursor.html#dupSecondary(boolean)"><code>dupSecondary(boolean)</code></a> method is provided to return a <a href="../../../com/sleepycat/db/SecondaryCursor.html" title="class in com.sleepycat.db"><code>SecondaryCursor</code></a> that doesn't require casting. </ul> <p> To obtain a secondary cursor with default attributes: <blockquote><pre> SecondaryCursor cursor = myDb.openSecondaryCursor(txn, null); </pre></blockquote> To customize the attributes of a cursor, use a CursorConfig object. <blockquote><pre> CursorConfig config = new CursorConfig(); config.setDirtyRead(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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span>Methods</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db">Cursor</a></code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryCursor.html#dup(boolean)">dup</a></strong>(boolean samePosition)</code> <div class="block">Returns a new <code>SecondaryCursor</code> for the same transaction as the original cursor.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../com/sleepycat/db/SecondaryCursor.html" title="class in com.sleepycat.db">SecondaryCursor</a></code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryCursor.html#dupSecondary(boolean)">dupSecondary</a></strong>(boolean samePosition)</code> <div class="block">Returns a new copy of the cursor as a <code>SecondaryCursor</code>.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryCursor.html#getCurrent(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getCurrent</a></strong>(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code> <div class="block">Returns the key/data pair to which the cursor refers.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryCursor.html#getFirst(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getFirst</a></strong>(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">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 class="altColor"> <td class="colFirst"><code><a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryCursor.html#getLast(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getLast</a></strong>(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">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 class="rowColor"> <td class="colFirst"><code><a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryCursor.html#getNext(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getNext</a></strong>(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code> <div class="block">Move the cursor to the next key/data pair and return that pair.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryCursor.html#getNextDup(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getNextDup</a></strong>(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">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 class="rowColor"> <td class="colFirst"><code><a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryCursor.html#getNextNoDup(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getNextNoDup</a></strong>(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">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 class="altColor"> <td class="colFirst"><code><a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryCursor.html#getPrev(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getPrev</a></strong>(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code> <div class="block">Move the cursor to the previous key/data pair and return that pair.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryCursor.html#getPrevDup(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getPrevDup</a></strong>(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">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 class="altColor"> <td class="colFirst"><code><a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryCursor.html#getPrevNoDup(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getPrevNoDup</a></strong>(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">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 class="rowColor"> <td class="colFirst"><code><a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryCursor.html#getRecordNumber(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getRecordNumber</a></strong>(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> secondaryRecno, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> primaryRecno, <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code> <div class="block">Return the record number associated with the cursor.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryCursor.html#getSearchBoth(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getSearchBoth</a></strong>(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">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 class="rowColor"> <td class="colFirst"><code><a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryCursor.html#getSearchBothRange(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getSearchBothRange</a></strong>(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">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 class="altColor"> <td class="colFirst"><code><a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryCursor.html#getSearchKey(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getSearchKey</a></strong>(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">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 class="rowColor"> <td class="colFirst"><code><a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryCursor.html#getSearchKeyRange(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getSearchKeyRange</a></strong>(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">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 class="altColor"> <td class="colFirst"><code><a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryCursor.html#getSearchRecordNumber(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getSearchRecordNumber</a></strong>(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> secondaryRecno, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code> <div class="block">Move the cursor to the specific numbered record of the database, and return the associated key/data pair.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../com/sleepycat/db/SecondaryDatabase.html" title="class in com.sleepycat.db">SecondaryDatabase</a></code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryCursor.html#getSecondaryDatabase()">getSecondaryDatabase</a></strong>()</code> <div class="block">Return the SecondaryDatabase handle associated with this Cursor.</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_com.sleepycat.db.Cursor"> <!-- --> </a> <h3>Methods inherited from class com.sleepycat.db.<a href="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db">Cursor</a></h3> <code><a href="../../../com/sleepycat/db/Cursor.html#close()">close</a>, <a href="../../../com/sleepycat/db/Cursor.html#compare(com.sleepycat.db.Cursor)">compare</a>, <a href="../../../com/sleepycat/db/Cursor.html#count()">count</a>, <a href="../../../com/sleepycat/db/Cursor.html#delete()">delete</a>, <a href="../../../com/sleepycat/db/Cursor.html#getConfig()">getConfig</a>, <a href="../../../com/sleepycat/db/Cursor.html#getCurrent(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getCurrent</a>, <a href="../../../com/sleepycat/db/Cursor.html#getDatabase()">getDatabase</a>, <a href="../../../com/sleepycat/db/Cursor.html#getFirst(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getFirst</a>, <a href="../../../com/sleepycat/db/Cursor.html#getLast(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getLast</a>, <a href="../../../com/sleepycat/db/Cursor.html#getNext(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getNext</a>, <a href="../../../com/sleepycat/db/Cursor.html#getNextDup(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getNextDup</a>, <a href="../../../com/sleepycat/db/Cursor.html#getNextNoDup(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getNextNoDup</a>, <a href="../../../com/sleepycat/db/Cursor.html#getPrev(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getPrev</a>, <a href="../../../com/sleepycat/db/Cursor.html#getPrevDup(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getPrevDup</a>, <a href="../../../com/sleepycat/db/Cursor.html#getPrevNoDup(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getPrevNoDup</a>, <a href="../../../com/sleepycat/db/Cursor.html#getPriority()">getPriority</a>, <a href="../../../com/sleepycat/db/Cursor.html#getRecordNumber(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getRecordNumber</a>, <a href="../../../com/sleepycat/db/Cursor.html#getSearchBoth(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getSearchBoth</a>, <a href="../../../com/sleepycat/db/Cursor.html#getSearchBothRange(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getSearchBothRange</a>, <a href="../../../com/sleepycat/db/Cursor.html#getSearchKey(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getSearchKey</a>, <a href="../../../com/sleepycat/db/Cursor.html#getSearchKeyRange(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getSearchKeyRange</a>, <a href="../../../com/sleepycat/db/Cursor.html#getSearchRecordNumber(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getSearchRecordNumber</a>, <a href="../../../com/sleepycat/db/Cursor.html#put(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">put</a>, <a href="../../../com/sleepycat/db/Cursor.html#putAfter(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">putAfter</a>, <a href="../../../com/sleepycat/db/Cursor.html#putBefore(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">putBefore</a>, <a href="../../../com/sleepycat/db/Cursor.html#putCurrent(com.sleepycat.db.DatabaseEntry)">putCurrent</a>, <a href="../../../com/sleepycat/db/Cursor.html#putKeyFirst(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">putKeyFirst</a>, <a href="../../../com/sleepycat/db/Cursor.html#putKeyLast(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">putKeyLast</a>, <a href="../../../com/sleepycat/db/Cursor.html#putNoDupData(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">putNoDupData</a>, <a href="../../../com/sleepycat/db/Cursor.html#putNoOverwrite(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">putNoOverwrite</a>, <a href="../../../com/sleepycat/db/Cursor.html#setPriority(com.sleepycat.db.CacheFilePriority)">setPriority</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="getSecondaryDatabase()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getSecondaryDatabase</h4> <pre>public <a href="../../../com/sleepycat/db/SecondaryDatabase.html" title="class in com.sleepycat.db">SecondaryDatabase</a> getSecondaryDatabase()</pre> <div class="block">Return the SecondaryDatabase handle associated with this Cursor. <p></div> <dl><dt><span class="strong">Returns:</span></dt><dd>The SecondaryDatabase handle associated with this Cursor. <p></dd></dl> </li> </ul> <a name="dup(boolean)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>dup</h4> <pre>public <a href="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db">Cursor</a> dup(boolean samePosition) throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> <div class="block">Returns a new <code>SecondaryCursor</code> for the same transaction as the original cursor.</div> <dl> <dt><strong>Overrides:</strong></dt> <dd><code><a href="../../../com/sleepycat/db/Cursor.html#dup(boolean)">dup</a></code> in class <code><a href="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db">Cursor</a></code></dd> <dt><span class="strong">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. <p></dd> <dt><span class="strong">Returns:</span></dt><dd>A new cursor with the same transaction and locker ID as the original cursor. <p> <p></dd> <dt><span class="strong">Throws:</span></dt> <dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> </li> </ul> <a name="dupSecondary(boolean)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>dupSecondary</h4> <pre>public <a href="../../../com/sleepycat/db/SecondaryCursor.html" title="class in com.sleepycat.db">SecondaryCursor</a> dupSecondary(boolean samePosition) throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> <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/db/SecondaryCursor.html#dup(boolean)"><code>dup(boolean)</code></a> and casting the result to <a href="../../../com/sleepycat/db/SecondaryCursor.html" title="class in com.sleepycat.db"><code>SecondaryCursor</code></a>. <p></div> <dl><dt><span class="strong">Throws:</span></dt> <dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/sleepycat/db/SecondaryCursor.html#dup(boolean)"><code>dup(boolean)</code></a></dd></dl> </li> </ul> <a name="getCurrent(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getCurrent</h4> <pre>public <a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getCurrent(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode) throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> <div class="block">Returns the key/data pair to which the cursor refers. <p> If this method fails for any reason, the position of the cursor will be unchanged.</div> <dl><dt><span class="strong">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. Multiple results can be retrieved by passing an object that is a subclass of <a href="../../../com/sleepycat/db/MultipleEntry.html" title="class in com.sleepycat.db"><code>MultipleEntry</code></a>, otherwise 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.</dd> <dt><span class="strong">Returns:</span></dt><dd><a href="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the key/pair at the cursor position has been deleted; otherwise, <a href="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or does not contain a required non-null byte array. <p></dd> <dd><code><a href="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a deadlock. <p></dd> <dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified. <p></dd> <dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs. <p></dd></dl> </li> </ul> <a name="getFirst(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getFirst</h4> <pre>public <a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getFirst(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode) throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></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. <p> If this method fails for any reason, the position of the cursor will be unchanged.</div> <dl><dt><span class="strong">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. Multiple results can be retrieved by passing an object that is a subclass of <a href="../../../com/sleepycat/db/MultipleEntry.html" title="class in com.sleepycat.db"><code>MultipleEntry</code></a>, otherwise 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.</dd> <dt><span class="strong">Returns:</span></dt><dd><a href="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found; <a href="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or does not contain a required non-null byte array. <p></dd> <dd><code><a href="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a deadlock. <p></dd> <dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified. <p></dd> <dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs. <p></dd></dl> </li> </ul> <a name="getLast(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getLast</h4> <pre>public <a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getLast(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode) throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></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. <p> If this method fails for any reason, the position of the cursor will be unchanged.</div> <dl><dt><span class="strong">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.</dd><dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd> <dt><span class="strong">Returns:</span></dt><dd><a href="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found; <a href="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or does not contain a required non-null byte array. <p></dd> <dd><code><a href="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a deadlock. <p></dd> <dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified. <p></dd> <dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs. <p></dd></dl> </li> </ul> <a name="getNext(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getNext</h4> <pre>public <a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getNext(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode) throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></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> If this method fails for any reason, the position of the cursor will be unchanged.</div> <dl><dt><span class="strong">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. Multiple results can be retrieved by passing an object that is a subclass of <a href="../../../com/sleepycat/db/MultipleEntry.html" title="class in com.sleepycat.db"><code>MultipleEntry</code></a>, otherwise 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.</dd> <dt><span class="strong">Returns:</span></dt><dd><a href="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found; <a href="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or does not contain a required non-null byte array. <p></dd> <dd><code><a href="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a deadlock. <p></dd> <dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified. <p></dd> <dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs. <p></dd></dl> </li> </ul> <a name="getNextDup(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getNextDup</h4> <pre>public <a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getNextDup(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode) throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></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. <p> If this method fails for any reason, the position of the cursor will be unchanged.</div> <dl><dt><span class="strong">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. Multiple results can be retrieved by passing an object that is a subclass of <a href="../../../com/sleepycat/db/MultipleEntry.html" title="class in com.sleepycat.db"><code>MultipleEntry</code></a>, otherwise 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.</dd> <dt><span class="strong">Returns:</span></dt><dd><a href="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found; <a href="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or does not contain a required non-null byte array. <p></dd> <dd><code><a href="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a deadlock. <p></dd> <dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified. <p></dd> <dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs. <p></dd></dl> </li> </ul> <a name="getNextNoDup(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getNextNoDup</h4> <pre>public <a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getNextNoDup(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode) throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></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> If this method fails for any reason, the position of the cursor will be unchanged.</div> <dl><dt><span class="strong">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. Multiple results can be retrieved by passing an object that is a subclass of <a href="../../../com/sleepycat/db/MultipleEntry.html" title="class in com.sleepycat.db"><code>MultipleEntry</code></a>, otherwise 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.</dd> <dt><span class="strong">Returns:</span></dt><dd><a href="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found; <a href="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or does not contain a required non-null byte array. <p></dd> <dd><code><a href="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a deadlock. <p></dd> <dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified. <p></dd> <dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs. <p></dd></dl> </li> </ul> <a name="getPrev(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getPrev</h4> <pre>public <a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getPrev(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode) throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></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> If this method fails for any reason, the position of the cursor will be unchanged.</div> <dl><dt><span class="strong">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.</dd><dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd> <dt><span class="strong">Returns:</span></dt><dd><a href="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found; <a href="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or does not contain a required non-null byte array. <p></dd> <dd><code><a href="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a deadlock. <p></dd> <dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified. <p></dd> <dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs. <p></dd></dl> </li> </ul> <a name="getPrevDup(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getPrevDup</h4> <pre>public <a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getPrevDup(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode) throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></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. <p> If this method fails for any reason, the position of the cursor will be unchanged.</div> <dl><dt><span class="strong">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.</dd><dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd> <dt><span class="strong">Returns:</span></dt><dd><a href="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found; <a href="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or does not contain a required non-null byte array. <p></dd> <dd><code><a href="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a deadlock. <p></dd> <dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified. <p></dd> <dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs. <p></dd></dl> </li> </ul> <a name="getPrevNoDup(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getPrevNoDup</h4> <pre>public <a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getPrevNoDup(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode) throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></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> If this method fails for any reason, the position of the cursor will be unchanged.</div> <dl><dt><span class="strong">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.</dd><dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd> <dt><span class="strong">Returns:</span></dt><dd><a href="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found; <a href="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or does not contain a required non-null byte array. <p></dd> <dd><code><a href="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a deadlock. <p></dd> <dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified. <p></dd> <dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs. <p></dd></dl> </li> </ul> <a name="getRecordNumber(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getRecordNumber</h4> <pre>public <a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getRecordNumber(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> secondaryRecno, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> primaryRecno, <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode) throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> <div class="block">Return the record number associated with the cursor. The record number will be returned in the data parameter. <p> For this method to be called, the underlying database must be of type Btree, and it must have been configured to support record numbers. <p> When called on a cursor opened on a database that has been made into a secondary index, the method returns the record numbers of both the secondary and primary databases. If either underlying database is not of type Btree or is not configured with record numbers, the out-of-band record number of 0 is returned. <p> If this method fails for any reason, the position of the cursor will be unchanged.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>secondaryRecno</code> - the secondary record number returned as output. Its byte array does not need to be initialized by the caller.</dd><dd><code>primaryRecno</code> - the primary record number 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.</dd> <dt><span class="strong">Returns:</span></dt><dd><a href="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found; <a href="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or does not contain a required non-null byte array. <p></dd> <dd><code><a href="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a deadlock. <p></dd> <dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified. <p></dd> <dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs. <p></dd></dl> </li> </ul> <a name="getSearchKey(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getSearchKey</h4> <pre>public <a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getSearchKey(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode) throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></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. <p> If this method fails for any reason, the position of the cursor will be unchanged.</div> <dl><dt><span class="strong">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. Multiple results can be retrieved by passing an object that is a subclass of <a href="../../../com/sleepycat/db/MultipleEntry.html" title="class in com.sleepycat.db"><code>MultipleEntry</code></a>, otherwise 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.</dd> <dt><span class="strong">Returns:</span></dt><dd><a href="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found; <a href="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or does not contain a required non-null byte array. <p></dd> <dd><code><a href="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a deadlock. <p></dd> <dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified. <p></dd> <dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs. <p></dd></dl> </li> </ul> <a name="getSearchKeyRange(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getSearchKeyRange</h4> <pre>public <a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getSearchKeyRange(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode) throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></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> If this method fails for any reason, the position of the cursor will be unchanged.</div> <dl><dt><span class="strong">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. Multiple results can be retrieved by passing an object that is a subclass of <a href="../../../com/sleepycat/db/MultipleEntry.html" title="class in com.sleepycat.db"><code>MultipleEntry</code></a>, otherwise 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.</dd> <dt><span class="strong">Returns:</span></dt><dd><a href="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found; <a href="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or does not contain a required non-null byte array. <p></dd> <dd><code><a href="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a deadlock. <p></dd> <dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified. <p></dd> <dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs. <p></dd></dl> </li> </ul> <a name="getSearchBoth(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getSearchBoth</h4> <pre>public <a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getSearchBoth(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode) throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> <div class="block">Move the cursor to the specified secondary and primary key, where both the primary and secondary key items must match. <p> If this method fails for any reason, the position of the cursor will be unchanged.</div> <dl><dt><span class="strong">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.</dd> <dt><span class="strong">Returns:</span></dt><dd><a href="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found; <a href="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or does not contain a required non-null byte array. <p></dd> <dd><code><a href="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a deadlock. <p></dd> <dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified. <p></dd> <dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs. <p></dd></dl> </li> </ul> <a name="getSearchBothRange(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getSearchBothRange</h4> <pre>public <a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getSearchBothRange(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode) throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></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> If this method fails for any reason, the position of the cursor will be unchanged.</div> <dl><dt><span class="strong">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 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.</dd> <dt><span class="strong">Returns:</span></dt><dd><a href="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found; <a href="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or does not contain a required non-null byte array. <p></dd> <dd><code><a href="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a deadlock. <p></dd> <dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified. <p></dd> <dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs. <p></dd></dl> </li> </ul> <a name="getSearchRecordNumber(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>getSearchRecordNumber</h4> <pre>public <a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getSearchRecordNumber(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> secondaryRecno, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode) throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> <div class="block">Move the cursor to the specific numbered record of the database, and return the associated key/data pair. <p> The data field of the specified key must be a byte array containing a record number, as described in <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><code>DatabaseEntry</code></a>. This determines the record to be retrieved. <p> For this method to be called, the underlying database must be of type Btree, and it must have been configured to support record numbers. <p> If this method fails for any reason, the position of the cursor will be unchanged.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>secondaryRecno</code> - the secondary record number 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. Multiple results can be retrieved by passing an object that is a subclass of <a href="../../../com/sleepycat/db/MultipleEntry.html" title="class in com.sleepycat.db"><code>MultipleEntry</code></a>, otherwise 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.</dd> <dt><span class="strong">Returns:</span></dt><dd><a href="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is found; <a href="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or does not contain a required non-null byte array. <p></dd> <dd><code><a href="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a deadlock. <p></dd> <dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified. <p></dd> <dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs. <p></dd></dl> </li> </ul> </li> </ul> </li> </ul> </div> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar_bottom"> <!-- --> </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="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> <div class="subNav"> <ul class="navList"> <li><a href="../../../com/sleepycat/db/SecondaryConfig.html" title="class in com.sleepycat.db"><span class="strong">Prev Class</span></a></li> <li><a href="../../../com/sleepycat/db/SecondaryDatabase.html" title="class in com.sleepycat.db"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?com/sleepycat/db/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 ======= --> </body> </html>