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.5.0) on Thu May 15 17:17:32 EDT 2008 --> 6<TITLE> 7Sequence (Oracle - Berkeley DB Java API) 8</TITLE> 9 10<META NAME="keywords" CONTENT="com.sleepycat.db.Sequence class"> 11 12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../style.css" TITLE="Style"> 13 14<SCRIPT type="text/javascript"> 15function windowTitle() 16{ 17 parent.document.title="Sequence (Oracle - Berkeley DB Java API)"; 18} 19</SCRIPT> 20<NOSCRIPT> 21</NOSCRIPT> 22 23</HEAD> 24 25<BODY BGCOLOR="white" onload="windowTitle();"> 26 27 28<!-- ========= START OF TOP NAVBAR ======= --> 29<A NAME="navbar_top"><!-- --></A> 30<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 31<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 32<TR> 33<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 34<A NAME="navbar_top_firstrow"><!-- --></A> 35<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 36 <TR ALIGN="center" VALIGN="top"> 37 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 39 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Sequence.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 45 </TR> 46</TABLE> 47</TD> 48<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 49<b>Berkeley DB</b><br><font size="-1"> version 4.7.25</font></EM> 50</TD> 51</TR> 52 53<TR> 54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 55 <A HREF="../../../com/sleepycat/db/SecondaryMultiKeyCreator.html" title="interface in com.sleepycat.db"><B>PREV CLASS</B></A> 56 <A HREF="../../../com/sleepycat/db/SequenceConfig.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD> 57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 58 <A HREF="../../../index.html?com/sleepycat/db/Sequence.html" target="_top"><B>FRAMES</B></A> 59 <A HREF="Sequence.html" target="_top"><B>NO FRAMES</B></A> 60 <SCRIPT type="text/javascript"> 61 <!-- 62 if(window==top) { 63 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); 64 } 65 //--> 66</SCRIPT> 67<NOSCRIPT> 68 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> 69</NOSCRIPT> 70 71 72</FONT></TD> 73</TR> 74<TR> 75<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 76 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 77<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 78DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 79</TR> 80</TABLE> 81<A NAME="skip-navbar_top"></A> 82<!-- ========= END OF TOP NAVBAR ========= --> 83 84<HR> 85<!-- ======== START OF CLASS DATA ======== --> 86<H2> 87<FONT SIZE="-1"> 88com.sleepycat.db</FONT> 89<BR> 90Class Sequence</H2> 91<PRE> 92<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A> 93 <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.db.Sequence</B> 94</PRE> 95<HR> 96<DL> 97<DT><PRE>public class <B>Sequence</B><DT>extends <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></DL> 98</PRE> 99 100<P> 101A Sequence handle is used to manipulate a sequence record in a database. 102Sequence handles are opened using the <A HREF="../../../com/sleepycat/db/Database.html#openSequence(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.SequenceConfig)"><CODE>Database.openSequence</CODE></A> method. 103<P> 104 105<P> 106<HR> 107 108<P> 109 110<!-- ========== METHOD SUMMARY =========== --> 111 112<A NAME="method_summary"><!-- --></A> 113<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 114<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 115<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 116<B>Method Summary</B></FONT></TH> 117</TR> 118<TR BGCOLOR="white" CLASS="TableRowColor"> 119<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 120<CODE> void</CODE></FONT></TD> 121<TD><CODE><B><A HREF="../../../com/sleepycat/db/Sequence.html#close()">close</A></B>()</CODE> 122 123<BR> 124 Close a sequence.</TD> 125</TR> 126<TR BGCOLOR="white" CLASS="TableRowColor"> 127<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 128<CODE> long</CODE></FONT></TD> 129<TD><CODE><B><A HREF="../../../com/sleepycat/db/Sequence.html#get(com.sleepycat.db.Transaction, int)">get</A></B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, 130 int delta)</CODE> 131 132<BR> 133 Return the next available element in the sequence and changes the sequence 134 value by <code>delta</code>.</TD> 135</TR> 136<TR BGCOLOR="white" CLASS="TableRowColor"> 137<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 138<CODE> <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A></CODE></FONT></TD> 139<TD><CODE><B><A HREF="../../../com/sleepycat/db/Sequence.html#getDatabase()">getDatabase</A></B>()</CODE> 140 141<BR> 142 Return the Database handle associated with this sequence.</TD> 143</TR> 144<TR BGCOLOR="white" CLASS="TableRowColor"> 145<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 146<CODE> <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A></CODE></FONT></TD> 147<TD><CODE><B><A HREF="../../../com/sleepycat/db/Sequence.html#getKey()">getKey</A></B>()</CODE> 148 149<BR> 150 Return the DatabaseEntry used to open this sequence.</TD> 151</TR> 152<TR BGCOLOR="white" CLASS="TableRowColor"> 153<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 154<CODE> <A HREF="../../../com/sleepycat/db/SequenceStats.html" title="class in com.sleepycat.db">SequenceStats</A></CODE></FONT></TD> 155<TD><CODE><B><A HREF="../../../com/sleepycat/db/Sequence.html#getStats(com.sleepycat.db.StatsConfig)">getStats</A></B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config)</CODE> 156 157<BR> 158 Return statistical information about the sequence.</TD> 159</TR> 160</TABLE> 161 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 162<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 163<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 164<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" title="class or interface in java.lang">Object</A></B></TH> 165</TR> 166<TR BGCOLOR="white" CLASS="TableRowColor"> 167<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#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#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#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#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#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#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#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#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#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#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#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> 168</TR> 169</TABLE> 170 171<P> 172 173<!-- ============ METHOD DETAIL ========== --> 174 175<A NAME="method_detail"><!-- --></A> 176<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 177<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 178<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 179<B>Method Detail</B></FONT></TH> 180</TR> 181</TABLE> 182 183<A NAME="close()"><!-- --></A><H3> 184close</H3> 185<PRE> 186public void <B>close</B>() 187 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 188<DL> 189<DD>Close a sequence. Any unused cached values are lost. 190 <p> 191 The sequence handle may not be used again after this method has been 192 called, regardless of the method's success or failure. 193 <p> 194 <p> 195<P> 196<DD><DL> 197 198<DT><B>Throws:</B> 199<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 200</DD> 201</DL> 202<HR> 203 204<A NAME="get(com.sleepycat.db.Transaction, int)"><!-- --></A><H3> 205get</H3> 206<PRE> 207public long <B>get</B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, 208 int delta) 209 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 210<DL> 211<DD>Return the next available element in the sequence and changes the sequence 212 value by <code>delta</code>. The value of <code>delta</code> must be 213 greater than zero. If there are enough cached values in the sequence 214 handle then they will be returned. Otherwise the next value will be 215 fetched from the database and incremented (decremented) by enough to cover 216 the <code>delta</code> and the next batch of cached values. 217 <p> 218 The <code>txn</code> handle must be null if the sequence handle was opened 219 with a non-zero cache size. 220 <p> 221 For maximum concurrency, a non-zero cache size should be specified prior to 222 opening the sequence handle, the <code>txn</code> handle should be 223 <code>null</code>, and <A HREF="../../../com/sleepycat/db/SequenceConfig.html#setAutoCommitNoSync(boolean)"><CODE>SequenceConfig.setAutoCommitNoSync</CODE></A> should 224 be called to disable log flushes. 225 <p> 226<P> 227<DD><DL> 228<DT><B>Parameters:</B><DD><CODE>txn</CODE> - For a transactional database, an explicit transaction may be specified, or null 229may be specified to use auto-commit. For a non-transactional database, null 230must be specified. 231 <p><DD><CODE>delta</CODE> - the amount by which to increment or decrement the sequence 232 <p> 233<DT><B>Returns:</B><DD>the next available element in the sequence 234<DT><B>Throws:</B> 235<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 236</DD> 237</DL> 238<HR> 239 240<A NAME="getDatabase()"><!-- --></A><H3> 241getDatabase</H3> 242<PRE> 243public <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A> <B>getDatabase</B>() 244 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 245<DL> 246<DD>Return the Database handle associated with this sequence. 247 <p> 248<P> 249<DD><DL> 250 251<DT><B>Returns:</B><DD>The Database handle associated with this sequence. 252<DT><B>Throws:</B> 253<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 254</DD> 255</DL> 256<HR> 257 258<A NAME="getKey()"><!-- --></A><H3> 259getKey</H3> 260<PRE> 261public <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> <B>getKey</B>() 262 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 263<DL> 264<DD>Return the DatabaseEntry used to open this sequence. 265 <p> 266<P> 267<DD><DL> 268 269<DT><B>Returns:</B><DD>The DatabaseEntry used to open this sequence. 270<DT><B>Throws:</B> 271<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 272</DD> 273</DL> 274<HR> 275 276<A NAME="getStats(com.sleepycat.db.StatsConfig)"><!-- --></A><H3> 277getStats</H3> 278<PRE> 279public <A HREF="../../../com/sleepycat/db/SequenceStats.html" title="class in com.sleepycat.db">SequenceStats</A> <B>getStats</B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config) 280 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 281<DL> 282<DD>Return statistical information about the sequence. 283 <p> 284 In the presence of multiple threads or processes accessing an active 285 sequence, the information returned by this method may be out-of-date. 286 <p> 287 The getStats method cannot be transaction-protected. For this reason, it 288 should be called in a thread of control that has no open cursors or active 289 transactions. 290 <p> 291<P> 292<DD><DL> 293<DT><B>Parameters:</B><DD><CODE>config</CODE> - The statistics returned; if null, default statistics are returned. 294 <p> 295<DT><B>Returns:</B><DD>Sequence statistics. 296<DT><B>Throws:</B> 297<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 298</DD> 299</DL> 300<!-- ========= END OF CLASS DATA ========= --> 301<HR> 302 303 304<!-- ======= START OF BOTTOM NAVBAR ====== --> 305<A NAME="navbar_bottom"><!-- --></A> 306<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 307<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 308<TR> 309<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 310<A NAME="navbar_bottom_firstrow"><!-- --></A> 311<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 312 <TR ALIGN="center" VALIGN="top"> 313 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 314 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 315 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 316 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Sequence.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 317 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 318 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 319 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 320 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 321 </TR> 322</TABLE> 323</TD> 324<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 325<b>Berkeley DB</b><br><font size="-1"> version 4.7.25</font></EM> 326</TD> 327</TR> 328 329<TR> 330<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 331 <A HREF="../../../com/sleepycat/db/SecondaryMultiKeyCreator.html" title="interface in com.sleepycat.db"><B>PREV CLASS</B></A> 332 <A HREF="../../../com/sleepycat/db/SequenceConfig.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD> 333<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 334 <A HREF="../../../index.html?com/sleepycat/db/Sequence.html" target="_top"><B>FRAMES</B></A> 335 <A HREF="Sequence.html" target="_top"><B>NO FRAMES</B></A> 336 <SCRIPT type="text/javascript"> 337 <!-- 338 if(window==top) { 339 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); 340 } 341 //--> 342</SCRIPT> 343<NOSCRIPT> 344 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> 345</NOSCRIPT> 346 347 348</FONT></TD> 349</TR> 350<TR> 351<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 352 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 353<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 354DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 355</TR> 356</TABLE> 357<A NAME="skip-navbar_bottom"></A> 358<!-- ======== END OF BOTTOM NAVBAR ======= --> 359 360<HR> 361<font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font> 362</BODY> 363</HTML> 364
