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:50 EDT 2010 --> 6<TITLE> 7EntityCursor (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="EntityCursor (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> </TD> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/EntityCursor.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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 <A HREF="../../../com/sleepycat/persist/DatabaseNamer.html" title="interface in com.sleepycat.persist"><B>PREV CLASS</B></A> 59 <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist"><B>NEXT CLASS</B></A></FONT></TD> 60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 61 <A HREF="../../../index.html?com/sleepycat/persist/EntityCursor.html" target="_top"><B>FRAMES</B></A> 62 <A HREF="EntityCursor.html" target="_top"><B>NO FRAMES</B></A> 63 <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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 81DETAIL: FIELD | CONSTR | <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.persist</FONT> 92<BR> 93Interface EntityCursor<V></H2> 94<DL> 95<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</A><V>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A><V></DD> 96</DL> 97<HR> 98<DL> 99<DT><PRE>public interface <B>EntityCursor<V></B><DT>extends <A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</A><V></DL> 100</PRE> 101 102<P> 103Traverses entity values or key values and allows deleting or updating the 104 entity at the current cursor position. The value type (V) is either an 105 entity class or a key class, depending on how the cursor was opened. 106 107 <p><code>EntityCursor</code> objects are <em>not</em> thread-safe. Cursors 108 should be opened, used and closed by a single thread.</p> 109 110 <p>Cursors are opened using the <A HREF="../../../com/sleepycat/persist/EntityIndex.html#keys()"><CODE>EntityIndex.keys()</CODE></A> and <A HREF="../../../com/sleepycat/persist/EntityIndex.html#entities()"><CODE>EntityIndex.entities()</CODE></A> family of methods. These methods are available for 111 objects of any class that implements <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist"><CODE>EntityIndex</CODE></A>: <A HREF="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><CODE>PrimaryIndex</CODE></A>, <A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="class in com.sleepycat.persist"><CODE>SecondaryIndex</CODE></A>, and the indices returned by <A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#keysIndex"><CODE>SecondaryIndex.keysIndex</CODE></A> and <A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#subIndex(SK)"><CODE>SecondaryIndex.subIndex(SK)</CODE></A>. A <A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist"><CODE>ForwardCursor</CODE></A>, which implements a subset of cursor operations, is also 112 available via the <A HREF="../../../com/sleepycat/persist/EntityJoin.html#keys()"><CODE>EntityJoin.keys()</CODE></A> and <A HREF="../../../com/sleepycat/persist/EntityJoin.html#entities()"><CODE>EntityJoin.entities()</CODE></A> 113 methods.</p> 114 115 <p>Values are always returned by a cursor in key order, where the key is 116 defined by the underlying <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist"><CODE>EntityIndex</CODE></A>. For example, a cursor on a 117 <A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="class in com.sleepycat.persist"><CODE>SecondaryIndex</CODE></A> returns values ordered by secondary key, while an 118 index on a <A HREF="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><CODE>PrimaryIndex</CODE></A> or a <A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#subIndex(SK)"><CODE>SecondaryIndex.subIndex(SK)</CODE></A> returns 119 values ordered by primary key.</p> 120 121 <p><em>WARNING:</em> Cursors must always be closed to prevent resource leaks 122 which could lead to the index becoming unusable or cause an 123 <code>OutOfMemoryError</code>. To ensure that a cursor is closed in the 124 face of exceptions, call <A HREF="../../../com/sleepycat/persist/EntityCursor.html#close()"><CODE>close()</CODE></A> in a finally block. For example, 125 the following code traverses all Employee entities and closes the cursor 126 whether or not an exception occurs:</p> 127 128 <pre class="code"> 129 @Entity 130 class Employee { 131 132 @PrimaryKey 133 long id; 134 135 @SecondaryKey(relate=MANY_TO_ONE) 136 String department; 137 138 String name; 139 140 private Employee() {} 141 } 142 143 EntityStore store = ... 144 145 <code>PrimaryIndex<Long,Employee></code> primaryIndex = 146 store.getPrimaryIndex(Long.class, Employee.class); 147 148 <code>EntityCursor<Employee></code> cursor = primaryIndex.entities(); 149 try { 150 for (Employee entity = cursor.first(); 151 entity != null; 152 entity = cursor.next()) { 153 // Do something with the entity... 154 } 155 } finally { 156 cursor.close(); 157 }</pre> 158 159 <h3>Initializing the Cursor Position</h3> 160 161 <p>When it is opened, a cursor is not initially positioned on any value; in 162 other words, it is uninitialized. Most methods in this interface initialize 163 the cursor position but certain methods, for example, <A HREF="../../../com/sleepycat/persist/EntityCursor.html#current()"><CODE>current()</CODE></A> and 164 <A HREF="../../../com/sleepycat/persist/EntityCursor.html#delete()"><CODE>delete()</CODE></A>, throw <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang"><CODE>IllegalStateException</CODE></A> when called for an 165 uninitialized cursor.</p> 166 167 <p>Note that the <A HREF="../../../com/sleepycat/persist/EntityCursor.html#next()"><CODE>next()</CODE></A> and <A HREF="../../../com/sleepycat/persist/EntityCursor.html#prev()"><CODE>prev()</CODE></A> methods return the first or 168 last value respectively for an uninitialized cursor. This allows the loop 169 in the example above to be rewritten as follows:</p> 170 171 <pre class="code"> 172 <code>EntityCursor<Employee></code> cursor = primaryIndex.entities(); 173 try { 174 Employee entity; 175 while ((entity = cursor.next()) != null) { 176 // Do something with the entity... 177 } 178 } finally { 179 cursor.close(); 180 }</pre> 181 182 <h3>Cursors and Iterators</h3> 183 184 <p>The <A HREF="../../../com/sleepycat/persist/EntityCursor.html#iterator()"><CODE>iterator()</CODE></A> method can be used to return a standard Java <code>Iterator</code> that returns the same values that the cursor returns. For 185 example:</p> 186 187 <pre class="code"> 188 <code>EntityCursor<Employee></code> cursor = primaryIndex.entities(); 189 try { 190 <code>Iterator<Employee></code> i = cursor.iterator(); 191 while (i.hasNext()) { 192 Employee entity = i.next(); 193 // Do something with the entity... 194 } 195 } finally { 196 cursor.close(); 197 }</pre> 198 199 <p>The <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang"><CODE>Iterable</CODE></A> interface is also extended by <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist"><CODE>EntityCursor</CODE></A> 200 to allow using the cursor as the target of a Java "foreach" statement:</p> 201 202 <pre class="code"> 203 <code>EntityCursor<Employee></code> cursor = primaryIndex.entities(); 204 try { 205 for (Employee entity : cursor) { 206 // Do something with the entity... 207 } 208 } finally { 209 cursor.close(); 210 }</pre> 211 212 <p>The iterator uses the cursor directly, so any changes to the cursor 213 position impact the iterator and vice versa. The iterator advances the 214 cursor by calling <A HREF="../../../com/sleepycat/persist/EntityCursor.html#next()"><CODE>next()</CODE></A> when <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html?is-external=true#hasNext()" title="class or interface in java.util"><CODE>Iterator.hasNext()</CODE></A> or <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html?is-external=true#next()" title="class or interface in java.util"><CODE>Iterator.next()</CODE></A> is called. Because of this interaction, to keep things 215 simple it is best not to mix the use of an <code>EntityCursor</code> 216 <code>Iterator</code> with the use of the <code>EntityCursor</code> traversal methods 217 such as <A HREF="../../../com/sleepycat/persist/EntityCursor.html#next()"><CODE>next()</CODE></A>, for a single <code>EntityCursor</code> object.</p> 218 219 <h3>Key Ranges</h3> 220 221 <p>A key range may be specified when opening the cursor, to restrict the 222 key range of the cursor to a subset of the complete range of keys in the 223 index. A <code>fromKey</code> and/or <code>toKey</code> parameter may be specified 224 when calling <A HREF="../../../com/sleepycat/persist/EntityIndex.html#keys(K, boolean, K, boolean)"><CODE>EntityIndex.keys(Object,boolean,Object,boolean)</CODE></A> or 225 <A HREF="../../../com/sleepycat/persist/EntityIndex.html#entities(K, boolean, K, boolean)"><CODE>EntityIndex.entities(Object,boolean,Object,boolean)</CODE></A>. The key 226 arguments may be specified as inclusive or exclusive values.</p> 227 228 <p>Whenever a cursor with a key range is moved, the key range bounds will be 229 checked, and the cursor will never be positioned outside the range. The 230 <A HREF="../../../com/sleepycat/persist/EntityCursor.html#first()"><CODE>first()</CODE></A> cursor value is the first existing value in the range, and 231 the <A HREF="../../../com/sleepycat/persist/EntityCursor.html#last()"><CODE>last()</CODE></A> cursor value is the last existing value in the range. For 232 example, the following code traverses Employee entities with keys from 100 233 (inclusive) to 200 (exclusive):</p> 234 235 <pre class="code"> 236 <code>EntityCursor<Employee></code> cursor = primaryIndex.entities(100, true, 200, false); 237 try { 238 for (Employee entity : cursor) { 239 // Do something with the entity... 240 } 241 } finally { 242 cursor.close(); 243 }</pre> 244 245 <h3>Duplicate Keys</h3> 246 247 <p>When using a cursor for a <A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="class in com.sleepycat.persist"><CODE>SecondaryIndex</CODE></A>, the keys in the index 248 may be non-unique (duplicates) if <A HREF="../../../com/sleepycat/persist/model/SecondaryKey.html#relate()"><CODE>SecondaryKey.relate()</CODE></A> is <A HREF="../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_ONE"><CODE>MANY_TO_ONE</CODE></A> or <A HREF="../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_MANY"><CODE>MANY_TO_MANY</CODE></A>. For example, a <code>MANY_TO_ONE</code> <code>Employee.department</code> secondary key is non-unique because there are multiple 249 Employee entities with the same department key value. The <A HREF="../../../com/sleepycat/persist/EntityCursor.html#nextDup()"><CODE>nextDup()</CODE></A>, 250 <A HREF="../../../com/sleepycat/persist/EntityCursor.html#prevDup()"><CODE>prevDup()</CODE></A>, <A HREF="../../../com/sleepycat/persist/EntityCursor.html#nextNoDup()"><CODE>nextNoDup()</CODE></A> and <A HREF="../../../com/sleepycat/persist/EntityCursor.html#prevNoDup()"><CODE>prevNoDup()</CODE></A> methods may be 251 used to control how non-unique keys are returned by the cursor.</p> 252 253 <p><A HREF="../../../com/sleepycat/persist/EntityCursor.html#nextDup()"><CODE>nextDup()</CODE></A> and <A HREF="../../../com/sleepycat/persist/EntityCursor.html#prevDup()"><CODE>prevDup()</CODE></A> return the next or previous value 254 only if it has the same key as the current value, and null is returned when 255 a different key is encountered. For example, these methods can be used to 256 return all employees in a given department.</p> 257 258 <p><A HREF="../../../com/sleepycat/persist/EntityCursor.html#nextNoDup()"><CODE>nextNoDup()</CODE></A> and <A HREF="../../../com/sleepycat/persist/EntityCursor.html#prevNoDup()"><CODE>prevNoDup()</CODE></A> return the next or previous 259 value with a unique key, skipping over values that have the same key. For 260 example, these methods can be used to return the first employee in each 261 department.</p> 262 263 <p>For example, the following code will find the first employee in each 264 department with <A HREF="../../../com/sleepycat/persist/EntityCursor.html#nextNoDup()"><CODE>nextNoDup()</CODE></A> until it finds a department name that 265 matches a particular regular expression. For each matching department it 266 will find all employees in that department using <A HREF="../../../com/sleepycat/persist/EntityCursor.html#nextDup()"><CODE>nextDup()</CODE></A>.</p> 267 268 <pre class="code"> 269 <code>SecondaryIndex<String,Long,Employee></code> secondaryIndex = 270 store.getSecondaryIndex(primaryIndex, String.class, "department"); 271 272 String regex = ...; 273 <code>EntityCursor<Employee></code> cursor = secondaryIndex.entities(); 274 try { 275 for (Employee entity = cursor.first(); 276 entity != null; 277 entity = cursor.nextNoDup()) { 278 if (entity.department.matches(regex)) { 279 while (entity != null) { 280 // Do something with the matching entities... 281 entity = cursor.nextDup(); 282 } 283 } 284 } 285 } finally { 286 cursor.close(); 287 }</pre> 288 289 <h3>Updating and Deleting Entities with a Cursor</h3> 290 291 <p>The <A HREF="../../../com/sleepycat/persist/EntityCursor.html#update(V)"><CODE>update(V)</CODE></A> and <A HREF="../../../com/sleepycat/persist/EntityCursor.html#delete()"><CODE>delete()</CODE></A> methods operate on the entity at 292 the current cursor position. Cursors on any type of index may be used to 293 delete entities. For example, the following code deletes all employees in 294 departments which have names that match a particular regular expression:</p> 295 296 <pre class="code"> 297 <code>SecondaryIndex<String,Long,Employee></code> secondaryIndex = 298 store.getSecondaryIndex(primaryIndex, String.class, "department"); 299 300 String regex = ...; 301 <code>EntityCursor<Employee></code> cursor = secondaryIndex.entities(); 302 try { 303 for (Employee entity = cursor.first(); 304 entity != null; 305 entity = cursor.nextNoDup()) { 306 if (entity.department.matches(regex)) { 307 while (entity != null) { 308 cursor.delete(); 309 entity = cursor.nextDup(); 310 } 311 } 312 } 313 } finally { 314 cursor.close(); 315 }</pre> 316 317 <p>Note that the cursor can be moved to the next (or previous) value after 318 deleting the entity at the current position. This is an important property 319 of cursors, since without it you would not be able to easily delete while 320 processing multiple values with a cursor. A cursor positioned on a deleted 321 entity is in a special state. In this state, <A HREF="../../../com/sleepycat/persist/EntityCursor.html#current()"><CODE>current()</CODE></A> will return 322 null, <A HREF="../../../com/sleepycat/persist/EntityCursor.html#delete()"><CODE>delete()</CODE></A> will return false, and <A HREF="../../../com/sleepycat/persist/EntityCursor.html#update(V)"><CODE>update(V)</CODE></A> will return 323 false.</p> 324 325 <p>The <A HREF="../../../com/sleepycat/persist/EntityCursor.html#update(V)"><CODE>update(V)</CODE></A> method is supported only if the value type is an 326 entity class (not a key class) and the underlying index is a <A HREF="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><CODE>PrimaryIndex</CODE></A>; in other words, for a cursor returned by one of the <CODE>BasicIndex.entities()</CODE> methods. For example, the following code changes all 327 employee names to uppercase:</p> 328 329 <pre class="code"> 330 <code>EntityCursor<Employee></code> cursor = primaryIndex.entities(); 331 try { 332 for (Employee entity = cursor.first(); 333 entity != null; 334 entity = cursor.next()) { 335 entity.name = entity.name.toUpperCase(); 336 cursor.update(entity); 337 } 338 } finally { 339 cursor.close(); 340 }</pre> 341<P> 342 343<P> 344<HR> 345 346<P> 347 348<!-- ========== METHOD SUMMARY =========== --> 349 350<A NAME="method_summary"><!-- --></A> 351<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 352<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 353<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 354<B>Method Summary</B></FONT></TH> 355</TR> 356<TR BGCOLOR="white" CLASS="TableRowColor"> 357<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 358<CODE> void</CODE></FONT></TD> 359<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#close()">close</A></B>()</CODE> 360 361<BR> 362 Closes the cursor.</TD> 363</TR> 364<TR BGCOLOR="white" CLASS="TableRowColor"> 365<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 366<CODE> int</CODE></FONT></TD> 367<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#count()">count</A></B>()</CODE> 368 369<BR> 370 Returns the number of values (duplicates) for the key at the cursor 371 position, or returns zero if all values for the key have been deleted, 372 Returns one or zero if the underlying index has unique keys.</TD> 373</TR> 374<TR BGCOLOR="white" CLASS="TableRowColor"> 375<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 376<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> 377<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#current()">current</A></B>()</CODE> 378 379<BR> 380 Returns the value at the cursor position, or null if the value at the 381 cursor position has been deleted.</TD> 382</TR> 383<TR BGCOLOR="white" CLASS="TableRowColor"> 384<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 385<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> 386<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#current(com.sleepycat.db.LockMode)">current</A></B>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> 387 388<BR> 389 Returns the value at the cursor position, or null if the value at the 390 cursor position has been deleted.</TD> 391</TR> 392<TR BGCOLOR="white" CLASS="TableRowColor"> 393<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 394<CODE> boolean</CODE></FONT></TD> 395<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#delete()">delete</A></B>()</CODE> 396 397<BR> 398 Deletes the entity at the cursor position.</TD> 399</TR> 400<TR BGCOLOR="white" CLASS="TableRowColor"> 401<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 402<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</A><<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A>></CODE></FONT></TD> 403<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#dup()">dup</A></B>()</CODE> 404 405<BR> 406 Duplicates the cursor at the cursor position.</TD> 407</TR> 408<TR BGCOLOR="white" CLASS="TableRowColor"> 409<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 410<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> 411<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#first()">first</A></B>()</CODE> 412 413<BR> 414 Moves the cursor to the first value and returns it, or returns null if 415 the cursor range is empty.</TD> 416</TR> 417<TR BGCOLOR="white" CLASS="TableRowColor"> 418<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 419<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> 420<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#first(com.sleepycat.db.LockMode)">first</A></B>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> 421 422<BR> 423 Moves the cursor to the first value and returns it, or returns null if 424 the cursor range is empty.</TD> 425</TR> 426<TR BGCOLOR="white" CLASS="TableRowColor"> 427<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 428<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A>></CODE></FONT></TD> 429<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#iterator()">iterator</A></B>()</CODE> 430 431<BR> 432 Returns an iterator over the key range, starting with the value 433 following the current position or at the first value if the cursor is 434 uninitialized.</TD> 435</TR> 436<TR BGCOLOR="white" CLASS="TableRowColor"> 437<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 438<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A>></CODE></FONT></TD> 439<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#iterator(com.sleepycat.db.LockMode)">iterator</A></B>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> 440 441<BR> 442 Returns an iterator over the key range, starting with the value 443 following the current position or at the first value if the cursor is 444 uninitialized.</TD> 445</TR> 446<TR BGCOLOR="white" CLASS="TableRowColor"> 447<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 448<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> 449<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#last()">last</A></B>()</CODE> 450 451<BR> 452 Moves the cursor to the last value and returns it, or returns null if 453 the cursor range is empty.</TD> 454</TR> 455<TR BGCOLOR="white" CLASS="TableRowColor"> 456<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 457<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> 458<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#last(com.sleepycat.db.LockMode)">last</A></B>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> 459 460<BR> 461 Moves the cursor to the last value and returns it, or returns null if 462 the cursor range is empty.</TD> 463</TR> 464<TR BGCOLOR="white" CLASS="TableRowColor"> 465<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 466<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> 467<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#next()">next</A></B>()</CODE> 468 469<BR> 470 Moves the cursor to the next value and returns it, or returns null 471 if there are no more values in the cursor range.</TD> 472</TR> 473<TR BGCOLOR="white" CLASS="TableRowColor"> 474<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 475<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> 476<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#next(com.sleepycat.db.LockMode)">next</A></B>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> 477 478<BR> 479 Moves the cursor to the next value and returns it, or returns null 480 if there are no more values in the cursor range.</TD> 481</TR> 482<TR BGCOLOR="white" CLASS="TableRowColor"> 483<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 484<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> 485<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#nextDup()">nextDup</A></B>()</CODE> 486 487<BR> 488 Moves the cursor to the next value with the same key (duplicate) and 489 returns it, or returns null if no more values are present for the key at 490 the current position.</TD> 491</TR> 492<TR BGCOLOR="white" CLASS="TableRowColor"> 493<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 494<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> 495<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#nextDup(com.sleepycat.db.LockMode)">nextDup</A></B>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> 496 497<BR> 498 Moves the cursor to the next value with the same key (duplicate) and 499 returns it, or returns null if no more values are present for the key at 500 the current position.</TD> 501</TR> 502<TR BGCOLOR="white" CLASS="TableRowColor"> 503<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 504<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> 505<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#nextNoDup()">nextNoDup</A></B>()</CODE> 506 507<BR> 508 Moves the cursor to the next value with a different key and returns it, 509 or returns null if there are no more unique keys in the cursor range.</TD> 510</TR> 511<TR BGCOLOR="white" CLASS="TableRowColor"> 512<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 513<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> 514<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#nextNoDup(com.sleepycat.db.LockMode)">nextNoDup</A></B>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> 515 516<BR> 517 Moves the cursor to the next value with a different key and returns it, 518 or returns null if there are no more unique keys in the cursor range.</TD> 519</TR> 520<TR BGCOLOR="white" CLASS="TableRowColor"> 521<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 522<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> 523<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#prev()">prev</A></B>()</CODE> 524 525<BR> 526 Moves the cursor to the previous value and returns it, or returns null 527 if there are no preceding values in the cursor range.</TD> 528</TR> 529<TR BGCOLOR="white" CLASS="TableRowColor"> 530<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 531<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> 532<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#prev(com.sleepycat.db.LockMode)">prev</A></B>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> 533 534<BR> 535 Moves the cursor to the previous value and returns it, or returns null 536 if there are no preceding values in the cursor range.</TD> 537</TR> 538<TR BGCOLOR="white" CLASS="TableRowColor"> 539<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 540<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> 541<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#prevDup()">prevDup</A></B>()</CODE> 542 543<BR> 544 Moves the cursor to the previous value with the same key (duplicate) and 545 returns it, or returns null if no preceding values are present for the 546 key at the current position.</TD> 547</TR> 548<TR BGCOLOR="white" CLASS="TableRowColor"> 549<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 550<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> 551<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#prevDup(com.sleepycat.db.LockMode)">prevDup</A></B>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> 552 553<BR> 554 Moves the cursor to the previous value with the same key (duplicate) and 555 returns it, or returns null if no preceding values are present for the 556 key at the current position.</TD> 557</TR> 558<TR BGCOLOR="white" CLASS="TableRowColor"> 559<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 560<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> 561<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#prevNoDup()">prevNoDup</A></B>()</CODE> 562 563<BR> 564 Moves the cursor to the preceding value with a different key and returns 565 it, or returns null if there are no preceding unique keys in the cursor 566 range.</TD> 567</TR> 568<TR BGCOLOR="white" CLASS="TableRowColor"> 569<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 570<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A></CODE></FONT></TD> 571<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#prevNoDup(com.sleepycat.db.LockMode)">prevNoDup</A></B>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> 572 573<BR> 574 Moves the cursor to the preceding value with a different key and returns 575 it, or returns null if there are no preceding unique keys in the cursor 576 range.</TD> 577</TR> 578<TR BGCOLOR="white" CLASS="TableRowColor"> 579<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 580<CODE> boolean</CODE></FONT></TD> 581<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html#update(V)">update</A></B>(<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> entity)</CODE> 582 583<BR> 584 Replaces the entity at the cursor position with the given entity.</TD> 585</TR> 586</TABLE> 587 588<P> 589 590<!-- ============ METHOD DETAIL ========== --> 591 592<A NAME="method_detail"><!-- --></A> 593<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 594<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 595<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 596<B>Method Detail</B></FONT></TH> 597</TR> 598</TABLE> 599 600<A NAME="first()"><!-- --></A><H3> 601first</H3> 602<PRE> 603<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>first</B>() 604 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 605<DL> 606<DD>Moves the cursor to the first value and returns it, or returns null if 607 the cursor range is empty. 608 609 <p><A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A> is used implicitly.</p> 610<P> 611<DD><DL> 612</DL> 613</DD> 614<DD><DL> 615 616<DT><B>Returns:</B><DD>the first value, or null if the cursor range is empty. 617<DT><B>Throws:</B> 618<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 619</DD> 620</DL> 621<HR> 622 623<A NAME="first(com.sleepycat.db.LockMode)"><!-- --></A><H3> 624first</H3> 625<PRE> 626<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>first</B>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode) 627 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 628<DL> 629<DD>Moves the cursor to the first value and returns it, or returns null if 630 the cursor range is empty. 631<P> 632<DD><DL> 633</DL> 634</DD> 635<DD><DL> 636<DT><B>Parameters:</B><DD><CODE>lockMode</CODE> - the lock mode to use for this operation, or null to 637 use <A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A>. 638<DT><B>Returns:</B><DD>the first value, or null if the cursor range is empty. 639<DT><B>Throws:</B> 640<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 641</DD> 642</DL> 643<HR> 644 645<A NAME="last()"><!-- --></A><H3> 646last</H3> 647<PRE> 648<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>last</B>() 649 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 650<DL> 651<DD>Moves the cursor to the last value and returns it, or returns null if 652 the cursor range is empty. 653 654 <p><A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A> is used implicitly.</p> 655<P> 656<DD><DL> 657</DL> 658</DD> 659<DD><DL> 660 661<DT><B>Returns:</B><DD>the last value, or null if the cursor range is empty. 662<DT><B>Throws:</B> 663<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 664</DD> 665</DL> 666<HR> 667 668<A NAME="last(com.sleepycat.db.LockMode)"><!-- --></A><H3> 669last</H3> 670<PRE> 671<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>last</B>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode) 672 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 673<DL> 674<DD>Moves the cursor to the last value and returns it, or returns null if 675 the cursor range is empty. 676<P> 677<DD><DL> 678</DL> 679</DD> 680<DD><DL> 681<DT><B>Parameters:</B><DD><CODE>lockMode</CODE> - the lock mode to use for this operation, or null to 682 use <A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A>. 683<DT><B>Returns:</B><DD>the last value, or null if the cursor range is empty. 684<DT><B>Throws:</B> 685<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 686</DD> 687</DL> 688<HR> 689 690<A NAME="next()"><!-- --></A><H3> 691next</H3> 692<PRE> 693<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>next</B>() 694 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 695<DL> 696<DD>Moves the cursor to the next value and returns it, or returns null 697 if there are no more values in the cursor range. If the cursor is 698 uninitialized, this method is equivalent to <A HREF="../../../com/sleepycat/persist/EntityCursor.html#first()"><CODE>first()</CODE></A>. 699 700 <p><A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A> is used implicitly.</p> 701<P> 702<DD><DL> 703<DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/sleepycat/persist/ForwardCursor.html#next()">next</A></CODE> in interface <CODE><A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</A><<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A>></CODE></DL> 704</DD> 705<DD><DL> 706 707<DT><B>Returns:</B><DD>the next value, or null if there are no more values in the 708 cursor range. 709<DT><B>Throws:</B> 710<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 711</DD> 712</DL> 713<HR> 714 715<A NAME="next(com.sleepycat.db.LockMode)"><!-- --></A><H3> 716next</H3> 717<PRE> 718<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>next</B>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode) 719 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 720<DL> 721<DD>Moves the cursor to the next value and returns it, or returns null 722 if there are no more values in the cursor range. If the cursor is 723 uninitialized, this method is equivalent to <A HREF="../../../com/sleepycat/persist/EntityCursor.html#first()"><CODE>first()</CODE></A>. 724<P> 725<DD><DL> 726<DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/sleepycat/persist/ForwardCursor.html#next(com.sleepycat.db.LockMode)">next</A></CODE> in interface <CODE><A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</A><<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A>></CODE></DL> 727</DD> 728<DD><DL> 729<DT><B>Parameters:</B><DD><CODE>lockMode</CODE> - the lock mode to use for this operation, or null to 730 use <A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A>. 731<DT><B>Returns:</B><DD>the next value, or null if there are no more values in the 732 cursor range. 733<DT><B>Throws:</B> 734<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 735</DD> 736</DL> 737<HR> 738 739<A NAME="nextDup()"><!-- --></A><H3> 740nextDup</H3> 741<PRE> 742<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>nextDup</B>() 743 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 744<DL> 745<DD>Moves the cursor to the next value with the same key (duplicate) and 746 returns it, or returns null if no more values are present for the key at 747 the current position. 748 749 <p><A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A> is used implicitly.</p> 750<P> 751<DD><DL> 752</DL> 753</DD> 754<DD><DL> 755 756<DT><B>Returns:</B><DD>the next value with the same key, or null if no more values are 757 present for the key at the current position. 758<DT><B>Throws:</B> 759<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the cursor is uninitialized. 760<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 761</DD> 762</DL> 763<HR> 764 765<A NAME="nextDup(com.sleepycat.db.LockMode)"><!-- --></A><H3> 766nextDup</H3> 767<PRE> 768<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>nextDup</B>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode) 769 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 770<DL> 771<DD>Moves the cursor to the next value with the same key (duplicate) and 772 returns it, or returns null if no more values are present for the key at 773 the current position. 774<P> 775<DD><DL> 776</DL> 777</DD> 778<DD><DL> 779<DT><B>Parameters:</B><DD><CODE>lockMode</CODE> - the lock mode to use for this operation, or null to 780 use <A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A>. 781<DT><B>Returns:</B><DD>the next value with the same key, or null if no more values are 782 present for the key at the current position. 783<DT><B>Throws:</B> 784<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the cursor is uninitialized. 785<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 786</DD> 787</DL> 788<HR> 789 790<A NAME="nextNoDup()"><!-- --></A><H3> 791nextNoDup</H3> 792<PRE> 793<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>nextNoDup</B>() 794 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 795<DL> 796<DD>Moves the cursor to the next value with a different key and returns it, 797 or returns null if there are no more unique keys in the cursor range. 798 If the cursor is uninitialized, this method is equivalent to <A HREF="../../../com/sleepycat/persist/EntityCursor.html#first()"><CODE>first()</CODE></A>. 799 800 <p><A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A> is used implicitly.</p> 801<P> 802<DD><DL> 803</DL> 804</DD> 805<DD><DL> 806 807<DT><B>Returns:</B><DD>the next value with a different key, or null if there are no 808 more unique keys in the cursor range. 809<DT><B>Throws:</B> 810<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 811</DD> 812</DL> 813<HR> 814 815<A NAME="nextNoDup(com.sleepycat.db.LockMode)"><!-- --></A><H3> 816nextNoDup</H3> 817<PRE> 818<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>nextNoDup</B>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode) 819 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 820<DL> 821<DD>Moves the cursor to the next value with a different key and returns it, 822 or returns null if there are no more unique keys in the cursor range. 823 If the cursor is uninitialized, this method is equivalent to <A HREF="../../../com/sleepycat/persist/EntityCursor.html#first()"><CODE>first()</CODE></A>. 824<P> 825<DD><DL> 826</DL> 827</DD> 828<DD><DL> 829<DT><B>Parameters:</B><DD><CODE>lockMode</CODE> - the lock mode to use for this operation, or null to 830 use <A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A>. 831<DT><B>Returns:</B><DD>the next value with a different key, or null if there are no 832 more unique keys in the cursor range. 833<DT><B>Throws:</B> 834<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 835</DD> 836</DL> 837<HR> 838 839<A NAME="prev()"><!-- --></A><H3> 840prev</H3> 841<PRE> 842<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>prev</B>() 843 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 844<DL> 845<DD>Moves the cursor to the previous value and returns it, or returns null 846 if there are no preceding values in the cursor range. If the cursor is 847 uninitialized, this method is equivalent to <A HREF="../../../com/sleepycat/persist/EntityCursor.html#last()"><CODE>last()</CODE></A>. 848 849 <p><A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A> is used implicitly.</p> 850<P> 851<DD><DL> 852</DL> 853</DD> 854<DD><DL> 855 856<DT><B>Returns:</B><DD>the previous value, or null if there are no preceding values in 857 the cursor range. 858<DT><B>Throws:</B> 859<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 860</DD> 861</DL> 862<HR> 863 864<A NAME="prev(com.sleepycat.db.LockMode)"><!-- --></A><H3> 865prev</H3> 866<PRE> 867<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>prev</B>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode) 868 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 869<DL> 870<DD>Moves the cursor to the previous value and returns it, or returns null 871 if there are no preceding values in the cursor range. If the cursor is 872 uninitialized, this method is equivalent to <A HREF="../../../com/sleepycat/persist/EntityCursor.html#last()"><CODE>last()</CODE></A>. 873<P> 874<DD><DL> 875</DL> 876</DD> 877<DD><DL> 878<DT><B>Parameters:</B><DD><CODE>lockMode</CODE> - the lock mode to use for this operation, or null to 879 use <A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A>. 880<DT><B>Returns:</B><DD>the previous value, or null if there are no preceding values in 881 the cursor range. 882<DT><B>Throws:</B> 883<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 884</DD> 885</DL> 886<HR> 887 888<A NAME="prevDup()"><!-- --></A><H3> 889prevDup</H3> 890<PRE> 891<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>prevDup</B>() 892 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 893<DL> 894<DD>Moves the cursor to the previous value with the same key (duplicate) and 895 returns it, or returns null if no preceding values are present for the 896 key at the current position. 897 898 <p><A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A> is used implicitly.</p> 899<P> 900<DD><DL> 901</DL> 902</DD> 903<DD><DL> 904 905<DT><B>Returns:</B><DD>the previous value with the same key, or null if no preceding 906 values are present for the key at the current position. 907<DT><B>Throws:</B> 908<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the cursor is uninitialized. 909<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 910</DD> 911</DL> 912<HR> 913 914<A NAME="prevDup(com.sleepycat.db.LockMode)"><!-- --></A><H3> 915prevDup</H3> 916<PRE> 917<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>prevDup</B>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode) 918 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 919<DL> 920<DD>Moves the cursor to the previous value with the same key (duplicate) and 921 returns it, or returns null if no preceding values are present for the 922 key at the current position. 923<P> 924<DD><DL> 925</DL> 926</DD> 927<DD><DL> 928<DT><B>Parameters:</B><DD><CODE>lockMode</CODE> - the lock mode to use for this operation, or null to 929 use <A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A>. 930<DT><B>Returns:</B><DD>the previous value with the same key, or null if no preceding 931 values are present for the key at the current position. 932<DT><B>Throws:</B> 933<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the cursor is uninitialized. 934<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 935</DD> 936</DL> 937<HR> 938 939<A NAME="prevNoDup()"><!-- --></A><H3> 940prevNoDup</H3> 941<PRE> 942<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>prevNoDup</B>() 943 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 944<DL> 945<DD>Moves the cursor to the preceding value with a different key and returns 946 it, or returns null if there are no preceding unique keys in the cursor 947 range. If the cursor is uninitialized, this method is equivalent to 948 <A HREF="../../../com/sleepycat/persist/EntityCursor.html#last()"><CODE>last()</CODE></A>. 949 950 <p><A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A> is used implicitly.</p> 951<P> 952<DD><DL> 953</DL> 954</DD> 955<DD><DL> 956 957<DT><B>Returns:</B><DD>the previous value with a different key, or null if there are no 958 preceding unique keys in the cursor range. 959<DT><B>Throws:</B> 960<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 961</DD> 962</DL> 963<HR> 964 965<A NAME="prevNoDup(com.sleepycat.db.LockMode)"><!-- --></A><H3> 966prevNoDup</H3> 967<PRE> 968<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>prevNoDup</B>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode) 969 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 970<DL> 971<DD>Moves the cursor to the preceding value with a different key and returns 972 it, or returns null if there are no preceding unique keys in the cursor 973 range. If the cursor is uninitialized, this method is equivalent to 974 <A HREF="../../../com/sleepycat/persist/EntityCursor.html#last()"><CODE>last()</CODE></A>. 975<P> 976<DD><DL> 977</DL> 978</DD> 979<DD><DL> 980<DT><B>Parameters:</B><DD><CODE>lockMode</CODE> - the lock mode to use for this operation, or null to 981 use <A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A>. 982<DT><B>Returns:</B><DD>the previous value with a different key, or null if there are no 983 preceding unique keys in the cursor range. 984<DT><B>Throws:</B> 985<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 986</DD> 987</DL> 988<HR> 989 990<A NAME="current()"><!-- --></A><H3> 991current</H3> 992<PRE> 993<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>current</B>() 994 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 995<DL> 996<DD>Returns the value at the cursor position, or null if the value at the 997 cursor position has been deleted. 998 999 <p><A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A> is used implicitly.</p> 1000<P> 1001<DD><DL> 1002</DL> 1003</DD> 1004<DD><DL> 1005 1006<DT><B>Returns:</B><DD>the value at the cursor position, or null if it has been 1007 deleted. 1008<DT><B>Throws:</B> 1009<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the cursor is uninitialized. 1010<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 1011</DD> 1012</DL> 1013<HR> 1014 1015<A NAME="current(com.sleepycat.db.LockMode)"><!-- --></A><H3> 1016current</H3> 1017<PRE> 1018<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> <B>current</B>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode) 1019 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1020<DL> 1021<DD>Returns the value at the cursor position, or null if the value at the 1022 cursor position has been deleted. 1023<P> 1024<DD><DL> 1025</DL> 1026</DD> 1027<DD><DL> 1028<DT><B>Parameters:</B><DD><CODE>lockMode</CODE> - the lock mode to use for this operation, or null to 1029 use <A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A>. 1030<DT><B>Returns:</B><DD>the value at the cursor position, or null if it has been 1031 deleted. 1032<DT><B>Throws:</B> 1033<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the cursor is uninitialized. 1034<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 1035</DD> 1036</DL> 1037<HR> 1038 1039<A NAME="count()"><!-- --></A><H3> 1040count</H3> 1041<PRE> 1042int <B>count</B>() 1043 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1044<DL> 1045<DD>Returns the number of values (duplicates) for the key at the cursor 1046 position, or returns zero if all values for the key have been deleted, 1047 Returns one or zero if the underlying index has unique keys. 1048 1049 <p><A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A> is used implicitly.</p> 1050<P> 1051<DD><DL> 1052</DL> 1053</DD> 1054<DD><DL> 1055 1056<DT><B>Returns:</B><DD>the number of duplicates, or zero if all values for the current 1057 key have been deleted. 1058<DT><B>Throws:</B> 1059<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the cursor is uninitialized. 1060<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 1061</DD> 1062</DL> 1063<HR> 1064 1065<A NAME="iterator()"><!-- --></A><H3> 1066iterator</H3> 1067<PRE> 1068<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A>> <B>iterator</B>()</PRE> 1069<DL> 1070<DD>Returns an iterator over the key range, starting with the value 1071 following the current position or at the first value if the cursor is 1072 uninitialized. 1073 1074 <p><A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A> is used implicitly.</p> 1075<P> 1076<DD><DL> 1077<DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/sleepycat/persist/ForwardCursor.html#iterator()">iterator</A></CODE> in interface <CODE><A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</A><<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A>></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Iterable.html?is-external=true#iterator()" title="class or interface in java.lang">iterator</A></CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A><<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A>></CODE></DL> 1078</DD> 1079<DD><DL> 1080 1081<DT><B>Returns:</B><DD>the iterator.</DL> 1082</DD> 1083</DL> 1084<HR> 1085 1086<A NAME="iterator(com.sleepycat.db.LockMode)"><!-- --></A><H3> 1087iterator</H3> 1088<PRE> 1089<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A>> <B>iterator</B>(<A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</PRE> 1090<DL> 1091<DD>Returns an iterator over the key range, starting with the value 1092 following the current position or at the first value if the cursor is 1093 uninitialized. 1094<P> 1095<DD><DL> 1096<DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/sleepycat/persist/ForwardCursor.html#iterator(com.sleepycat.db.LockMode)">iterator</A></CODE> in interface <CODE><A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</A><<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A>></CODE></DL> 1097</DD> 1098<DD><DL> 1099<DT><B>Parameters:</B><DD><CODE>lockMode</CODE> - the lock mode to use for all operations performed 1100 using the iterator, or null to use <A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A>. 1101<DT><B>Returns:</B><DD>the iterator.</DL> 1102</DD> 1103</DL> 1104<HR> 1105 1106<A NAME="update(java.lang.Object)"><!-- --></A><A NAME="update(V)"><!-- --></A><H3> 1107update</H3> 1108<PRE> 1109boolean <B>update</B>(<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A> entity) 1110 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1111<DL> 1112<DD>Replaces the entity at the cursor position with the given entity. 1113<P> 1114<DD><DL> 1115</DL> 1116</DD> 1117<DD><DL> 1118<DT><B>Parameters:</B><DD><CODE>entity</CODE> - the entity to replace the entity at the current position. 1119<DT><B>Returns:</B><DD>true if successful or false if the entity at the current 1120 position was previously deleted. 1121<DT><B>Throws:</B> 1122<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the cursor is uninitialized. 1123<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - if the index is read only or if 1124 the value type is not an entity type. 1125<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 1126</DD> 1127</DL> 1128<HR> 1129 1130<A NAME="delete()"><!-- --></A><H3> 1131delete</H3> 1132<PRE> 1133boolean <B>delete</B>() 1134 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1135<DL> 1136<DD>Deletes the entity at the cursor position. 1137<P> 1138<DD><DL> 1139</DL> 1140</DD> 1141<DD><DL> 1142 1143<DT><B>Returns:</B><DD>true if successful or false if the entity at the current 1144 position has been deleted. 1145<DT><B>Throws:</B> 1146<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the cursor is uninitialized. 1147<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - if the index is read only. 1148<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 1149</DD> 1150</DL> 1151<HR> 1152 1153<A NAME="dup()"><!-- --></A><H3> 1154dup</H3> 1155<PRE> 1156<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</A><<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A>> <B>dup</B>() 1157 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1158<DL> 1159<DD>Duplicates the cursor at the cursor position. The returned cursor will 1160 be initially positioned at the same position as this current cursor, and 1161 will inherit this cursor's <A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db"><CODE>Transaction</CODE></A> and <A HREF="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db"><CODE>CursorConfig</CODE></A>. 1162<P> 1163<DD><DL> 1164</DL> 1165</DD> 1166<DD><DL> 1167 1168<DT><B>Returns:</B><DD>the duplicated cursor. 1169<DT><B>Throws:</B> 1170<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 1171</DD> 1172</DL> 1173<HR> 1174 1175<A NAME="close()"><!-- --></A><H3> 1176close</H3> 1177<PRE> 1178void <B>close</B>() 1179 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1180<DL> 1181<DD>Closes the cursor. 1182<P> 1183<DD><DL> 1184<DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/sleepycat/persist/ForwardCursor.html#close()">close</A></CODE> in interface <CODE><A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</A><<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="type parameter in EntityCursor">V</A>></CODE></DL> 1185</DD> 1186<DD><DL> 1187 1188<DT><B>Throws:</B> 1189<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 1190</DD> 1191</DL> 1192<!-- ========= END OF CLASS DATA ========= --> 1193<HR> 1194 1195 1196<!-- ======= START OF BOTTOM NAVBAR ====== --> 1197<A NAME="navbar_bottom"><!-- --></A> 1198<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 1199<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 1200<TR> 1201<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 1202<A NAME="navbar_bottom_firstrow"><!-- --></A> 1203<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 1204 <TR ALIGN="center" VALIGN="top"> 1205 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 1206 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 1207 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 1208 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/EntityCursor.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 1209 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 1210 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 1211 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 1212 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 1213 </TR> 1214</TABLE> 1215</TD> 1216<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 1217<b>Berkeley DB</b><br><font size="-1"> version 4.8.30</font></EM> 1218</TD> 1219</TR> 1220 1221<TR> 1222<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 1223 <A HREF="../../../com/sleepycat/persist/DatabaseNamer.html" title="interface in com.sleepycat.persist"><B>PREV CLASS</B></A> 1224 <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist"><B>NEXT CLASS</B></A></FONT></TD> 1225<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 1226 <A HREF="../../../index.html?com/sleepycat/persist/EntityCursor.html" target="_top"><B>FRAMES</B></A> 1227 <A HREF="EntityCursor.html" target="_top"><B>NO FRAMES</B></A> 1228 <SCRIPT type="text/javascript"> 1229 <!-- 1230 if(window==top) { 1231 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); 1232 } 1233 //--> 1234</SCRIPT> 1235<NOSCRIPT> 1236 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> 1237</NOSCRIPT> 1238 1239 1240</FONT></TD> 1241</TR> 1242<TR> 1243<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 1244 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 1245<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 1246DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 1247</TR> 1248</TABLE> 1249<A NAME="skip-navbar_bottom"></A> 1250<!-- ======== END OF BOTTOM NAVBAR ======= --> 1251 1252<HR> 1253<font size=1>Copyright (c) 1996-2009 Oracle. All rights reserved.</font> 1254</BODY> 1255</HTML> 1256