• Home
  • History
  • Annotate
  • Line#
  • Navigate
  • Raw
  • Download
  • only in /asuswrt-rt-n18u-9.0.0.4.380.2695/release/src-rt-6.x.4708/router/db-4.8.30/docs/java/com/sleepycat/db/
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.6.0_03) on Mon Apr 12 16:25:45 EDT 2010 -->
6<TITLE>
7Cursor (Oracle - Berkeley DB Java API)
8</TITLE>
9
10<META NAME="date" CONTENT="2010-04-12">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../style.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17    if (location.href.indexOf('is-external=true') == -1) {
18        parent.document.title="Cursor (Oracle - Berkeley DB Java API)";
19    }
20}
21</SCRIPT>
22<NOSCRIPT>
23</NOSCRIPT>
24
25</HEAD>
26
27<BODY BGCOLOR="white" onload="windowTitle();">
28<HR>
29
30
31<!-- ========= START OF TOP NAVBAR ======= -->
32<A NAME="navbar_top"><!-- --></A>
33<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
34<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
35<TR>
36<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
37<A NAME="navbar_top_firstrow"><!-- --></A>
38<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
39  <TR ALIGN="center" VALIGN="top">
40  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
42  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
43  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Cursor.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
47  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
48  </TR>
49</TABLE>
50</TD>
51<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
52<b>Berkeley DB</b><br><font size="-1"> version 4.8.30</font></EM>
53</TD>
54</TR>
55
56<TR>
57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
58&nbsp;<A HREF="../../../com/sleepycat/db/CompactStats.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../index.html?com/sleepycat/db/Cursor.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="Cursor.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
63&nbsp;<SCRIPT type="text/javascript">
64  <!--
65  if(window==top) {
66    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
67  }
68  //-->
69</SCRIPT>
70<NOSCRIPT>
71  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
72</NOSCRIPT>
73
74
75</FONT></TD>
76</TR>
77<TR>
78<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
79  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
82</TR>
83</TABLE>
84<A NAME="skip-navbar_top"></A>
85<!-- ========= END OF TOP NAVBAR ========= -->
86
87<HR>
88<!-- ======== START OF CLASS DATA ======== -->
89<H2>
90<FONT SIZE="-1">
91com.sleepycat.db</FONT>
92<BR>
93Class Cursor</H2>
94<PRE>
95<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
96  <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.db.Cursor</B>
97</PRE>
98<DL>
99<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../com/sleepycat/db/SecondaryCursor.html" title="class in com.sleepycat.db">SecondaryCursor</A></DD>
100</DL>
101<HR>
102<DL>
103<DT><PRE>public class <B>Cursor</B><DT>extends <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL>
104</PRE>
105
106<P>
107A database cursor. Cursors are used for operating on collections of
108records, for iterating over a database, and for saving handles to
109individual records, so that they can be modified after they have been
110read.
111<p>
112Cursors may be used by multiple threads, but only serially.  That is,
113the application must serialize access to the handle.
114<p>
115If the cursor is to be used to perform operations on behalf of a
116transaction, the cursor must be opened and closed within the context of
117that single transaction.
118<p>
119Once the cursor close method has been called, the handle may not be
120accessed again, regardless of the close method's success or failure.
121<p>
122To obtain a cursor with default attributes:
123<blockquote><pre>
124    Cursor cursor = myDatabase.openCursor(txn, null);
125</pre></blockquote>
126To customize the attributes of a cursor, use a CursorConfig object.
127<blockquote><pre>
128    CursorConfig config = new CursorConfig();
129    config.setDirtyRead(true);
130    Cursor cursor = myDatabase.openCursor(txn, config);
131</pre></blockquote>
132<p>
133Modifications to the database during a sequential scan will be reflected
134in the scan; that is, records inserted behind a cursor will not be
135returned while records inserted in front of a cursor will be returned.
136In Queue and Recno databases, missing entries (that is, entries that
137were never explicitly created or that were created and then deleted)
138will be ignored during a sequential scan.
139<P>
140
141<P>
142<HR>
143
144<P>
145
146<!-- ======== CONSTRUCTOR SUMMARY ======== -->
147
148<A NAME="constructor_summary"><!-- --></A>
149<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
150<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
151<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
152<B>Constructor Summary</B></FONT></TH>
153</TR>
154<TR BGCOLOR="white" CLASS="TableRowColor">
155<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
156<CODE>protected </CODE></FONT></TD>
157<TD><CODE><B><A HREF="../../../com/sleepycat/db/Cursor.html#Cursor(com.sleepycat.db.Database, com.sleepycat.db.CursorConfig)">Cursor</A></B>(<A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A>&nbsp;database,
158       <A HREF="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</A>&nbsp;config)</CODE>
159
160<BR>
161&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
162</TR>
163</TABLE>
164&nbsp;
165<!-- ========== METHOD SUMMARY =========== -->
166
167<A NAME="method_summary"><!-- --></A>
168<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
169<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
170<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
171<B>Method Summary</B></FONT></TH>
172</TR>
173<TR BGCOLOR="white" CLASS="TableRowColor">
174<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
175<CODE>&nbsp;void</CODE></FONT></TD>
176<TD><CODE><B><A HREF="../../../com/sleepycat/db/Cursor.html#close()">close</A></B>()</CODE>
177
178<BR>
179&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
180</TR>
181<TR BGCOLOR="white" CLASS="TableRowColor">
182<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
183<CODE>&nbsp;int</CODE></FONT></TD>
184<TD><CODE><B><A HREF="../../../com/sleepycat/db/Cursor.html#compare(com.sleepycat.db.Cursor)">compare</A></B>(<A HREF="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db">Cursor</A>&nbsp;OtherCursor)</CODE>
185
186<BR>
187&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return a comparison of the two cursors.</TD>
188</TR>
189<TR BGCOLOR="white" CLASS="TableRowColor">
190<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
191<CODE>&nbsp;int</CODE></FONT></TD>
192<TD><CODE><B><A HREF="../../../com/sleepycat/db/Cursor.html#count()">count</A></B>()</CODE>
193
194<BR>
195&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return a count of the number of data items for the key to which the
196    cursor refers.</TD>
197</TR>
198<TR BGCOLOR="white" CLASS="TableRowColor">
199<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
200<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD>
201<TD><CODE><B><A HREF="../../../com/sleepycat/db/Cursor.html#delete()">delete</A></B>()</CODE>
202
203<BR>
204&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Delete the key/data pair to which the cursor refers.</TD>
205</TR>
206<TR BGCOLOR="white" CLASS="TableRowColor">
207<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
208<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db">Cursor</A></CODE></FONT></TD>
209<TD><CODE><B><A HREF="../../../com/sleepycat/db/Cursor.html#dup(boolean)">dup</A></B>(boolean&nbsp;samePosition)</CODE>
210
211<BR>
212&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return a new cursor with the same transaction and locker ID as the
213    original cursor.</TD>
214</TR>
215<TR BGCOLOR="white" CLASS="TableRowColor">
216<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
217<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</A></CODE></FONT></TD>
218<TD><CODE><B><A HREF="../../../com/sleepycat/db/Cursor.html#getConfig()">getConfig</A></B>()</CODE>
219
220<BR>
221&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return this cursor's configuration.</TD>
222</TR>
223<TR BGCOLOR="white" CLASS="TableRowColor">
224<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
225<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD>
226<TD><CODE><B><A HREF="../../../com/sleepycat/db/Cursor.html#getCurrent(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getCurrent</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
227           <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data,
228           <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)</CODE>
229
230<BR>
231&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the key/data pair to which the cursor refers.</TD>
232</TR>
233<TR BGCOLOR="white" CLASS="TableRowColor">
234<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
235<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A></CODE></FONT></TD>
236<TD><CODE><B><A HREF="../../../com/sleepycat/db/Cursor.html#getDatabase()">getDatabase</A></B>()</CODE>
237
238<BR>
239&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the Database handle associated with this Cursor.</TD>
240</TR>
241<TR BGCOLOR="white" CLASS="TableRowColor">
242<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
243<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD>
244<TD><CODE><B><A HREF="../../../com/sleepycat/db/Cursor.html#getFirst(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getFirst</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
245         <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data,
246         <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)</CODE>
247
248<BR>
249&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Move the cursor to the first key/data pair of the database, and return
250that pair.</TD>
251</TR>
252<TR BGCOLOR="white" CLASS="TableRowColor">
253<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
254<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD>
255<TD><CODE><B><A HREF="../../../com/sleepycat/db/Cursor.html#getLast(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getLast</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
256        <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data,
257        <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)</CODE>
258
259<BR>
260&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Move the cursor to the last key/data pair of the database, and return
261that pair.</TD>
262</TR>
263<TR BGCOLOR="white" CLASS="TableRowColor">
264<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
265<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD>
266<TD><CODE><B><A HREF="../../../com/sleepycat/db/Cursor.html#getNext(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getNext</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
267        <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data,
268        <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)</CODE>
269
270<BR>
271&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Move the cursor to the next key/data pair and return that pair.</TD>
272</TR>
273<TR BGCOLOR="white" CLASS="TableRowColor">
274<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
275<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD>
276<TD><CODE><B><A HREF="../../../com/sleepycat/db/Cursor.html#getNextDup(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getNextDup</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
277           <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data,
278           <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)</CODE>
279
280<BR>
281&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If the next key/data pair of the database is a duplicate data record for
282the current key/data pair, move the cursor to the next key/data pair
283of the database and return that pair.</TD>
284</TR>
285<TR BGCOLOR="white" CLASS="TableRowColor">
286<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
287<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD>
288<TD><CODE><B><A HREF="../../../com/sleepycat/db/Cursor.html#getNextNoDup(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getNextNoDup</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
289             <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data,
290             <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)</CODE>
291
292<BR>
293&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Move the cursor to the next non-duplicate key/data pair and return
294that pair.</TD>
295</TR>
296<TR BGCOLOR="white" CLASS="TableRowColor">
297<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
298<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD>
299<TD><CODE><B><A HREF="../../../com/sleepycat/db/Cursor.html#getPrev(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getPrev</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
300        <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data,
301        <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)</CODE>
302
303<BR>
304&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Move the cursor to the previous key/data pair and return that pair.</TD>
305</TR>
306<TR BGCOLOR="white" CLASS="TableRowColor">
307<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
308<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD>
309<TD><CODE><B><A HREF="../../../com/sleepycat/db/Cursor.html#getPrevDup(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getPrevDup</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
310           <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data,
311           <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)</CODE>
312
313<BR>
314&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If the previous key/data pair of the database is a duplicate data record
315for the current key/data pair, move the cursor to the previous key/data
316pair of the database and return that pair.</TD>
317</TR>
318<TR BGCOLOR="white" CLASS="TableRowColor">
319<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
320<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD>
321<TD><CODE><B><A HREF="../../../com/sleepycat/db/Cursor.html#getPrevNoDup(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getPrevNoDup</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
322             <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data,
323             <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)</CODE>
324
325<BR>
326&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Move the cursor to the previous non-duplicate key/data pair and return
327that pair.</TD>
328</TR>
329<TR BGCOLOR="white" CLASS="TableRowColor">
330<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
331<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/CacheFilePriority.html" title="class in com.sleepycat.db">CacheFilePriority</A></CODE></FONT></TD>
332<TD><CODE><B><A HREF="../../../com/sleepycat/db/Cursor.html#getPriority()">getPriority</A></B>()</CODE>
333
334<BR>
335&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the cache priority for pages referenced by the cursor.</TD>
336</TR>
337<TR BGCOLOR="white" CLASS="TableRowColor">
338<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
339<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD>
340<TD><CODE><B><A HREF="../../../com/sleepycat/db/Cursor.html#getRecordNumber(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getRecordNumber</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data,
341                <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)</CODE>
342
343<BR>
344&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the record number associated with the cursor.</TD>
345</TR>
346<TR BGCOLOR="white" CLASS="TableRowColor">
347<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
348<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD>
349<TD><CODE><B><A HREF="../../../com/sleepycat/db/Cursor.html#getSearchBoth(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getSearchBoth</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
350              <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data,
351              <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)</CODE>
352
353<BR>
354&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Move the cursor to the specified key/data pair, where both the key and
355data items must match.</TD>
356</TR>
357<TR BGCOLOR="white" CLASS="TableRowColor">
358<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
359<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD>
360<TD><CODE><B><A HREF="../../../com/sleepycat/db/Cursor.html#getSearchBothRange(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getSearchBothRange</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
361                   <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data,
362                   <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)</CODE>
363
364<BR>
365&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Move the cursor to the specified key and closest matching data item of the
366database.</TD>
367</TR>
368<TR BGCOLOR="white" CLASS="TableRowColor">
369<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
370<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD>
371<TD><CODE><B><A HREF="../../../com/sleepycat/db/Cursor.html#getSearchKey(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getSearchKey</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
372             <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data,
373             <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)</CODE>
374
375<BR>
376&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Move the cursor to the given key of the database, and return the datum
377associated with the given key.</TD>
378</TR>
379<TR BGCOLOR="white" CLASS="TableRowColor">
380<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
381<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD>
382<TD><CODE><B><A HREF="../../../com/sleepycat/db/Cursor.html#getSearchKeyRange(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getSearchKeyRange</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
383                  <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data,
384                  <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)</CODE>
385
386<BR>
387&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Move the cursor to the closest matching key of the database, and return
388the data item associated with the matching key.</TD>
389</TR>
390<TR BGCOLOR="white" CLASS="TableRowColor">
391<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
392<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD>
393<TD><CODE><B><A HREF="../../../com/sleepycat/db/Cursor.html#getSearchRecordNumber(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getSearchRecordNumber</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
394                      <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data,
395                      <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)</CODE>
396
397<BR>
398&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Move the cursor to the specific numbered record of the database, and
399return the associated key/data pair.</TD>
400</TR>
401<TR BGCOLOR="white" CLASS="TableRowColor">
402<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
403<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD>
404<TD><CODE><B><A HREF="../../../com/sleepycat/db/Cursor.html#put(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">put</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
405    <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data)</CODE>
406
407<BR>
408&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Store a key/data pair into the database.</TD>
409</TR>
410<TR BGCOLOR="white" CLASS="TableRowColor">
411<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
412<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD>
413<TD><CODE><B><A HREF="../../../com/sleepycat/db/Cursor.html#putAfter(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">putAfter</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
414         <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data)</CODE>
415
416<BR>
417&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Store a key/data pair into the database.</TD>
418</TR>
419<TR BGCOLOR="white" CLASS="TableRowColor">
420<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
421<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD>
422<TD><CODE><B><A HREF="../../../com/sleepycat/db/Cursor.html#putBefore(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">putBefore</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
423          <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data)</CODE>
424
425<BR>
426&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Store a key/data pair into the database.</TD>
427</TR>
428<TR BGCOLOR="white" CLASS="TableRowColor">
429<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
430<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD>
431<TD><CODE><B><A HREF="../../../com/sleepycat/db/Cursor.html#putCurrent(com.sleepycat.db.DatabaseEntry)">putCurrent</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data)</CODE>
432
433<BR>
434&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Replaces the data in the key/data pair at the current cursor position.</TD>
435</TR>
436<TR BGCOLOR="white" CLASS="TableRowColor">
437<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
438<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD>
439<TD><CODE><B><A HREF="../../../com/sleepycat/db/Cursor.html#putKeyFirst(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">putKeyFirst</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
440            <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data)</CODE>
441
442<BR>
443&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Store a key/data pair into the database.</TD>
444</TR>
445<TR BGCOLOR="white" CLASS="TableRowColor">
446<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
447<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD>
448<TD><CODE><B><A HREF="../../../com/sleepycat/db/Cursor.html#putKeyLast(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">putKeyLast</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
449           <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data)</CODE>
450
451<BR>
452&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Store a key/data pair into the database.</TD>
453</TR>
454<TR BGCOLOR="white" CLASS="TableRowColor">
455<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
456<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD>
457<TD><CODE><B><A HREF="../../../com/sleepycat/db/Cursor.html#putNoDupData(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">putNoDupData</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
458             <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data)</CODE>
459
460<BR>
461&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Store a key/data pair into the database.</TD>
462</TR>
463<TR BGCOLOR="white" CLASS="TableRowColor">
464<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
465<CODE>&nbsp;<A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD>
466<TD><CODE><B><A HREF="../../../com/sleepycat/db/Cursor.html#putNoOverwrite(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">putNoOverwrite</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
467               <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data)</CODE>
468
469<BR>
470&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Store a key/data pair into the database.</TD>
471</TR>
472<TR BGCOLOR="white" CLASS="TableRowColor">
473<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
474<CODE>&nbsp;void</CODE></FONT></TD>
475<TD><CODE><B><A HREF="../../../com/sleepycat/db/Cursor.html#setPriority(com.sleepycat.db.CacheFilePriority)">setPriority</A></B>(<A HREF="../../../com/sleepycat/db/CacheFilePriority.html" title="class in com.sleepycat.db">CacheFilePriority</A>&nbsp;priority)</CODE>
476
477<BR>
478&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the cache priority for pages referenced by the DBC handle.</TD>
479</TR>
480</TABLE>
481&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
482<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
483<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
484<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
485</TR>
486<TR BGCOLOR="white" CLASS="TableRowColor">
487<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
488</TR>
489</TABLE>
490&nbsp;
491<P>
492
493<!-- ========= CONSTRUCTOR DETAIL ======== -->
494
495<A NAME="constructor_detail"><!-- --></A>
496<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
497<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
498<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
499<B>Constructor Detail</B></FONT></TH>
500</TR>
501</TABLE>
502
503<A NAME="Cursor(com.sleepycat.db.Database, com.sleepycat.db.CursorConfig)"><!-- --></A><H3>
504Cursor</H3>
505<PRE>
506protected <B>Cursor</B>(<A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A>&nbsp;database,
507                 <A HREF="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</A>&nbsp;config)</PRE>
508<DL>
509</DL>
510
511<!-- ============ METHOD DETAIL ========== -->
512
513<A NAME="method_detail"><!-- --></A>
514<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
515<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
516<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
517<B>Method Detail</B></FONT></TH>
518</TR>
519</TABLE>
520
521<A NAME="close()"><!-- --></A><H3>
522close</H3>
523<PRE>
524public void <B>close</B>()
525           throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
526<DL>
527<DD><DL>
528
529<DT><B>Throws:</B>
530<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL>
531</DD>
532</DL>
533<HR>
534
535<A NAME="dup(boolean)"><!-- --></A><H3>
536dup</H3>
537<PRE>
538public <A HREF="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db">Cursor</A> <B>dup</B>(boolean&nbsp;samePosition)
539           throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
540<DL>
541<DD>Return a new cursor with the same transaction and locker ID as the
542    original cursor.
543    <p>
544    This is useful when an application is using locking and requires two
545    or more cursors in the same thread of control.
546    <p>
547<P>
548<DD><DL>
549<DT><B>Parameters:</B><DD><CODE>samePosition</CODE> - If true, the newly created cursor is initialized to refer to the
550    same position in the database as the original cursor (if any) and
551    hold the same locks (if any). If false, or the original cursor does
552    not hold a database position and locks, the returned cursor is
553    uninitialized and will behave like a newly created cursor.
554    <p>
555<DT><B>Returns:</B><DD>A new cursor with the same transaction and locker ID as the original
556    cursor.
557    <p>
558    <p>
559<DT><B>Throws:</B>
560<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
561</DD>
562</DL>
563<HR>
564
565<A NAME="getConfig()"><!-- --></A><H3>
566getConfig</H3>
567<PRE>
568public <A HREF="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</A> <B>getConfig</B>()</PRE>
569<DL>
570<DD>Return this cursor's configuration.
571    <p>
572    This may differ from the configuration used to open this object if
573    the cursor existed previously.
574    <p>
575<P>
576<DD><DL>
577
578<DT><B>Returns:</B><DD>This cursor's configuration.
579    <p>
580    <p>
581<DT><B>Throws:</B>
582<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
583</DD>
584</DL>
585<HR>
586
587<A NAME="getDatabase()"><!-- --></A><H3>
588getDatabase</H3>
589<PRE>
590public <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A> <B>getDatabase</B>()</PRE>
591<DL>
592<DD>Return the Database handle associated with this Cursor.
593    <p>
594<P>
595<DD><DL>
596
597<DT><B>Returns:</B><DD>The Database handle associated with this Cursor.
598    <p></DL>
599</DD>
600</DL>
601<HR>
602
603<A NAME="compare(com.sleepycat.db.Cursor)"><!-- --></A><H3>
604compare</H3>
605<PRE>
606public int <B>compare</B>(<A HREF="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db">Cursor</A>&nbsp;OtherCursor)
607            throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
608<DL>
609<DD>Return a comparison of the two cursors.
610    <p>
611<P>
612<DD><DL>
613
614<DT><B>Returns:</B><DD>An integer representing the result of the comparison. 0 is equal, 1 
615    indicates this cursor is greater than OtherCursor, -1 indicates that 
616    OtherCursor is greater than this cursor.
617    <p>
618    <p>
619<DT><B>Throws:</B>
620<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
621deadlock.
622<p>
623<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
624</DD>
625</DL>
626<HR>
627
628<A NAME="count()"><!-- --></A><H3>
629count</H3>
630<PRE>
631public int <B>count</B>()
632          throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
633<DL>
634<DD>Return a count of the number of data items for the key to which the
635    cursor refers.
636    <p>
637<P>
638<DD><DL>
639
640<DT><B>Returns:</B><DD>A count of the number of data items for the key to which the cursor
641    refers.
642    <p>
643    <p>
644<DT><B>Throws:</B>
645<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
646deadlock.
647<p>
648<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
649</DD>
650</DL>
651<HR>
652
653<A NAME="delete()"><!-- --></A><H3>
654delete</H3>
655<PRE>
656public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>delete</B>()
657                       throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
658<DL>
659<DD>Delete the key/data pair to which the cursor refers.
660    <p>
661    When called on a cursor opened on a database that has been made into a
662    secondary index, this method the key/data pair from the primary database
663    and all secondary indices.
664    <p>
665    The cursor position is unchanged after a delete, and subsequent calls
666to cursor functions expecting the cursor to refer to an existing key
667will fail.
668    <p>
669    <p>
670<P>
671<DD><DL>
672
673<DT><B>Throws:</B>
674<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
675deadlock.
676<p>
677<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
678</DD>
679</DL>
680<HR>
681
682<A NAME="getCurrent(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><!-- --></A><H3>
683getCurrent</H3>
684<PRE>
685public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>getCurrent</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
686                                  <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data,
687                                  <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)
688                           throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
689<DL>
690<DD>Returns the key/data pair to which the cursor refers.
691<p>
692If this method fails for any reason, the position of the cursor will be
693unchanged.
694<P>
695<DD><DL>
696<DT><B>Parameters:</B><DD><CODE>key</CODE> - the  key
697returned as output.  Its byte array does not need to be initialized by the
698caller.<DD><CODE>data</CODE> - the  data
699returned as output.  Multiple results can be retrieved by passing an object
700that 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
701need to be initialized by the caller.<DD><CODE>lockMode</CODE> - the locking attributes; if null, default attributes are used.
702<DT><B>Returns:</B><DD><A HREF="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><CODE>OperationStatus.KEYEMPTY</CODE></A> if the key/pair at the cursor
703position has been deleted; otherwise, <A HREF="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><CODE>OperationStatus.SUCCESS</CODE></A>.
704<DT><B>Throws:</B>
705<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if a DatabaseEntry parameter is null or
706does not contain a required non-null byte array.
707<p>
708<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
709deadlock.
710<p>
711<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified.
712<p>
713<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.
714<p></DL>
715</DD>
716</DL>
717<HR>
718
719<A NAME="getFirst(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><!-- --></A><H3>
720getFirst</H3>
721<PRE>
722public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>getFirst</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
723                                <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data,
724                                <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)
725                         throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
726<DL>
727<DD>Move the cursor to the first key/data pair of the database, and return
728that pair.  If the first key has duplicate values, the first data item
729in the set of duplicates is returned.
730<p>
731If this method fails for any reason, the position of the cursor will be
732unchanged.
733<P>
734<DD><DL>
735<DT><B>Parameters:</B><DD><CODE>key</CODE> - the  key
736returned as output.  Its byte array does not need to be initialized by the
737caller.<DD><CODE>data</CODE> - the  data
738returned as output.  Multiple results can be retrieved by passing an object
739that 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
740need to be initialized by the caller.<DD><CODE>lockMode</CODE> - the locking attributes; if null, default attributes are used.
741<DT><B>Returns:</B><DD><A HREF="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><CODE>OperationStatus.NOTFOUND</CODE></A> if no matching key/data pair is
742found; <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>.
743<DT><B>Throws:</B>
744<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if a DatabaseEntry parameter is null or
745does not contain a required non-null byte array.
746<p>
747<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
748deadlock.
749<p>
750<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified.
751<p>
752<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.
753<p></DL>
754</DD>
755</DL>
756<HR>
757
758<A NAME="getLast(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><!-- --></A><H3>
759getLast</H3>
760<PRE>
761public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>getLast</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
762                               <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data,
763                               <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)
764                        throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
765<DL>
766<DD>Move the cursor to the last key/data pair of the database, and return
767that pair.  If the last key has duplicate values, the last data item in
768the set of duplicates is returned.
769<p>
770If this method fails for any reason, the position of the cursor will be
771unchanged.
772<P>
773<DD><DL>
774<DT><B>Parameters:</B><DD><CODE>key</CODE> - the  key
775returned as output.  Its byte array does not need to be initialized by the
776caller.<DD><CODE>data</CODE> - the  data
777returned as output.  Its byte array does not need to be initialized by the
778caller.<DD><CODE>lockMode</CODE> - the locking attributes; if null, default attributes are used.
779<DT><B>Returns:</B><DD><A HREF="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><CODE>OperationStatus.NOTFOUND</CODE></A> if no matching key/data pair is
780found; <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>.
781<DT><B>Throws:</B>
782<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if a DatabaseEntry parameter is null or
783does not contain a required non-null byte array.
784<p>
785<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
786deadlock.
787<p>
788<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified.
789<p>
790<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.
791<p></DL>
792</DD>
793</DL>
794<HR>
795
796<A NAME="getNext(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><!-- --></A><H3>
797getNext</H3>
798<PRE>
799public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>getNext</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
800                               <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data,
801                               <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)
802                        throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
803<DL>
804<DD>Move the cursor to the next key/data pair and return that pair.  If
805the matching key has duplicate values, the first data item in the set
806of duplicates is returned.
807<p>
808If the cursor is not yet initialized, move the cursor to the first
809key/data pair of the database, and return that pair.  Otherwise, the
810cursor is moved to the next key/data pair of the database, and that pair
811is returned.  In the presence of duplicate key values, the value of the
812key may not change.
813<p>
814If this method fails for any reason, the position of the cursor will be
815unchanged.
816<P>
817<DD><DL>
818<DT><B>Parameters:</B><DD><CODE>key</CODE> - the  key
819returned as output.  Its byte array does not need to be initialized by the
820caller.<DD><CODE>data</CODE> - the  data
821returned as output.  Multiple results can be retrieved by passing an object
822that 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
823need to be initialized by the caller.<DD><CODE>lockMode</CODE> - the locking attributes; if null, default attributes are used.
824<DT><B>Returns:</B><DD><A HREF="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><CODE>OperationStatus.NOTFOUND</CODE></A> if no matching key/data pair is
825found; <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>.
826<DT><B>Throws:</B>
827<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if a DatabaseEntry parameter is null or
828does not contain a required non-null byte array.
829<p>
830<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
831deadlock.
832<p>
833<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified.
834<p>
835<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.
836<p></DL>
837</DD>
838</DL>
839<HR>
840
841<A NAME="getNextDup(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><!-- --></A><H3>
842getNextDup</H3>
843<PRE>
844public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>getNextDup</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
845                                  <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data,
846                                  <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)
847                           throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
848<DL>
849<DD>If the next key/data pair of the database is a duplicate data record for
850the current key/data pair, move the cursor to the next key/data pair
851of the database and return that pair.
852<p>
853If this method fails for any reason, the position of the cursor will be
854unchanged.
855<P>
856<DD><DL>
857<DT><B>Parameters:</B><DD><CODE>key</CODE> - the  key
858returned as output.  Its byte array does not need to be initialized by the
859caller.<DD><CODE>data</CODE> - the  data
860returned as output.  Multiple results can be retrieved by passing an object
861that 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
862need to be initialized by the caller.<DD><CODE>lockMode</CODE> - the locking attributes; if null, default attributes are used.
863<DT><B>Returns:</B><DD><A HREF="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><CODE>OperationStatus.NOTFOUND</CODE></A> if no matching key/data pair is
864found; <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>.
865<DT><B>Throws:</B>
866<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if a DatabaseEntry parameter is null or
867does not contain a required non-null byte array.
868<p>
869<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
870deadlock.
871<p>
872<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified.
873<p>
874<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.
875<p></DL>
876</DD>
877</DL>
878<HR>
879
880<A NAME="getNextNoDup(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><!-- --></A><H3>
881getNextNoDup</H3>
882<PRE>
883public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>getNextNoDup</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
884                                    <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data,
885                                    <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)
886                             throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
887<DL>
888<DD>Move the cursor to the next non-duplicate key/data pair and return
889that pair.  If the matching key has duplicate values, the first data
890item in the set of duplicates is returned.
891<p>
892If the cursor is not yet initialized, move the cursor to the first
893key/data pair of the database, and return that pair.  Otherwise, the
894cursor is moved to the next non-duplicate key of the database, and that
895key/data pair is returned.
896<p>
897If this method fails for any reason, the position of the cursor will be
898unchanged.
899<P>
900<DD><DL>
901<DT><B>Parameters:</B><DD><CODE>key</CODE> - the  key
902returned as output.  Its byte array does not need to be initialized by the
903caller.<DD><CODE>data</CODE> - the  data
904returned as output.  Multiple results can be retrieved by passing an object
905that 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
906need to be initialized by the caller.<DD><CODE>lockMode</CODE> - the locking attributes; if null, default attributes are used.
907<DT><B>Returns:</B><DD><A HREF="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><CODE>OperationStatus.NOTFOUND</CODE></A> if no matching key/data pair is
908found; <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>.
909<DT><B>Throws:</B>
910<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if a DatabaseEntry parameter is null or
911does not contain a required non-null byte array.
912<p>
913<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
914deadlock.
915<p>
916<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified.
917<p>
918<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.
919<p></DL>
920</DD>
921</DL>
922<HR>
923
924<A NAME="getPrev(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><!-- --></A><H3>
925getPrev</H3>
926<PRE>
927public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>getPrev</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
928                               <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data,
929                               <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)
930                        throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
931<DL>
932<DD>Move the cursor to the previous key/data pair and return that pair.
933If the matching key has duplicate values, the last data item in the set
934of duplicates is returned.
935<p>
936If the cursor is not yet initialized, move the cursor to the last
937key/data pair of the database, and return that pair.  Otherwise, the
938cursor is moved to the previous key/data pair of the database, and that
939pair is returned. In the presence of duplicate key values, the value of
940the key may not change.
941<p>
942If this method fails for any reason, the position of the cursor will be
943unchanged.
944<P>
945<DD><DL>
946<DT><B>Parameters:</B><DD><CODE>key</CODE> - the  key
947returned as output.  Its byte array does not need to be initialized by the
948caller.<DD><CODE>data</CODE> - the  data
949returned as output.  Its byte array does not need to be initialized by the
950caller.<DD><CODE>lockMode</CODE> - the locking attributes; if null, default attributes are used.
951<DT><B>Returns:</B><DD><A HREF="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><CODE>OperationStatus.NOTFOUND</CODE></A> if no matching key/data pair is
952found; <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>.
953<DT><B>Throws:</B>
954<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if a DatabaseEntry parameter is null or
955does not contain a required non-null byte array.
956<p>
957<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
958deadlock.
959<p>
960<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified.
961<p>
962<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.
963<p></DL>
964</DD>
965</DL>
966<HR>
967
968<A NAME="getPrevDup(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><!-- --></A><H3>
969getPrevDup</H3>
970<PRE>
971public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>getPrevDup</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
972                                  <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data,
973                                  <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)
974                           throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
975<DL>
976<DD>If the previous key/data pair of the database is a duplicate data record
977for the current key/data pair, move the cursor to the previous key/data
978pair of the database and return that pair.
979<p>
980If this method fails for any reason, the position of the cursor will be
981unchanged.
982<P>
983<DD><DL>
984<DT><B>Parameters:</B><DD><CODE>key</CODE> - the  key
985returned as output.  Its byte array does not need to be initialized by the
986caller.<DD><CODE>data</CODE> - the  data
987returned as output.  Its byte array does not need to be initialized by the
988caller.<DD><CODE>lockMode</CODE> - the locking attributes; if null, default attributes are used.
989<DT><B>Returns:</B><DD><A HREF="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><CODE>OperationStatus.NOTFOUND</CODE></A> if no matching key/data pair is
990found; <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>.
991<DT><B>Throws:</B>
992<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if a DatabaseEntry parameter is null or
993does not contain a required non-null byte array.
994<p>
995<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
996deadlock.
997<p>
998<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified.
999<p>
1000<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.
1001<p></DL>
1002</DD>
1003</DL>
1004<HR>
1005
1006<A NAME="getPrevNoDup(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><!-- --></A><H3>
1007getPrevNoDup</H3>
1008<PRE>
1009public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>getPrevNoDup</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
1010                                    <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data,
1011                                    <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)
1012                             throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
1013<DL>
1014<DD>Move the cursor to the previous non-duplicate key/data pair and return
1015that pair.  If the matching key has duplicate values, the last data item
1016in the set of duplicates is returned.
1017<p>
1018If the cursor is not yet initialized, move the cursor to the last
1019key/data pair of the database, and return that pair.  Otherwise, the
1020cursor is moved to the previous non-duplicate key of the database, and
1021that key/data pair is returned.
1022<p>
1023If this method fails for any reason, the position of the cursor will be
1024unchanged.
1025<P>
1026<DD><DL>
1027<DT><B>Parameters:</B><DD><CODE>key</CODE> - the  key
1028returned as output.  Its byte array does not need to be initialized by the
1029caller.<DD><CODE>data</CODE> - the  data
1030returned as output.  Its byte array does not need to be initialized by the
1031caller.<DD><CODE>lockMode</CODE> - the locking attributes; if null, default attributes are used.
1032<DT><B>Returns:</B><DD><A HREF="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><CODE>OperationStatus.NOTFOUND</CODE></A> if no matching key/data pair is
1033found; <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>.
1034<DT><B>Throws:</B>
1035<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if a DatabaseEntry parameter is null or
1036does not contain a required non-null byte array.
1037<p>
1038<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
1039deadlock.
1040<p>
1041<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified.
1042<p>
1043<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.
1044<p></DL>
1045</DD>
1046</DL>
1047<HR>
1048
1049<A NAME="getRecordNumber(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><!-- --></A><H3>
1050getRecordNumber</H3>
1051<PRE>
1052public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>getRecordNumber</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data,
1053                                       <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)
1054                                throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
1055<DL>
1056<DD>Return the record number associated with the cursor.  The record number
1057will be returned in the data parameter.
1058<p>
1059For this method to be called, the underlying database must be of type
1060Btree, and it must have been configured to support record numbers.
1061<p>
1062If this method fails for any reason, the position of the cursor will be
1063unchanged.
1064<P>
1065<DD><DL>
1066<DT><B>Parameters:</B><DD><CODE>data</CODE> - the  data
1067returned as output.  Its byte array does not need to be initialized by the
1068caller.<DD><CODE>lockMode</CODE> - the locking attributes; if null, default attributes are used.
1069<DT><B>Returns:</B><DD><A HREF="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><CODE>OperationStatus.NOTFOUND</CODE></A> if no matching key/data pair is
1070found; <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>.
1071<DT><B>Throws:</B>
1072<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if a DatabaseEntry parameter is null or
1073does not contain a required non-null byte array.
1074<p>
1075<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
1076deadlock.
1077<p>
1078<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified.
1079<p>
1080<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.
1081<p></DL>
1082</DD>
1083</DL>
1084<HR>
1085
1086<A NAME="getSearchKey(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><!-- --></A><H3>
1087getSearchKey</H3>
1088<PRE>
1089public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>getSearchKey</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
1090                                    <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data,
1091                                    <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)
1092                             throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
1093<DL>
1094<DD>Move the cursor to the given key of the database, and return the datum
1095associated with the given key.  If the matching key has duplicate
1096values, the first data item in the set of duplicates is returned.
1097<p>
1098If this method fails for any reason, the position of the cursor will be
1099unchanged.
1100<P>
1101<DD><DL>
1102<DT><B>Parameters:</B><DD><CODE>key</CODE> - the  key
1103used as input.  It must be initialized with a non-null byte array by the
1104caller.<DD><CODE>data</CODE> - the  data
1105returned as output.  Multiple results can be retrieved by passing an object
1106that 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
1107need to be initialized by the caller.<DD><CODE>lockMode</CODE> - the locking attributes; if null, default attributes are used.
1108<DT><B>Returns:</B><DD><A HREF="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><CODE>OperationStatus.NOTFOUND</CODE></A> if no matching key/data pair is
1109found; <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>.
1110<DT><B>Throws:</B>
1111<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if a DatabaseEntry parameter is null or
1112does not contain a required non-null byte array.
1113<p>
1114<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
1115deadlock.
1116<p>
1117<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified.
1118<p>
1119<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.
1120<p></DL>
1121</DD>
1122</DL>
1123<HR>
1124
1125<A NAME="getSearchKeyRange(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><!-- --></A><H3>
1126getSearchKeyRange</H3>
1127<PRE>
1128public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>getSearchKeyRange</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
1129                                         <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data,
1130                                         <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)
1131                                  throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
1132<DL>
1133<DD>Move the cursor to the closest matching key of the database, and return
1134the data item associated with the matching key.  If the matching key has
1135duplicate values, the first data item in the set of duplicates is returned.
1136<p>
1137The returned key/data pair is for the smallest key greater than or equal
1138to the specified key (as determined by the key comparison function),
1139permitting partial key matches and range searches.
1140<p>
1141If this method fails for any reason, the position of the cursor will be
1142unchanged.
1143<P>
1144<DD><DL>
1145<DT><B>Parameters:</B><DD><CODE>key</CODE> - the  key
1146used as input and returned as output.  It must be initialized with a non-null
1147byte array by the caller.<DD><CODE>data</CODE> - the  data
1148returned as output.  Multiple results can be retrieved by passing an object
1149that 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
1150need to be initialized by the caller.<DD><CODE>lockMode</CODE> - the locking attributes; if null, default attributes are used.
1151<DT><B>Returns:</B><DD><A HREF="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><CODE>OperationStatus.NOTFOUND</CODE></A> if no matching key/data pair is
1152found; <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>.
1153<DT><B>Throws:</B>
1154<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if a DatabaseEntry parameter is null or
1155does not contain a required non-null byte array.
1156<p>
1157<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
1158deadlock.
1159<p>
1160<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified.
1161<p>
1162<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.
1163<p></DL>
1164</DD>
1165</DL>
1166<HR>
1167
1168<A NAME="getSearchBoth(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><!-- --></A><H3>
1169getSearchBoth</H3>
1170<PRE>
1171public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>getSearchBoth</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
1172                                     <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data,
1173                                     <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)
1174                              throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
1175<DL>
1176<DD>Move the cursor to the specified key/data pair, where both the key and
1177data items must match.
1178<p>
1179If this method fails for any reason, the position of the cursor will be
1180unchanged.
1181<P>
1182<DD><DL>
1183<DT><B>Parameters:</B><DD><CODE>key</CODE> - the  key
1184used as input.  It must be initialized with a non-null byte array by the
1185caller.<DD><CODE>data</CODE> - the  data
1186used as input.  It must be initialized with a non-null byte array by the
1187caller.<DD><CODE>lockMode</CODE> - the locking attributes; if null, default attributes are used.
1188<DT><B>Returns:</B><DD><A HREF="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><CODE>OperationStatus.NOTFOUND</CODE></A> if no matching key/data pair is
1189found; <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>.
1190<DT><B>Throws:</B>
1191<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if a DatabaseEntry parameter is null or
1192does not contain a required non-null byte array.
1193<p>
1194<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
1195deadlock.
1196<p>
1197<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified.
1198<p>
1199<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.
1200<p></DL>
1201</DD>
1202</DL>
1203<HR>
1204
1205<A NAME="getSearchBothRange(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><!-- --></A><H3>
1206getSearchBothRange</H3>
1207<PRE>
1208public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>getSearchBothRange</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
1209                                          <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data,
1210                                          <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)
1211                                   throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
1212<DL>
1213<DD>Move the cursor to the specified key and closest matching data item of the
1214database.
1215<p>
1216In the case of any database supporting sorted duplicate sets, the returned
1217key/data pair is for the smallest data item greater than or equal to the
1218specified data item (as determined by the duplicate comparison function),
1219permitting partial matches and range searches in duplicate data sets.
1220<p>
1221If this method fails for any reason, the position of the cursor will be
1222unchanged.
1223<P>
1224<DD><DL>
1225<DT><B>Parameters:</B><DD><CODE>key</CODE> - the  key
1226used as input and returned as output.  It must be initialized with a non-null
1227byte array by the caller.<DD><CODE>data</CODE> - the  data
1228used as input and returned as output.  It must be initialized with a non-null
1229byte array by the caller.<DD><CODE>lockMode</CODE> - the locking attributes; if null, default attributes are used.
1230<DT><B>Returns:</B><DD><A HREF="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><CODE>OperationStatus.NOTFOUND</CODE></A> if no matching key/data pair is
1231found; <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>.
1232<DT><B>Throws:</B>
1233<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if a DatabaseEntry parameter is null or
1234does not contain a required non-null byte array.
1235<p>
1236<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
1237deadlock.
1238<p>
1239<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified.
1240<p>
1241<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.
1242<p></DL>
1243</DD>
1244</DL>
1245<HR>
1246
1247<A NAME="getSearchRecordNumber(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><!-- --></A><H3>
1248getSearchRecordNumber</H3>
1249<PRE>
1250public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>getSearchRecordNumber</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
1251                                             <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data,
1252                                             <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A>&nbsp;lockMode)
1253                                      throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
1254<DL>
1255<DD>Move the cursor to the specific numbered record of the database, and
1256return the associated key/data pair.
1257<p>
1258The data field of the specified key must be a byte array containing a
1259record number, as described in <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><CODE>DatabaseEntry</CODE></A>.  This determines
1260the record to be retrieved.
1261<p>
1262For this method to be called, the underlying database must be of type
1263Btree, and it must have been configured to support record numbers.
1264<p>
1265If this method fails for any reason, the position of the cursor will be
1266unchanged.
1267<P>
1268<DD><DL>
1269<DT><B>Parameters:</B><DD><CODE>key</CODE> - the  key
1270returned as output.  Its byte array does not need to be initialized by the
1271caller.<DD><CODE>data</CODE> - the  data
1272returned as output.  Multiple results can be retrieved by passing an object
1273that 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
1274need to be initialized by the caller.<DD><CODE>lockMode</CODE> - the locking attributes; if null, default attributes are used.
1275<DT><B>Returns:</B><DD><A HREF="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><CODE>OperationStatus.NOTFOUND</CODE></A> if no matching key/data pair is
1276found; <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>.
1277<DT><B>Throws:</B>
1278<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if a DatabaseEntry parameter is null or
1279does not contain a required non-null byte array.
1280<p>
1281<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
1282deadlock.
1283<p>
1284<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified.
1285<p>
1286<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.
1287<p></DL>
1288</DD>
1289</DL>
1290<HR>
1291
1292<A NAME="put(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)"><!-- --></A><H3>
1293put</H3>
1294<PRE>
1295public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>put</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
1296                           <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data)
1297                    throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
1298<DL>
1299<DD>Store a key/data pair into the database.
1300<p>
1301If the put method succeeds, the cursor is always positioned to refer to
1302the newly inserted item.  If the put method fails for any reason, the
1303state of the cursor will be unchanged.
1304<p>
1305If the key already appears in the database and duplicates are supported,
1306the new data value is inserted at the correct sorted location.  If the
1307key already appears in the database and duplicates are not supported,
1308the existing key/data pair will be replaced.
1309<p>
1310<P>
1311<DD><DL>
1312<DT><B>Parameters:</B><DD><CODE>key</CODE> - the key <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><CODE>DatabaseEntry</CODE></A> operated on.
1313<p><DD><CODE>data</CODE> - the data <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><CODE>DatabaseEntry</CODE></A> stored.
1314<p>
1315<p>
1316<DT><B>Throws:</B>
1317<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
1318deadlock.
1319<p>
1320<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified.
1321<p>
1322<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
1323</DD>
1324</DL>
1325<HR>
1326
1327<A NAME="putAfter(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)"><!-- --></A><H3>
1328putAfter</H3>
1329<PRE>
1330public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>putAfter</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
1331                                <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data)
1332                         throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
1333<DL>
1334<DD>Store a key/data pair into the database.
1335<p>
1336If the putAfter method succeeds, the cursor is always positioned to refer to
1337the newly inserted item.  If the putAfter method fails for any reason, the
1338state of the cursor will be unchanged.
1339<p>
1340In the case of the Btree and Hash access methods, insert the data
1341element as a duplicate element of the key to which the cursor refers.
1342The new element appears immediately
1343after
1344the current cursor position.  It is an error to call this method if the
1345underlying Btree or Hash database does not support duplicate data items.
1346The key parameter is ignored.
1347<p>
1348In the case of the Hash access method, the putAfter method will fail and
1349throw an exception if the current cursor record has already been deleted.
1350<p>
1351In the case of the Recno access method, it is an error to call this
1352method if the underlying Recno database was not configured to have
1353mutable record numbers.  A new key is created, all records after the
1354inserted item are automatically renumbered, and the key of the new
1355record is returned in the key parameter.  The initial value of the key
1356parameter is ignored.
1357<p>
1358The putAfter method may not be called for the Queue access method.
1359<p>
1360<P>
1361<DD><DL>
1362<DT><B>Parameters:</B><DD><CODE>key</CODE> - the key <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><CODE>DatabaseEntry</CODE></A> operated on.
1363<p><DD><CODE>data</CODE> - the data <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><CODE>DatabaseEntry</CODE></A> stored.
1364<p>
1365<p>
1366<DT><B>Throws:</B>
1367<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
1368deadlock.
1369<p>
1370<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified.
1371<p>
1372<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
1373</DD>
1374</DL>
1375<HR>
1376
1377<A NAME="putBefore(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)"><!-- --></A><H3>
1378putBefore</H3>
1379<PRE>
1380public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>putBefore</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
1381                                 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data)
1382                          throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
1383<DL>
1384<DD>Store a key/data pair into the database.
1385<p>
1386If the putBefore method succeeds, the cursor is always positioned to refer to
1387the newly inserted item.  If the putBefore method fails for any reason, the
1388state of the cursor will be unchanged.
1389<p>
1390In the case of the Btree and Hash access methods, insert the data
1391element as a duplicate element of the key to which the cursor refers.
1392The new element appears immediately
1393before
1394the current cursor position.  It is an error to call this method if the
1395underlying Btree or Hash database does not support duplicate data items.
1396The key parameter is ignored.
1397<p>
1398In the case of the Hash access method, the putBefore method will fail and
1399throw an exception if the current cursor record has already been deleted.
1400<p>
1401In the case of the Recno access method, it is an error to call this
1402method if the underlying Recno database was not configured to have
1403mutable record numbers.  A new key is created, all records after the
1404inserted item are automatically renumbered, and the key of the new
1405record is returned in the key parameter.  The initial value of the key
1406parameter is ignored.
1407<p>
1408The putBefore method may not be called for the Queue access method.
1409<p>
1410<P>
1411<DD><DL>
1412<DT><B>Parameters:</B><DD><CODE>key</CODE> - the key <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><CODE>DatabaseEntry</CODE></A> operated on.
1413<p><DD><CODE>data</CODE> - the data <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><CODE>DatabaseEntry</CODE></A> stored.
1414<p>
1415<p>
1416<DT><B>Throws:</B>
1417<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
1418deadlock.
1419<p>
1420<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified.
1421<p>
1422<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
1423</DD>
1424</DL>
1425<HR>
1426
1427<A NAME="putNoOverwrite(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)"><!-- --></A><H3>
1428putNoOverwrite</H3>
1429<PRE>
1430public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>putNoOverwrite</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
1431                                      <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data)
1432                               throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
1433<DL>
1434<DD>Store a key/data pair into the database.
1435<p>
1436If the putNoOverwrite method succeeds, the cursor is always positioned to refer to
1437the newly inserted item.  If the putNoOverwrite method fails for any reason, the
1438state of the cursor will be unchanged.
1439<p>
1440If the key already appears in the database, putNoOverwrite will return
1441<A HREF="../../../com/sleepycat/db/OperationStatus.html#KEYEXIST"><CODE>OperationStatus.KEYEXIST</CODE></A>.
1442<p>
1443<P>
1444<DD><DL>
1445<DT><B>Parameters:</B><DD><CODE>key</CODE> - the key <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><CODE>DatabaseEntry</CODE></A> operated on.
1446<p><DD><CODE>data</CODE> - the data <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><CODE>DatabaseEntry</CODE></A> stored.
1447<p>
1448<p>
1449<DT><B>Throws:</B>
1450<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
1451deadlock.
1452<p>
1453<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified.
1454<p>
1455<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
1456</DD>
1457</DL>
1458<HR>
1459
1460<A NAME="putKeyFirst(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)"><!-- --></A><H3>
1461putKeyFirst</H3>
1462<PRE>
1463public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>putKeyFirst</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
1464                                   <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data)
1465                            throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
1466<DL>
1467<DD>Store a key/data pair into the database.
1468<p>
1469If the putKeyFirst method succeeds, the cursor is always positioned to refer to
1470the newly inserted item.  If the putKeyFirst method fails for any reason, the
1471state of the cursor will be unchanged.
1472<p>
1473In the case of the Btree and Hash access methods, insert the specified
1474key/data pair into the database.
1475<p>
1476If the underlying database supports duplicate data items, and if the
1477key already exists in the database and a duplicate sort function has
1478been specified, the inserted data item is added in its sorted location.
1479If the key already exists in the database and no duplicate sort function
1480has been specified, the inserted data item is added as the
1481first
1482of the data items for that key.
1483<p>
1484The putKeyFirst method may not be called for the Queue or Recno access methods.
1485<p>
1486<P>
1487<DD><DL>
1488<DT><B>Parameters:</B><DD><CODE>key</CODE> - the key <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><CODE>DatabaseEntry</CODE></A> operated on.
1489<p><DD><CODE>data</CODE> - the data <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><CODE>DatabaseEntry</CODE></A> stored.
1490<p>
1491<p>
1492<DT><B>Throws:</B>
1493<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
1494deadlock.
1495<p>
1496<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified.
1497<p>
1498<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
1499</DD>
1500</DL>
1501<HR>
1502
1503<A NAME="putKeyLast(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)"><!-- --></A><H3>
1504putKeyLast</H3>
1505<PRE>
1506public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>putKeyLast</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
1507                                  <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data)
1508                           throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
1509<DL>
1510<DD>Store a key/data pair into the database.
1511<p>
1512If the putKeyLast method succeeds, the cursor is always positioned to refer to
1513the newly inserted item.  If the putKeyLast method fails for any reason, the
1514state of the cursor will be unchanged.
1515<p>
1516In the case of the Btree and Hash access methods, insert the specified
1517key/data pair into the database.
1518<p>
1519If the underlying database supports duplicate data items, and if the
1520key already exists in the database and a duplicate sort function has
1521been specified, the inserted data item is added in its sorted location.
1522If the key already exists in the database and no duplicate sort function
1523has been specified, the inserted data item is added as the
1524last
1525of the data items for that key.
1526<p>
1527The putKeyLast method may not be called for the Queue or Recno access methods.
1528<p>
1529<P>
1530<DD><DL>
1531<DT><B>Parameters:</B><DD><CODE>key</CODE> - the key <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><CODE>DatabaseEntry</CODE></A> operated on.
1532<p><DD><CODE>data</CODE> - the data <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><CODE>DatabaseEntry</CODE></A> stored.
1533<p>
1534<p>
1535<DT><B>Throws:</B>
1536<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
1537deadlock.
1538<p>
1539<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified.
1540<p>
1541<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
1542</DD>
1543</DL>
1544<HR>
1545
1546<A NAME="putNoDupData(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)"><!-- --></A><H3>
1547putNoDupData</H3>
1548<PRE>
1549public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>putNoDupData</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;key,
1550                                    <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data)
1551                             throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
1552<DL>
1553<DD>Store a key/data pair into the database.
1554<p>
1555If the putNoDupData method succeeds, the cursor is always positioned to refer to
1556the newly inserted item.  If the putNoDupData method fails for any reason, the
1557state of the cursor will be unchanged.
1558<p>
1559In the case of the Btree and Hash access methods, insert
1560the specified key/data pair into the database, unless a key/data pair
1561comparing equally to it already exists in the database.  If a matching
1562key/data pair already exists in the database, <A HREF="../../../com/sleepycat/db/OperationStatus.html#KEYEXIST"><CODE>OperationStatus.KEYEXIST</CODE></A> is returned.
1563<p>
1564This method may only be called if the underlying database has been
1565configured to support sorted duplicate data items.
1566<p>
1567This method may not be called for the Queue or Recno access methods.
1568<p>
1569<P>
1570<DD><DL>
1571<DT><B>Parameters:</B><DD><CODE>key</CODE> - the key <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><CODE>DatabaseEntry</CODE></A> operated on.
1572<p><DD><CODE>data</CODE> - the data <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><CODE>DatabaseEntry</CODE></A> stored.
1573<p>
1574<p>
1575<DT><B>Throws:</B>
1576<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
1577deadlock.
1578<p>
1579<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified.
1580<p>
1581<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
1582</DD>
1583</DL>
1584<HR>
1585
1586<A NAME="putCurrent(com.sleepycat.db.DatabaseEntry)"><!-- --></A><H3>
1587putCurrent</H3>
1588<PRE>
1589public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>putCurrent</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A>&nbsp;data)
1590                           throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
1591<DL>
1592<DD>Replaces the data in the key/data pair at the current cursor position.
1593    <p>
1594    Whether the putCurrent method succeeds or fails for any reason, the state
1595    of the cursor will be unchanged.
1596    <p>
1597    Overwrite the data of the key/data pair to which the cursor refers with the
1598    specified data item. This method will return OperationStatus.NOTFOUND if
1599    the cursor currently refers to an already-deleted key/data pair.
1600    <p>
1601    For a database that does not support duplicates, the data may be changed by
1602    this method.  If duplicates are supported, the data may be changed only if
1603    a custom partial comparator is configured and the comparator considers the
1604    old and new data to be equal (that is, the comparator returns zero).  For
1605    more information on partial comparators see <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setDuplicateComparator(java.util.Comparator)"><CODE>DatabaseConfig.setDuplicateComparator(java.util.Comparator)</CODE></A>.
1606    <p>
1607    If the old and new data are unequal according to the comparator, a <code>DatabaseException</code> is thrown.  Changing the data in this case would change
1608    the sort order of the record, which would change the cursor position, and
1609    this is not allowed.  To change the sort order of a record, delete it and
1610    then re-insert it.
1611    <p>
1612<P>
1613<DD><DL>
1614<DT><B>Parameters:</B><DD><CODE>data</CODE> - - the data DatabaseEntry stored.
1615    <br>
1616<DT><B>Throws:</B>
1617<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
1618    deadlock.
1619    <br>
1620<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - - if an invalid parameter was specified.
1621    <br>
1622<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - - if the old and new data are not equal according
1623    to the configured duplicate comparator or default comparator, or if a
1624    failure occurs.
1625    <br></DL>
1626</DD>
1627</DL>
1628<HR>
1629
1630<A NAME="getPriority()"><!-- --></A><H3>
1631getPriority</H3>
1632<PRE>
1633public <A HREF="../../../com/sleepycat/db/CacheFilePriority.html" title="class in com.sleepycat.db">CacheFilePriority</A> <B>getPriority</B>()
1634                              throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
1635<DL>
1636<DD>Get the cache priority for pages referenced by the cursor.
1637    <p>
1638    This method may be called at any time during the life of the application.
1639    <p>
1640    <p>
1641<P>
1642<DD><DL>
1643
1644<DT><B>Throws:</B>
1645<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
1646</DD>
1647</DL>
1648<HR>
1649
1650<A NAME="setPriority(com.sleepycat.db.CacheFilePriority)"><!-- --></A><H3>
1651setPriority</H3>
1652<PRE>
1653public void <B>setPriority</B>(<A HREF="../../../com/sleepycat/db/CacheFilePriority.html" title="class in com.sleepycat.db">CacheFilePriority</A>&nbsp;priority)
1654                 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
1655<DL>
1656<DD>Set the cache priority for pages referenced by the DBC handle.
1657    <p>
1658    The priority of a page biases the replacement algorithm to be more or less
1659    likely to discard a page when space is needed in the buffer pool. The bias
1660    is temporary, and pages will eventually be discarded if they are not
1661    referenced again. The DBcursor->set_priority method is only advisory, and
1662    does not guarantee pages will be treated in a specific way.
1663    <p>
1664    This method may be called at any time during the life of the application.
1665    <p>
1666    <p>
1667<P>
1668<DD><DL>
1669
1670<DT><B>Throws:</B>
1671<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
1672</DD>
1673</DL>
1674<!-- ========= END OF CLASS DATA ========= -->
1675<HR>
1676
1677
1678<!-- ======= START OF BOTTOM NAVBAR ====== -->
1679<A NAME="navbar_bottom"><!-- --></A>
1680<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
1681<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
1682<TR>
1683<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
1684<A NAME="navbar_bottom_firstrow"><!-- --></A>
1685<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
1686  <TR ALIGN="center" VALIGN="top">
1687  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
1688  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
1689  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
1690  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Cursor.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
1691  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
1692  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
1693  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
1694  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
1695  </TR>
1696</TABLE>
1697</TD>
1698<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
1699<b>Berkeley DB</b><br><font size="-1"> version 4.8.30</font></EM>
1700</TD>
1701</TR>
1702
1703<TR>
1704<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1705&nbsp;<A HREF="../../../com/sleepycat/db/CompactStats.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A>&nbsp;
1706&nbsp;<A HREF="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD>
1707<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1708  <A HREF="../../../index.html?com/sleepycat/db/Cursor.html" target="_top"><B>FRAMES</B></A>  &nbsp;
1709&nbsp;<A HREF="Cursor.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
1710&nbsp;<SCRIPT type="text/javascript">
1711  <!--
1712  if(window==top) {
1713    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
1714  }
1715  //-->
1716</SCRIPT>
1717<NOSCRIPT>
1718  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
1719</NOSCRIPT>
1720
1721
1722</FONT></TD>
1723</TR>
1724<TR>
1725<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1726  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
1727<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1728DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
1729</TR>
1730</TABLE>
1731<A NAME="skip-navbar_bottom"></A>
1732<!-- ======== END OF BOTTOM NAVBAR ======= -->
1733
1734<HR>
1735<font size=1>Copyright (c) 1996-2009 Oracle.  All rights reserved.</font>
1736</BODY>
1737</HTML>
1738