diff options
Diffstat (limited to 'docs/java/com/sleepycat/persist/EntityIndex.html')
| -rw-r--r-- | docs/java/com/sleepycat/persist/EntityIndex.html | 1428 |
1 files changed, 691 insertions, 737 deletions
diff --git a/docs/java/com/sleepycat/persist/EntityIndex.html b/docs/java/com/sleepycat/persist/EntityIndex.html index 78a4fa6f..ff27a7d1 100644 --- a/docs/java/com/sleepycat/persist/EntityIndex.html +++ b/docs/java/com/sleepycat/persist/EntityIndex.html @@ -1,106 +1,100 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<!--NewPage--> -<HTML> -<HEAD> -<!-- Generated by javadoc (build 1.6.0_23) on Fri May 11 14:10:07 EDT 2012 --> -<TITLE> -EntityIndex (Oracle - Berkeley DB Java API) -</TITLE> - -<META NAME="date" CONTENT="2012-05-11"> - -<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../style.css" TITLE="Style"> - -<SCRIPT type="text/javascript"> -function windowTitle() -{ +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_60) on Tue Feb 17 12:25:55 EST 2015 --> +<title>EntityIndex (Oracle - Berkeley DB Java API)</title> +<meta name="date" content="2015-02-17"> +<link rel="stylesheet" type="text/css" href="../../../style.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { parent.document.title="EntityIndex (Oracle - Berkeley DB Java API)"; } -} -</SCRIPT> -<NOSCRIPT> -</NOSCRIPT> - -</HEAD> - -<BODY BGCOLOR="white" onload="windowTitle();"> -<HR> - - +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> <!-- ========= START OF TOP NAVBAR ======= --> -<A NAME="navbar_top"><!-- --></A> -<A HREF="#skip-navbar_top" title="Skip navigation links"></A> -<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> -<TR> -<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> -<A NAME="navbar_top_firstrow"><!-- --></A> -<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> - <TR ALIGN="center" VALIGN="top"> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> - <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/EntityIndex.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> - </TR> -</TABLE> -</TD> -<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> -<b>Berkeley DB</b><br><font size="-1"> version 5.3.21</font></EM> -</TD> -</TR> - -<TR> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist"><B>PREV CLASS</B></A> - <A HREF="../../../com/sleepycat/persist/EntityJoin.html" title="class in com.sleepycat.persist"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../index.html?com/sleepycat/persist/EntityIndex.html" target="_top"><B>FRAMES</B></A> - <A HREF="EntityIndex.html" target="_top"><B>NO FRAMES</B></A> - <SCRIPT type="text/javascript"> - <!-- +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/EntityIndex.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +<div class="aboutLanguage"><em><b>Berkeley DB</b><br><font size="-1"> version 6.1.23</font></em></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/sleepycat/persist/EntityJoin.html" title="class in com.sleepycat.persist"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/sleepycat/persist/EntityIndex.html" target="_top">Frames</a></li> +<li><a href="EntityIndex.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); if(window==top) { - document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; } //--> -</SCRIPT> -<NOSCRIPT> - <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> -</NOSCRIPT> - - -</FONT></TD> -</TR> -<TR> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> - SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_top"></A> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> <!-- ========= END OF TOP NAVBAR ========= --> - -<HR> <!-- ======== START OF CLASS DATA ======== --> -<H2> -<FONT SIZE="-1"> -com.sleepycat.persist</FONT> -<BR> -Interface EntityIndex<K,V></H2> -<DL> -<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist">PrimaryIndex</A>, <A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="class in com.sleepycat.persist">SecondaryIndex</A></DD> -</DL> -<HR> -<DL> -<DT><PRE>public interface <B>EntityIndex<K,V></B></DL> -</PRE> - -<P> -The interface for accessing keys and entities via a primary or secondary +<div class="header"> +<div class="subTitle">com.sleepycat.persist</div> +<h2 title="Interface EntityIndex" class="title">Interface EntityIndex<K,V></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist">PrimaryIndex</a>, <a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="class in com.sleepycat.persist">SecondaryIndex</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">EntityIndex<K,V></span></pre> +<div class="block">The interface for accessing keys and entities via a primary or secondary index. <p><code>EntityIndex</code> objects are thread-safe. Multiple threads may safely @@ -108,25 +102,25 @@ The interface for accessing keys and entities via a primary or secondary <p>An index is conceptually a <em>map</em>. {key:value} mappings are stored in the index and accessed by key. In fact, for interoperability with - other libraries that use the standard Java <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><CODE>Map</CODE></A> or <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util"><CODE>SortedMap</CODE></A> + other libraries that use the standard Java <code>Map</code> or <code>SortedMap</code> interfaces, an <code>EntityIndex</code> may be accessed via these standard - interfaces by calling the <A HREF="../../../com/sleepycat/persist/EntityIndex.html#map()"><CODE>map()</CODE></A> or <A HREF="../../../com/sleepycat/persist/EntityIndex.html#sortedMap()"><CODE>sortedMap()</CODE></A> methods.</p> + interfaces by calling the <a href="../../../com/sleepycat/persist/EntityIndex.html#map()"><code>map()</code></a> or <a href="../../../com/sleepycat/persist/EntityIndex.html#sortedMap()"><code>sortedMap()</code></a> methods.</p> <p><code>EntityIndex</code> is an interface that is implemented by several classes in this package for different purposes. Depending on the context, the key type (K) and value type (V) of the index take on different meanings. The different classes that implement <code>EntityIndex</code> are:</p> <ul> - <li><A HREF="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><CODE>PrimaryIndex</CODE></A> maps primary keys to entities.</li> - <li><A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="class in com.sleepycat.persist"><CODE>SecondaryIndex</CODE></A> maps secondary keys to entities.</li> - <li><A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#keysIndex"><CODE>SecondaryIndex.keysIndex</CODE></A> maps secondary keys to primary + <li><a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><code>PrimaryIndex</code></a> maps primary keys to entities.</li> + <li><a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="class in com.sleepycat.persist"><code>SecondaryIndex</code></a> maps secondary keys to entities.</li> + <li><a href="../../../com/sleepycat/persist/SecondaryIndex.html#keysIndex"><code>SecondaryIndex.keysIndex</code></a> maps secondary keys to primary keys.</li> - <li><A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#subIndex(SK)"><CODE>SecondaryIndex.subIndex(SK)</CODE></A> maps primary keys to entities, for the + <li><a href="../../../com/sleepycat/persist/SecondaryIndex.html#subIndex(SK)"><code>SecondaryIndex.subIndex(SK)</code></a> maps primary keys to entities, for the subset of entities having a specified secondary key.</li> </ul> <p>In all cases, the index key type (K) is a primary or secondary key class. - The index value type (V) is an entity class in all cases except for a <A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#keysIndex"><CODE>SecondaryIndex.keysIndex</CODE></A>, when it is a primary key class.</p> + The index value type (V) is an entity class in all cases except for a <a href="../../../com/sleepycat/persist/SecondaryIndex.html#keysIndex"><code>SecondaryIndex.keysIndex</code></a>, when it is a primary key class.</p> <p>In the following example, a <code>Employee</code> entity with a <code>MANY_TO_ONE</code> secondary key is defined.</p> @@ -156,7 +150,7 @@ The interface for accessing keys and entities via a primary or secondary <tr><td>4</td><td>Sales</td><td>Jim Smith</td></tr> </table></p> - <p><A HREF="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><CODE>PrimaryIndex</CODE></A> maps primary keys to entities:</p> + <p><a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><code>PrimaryIndex</code></a> maps primary keys to entities:</p> <pre class="code"> <code>PrimaryIndex<Long, Employee></code> primaryIndex = @@ -171,7 +165,7 @@ The interface for accessing keys and entities via a primary or secondary <tr><td>4</td><td>4</td><td>Sales</td><td>Jim Smith</td></tr> </table></p> - <p><A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="class in com.sleepycat.persist"><CODE>SecondaryIndex</CODE></A> maps secondary keys to entities:</p> + <p><a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="class in com.sleepycat.persist"><code>SecondaryIndex</code></a> maps secondary keys to entities:</p> <pre class="code"> <code>SecondaryIndex<String, Long, Employee></code> secondaryIndex = @@ -186,7 +180,7 @@ The interface for accessing keys and entities via a primary or secondary <tr><td>Sales</td><td>4</td><td>Sales</td><td>Jim Smith</td></tr> </table></p> - <p><A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#keysIndex"><CODE>SecondaryIndex.keysIndex</CODE></A> maps secondary keys to primary + <p><a href="../../../com/sleepycat/persist/SecondaryIndex.html#keysIndex"><code>SecondaryIndex.keysIndex</code></a> maps secondary keys to primary keys:</p> <pre class="code"> @@ -201,7 +195,7 @@ The interface for accessing keys and entities via a primary or secondary <tr><td>Sales</td><td>4</td></tr> </table></p> - <p><A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#subIndex(SK)"><CODE>SecondaryIndex.subIndex(SK)</CODE></A> maps primary keys to entities, for the + <p><a href="../../../com/sleepycat/persist/SecondaryIndex.html#subIndex(SK)"><code>SecondaryIndex.subIndex(SK)</code></a> maps primary keys to entities, for the subset of entities having a specified secondary key:</p> <pre class="code"> @@ -219,24 +213,24 @@ The interface for accessing keys and entities via a primary or secondary <p>An <code>EntityIndex</code> provides a variety of methods for retrieving entities from an index. It also provides methods for deleting entities. However, it does not provide methods for inserting and updating. To insert - and update entities, use the <A HREF="../../../com/sleepycat/persist/PrimaryIndex.html#put(E)"><CODE>PrimaryIndex.put(E)</CODE></A> family of methods in - the <A HREF="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><CODE>PrimaryIndex</CODE></A> class.</p> + and update entities, use the <a href="../../../com/sleepycat/persist/PrimaryIndex.html#put(E)"><code>PrimaryIndex.put(E)</code></a> family of methods in + the <a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><code>PrimaryIndex</code></a> class.</p> <p>An <code>EntityIndex</code> supports two mechanisms for retrieving entities:</p> <ol> - <li>The <A HREF="../../../com/sleepycat/persist/EntityIndex.html#get(K)"><CODE>get(K)</CODE></A> method returns a single value for a given key. If there + <li>The <a href="../../../com/sleepycat/persist/EntityIndex.html#get(K)"><code>get(K)</code></a> method returns a single value for a given key. If there are multiple values with the same secondary key (duplicates), it returns the first entity in the duplicate set.</li> - <li>An <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist"><CODE>EntityCursor</CODE></A> can be obtained using the <A HREF="../../../com/sleepycat/persist/EntityIndex.html#keys()"><CODE>keys()</CODE></A> and - <A HREF="../../../com/sleepycat/persist/EntityIndex.html#entities()"><CODE>entities()</CODE></A> family of methods. A cursor can be used to return all + <li>An <a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist"><code>EntityCursor</code></a> can be obtained using the <a href="../../../com/sleepycat/persist/EntityIndex.html#keys()"><code>keys()</code></a> and + <a href="../../../com/sleepycat/persist/EntityIndex.html#entities()"><code>entities()</code></a> family of methods. A cursor can be used to return all values in the index, including duplicates. A cursor can also be used to return values within a specified range of keys.</li> </ol> - <p>Using the example entities above, calling <A HREF="../../../com/sleepycat/persist/EntityIndex.html#get(K)"><CODE>get(K)</CODE></A> on the primary + <p>Using the example entities above, calling <a href="../../../com/sleepycat/persist/EntityIndex.html#get(K)"><code>get(K)</code></a> on the primary index will always return the employee with the given ID, or null if no such - ID exists. But calling <A HREF="../../../com/sleepycat/persist/EntityIndex.html#get(K)"><CODE>get(K)</CODE></A> on the secondary index will retrieve + ID exists. But calling <a href="../../../com/sleepycat/persist/EntityIndex.html#get(K)"><code>get(K)</code></a> on the secondary index will retrieve the first employee in the given department, which may not be very useful:</p> @@ -303,7 +297,7 @@ The interface for accessing keys and entities via a primary or secondary <pre class="code"> Employee emp = subIndex.get(2);</pre> - <p>For more information on using cursors and cursor ranges, see <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist"><CODE>EntityCursor</CODE></A>.</p> + <p>For more information on using cursors and cursor ranges, see <a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist"><code>EntityCursor</code></a>.</p> <p>Note that when using an index, keys and values are stored and retrieved by value not by reference. In other words, if an entity object is stored @@ -320,7 +314,7 @@ The interface for accessing keys and entities via a primary or secondary <h3>Deleting from the Index</h3> <p>Any type of index may be used to delete entities with a specified key by - calling <A HREF="../../../com/sleepycat/persist/EntityIndex.html#delete(K)"><CODE>delete(K)</CODE></A>. The important thing to keep in mind is that + calling <a href="../../../com/sleepycat/persist/EntityIndex.html#delete(K)"><code>delete(K)</code></a>. The important thing to keep in mind is that <em>all entities</em> with the specified key are deleted. In a primary index, at most a single entity is deleted:</p> @@ -334,7 +328,7 @@ The interface for accessing keys and entities via a primary or secondary <p>This begs this question: How can a single entity be deleted without knowing its primary key? The answer is to use cursors. After locating an - entity using a cursor, the entity can be deleted by calling <A HREF="../../../com/sleepycat/persist/EntityCursor.html#delete()"><CODE>EntityCursor.delete()</CODE></A>.</p> + entity using a cursor, the entity can be deleted by calling <a href="../../../com/sleepycat/persist/EntityCursor.html#delete()"><code>EntityCursor.delete()</code></a>.</p> <h3>Transactions</h3> @@ -346,9 +340,9 @@ The interface for accessing keys and entities via a primary or secondary href="../../../../gsg_txn/JAVA/index.html">Writing Transactional Applications</a>.</p> - <p>Transactions may be used only with a transactional <A HREF="../../../com/sleepycat/persist/EntityStore.html" title="class in com.sleepycat.persist"><CODE>EntityStore</CODE></A>, - which is one for which <A HREF="../../../com/sleepycat/persist/StoreConfig.html#setTransactional(boolean)"><CODE>StoreConfig.setTransactional(true)</CODE></A> has been called. Likewise, a - transactional store may only be used with a transactional <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A>, which is one for which <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setTransactional(boolean)"><CODE>EnvironmentConfig.setTransactional(true)</CODE></A> + <p>Transactions may be used only with a transactional <a href="../../../com/sleepycat/persist/EntityStore.html" title="class in com.sleepycat.persist"><code>EntityStore</code></a>, + which is one for which <a href="../../../com/sleepycat/persist/StoreConfig.html#setTransactional(boolean)"><code>StoreConfig.setTransactional(true)</code></a> has been called. Likewise, a + transactional store may only be used with a transactional <a href="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><code>Environment</code></a>, which is one for which <a href="../../../com/sleepycat/db/EnvironmentConfig.html#setTransactional(boolean)"><code>EnvironmentConfig.setTransactional(true)</code></a> has been called. For example:</p> <pre class="code"> @@ -362,20 +356,20 @@ The interface for accessing keys and entities via a primary or secondary storeConfig.setAllowCreate(true); EntityStore store = new EntityStore(env, "myStore", storeConfig);</pre> - <p>Transactions are represented by <A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db"><CODE>Transaction</CODE></A> objects, which are - part of the <A HREF="../../../com/sleepycat/db/package-summary.html"><CODE>Base API</CODE></A>. Transactions are created - using the <A HREF="../../../com/sleepycat/db/Environment.html#beginTransaction(com.sleepycat.db.Transaction, com.sleepycat.db.TransactionConfig)"><CODE>Environment.beginTransaction</CODE></A> + <p>Transactions are represented by <a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db"><code>Transaction</code></a> objects, which are + part of the <a href="../../../com/sleepycat/db/package-summary.html"><code>Base API</code></a>. Transactions are created + using the <a href="../../../com/sleepycat/db/Environment.html#beginTransaction(com.sleepycat.db.Transaction,%20com.sleepycat.db.TransactionConfig)"><code>Environment.beginTransaction</code></a> method.</p> <p>A transaction will include all operations for which the transaction object is passed as a method argument. All retrieval, storage and deletion - methods have an optional <A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db"><CODE>Transaction</CODE></A> parameter for this purpose. + methods have an optional <a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db"><code>Transaction</code></a> parameter for this purpose. When a transaction is passed to a method that opens a cursor, all retrieval, storage and deletion operations performed using that cursor will be included in the transaction.</p> - <p>A transaction may be committed by calling <A HREF="../../../com/sleepycat/db/Transaction.html#commit()"><CODE>Transaction.commit()</CODE></A> or - aborted by calling <A HREF="../../../com/sleepycat/db/Transaction.html#abort()"><CODE>Transaction.abort()</CODE></A>. For example, two employees + <p>A transaction may be committed by calling <a href="../../../com/sleepycat/db/Transaction.html#commit()"><code>Transaction.commit()</code></a> or + aborted by calling <a href="../../../com/sleepycat/db/Transaction.html#abort()"><code>Transaction.abort()</code></a>. For example, two employees may be deleted atomically with a transaction; other words, either both are deleted or neither is deleted:</p> @@ -395,7 +389,7 @@ The interface for accessing keys and entities via a primary or secondary <p><em>WARNING:</em> Transactions must always be committed or aborted to prevent resource leaks which could lead to the index becoming unusable or cause an <code>OutOfMemoryError</code>. To ensure that a transaction is - aborted in the face of exceptions, call <A HREF="../../../com/sleepycat/db/Transaction.html#abort()"><CODE>Transaction.abort()</CODE></A> in a + aborted in the face of exceptions, call <a href="../../../com/sleepycat/db/Transaction.html#abort()"><code>Transaction.abort()</code></a> in a finally block.</p> <p>For a transactional store, storage and deletion operations are always @@ -423,8 +417,8 @@ The interface for accessing keys and entities via a primary or secondary <p>For non-transactional and auto-commit usage, overloaded signatures for retrieval, storage and deletion methods are provided to avoid having to pass - a null transaction argument. For example, <A HREF="../../../com/sleepycat/persist/EntityIndex.html#delete(K)"><CODE>delete(K)</CODE></A> may be called - instead of <A HREF="../../../com/sleepycat/persist/EntityIndex.html#delete(com.sleepycat.db.Transaction, K)"><CODE>delete(Transaction,Object)</CODE></A>. For example, the following + a null transaction argument. For example, <a href="../../../com/sleepycat/persist/EntityIndex.html#delete(K)"><code>delete(K)</code></a> may be called + instead of <a href="../../../com/sleepycat/persist/EntityIndex.html#delete(com.sleepycat.db.Transaction,%20K)"><code>delete(Transaction,Object)</code></a>. For example, the following code is equivalent to the code above where null was passed for the transaction:</p> @@ -433,8 +427,8 @@ The interface for accessing keys and entities via a primary or secondary primaryIndex.delete(2);</pre> <p>For retrieval methods the overloaded signatures also include an optional - <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db"><CODE>LockMode</CODE></A> parameter, and overloaded signatures for opening cursors - include an optional <A HREF="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db"><CODE>CursorConfig</CODE></A> parameter. These parameters are + <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db"><code>LockMode</code></a> parameter, and overloaded signatures for opening cursors + include an optional <a href="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db"><code>CursorConfig</code></a> parameter. These parameters are described further below in the Locking and Lock Modes section.</p> <h3>Transactions and Cursors</h3> @@ -444,7 +438,7 @@ The interface for accessing keys and entities via a primary or secondary methods that open a cursor if that cursor will be used to delete or update entities. Cursors do not perform auto-commit when a null transaction is explicitly passed or implied by the method signature. For example, the - following code will throw <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> when the <A HREF="../../../com/sleepycat/persist/EntityCursor.html#delete()"><CODE>EntityCursor.delete()</CODE></A> method is called:</p> + following code will throw <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><code>DatabaseException</code></a> when the <a href="../../../com/sleepycat/persist/EntityCursor.html#delete()"><code>EntityCursor.delete()</code></a> method is called:</p> <pre class="code"> // <strong>Does not work with a transactional store!</strong> @@ -457,7 +451,7 @@ The interface for accessing keys and entities via a primary or secondary cursor.close(); }</pre> - <p>Instead, the <A HREF="../../../com/sleepycat/persist/EntityIndex.html#entities(com.sleepycat.db.Transaction, com.sleepycat.db.CursorConfig)"><CODE>entities(Transaction,CursorConfig)</CODE></A> signature must + <p>Instead, the <a href="../../../com/sleepycat/persist/EntityIndex.html#entities(com.sleepycat.db.Transaction,%20com.sleepycat.db.CursorConfig)"><code>entities(Transaction,CursorConfig)</code></a> signature must be used and a non-null transaction must be passed:</p> <pre class="code"> @@ -525,12 +519,12 @@ The interface for accessing keys and entities via a primary or secondary and cursor stability. However, application performance can sometimes be improved by compromising these guarantees. As described in <a href="../../../../gsg_txn/JAVA/index.html">Writing - Transactional Applications</a>, the <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db"><CODE>LockMode</CODE></A> and <A HREF="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db"><CODE>CursorConfig</CODE></A> parameters are two of the mechanisms that can be used to make + Transactional Applications</a>, the <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db"><code>LockMode</code></a> and <a href="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db"><code>CursorConfig</code></a> parameters are two of the mechanisms that can be used to make compromises.</p> <p>For example, imagine that you need an approximate count of all entities matching certain criterion, and it is acceptable for entities to be changed - by other threads or other transactions while performing this query. <A HREF="../../../com/sleepycat/db/LockMode.html#READ_UNCOMMITTED"><CODE>LockMode.READ_UNCOMMITTED</CODE></A> can be used to perform the retrievals without + by other threads or other transactions while performing this query. <a href="../../../com/sleepycat/db/LockMode.html#READ_UNCOMMITTED"><code>LockMode.READ_UNCOMMITTED</code></a> can be used to perform the retrievals without acquiring any locks. This reduces memory consumption, does less processing, and improves concurrency.</p> @@ -545,12 +539,12 @@ The interface for accessing keys and entities via a primary or secondary cursor.close(); }</pre> - <p>The <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db"><CODE>LockMode</CODE></A> parameter specifies locking behavior on a - per-operation basis. If null or <A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A> is specified, the + <p>The <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db"><code>LockMode</code></a> parameter specifies locking behavior on a + per-operation basis. If null or <a href="../../../com/sleepycat/db/LockMode.html#DEFAULT"><code>LockMode.DEFAULT</code></a> is specified, the default lock mode is used.</p> <p>It is also possible to specify the default locking behavior for a cursor - using <A HREF="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db"><CODE>CursorConfig</CODE></A>. The example below is equivalent to the example + using <a href="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db"><code>CursorConfig</code></a>. The example below is equivalent to the example above:</p> <pre class="code"> @@ -633,658 +627,618 @@ The interface for accessing keys and entities via a primary or secondary <h3>Low Level Access</h3> <p>Each Direct Persistence Layer index is associated with an underlying - <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> or <A HREF="../../../com/sleepycat/db/SecondaryDatabase.html" title="class in com.sleepycat.db"><CODE>SecondaryDatabase</CODE></A> defined in the <A HREF="../../../com/sleepycat/db/package-summary.html"><CODE>Base API</CODE></A>. At this level, an index is a Btree managed by + <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> or <a href="../../../com/sleepycat/db/SecondaryDatabase.html" title="class in com.sleepycat.db"><code>SecondaryDatabase</code></a> defined in the <a href="../../../com/sleepycat/db/package-summary.html"><code>Base API</code></a>. At this level, an index is a Btree managed by the Berkeley DB Java Edition transactional storage engine. Although you may never need to work at the <code>Base API</code> level, keep in mind that some types of performance tuning can be done by configuring the underlying - databases. See the <A HREF="../../../com/sleepycat/persist/EntityStore.html" title="class in com.sleepycat.persist"><CODE>EntityStore</CODE></A> class for more information on + databases. See the <a href="../../../com/sleepycat/persist/EntityStore.html" title="class in com.sleepycat.persist"><code>EntityStore</code></a> class for more information on database and sequence configuration.</p> <p>If you wish to access an index using the <code>Base API</code>, you may call - the <A HREF="../../../com/sleepycat/persist/PrimaryIndex.html#getDatabase()"><CODE>PrimaryIndex.getDatabase()</CODE></A> or <A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#getDatabase()"><CODE>SecondaryIndex.getDatabase()</CODE></A> + the <a href="../../../com/sleepycat/persist/PrimaryIndex.html#getDatabase()"><code>PrimaryIndex.getDatabase()</code></a> or <a href="../../../com/sleepycat/persist/SecondaryIndex.html#getDatabase()"><code>SecondaryIndex.getDatabase()</code></a> method to get the underlying database. To translate between entity or key - objects and <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><CODE>DatabaseEntry</CODE></A> objects at this level, use the bindings - returned by <A HREF="../../../com/sleepycat/persist/PrimaryIndex.html#getEntityBinding()"><CODE>PrimaryIndex.getEntityBinding()</CODE></A>, <A HREF="../../../com/sleepycat/persist/PrimaryIndex.html#getKeyBinding()"><CODE>PrimaryIndex.getKeyBinding()</CODE></A>, and <A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#getKeyBinding()"><CODE>SecondaryIndex.getKeyBinding()</CODE></A>.</p> -<P> - -<P> -<HR> - -<P> - + objects and <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><code>DatabaseEntry</code></a> objects at this level, use the bindings + returned by <a href="../../../com/sleepycat/persist/PrimaryIndex.html#getEntityBinding()"><code>PrimaryIndex.getEntityBinding()</code></a>, <a href="../../../com/sleepycat/persist/PrimaryIndex.html#getKeyBinding()"><code>PrimaryIndex.getKeyBinding()</code></a>, and <a href="../../../com/sleepycat/persist/SecondaryIndex.html#getKeyBinding()"><code>SecondaryIndex.getKeyBinding()</code></a>.</p></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> <!-- ========== METHOD SUMMARY =========== --> - -<A NAME="method_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Method Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityIndex.html#contains(K)">contains</A></B>(<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A> key)</CODE> - -<BR> - Checks for existence of a key in this index.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityIndex.html#contains(com.sleepycat.db.Transaction, K, com.sleepycat.db.LockMode)">contains</A></B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A> key, - <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> - -<BR> - Checks for existence of a key in this index.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> long</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityIndex.html#count()">count</A></B>()</CODE> - -<BR> - Returns a non-transactional count of the entities in this index.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityIndex.html#delete(K)">delete</A></B>(<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A> key)</CODE> - -<BR> - Deletes all entities with a given index key.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityIndex.html#delete(com.sleepycat.db.Transaction, K)">delete</A></B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A> key)</CODE> - -<BR> - Deletes all entities with a given index key.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</A><<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">V</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityIndex.html#entities()">entities</A></B>()</CODE> - -<BR> - Opens a cursor for traversing all entities in this index.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</A><<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">V</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityIndex.html#entities(K, boolean, K, boolean)">entities</A></B>(<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A> fromKey, - boolean fromInclusive, - <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A> toKey, - boolean toInclusive)</CODE> - -<BR> - Opens a cursor for traversing entities in a key range.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</A><<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">V</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityIndex.html#entities(com.sleepycat.db.Transaction, com.sleepycat.db.CursorConfig)">entities</A></B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</A> config)</CODE> - -<BR> - Opens a cursor for traversing all entities in this index.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</A><<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">V</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityIndex.html#entities(com.sleepycat.db.Transaction, K, boolean, K, boolean, com.sleepycat.db.CursorConfig)">entities</A></B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A> fromKey, - boolean fromInclusive, - <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A> toKey, - boolean toInclusive, - <A HREF="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</A> config)</CODE> - -<BR> - Opens a cursor for traversing entities in a key range.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">V</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityIndex.html#get(K)">get</A></B>(<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A> key)</CODE> - -<BR> - Gets an entity via a key of this index.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">V</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityIndex.html#get(com.sleepycat.db.Transaction, K, com.sleepycat.db.LockMode)">get</A></B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A> key, - <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> - -<BR> - Gets an entity via a key of this index.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</A><<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityIndex.html#keys()">keys</A></B>()</CODE> - -<BR> - Opens a cursor for traversing all keys in this index.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</A><<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityIndex.html#keys(K, boolean, K, boolean)">keys</A></B>(<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A> fromKey, - boolean fromInclusive, - <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A> toKey, - boolean toInclusive)</CODE> - -<BR> - Opens a cursor for traversing keys in a key range.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</A><<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityIndex.html#keys(com.sleepycat.db.Transaction, com.sleepycat.db.CursorConfig)">keys</A></B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</A> config)</CODE> - -<BR> - Opens a cursor for traversing all keys in this index.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</A><<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityIndex.html#keys(com.sleepycat.db.Transaction, K, boolean, K, boolean, com.sleepycat.db.CursorConfig)">keys</A></B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A> fromKey, - boolean fromInclusive, - <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A> toKey, - boolean toInclusive, - <A HREF="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</A> config)</CODE> - -<BR> - Opens a cursor for traversing keys in a key range.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A>,<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">V</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityIndex.html#map()">map</A></B>()</CODE> - -<BR> - Returns a standard Java map based on this entity index.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</A><<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A>,<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">V</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/EntityIndex.html#sortedMap()">sortedMap</A></B>()</CODE> - -<BR> - Returns a standard Java sorted map based on this entity index.</TD> -</TR> -</TABLE> - -<P> - +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityIndex.html#contains(K)">contains</a></strong>(<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a> key)</code> +<div class="block">Checks for existence of a key in this index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityIndex.html#contains(com.sleepycat.db.Transaction,%20K,%20com.sleepycat.db.LockMode)">contains</a></strong>(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + <a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a> key, + <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code> +<div class="block">Checks for existence of a key in this index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityIndex.html#count()">count</a></strong>()</code> +<div class="block">Returns a non-transactional count of the entities in this index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityIndex.html#delete(K)">delete</a></strong>(<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a> key)</code> +<div class="block">Deletes all entities with a given index key.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityIndex.html#delete(com.sleepycat.db.Transaction,%20K)">delete</a></strong>(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + <a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a> key)</code> +<div class="block">Deletes all entities with a given index key.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">V</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityIndex.html#entities()">entities</a></strong>()</code> +<div class="block">Opens a cursor for traversing all entities in this index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">V</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityIndex.html#entities(K,%20boolean,%20K,%20boolean)">entities</a></strong>(<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a> fromKey, + boolean fromInclusive, + <a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a> toKey, + boolean toInclusive)</code> +<div class="block">Opens a cursor for traversing entities in a key range.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">V</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityIndex.html#entities(com.sleepycat.db.Transaction,%20com.sleepycat.db.CursorConfig)">entities</a></strong>(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + <a href="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</a> config)</code> +<div class="block">Opens a cursor for traversing all entities in this index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">V</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityIndex.html#entities(com.sleepycat.db.Transaction,%20K,%20boolean,%20K,%20boolean,%20com.sleepycat.db.CursorConfig)">entities</a></strong>(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + <a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a> fromKey, + boolean fromInclusive, + <a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a> toKey, + boolean toInclusive, + <a href="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</a> config)</code> +<div class="block">Opens a cursor for traversing entities in a key range.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">V</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityIndex.html#get(K)">get</a></strong>(<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a> key)</code> +<div class="block">Gets an entity via a key of this index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">V</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityIndex.html#get(com.sleepycat.db.Transaction,%20K,%20com.sleepycat.db.LockMode)">get</a></strong>(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + <a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a> key, + <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code> +<div class="block">Gets an entity via a key of this index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityIndex.html#keys()">keys</a></strong>()</code> +<div class="block">Opens a cursor for traversing all keys in this index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityIndex.html#keys(K,%20boolean,%20K,%20boolean)">keys</a></strong>(<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a> fromKey, + boolean fromInclusive, + <a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a> toKey, + boolean toInclusive)</code> +<div class="block">Opens a cursor for traversing keys in a key range.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityIndex.html#keys(com.sleepycat.db.Transaction,%20com.sleepycat.db.CursorConfig)">keys</a></strong>(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + <a href="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</a> config)</code> +<div class="block">Opens a cursor for traversing all keys in this index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityIndex.html#keys(com.sleepycat.db.Transaction,%20K,%20boolean,%20K,%20boolean,%20com.sleepycat.db.CursorConfig)">keys</a></strong>(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + <a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a> fromKey, + boolean fromInclusive, + <a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a> toKey, + boolean toInclusive, + <a href="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</a> config)</code> +<div class="block">Opens a cursor for traversing keys in a key range.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Map<<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a>,<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">V</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityIndex.html#map()">map</a></strong>()</code> +<div class="block">Returns a standard Java map based on this entity index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.SortedMap<<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a>,<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">V</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/EntityIndex.html#sortedMap()">sortedMap</a></strong>()</code> +<div class="block">Returns a standard Java sorted map based on this entity index.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> <!-- ============ METHOD DETAIL ========== --> - -<A NAME="method_detail"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> -<B>Method Detail</B></FONT></TH> -</TR> -</TABLE> - -<A NAME="contains(java.lang.Object)"><!-- --></A><A NAME="contains(K)"><!-- --></A><H3> -contains</H3> -<PRE> -boolean <B>contains</B>(<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A> key) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Checks for existence of a key in this index. - - <p>The operation will not be transaction protected, and <A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A> is used implicitly.</p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>key</CODE> - the key to search for. -<DT><B>Returns:</B><DD>whether the key exists in the index. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="contains(com.sleepycat.db.Transaction,java.lang.Object,com.sleepycat.db.LockMode)"><!-- --></A><A NAME="contains(com.sleepycat.db.Transaction, K, com.sleepycat.db.LockMode)"><!-- --></A><H3> -contains</H3> -<PRE> -boolean <B>contains</B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A> key, - <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Checks for existence of a key in this index. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>txn</CODE> - the transaction used to protect this operation, or null - if the operation should not be transaction protected.<DD><CODE>key</CODE> - the key to search for.<DD><CODE>lockMode</CODE> - the lock mode to use for this operation, or null to - use <A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A>. -<DT><B>Returns:</B><DD>whether the key exists in the index. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="get(java.lang.Object)"><!-- --></A><A NAME="get(K)"><!-- --></A><H3> -get</H3> -<PRE> -<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">V</A> <B>get</B>(<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A> key) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Gets an entity via a key of this index. - - <p>The operation will not be transaction protected, and <A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A> is used implicitly.</p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>key</CODE> - the key to search for. -<DT><B>Returns:</B><DD>the value mapped to the given key, or null if the key is not - present in the index. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="get(com.sleepycat.db.Transaction,java.lang.Object,com.sleepycat.db.LockMode)"><!-- --></A><A NAME="get(com.sleepycat.db.Transaction, K, com.sleepycat.db.LockMode)"><!-- --></A><H3> -get</H3> -<PRE> -<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">V</A> <B>get</B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A> key, - <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Gets an entity via a key of this index. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>txn</CODE> - the transaction used to protect this operation, or null - if the operation should not be transaction protected.<DD><CODE>key</CODE> - the key to search for.<DD><CODE>lockMode</CODE> - the lock mode to use for this operation, or null to - use <A HREF="../../../com/sleepycat/db/LockMode.html#DEFAULT"><CODE>LockMode.DEFAULT</CODE></A>. -<DT><B>Returns:</B><DD>the value mapped to the given key, or null if the key is not - present in the index. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="count()"><!-- --></A><H3> -count</H3> -<PRE> -long <B>count</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Returns a non-transactional count of the entities in this index. +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="contains(java.lang.Object)"> +<!-- --> +</a><a name="contains(K)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>contains</h4> +<pre>boolean contains(<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a> key) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Checks for existence of a key in this index. + + <p>The operation will not be transaction protected, and <a href="../../../com/sleepycat/db/LockMode.html#DEFAULT"><code>LockMode.DEFAULT</code></a> is used implicitly.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key to search for.</dd> +<dt><span class="strong">Returns:</span></dt><dd>whether the key exists in the index.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="contains(com.sleepycat.db.Transaction,java.lang.Object,com.sleepycat.db.LockMode)"> +<!-- --> +</a><a name="contains(com.sleepycat.db.Transaction, K, com.sleepycat.db.LockMode)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>contains</h4> +<pre>boolean contains(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + <a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a> key, + <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Checks for existence of a key in this index.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - the transaction used to protect this operation, or null + if the operation should not be transaction protected.</dd><dd><code>key</code> - the key to search for.</dd><dd><code>lockMode</code> - the lock mode to use for this operation, or null to + use <a href="../../../com/sleepycat/db/LockMode.html#DEFAULT"><code>LockMode.DEFAULT</code></a>.</dd> +<dt><span class="strong">Returns:</span></dt><dd>whether the key exists in the index.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="get(java.lang.Object)"> +<!-- --> +</a><a name="get(K)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre><a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">V</a> get(<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a> key) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Gets an entity via a key of this index. + + <p>The operation will not be transaction protected, and <a href="../../../com/sleepycat/db/LockMode.html#DEFAULT"><code>LockMode.DEFAULT</code></a> is used implicitly.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key to search for.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the value mapped to the given key, or null if the key is not + present in the index.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="get(com.sleepycat.db.Transaction,java.lang.Object,com.sleepycat.db.LockMode)"> +<!-- --> +</a><a name="get(com.sleepycat.db.Transaction, K, com.sleepycat.db.LockMode)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre><a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">V</a> get(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + <a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a> key, + <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Gets an entity via a key of this index.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - the transaction used to protect this operation, or null + if the operation should not be transaction protected.</dd><dd><code>key</code> - the key to search for.</dd><dd><code>lockMode</code> - the lock mode to use for this operation, or null to + use <a href="../../../com/sleepycat/db/LockMode.html#DEFAULT"><code>LockMode.DEFAULT</code></a>.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the value mapped to the given key, or null if the key is not + present in the index.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="count()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>long count() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Returns a non-transactional count of the entities in this index. <p>This operation is faster than obtaining a count by scanning the index manually, and will not perturb the current contents of the cache. However, the count is not guaranteed to be accurate if there are concurrent updates. Note that this method does scan a significant portion of the index and should be considered a fairly expensive - operation.</p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>the number of entities in this index. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="delete(java.lang.Object)"><!-- --></A><A NAME="delete(K)"><!-- --></A><H3> -delete</H3> -<PRE> -boolean <B>delete</B>(<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A> key) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Deletes all entities with a given index key. - - <p>Auto-commit is used implicitly if the store is transactional.</p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>key</CODE> - the key to search for. -<DT><B>Returns:</B><DD>whether any entities were deleted. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="delete(com.sleepycat.db.Transaction,java.lang.Object)"><!-- --></A><A NAME="delete(com.sleepycat.db.Transaction, K)"><!-- --></A><H3> -delete</H3> -<PRE> -boolean <B>delete</B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A> key) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Deletes all entities with a given index key. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>txn</CODE> - the transaction used to protect this operation, null to use - auto-commit, or null if the store is non-transactional.<DD><CODE>key</CODE> - the key to search for. -<DT><B>Returns:</B><DD>whether any entities were deleted. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="keys()"><!-- --></A><H3> -keys</H3> -<PRE> -<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</A><<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A>> <B>keys</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Opens a cursor for traversing all keys in this index. + operation.</p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the number of entities in this index.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="delete(java.lang.Object)"> +<!-- --> +</a><a name="delete(K)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>delete</h4> +<pre>boolean delete(<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a> key) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Deletes all entities with a given index key. + + <p>Auto-commit is used implicitly if the store is transactional.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key to search for.</dd> +<dt><span class="strong">Returns:</span></dt><dd>whether any entities were deleted.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="delete(com.sleepycat.db.Transaction,java.lang.Object)"> +<!-- --> +</a><a name="delete(com.sleepycat.db.Transaction, K)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>delete</h4> +<pre>boolean delete(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + <a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a> key) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Deletes all entities with a given index key.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - the transaction used to protect this operation, null to use + auto-commit, or null if the store is non-transactional.</dd><dd><code>key</code> - the key to search for.</dd> +<dt><span class="strong">Returns:</span></dt><dd>whether any entities were deleted.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="keys()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>keys</h4> +<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a>> keys() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Opens a cursor for traversing all keys in this index. <p>The operations performed with the cursor will not be transaction - protected, and <A HREF="../../../com/sleepycat/db/CursorConfig.html#DEFAULT"><CODE>CursorConfig.DEFAULT</CODE></A> is used implicitly. If the + protected, and <a href="../../../com/sleepycat/db/CursorConfig.html#DEFAULT"><code>CursorConfig.DEFAULT</code></a> is used implicitly. If the store is transactional, the cursor may not be used to update or delete - entities.</p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>the cursor. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="keys(com.sleepycat.db.Transaction, com.sleepycat.db.CursorConfig)"><!-- --></A><H3> -keys</H3> -<PRE> -<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</A><<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A>> <B>keys</B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</A> config) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Opens a cursor for traversing all keys in this index. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>txn</CODE> - the transaction used to protect all operations performed with + entities.</p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the cursor.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="keys(com.sleepycat.db.Transaction, com.sleepycat.db.CursorConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>keys</h4> +<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a>> keys(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + <a href="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</a> config) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Opens a cursor for traversing all keys in this index.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - the transaction used to protect all operations performed with the cursor, or null if the operations should not be transaction protected. If the store is non-transactional, null must be specified. For a transactional store the transaction is optional for read-only - access and required for read-write access.<DD><CODE>config</CODE> - the cursor configuration that determines the default lock - mode used for all cursor operations, or null to implicitly use <A HREF="../../../com/sleepycat/db/CursorConfig.html#DEFAULT"><CODE>CursorConfig.DEFAULT</CODE></A>. -<DT><B>Returns:</B><DD>the cursor. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="entities()"><!-- --></A><H3> -entities</H3> -<PRE> -<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</A><<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">V</A>> <B>entities</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Opens a cursor for traversing all entities in this index. + access and required for read-write access.</dd><dd><code>config</code> - the cursor configuration that determines the default lock + mode used for all cursor operations, or null to implicitly use <a href="../../../com/sleepycat/db/CursorConfig.html#DEFAULT"><code>CursorConfig.DEFAULT</code></a>.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the cursor.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="entities()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>entities</h4> +<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">V</a>> entities() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Opens a cursor for traversing all entities in this index. <p>The operations performed with the cursor will not be transaction - protected, and <A HREF="../../../com/sleepycat/db/CursorConfig.html#DEFAULT"><CODE>CursorConfig.DEFAULT</CODE></A> is used implicitly. If the + protected, and <a href="../../../com/sleepycat/db/CursorConfig.html#DEFAULT"><code>CursorConfig.DEFAULT</code></a> is used implicitly. If the store is transactional, the cursor may not be used to update or delete - entities.</p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>the cursor. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="entities(com.sleepycat.db.Transaction, com.sleepycat.db.CursorConfig)"><!-- --></A><H3> -entities</H3> -<PRE> -<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</A><<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">V</A>> <B>entities</B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</A> config) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Opens a cursor for traversing all entities in this index. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>txn</CODE> - the transaction used to protect all operations performed with + entities.</p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the cursor.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="entities(com.sleepycat.db.Transaction, com.sleepycat.db.CursorConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>entities</h4> +<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">V</a>> entities(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + <a href="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</a> config) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Opens a cursor for traversing all entities in this index.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - the transaction used to protect all operations performed with the cursor, or null if the operations should not be transaction protected. If the store is non-transactional, null must be specified. For a transactional store the transaction is optional for read-only - access and required for read-write access.<DD><CODE>config</CODE> - the cursor configuration that determines the default lock - mode used for all cursor operations, or null to implicitly use <A HREF="../../../com/sleepycat/db/CursorConfig.html#DEFAULT"><CODE>CursorConfig.DEFAULT</CODE></A>. -<DT><B>Returns:</B><DD>the cursor. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="keys(java.lang.Object,boolean,java.lang.Object,boolean)"><!-- --></A><A NAME="keys(K, boolean, K, boolean)"><!-- --></A><H3> -keys</H3> -<PRE> -<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</A><<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A>> <B>keys</B>(<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A> fromKey, - boolean fromInclusive, - <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A> toKey, - boolean toInclusive) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Opens a cursor for traversing keys in a key range. + access and required for read-write access.</dd><dd><code>config</code> - the cursor configuration that determines the default lock + mode used for all cursor operations, or null to implicitly use <a href="../../../com/sleepycat/db/CursorConfig.html#DEFAULT"><code>CursorConfig.DEFAULT</code></a>.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the cursor.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="keys(java.lang.Object,boolean,java.lang.Object,boolean)"> +<!-- --> +</a><a name="keys(K, boolean, K, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>keys</h4> +<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a>> keys(<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a> fromKey, + boolean fromInclusive, + <a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a> toKey, + boolean toInclusive) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Opens a cursor for traversing keys in a key range. <p>The operations performed with the cursor will not be transaction - protected, and <A HREF="../../../com/sleepycat/db/CursorConfig.html#DEFAULT"><CODE>CursorConfig.DEFAULT</CODE></A> is used implicitly. If the + protected, and <a href="../../../com/sleepycat/db/CursorConfig.html#DEFAULT"><code>CursorConfig.DEFAULT</code></a> is used implicitly. If the store is transactional, the cursor may not be used to update or delete - entities.</p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>fromKey</CODE> - is the lower bound of the key range, or null if the range - has no lower bound.<DD><CODE>fromInclusive</CODE> - is true if keys greater than or equal to fromKey + entities.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fromKey</code> - is the lower bound of the key range, or null if the range + has no lower bound.</dd><dd><code>fromInclusive</code> - is true if keys greater than or equal to fromKey should be included in the key range, or false if only keys greater than - fromKey should be included.<DD><CODE>toKey</CODE> - is the upper bound of the key range, or null if the range - has no upper bound.<DD><CODE>toInclusive</CODE> - is true if keys less than or equal to toKey should be + fromKey should be included.</dd><dd><code>toKey</code> - is the upper bound of the key range, or null if the range + has no upper bound.</dd><dd><code>toInclusive</code> - is true if keys less than or equal to toKey should be included in the key range, or false if only keys less than toKey should - be included. -<DT><B>Returns:</B><DD>the cursor. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="keys(com.sleepycat.db.Transaction,java.lang.Object,boolean,java.lang.Object,boolean,com.sleepycat.db.CursorConfig)"><!-- --></A><A NAME="keys(com.sleepycat.db.Transaction, K, boolean, K, boolean, com.sleepycat.db.CursorConfig)"><!-- --></A><H3> -keys</H3> -<PRE> -<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</A><<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A>> <B>keys</B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A> fromKey, - boolean fromInclusive, - <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A> toKey, - boolean toInclusive, - <A HREF="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</A> config) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Opens a cursor for traversing keys in a key range. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>txn</CODE> - the transaction used to protect all operations performed with + be included.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the cursor.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="keys(com.sleepycat.db.Transaction,java.lang.Object,boolean,java.lang.Object,boolean,com.sleepycat.db.CursorConfig)"> +<!-- --> +</a><a name="keys(com.sleepycat.db.Transaction, K, boolean, K, boolean, com.sleepycat.db.CursorConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>keys</h4> +<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a>> keys(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + <a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a> fromKey, + boolean fromInclusive, + <a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a> toKey, + boolean toInclusive, + <a href="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</a> config) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Opens a cursor for traversing keys in a key range.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - the transaction used to protect all operations performed with the cursor, or null if the operations should not be transaction protected. If the store is non-transactional, null must be specified. For a transactional store the transaction is optional for read-only - access and required for read-write access.<DD><CODE>fromKey</CODE> - is the lower bound of the key range, or null if the range - has no lower bound.<DD><CODE>fromInclusive</CODE> - is true if keys greater than or equal to fromKey + access and required for read-write access.</dd><dd><code>fromKey</code> - is the lower bound of the key range, or null if the range + has no lower bound.</dd><dd><code>fromInclusive</code> - is true if keys greater than or equal to fromKey should be included in the key range, or false if only keys greater than - fromKey should be included.<DD><CODE>toKey</CODE> - is the upper bound of the key range, or null if the range - has no upper bound.<DD><CODE>toInclusive</CODE> - is true if keys less than or equal to toKey should be + fromKey should be included.</dd><dd><code>toKey</code> - is the upper bound of the key range, or null if the range + has no upper bound.</dd><dd><code>toInclusive</code> - is true if keys less than or equal to toKey should be included in the key range, or false if only keys less than toKey should - be included.<DD><CODE>config</CODE> - the cursor configuration that determines the default lock - mode used for all cursor operations, or null to implicitly use <A HREF="../../../com/sleepycat/db/CursorConfig.html#DEFAULT"><CODE>CursorConfig.DEFAULT</CODE></A>. -<DT><B>Returns:</B><DD>the cursor. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="entities(java.lang.Object,boolean,java.lang.Object,boolean)"><!-- --></A><A NAME="entities(K, boolean, K, boolean)"><!-- --></A><H3> -entities</H3> -<PRE> -<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</A><<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">V</A>> <B>entities</B>(<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A> fromKey, - boolean fromInclusive, - <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A> toKey, - boolean toInclusive) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Opens a cursor for traversing entities in a key range. + be included.</dd><dd><code>config</code> - the cursor configuration that determines the default lock + mode used for all cursor operations, or null to implicitly use <a href="../../../com/sleepycat/db/CursorConfig.html#DEFAULT"><code>CursorConfig.DEFAULT</code></a>.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the cursor.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="entities(java.lang.Object,boolean,java.lang.Object,boolean)"> +<!-- --> +</a><a name="entities(K, boolean, K, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>entities</h4> +<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">V</a>> entities(<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a> fromKey, + boolean fromInclusive, + <a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a> toKey, + boolean toInclusive) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Opens a cursor for traversing entities in a key range. <p>The operations performed with the cursor will not be transaction - protected, and <A HREF="../../../com/sleepycat/db/CursorConfig.html#DEFAULT"><CODE>CursorConfig.DEFAULT</CODE></A> is used implicitly. If the + protected, and <a href="../../../com/sleepycat/db/CursorConfig.html#DEFAULT"><code>CursorConfig.DEFAULT</code></a> is used implicitly. If the store is transactional, the cursor may not be used to update or delete - entities.</p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>fromKey</CODE> - is the lower bound of the key range, or null if the range - has no lower bound.<DD><CODE>fromInclusive</CODE> - is true if keys greater than or equal to fromKey + entities.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fromKey</code> - is the lower bound of the key range, or null if the range + has no lower bound.</dd><dd><code>fromInclusive</code> - is true if keys greater than or equal to fromKey should be included in the key range, or false if only keys greater than - fromKey should be included.<DD><CODE>toKey</CODE> - is the upper bound of the key range, or null if the range - has no upper bound.<DD><CODE>toInclusive</CODE> - is true if keys less than or equal to toKey should be + fromKey should be included.</dd><dd><code>toKey</code> - is the upper bound of the key range, or null if the range + has no upper bound.</dd><dd><code>toInclusive</code> - is true if keys less than or equal to toKey should be included in the key range, or false if only keys less than toKey should - be included. -<DT><B>Returns:</B><DD>the cursor. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="entities(com.sleepycat.db.Transaction,java.lang.Object,boolean,java.lang.Object,boolean,com.sleepycat.db.CursorConfig)"><!-- --></A><A NAME="entities(com.sleepycat.db.Transaction, K, boolean, K, boolean, com.sleepycat.db.CursorConfig)"><!-- --></A><H3> -entities</H3> -<PRE> -<A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</A><<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">V</A>> <B>entities</B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A> fromKey, - boolean fromInclusive, - <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A> toKey, - boolean toInclusive, - <A HREF="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</A> config) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Opens a cursor for traversing entities in a key range. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>txn</CODE> - the transaction used to protect all operations performed with + be included.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the cursor.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="entities(com.sleepycat.db.Transaction,java.lang.Object,boolean,java.lang.Object,boolean,com.sleepycat.db.CursorConfig)"> +<!-- --> +</a><a name="entities(com.sleepycat.db.Transaction, K, boolean, K, boolean, com.sleepycat.db.CursorConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>entities</h4> +<pre><a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">V</a>> entities(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + <a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a> fromKey, + boolean fromInclusive, + <a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a> toKey, + boolean toInclusive, + <a href="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</a> config) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Opens a cursor for traversing entities in a key range.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - the transaction used to protect all operations performed with the cursor, or null if the operations should not be transaction protected. If the store is non-transactional, null must be specified. For a transactional store the transaction is optional for read-only - access and required for read-write access.<DD><CODE>fromKey</CODE> - is the lower bound of the key range, or null if the range - has no lower bound.<DD><CODE>fromInclusive</CODE> - is true if keys greater than or equal to fromKey + access and required for read-write access.</dd><dd><code>fromKey</code> - is the lower bound of the key range, or null if the range + has no lower bound.</dd><dd><code>fromInclusive</code> - is true if keys greater than or equal to fromKey should be included in the key range, or false if only keys greater than - fromKey should be included.<DD><CODE>toKey</CODE> - is the upper bound of the key range, or null if the range - has no upper bound.<DD><CODE>toInclusive</CODE> - is true if keys less than or equal to toKey should be + fromKey should be included.</dd><dd><code>toKey</code> - is the upper bound of the key range, or null if the range + has no upper bound.</dd><dd><code>toInclusive</code> - is true if keys less than or equal to toKey should be included in the key range, or false if only keys less than toKey should - be included.<DD><CODE>config</CODE> - the cursor configuration that determines the default lock - mode used for all cursor operations, or null to implicitly use <A HREF="../../../com/sleepycat/db/CursorConfig.html#DEFAULT"><CODE>CursorConfig.DEFAULT</CODE></A>. -<DT><B>Returns:</B><DD>the cursor. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - the base class for all BDB exceptions.</DL> -</DD> -</DL> -<HR> - -<A NAME="map()"><!-- --></A><H3> -map</H3> -<PRE> -<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A>,<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">V</A>> <B>map</B>()</PRE> -<DL> -<DD>Returns a standard Java map based on this entity index. The <A HREF="../../../com/sleepycat/collections/StoredMap.html" title="class in com.sleepycat.collections"><CODE>StoredMap</CODE></A> returned is defined by the <A HREF="../../../com/sleepycat/collections/package-summary.html">Collections API</A>. Stored collections conform - to the standard Java collections framework interface. -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>the map.</DL> -</DD> -</DL> -<HR> - -<A NAME="sortedMap()"><!-- --></A><H3> -sortedMap</H3> -<PRE> -<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</A><<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</A>,<A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">V</A>> <B>sortedMap</B>()</PRE> -<DL> -<DD>Returns a standard Java sorted map based on this entity index. The - <A HREF="../../../com/sleepycat/collections/StoredSortedMap.html" title="class in com.sleepycat.collections"><CODE>StoredSortedMap</CODE></A> returned is defined by the <A HREF="../../../com/sleepycat/collections/package-summary.html">Collections API</A>. Stored collections conform - to the standard Java collections framework interface. -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>the map.</DL> -</DD> -</DL> + be included.</dd><dd><code>config</code> - the cursor configuration that determines the default lock + mode used for all cursor operations, or null to implicitly use <a href="../../../com/sleepycat/db/CursorConfig.html#DEFAULT"><code>CursorConfig.DEFAULT</code></a>.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the cursor.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - the base class for all BDB exceptions.</dd></dl> +</li> +</ul> +<a name="map()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>map</h4> +<pre>java.util.Map<<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a>,<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">V</a>> map()</pre> +<div class="block">Returns a standard Java map based on this entity index. The <a href="../../../com/sleepycat/collections/StoredMap.html" title="class in com.sleepycat.collections"><code>StoredMap</code></a> returned is defined by the <a href="../../../com/sleepycat/collections/package-summary.html">Collections API</a>. Stored collections conform + to the standard Java collections framework interface.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the map.</dd></dl> +</li> +</ul> +<a name="sortedMap()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>sortedMap</h4> +<pre>java.util.SortedMap<<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">K</a>,<a href="../../../com/sleepycat/persist/EntityIndex.html" title="type parameter in EntityIndex">V</a>> sortedMap()</pre> +<div class="block">Returns a standard Java sorted map based on this entity index. The + <a href="../../../com/sleepycat/collections/StoredSortedMap.html" title="class in com.sleepycat.collections"><code>StoredSortedMap</code></a> returned is defined by the <a href="../../../com/sleepycat/collections/package-summary.html">Collections API</a>. Stored collections conform + to the standard Java collections framework interface.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the map.</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> <!-- ========= END OF CLASS DATA ========= --> -<HR> - - <!-- ======= START OF BOTTOM NAVBAR ====== --> -<A NAME="navbar_bottom"><!-- --></A> -<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> -<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> -<TR> -<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> -<A NAME="navbar_bottom_firstrow"><!-- --></A> -<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> - <TR ALIGN="center" VALIGN="top"> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> - <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/EntityIndex.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> - </TR> -</TABLE> -</TD> -<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> -<b>Berkeley DB</b><br><font size="-1"> version 5.3.21</font></EM> -</TD> -</TR> - -<TR> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist"><B>PREV CLASS</B></A> - <A HREF="../../../com/sleepycat/persist/EntityJoin.html" title="class in com.sleepycat.persist"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../index.html?com/sleepycat/persist/EntityIndex.html" target="_top"><B>FRAMES</B></A> - <A HREF="EntityIndex.html" target="_top"><B>NO FRAMES</B></A> - <SCRIPT type="text/javascript"> - <!-- +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/EntityIndex.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +<div class="aboutLanguage"><em><b>Berkeley DB</b><br><font size="-1"> version 6.1.23</font></em></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/sleepycat/persist/EntityJoin.html" title="class in com.sleepycat.persist"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/sleepycat/persist/EntityIndex.html" target="_top">Frames</a></li> +<li><a href="EntityIndex.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); if(window==top) { - document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; } //--> -</SCRIPT> -<NOSCRIPT> - <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> -</NOSCRIPT> - - -</FONT></TD> -</TR> -<TR> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> - SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_bottom"></A> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> - -<HR> -<font size=1>Copyright (c) 1996, 2012 Oracle and/or its affiliates. All rights reserved.</font> -</BODY> -</HTML> +<p class="legalCopy"><small><font size=1>Copyright (c) 1996, 2015 Oracle and/or its affiliates. All rights reserved.</font></small></p> +</body> +</html> |