diff options
Diffstat (limited to 'docs/java/com/sleepycat/persist/SecondaryIndex.html')
| -rw-r--r-- | docs/java/com/sleepycat/persist/SecondaryIndex.html | 1952 |
1 files changed, 939 insertions, 1013 deletions
diff --git a/docs/java/com/sleepycat/persist/SecondaryIndex.html b/docs/java/com/sleepycat/persist/SecondaryIndex.html index 5c45b20c..78742379 100644 --- a/docs/java/com/sleepycat/persist/SecondaryIndex.html +++ b/docs/java/com/sleepycat/persist/SecondaryIndex.html @@ -1,119 +1,118 @@ <!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> -SecondaryIndex (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>SecondaryIndex (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="SecondaryIndex (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/SecondaryIndex.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/PrimaryIndex.html" title="class in com.sleepycat.persist"><B>PREV CLASS</B></A> - <A HREF="../../../com/sleepycat/persist/StoreConfig.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/SecondaryIndex.html" target="_top"><B>FRAMES</B></A> - <A HREF="SecondaryIndex.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/SecondaryIndex.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/PrimaryIndex.html" title="class in com.sleepycat.persist"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/sleepycat/persist/StoreConfig.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/SecondaryIndex.html" target="_top">Frames</a></li> +<li><a href="SecondaryIndex.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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> -Class SecondaryIndex<SK,PK,E></H2> -<PRE> -<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> - <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.persist.SecondaryIndex<SK,PK,E></B> -</PRE> -<DL> -<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</A><SK,E></DD> -</DL> -<HR> -<DL> -<DT><PRE>public class <B>SecondaryIndex<SK,PK,E></B><DT>extends <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL> -</PRE> - -<P> -The secondary index for an entity class and a secondary key. +<div class="header"> +<div class="subTitle">com.sleepycat.persist</div> +<h2 title="Class SecondaryIndex" class="title">Class SecondaryIndex<SK,PK,E></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.sleepycat.persist.SecondaryIndex<SK,PK,E></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><SK,E></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">SecondaryIndex<SK,PK,E></span> +extends java.lang.Object</pre> +<div class="block">The secondary index for an entity class and a secondary key. <p><code>SecondaryIndex</code> objects are thread-safe. Multiple threads may safely call the methods of a shared <code>SecondaryIndex</code> object.</p> - <p><code>SecondaryIndex</code> implements <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist"><CODE>EntityIndex</CODE></A> to map the + <p><code>SecondaryIndex</code> implements <a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist"><code>EntityIndex</code></a> to map the secondary key type (SK) to the entity type (E). In other words, entities are accessed by secondary key values.</p> - <p>The <A HREF="../../../com/sleepycat/persist/model/SecondaryKey.html" title="annotation in com.sleepycat.persist.model"><CODE>SecondaryKey</CODE></A> annotation may be used to define a secondary key + <p>The <a href="../../../com/sleepycat/persist/model/SecondaryKey.html" title="annotation in com.sleepycat.persist.model"><code>SecondaryKey</code></a> annotation may be used to define a secondary key as shown in the following example.</p> <pre class="code"> @@ -131,9 +130,9 @@ The secondary index for an entity class and a secondary key. private Employee() {} }</pre> - <p>Before obtaining a <code>SecondaryIndex</code>, the <A HREF="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><CODE>PrimaryIndex</CODE></A> must + <p>Before obtaining a <code>SecondaryIndex</code>, the <a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><code>PrimaryIndex</code></a> must be obtained for the entity class. To obtain the <code>SecondaryIndex</code> call - <A HREF="../../../com/sleepycat/persist/EntityStore.html#getSecondaryIndex(com.sleepycat.persist.PrimaryIndex, java.lang.Class, java.lang.String)"><CODE>EntityStore.getSecondaryIndex</CODE></A>, passing + <a href="../../../com/sleepycat/persist/EntityStore.html#getSecondaryIndex(com.sleepycat.persist.PrimaryIndex,%20java.lang.Class,%20java.lang.String)"><code>EntityStore.getSecondaryIndex</code></a>, passing the primary index, the secondary key class and the secondary key name. For example:</p> @@ -146,16 +145,16 @@ The secondary index for an entity class and a secondary key. <code>SecondaryIndex<String, Long, Employee></code> secondaryIndex = store.getSecondaryIndex(primaryIndex, String.class, "department");</pre> - <p>Since <code>SecondaryIndex</code> implements the <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist"><CODE>EntityIndex</CODE></A> + <p>Since <code>SecondaryIndex</code> implements the <a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist"><code>EntityIndex</code></a> interface, it shares the common index methods for retrieving and deleting - entities, opening cursors and using transactions. See <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist"><CODE>EntityIndex</CODE></A> + entities, opening cursors and using transactions. See <a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist"><code>EntityIndex</code></a> for more information on these topics.</p> <p><code>SecondaryIndex</code> does <em>not</em> provide methods for inserting - and updating entities. That must be done using the <A HREF="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><CODE>PrimaryIndex</CODE></A>.</p> + and updating entities. That must be done using the <a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><code>PrimaryIndex</code></a>.</p> <p>Note that a <code>SecondaryIndex</code> has three type parameters <code><SK, - PK, E></code> or in the example <code><String, Long, Employee></code> while a <A HREF="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><CODE>PrimaryIndex</CODE></A> has only two type parameters <code><PK, E></code> or <code><Long, + PK, E></code> or in the example <code><String, Long, Employee></code> while a <a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><code>PrimaryIndex</code></a> has only two type parameters <code><PK, E></code> or <code><Long, Employee></code>. This is because a <code>SecondaryIndex</code> has an extra level of mapping: It maps from secondary key to primary key, and then from primary key to entity. For example, consider this entity:</p> @@ -165,7 +164,7 @@ The secondary index for an entity class and a secondary key. <tr><td>1</td><td>Engineering</td><td>Jane Smith</td></tr> </table></p> - <p>The <A HREF="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><CODE>PrimaryIndex</CODE></A> maps from id directly to the entity, or from + <p>The <a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><code>PrimaryIndex</code></a> maps from id directly to the entity, or from primary key 1 to the "Jane Smith" entity in the example. The <code>SecondaryIndex</code> maps from department to id, or from secondary key "Engineering" to primary key 1 in the example, and then uses the <code>PrimaryIndex</code> to map from the primary key to the entity.</p> @@ -178,7 +177,7 @@ The secondary index for an entity class and a secondary key. <p>The second mapping provided by <code>SecondaryIndex</code> is from secondary key (SK) to primary key (PK), or in the example, from the String department - key to the Long id key. The <A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#keysIndex"><CODE>keysIndex</CODE></A> method provides this + key to the Long id key. The <a href="../../../com/sleepycat/persist/SecondaryIndex.html#keysIndex"><code>keysIndex</code></a> method provides this mapping. When accessing the keys index, the primary key is returned rather than the entity. When only the primary key is needed and not the entire entity, using the keys index is less expensive than using the secondary @@ -186,13 +185,13 @@ The secondary index for an entity class and a secondary key. <p>The third mapping provided by <code>SecondaryIndex</code> is from primary key (PK) to entity (E), for the subset of entities having a given secondary key - (SK). This mapping is provided by the <A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#subIndex(SK)"><CODE>subIndex(SK)</CODE></A> method. A + (SK). This mapping is provided by the <a href="../../../com/sleepycat/persist/SecondaryIndex.html#subIndex(SK)"><code>subIndex(SK)</code></a> method. A sub-index is convenient when you are interested in working with the subset of entities having a particular secondary key value, for example, all employees in a given department.</p> - <p>All three mappings, along with the mapping provided by the <A HREF="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><CODE>PrimaryIndex</CODE></A>, are shown using example data in the <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist"><CODE>EntityIndex</CODE></A> - interface documentation. See <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist"><CODE>EntityIndex</CODE></A> for more information.</p> + <p>All three mappings, along with the mapping provided by the <a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><code>PrimaryIndex</code></a>, are shown using example data in the <a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist"><code>EntityIndex</code></a> + interface documentation. See <a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist"><code>EntityIndex</code></a> for more information.</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 @@ -208,7 +207,7 @@ The secondary index for an entity class and a secondary key. <h3>One-to-One Relationships</h3> - <p>A <A HREF="../../../com/sleepycat/persist/model/Relationship.html#ONE_TO_ONE"><CODE>ONE_TO_ONE</CODE></A> relationship, although less + <p>A <a href="../../../com/sleepycat/persist/model/Relationship.html#ONE_TO_ONE"><code>ONE_TO_ONE</code></a> relationship, although less common than other types of relationships, is the simplest type of relationship. A single entity is related to a single secondary key value. For example:</p> @@ -231,20 +230,20 @@ The secondary index for an entity class and a secondary key. <code>SecondaryIndex<String, Long, Employee></code> employeeBySsn = store.getSecondaryIndex(primaryIndex, String.class, "ssn");</pre> - <p>With a <A HREF="../../../com/sleepycat/persist/model/Relationship.html#ONE_TO_ONE"><CODE>ONE_TO_ONE</CODE></A> relationship, the + <p>With a <a href="../../../com/sleepycat/persist/model/Relationship.html#ONE_TO_ONE"><code>ONE_TO_ONE</code></a> relationship, the secondary key must be unique; in other words, no two entities may have the same secondary key value. If an attempt is made to store an entity having - the same secondary key value as another existing entity, a <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> will be thrown.</p> + the same secondary key value as another existing entity, a <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><code>DatabaseException</code></a> will be thrown.</p> <p>Because the secondary key is unique, it is useful to lookup entities by - secondary key using <A HREF="../../../com/sleepycat/persist/EntityIndex.html#get(K)"><CODE>EntityIndex.get(K)</CODE></A>. For example:</p> + secondary key using <a href="../../../com/sleepycat/persist/EntityIndex.html#get(K)"><code>EntityIndex.get(K)</code></a>. For example:</p> <pre class="code"> Employee employee = employeeBySsn.get(mySsn);</pre> <h3>Many-to-One Relationships</h3> - <p>A <A HREF="../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_ONE"><CODE>MANY_TO_ONE</CODE></A> relationship is the most + <p>A <a href="../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_ONE"><code>MANY_TO_ONE</code></a> relationship is the most common type of relationship. One or more entities is related to a single secondary key value. For example:</p> @@ -266,7 +265,7 @@ The secondary index for an entity class and a secondary key. <code>SecondaryIndex<String, Long, Employee></code> employeeByDepartment = store.getSecondaryIndex(primaryIndex, String.class, "department");</pre> - <p>With a <A HREF="../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_ONE"><CODE>MANY_TO_ONE</CODE></A> relationship, the + <p>With a <a href="../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_ONE"><code>MANY_TO_ONE</code></a> relationship, the secondary key is not required to be unique; in other words, more than one entity may have the same secondary key value. In this example, more than one employee may belong to the same department.</p> @@ -287,7 +286,7 @@ The secondary index for an entity class and a secondary key. <h3>One-to-Many Relationships</h3> - <p>In a <A HREF="../../../com/sleepycat/persist/model/Relationship.html#ONE_TO_MANY"><CODE>ONE_TO_MANY</CODE></A> relationship, a single + <p>In a <a href="../../../com/sleepycat/persist/model/Relationship.html#ONE_TO_MANY"><code>ONE_TO_MANY</code></a> relationship, a single entity is related to one or more secondary key values. For example:</p> <pre class="code"> @@ -308,19 +307,19 @@ The secondary index for an entity class and a secondary key. <code>SecondaryIndex<String, Long, Employee></code> employeeByEmail = store.getSecondaryIndex(primaryIndex, String.class, "emailAddresses");</pre> - <p>With a <A HREF="../../../com/sleepycat/persist/model/Relationship.html#ONE_TO_MANY"><CODE>ONE_TO_MANY</CODE></A> relationship, the + <p>With a <a href="../../../com/sleepycat/persist/model/Relationship.html#ONE_TO_MANY"><code>ONE_TO_MANY</code></a> relationship, the secondary key must be unique; in other words, no two entities may have the same secondary key value. In this example, no two employees may have the same email address. If an attempt is made to store an entity having the - same secondary key value as another existing entity, a <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> will be thrown.</p> + same secondary key value as another existing entity, a <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><code>DatabaseException</code></a> will be thrown.</p> <p>Because the secondary key is unique, it is useful to lookup entities by - secondary key using <A HREF="../../../com/sleepycat/persist/EntityIndex.html#get(K)"><CODE>EntityIndex.get(K)</CODE></A>. For example:</p> + secondary key using <a href="../../../com/sleepycat/persist/EntityIndex.html#get(K)"><code>EntityIndex.get(K)</code></a>. For example:</p> <pre class="code"> Employee employee = employeeByEmail.get(myEmailAddress);</pre> - <p>The secondary key field for a <A HREF="../../../com/sleepycat/persist/model/Relationship.html#ONE_TO_MANY"><CODE>ONE_TO_MANY</CODE></A> relationship must be an array or collection type. To access + <p>The secondary key field for a <a href="../../../com/sleepycat/persist/model/Relationship.html#ONE_TO_MANY"><code>ONE_TO_MANY</code></a> relationship must be an array or collection type. To access the email addresses of an employee, simply access the collection field directly. For example:</p> @@ -331,7 +330,7 @@ The secondary index for an entity class and a secondary key. <h3>Many-to-Many Relationships</h3> - <p>In a <A HREF="../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_MANY"><CODE>MANY_TO_MANY</CODE></A> relationship, one + <p>In a <a href="../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_MANY"><code>MANY_TO_MANY</code></a> relationship, one or more entities is related to one or more secondary key values. For example:</p> @@ -353,7 +352,7 @@ The secondary index for an entity class and a secondary key. <code>SecondaryIndex<String, Long, Employee></code> employeeByOrganization = store.getSecondaryIndex(primaryIndex, String.class, "organizations");</pre> - <p>With a <A HREF="../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_MANY"><CODE>MANY_TO_MANY</CODE></A> relationship, the + <p>With a <a href="../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_MANY"><code>MANY_TO_MANY</code></a> relationship, the secondary key is not required to be unique; in other words, more than one entity may have the same secondary key value. In this example, more than one employee may belong to the same organization.</p> @@ -372,7 +371,7 @@ The secondary index for an entity class and a secondary key. cursor.close(); }</pre> - <p>The secondary key field for a <A HREF="../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_MANY"><CODE>MANY_TO_MANY</CODE></A> relationship must be an array or collection type. To access + <p>The secondary key field for a <a href="../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_MANY"><code>MANY_TO_MANY</code></a> relationship must be an array or collection type. To access the organizations of an employee, simply access the collection field directly. For example:</p> @@ -445,7 +444,7 @@ The secondary index for an entity class and a secondary key. field as a foreign key that refers to a Department entity. Whenever a Employee entity is stored, its department field value will be checked to ensure that a Department entity exists with that value as its primary key. - If no such Department entity exists, then a <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> is + If no such Department entity exists, then a <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><code>DatabaseException</code></a> is thrown, causing the transaction to be aborted (assuming that transactions are used).</p> @@ -457,15 +456,15 @@ The secondary index for an entity class and a secondary key. department that does not exist.</p> <p>By default, when this situation arises the system does not allow the - department to be deleted. Instead, a <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A> is thrown, + department to be deleted. Instead, a <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><code>DatabaseException</code></a> is thrown, causing the transaction to be aborted. In this case, in order to delete a department, the department field of all Employee entities must first be updated to refer to a different existing department, or set to null. This is the responsibility of the application.</p> <p>There are two additional ways of handling deletion of a Department - entity. These alternatives are configured using the <A HREF="../../../com/sleepycat/persist/model/SecondaryKey.html#onRelatedEntityDelete()"><CODE>SecondaryKey.onRelatedEntityDelete()</CODE></A> annotation property. Setting this - property to <A HREF="../../../com/sleepycat/persist/model/DeleteAction.html#NULLIFY"><CODE>DeleteAction.NULLIFY</CODE></A> causes the Employee department + entity. These alternatives are configured using the <a href="../../../com/sleepycat/persist/model/SecondaryKey.html#onRelatedEntityDelete()"><code>SecondaryKey.onRelatedEntityDelete()</code></a> annotation property. Setting this + property to <a href="../../../com/sleepycat/persist/model/DeleteAction.html#NULLIFY"><code>DeleteAction.NULLIFY</code></a> causes the Employee department field to be automatically set to null when the department they refer to is deleted. This may or may not be desirable, depending on application policies. For example:</p> @@ -486,7 +485,7 @@ The secondary index for an entity class and a secondary key. private Employee() {} }</pre> - <p>The <A HREF="../../../com/sleepycat/persist/model/DeleteAction.html#CASCADE"><CODE>DeleteAction.CASCADE</CODE></A> value, on the other hand, causes the + <p>The <a href="../../../com/sleepycat/persist/model/DeleteAction.html#CASCADE"><code>DeleteAction.CASCADE</code></a> value, on the other hand, causes the Employee entities to be automatically deleted when the department they refer to is deleted. This is probably not desirable in this particular example, but is useful for parent-child relationships. For example:</p> @@ -522,7 +521,7 @@ The secondary index for an entity class and a secondary key. Order entity is deleted, it may be useful to automatically delete its "child" OrderItem entities.</p> - <p>For more information, see <A HREF="../../../com/sleepycat/persist/model/SecondaryKey.html#onRelatedEntityDelete()"><CODE>SecondaryKey.onRelatedEntityDelete()</CODE></A>.</p> + <p>For more information, see <a href="../../../com/sleepycat/persist/model/SecondaryKey.html#onRelatedEntityDelete()"><code>SecondaryKey.onRelatedEntityDelete()</code></a>.</p> <h3>One-to-Many versus Many-to-One for Related Entities</h3> @@ -824,400 +823,342 @@ The secondary index for an entity class and a secondary key. <p>Be aware that the relationship entity approach adds overhead compared to Many-to-Many. There is one additional entity and one additional secondary key. These factors should be weighed against its advantages and the - relevant application access patterns should be considered.</p> -<P> - -<P> -<HR> - -<P> - + relevant application access patterns should be considered.</p></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> <!-- ======== CONSTRUCTOR SUMMARY ======== --> - -<A NAME="constructor_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>Constructor Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#SecondaryIndex(com.sleepycat.db.SecondaryDatabase, com.sleepycat.db.Database, com.sleepycat.persist.PrimaryIndex, java.lang.Class, com.sleepycat.bind.EntryBinding)">SecondaryIndex</A></B>(<A HREF="../../../com/sleepycat/db/SecondaryDatabase.html" title="class in com.sleepycat.db">SecondaryDatabase</A> database, - <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A> keysDatabase, - <A HREF="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist">PrimaryIndex</A><<A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">PK</A>,<A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</A>> primaryIndex, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><<A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</A>> secondaryKeyClass, - <A HREF="../../../com/sleepycat/bind/EntryBinding.html" title="interface in com.sleepycat.bind">EntryBinding</A><<A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</A>> secondaryKeyBinding)</CODE> - -<BR> - Creates a secondary index without using an <code>EntityStore</code>.</TD> -</TR> -</TABLE> - +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#SecondaryIndex(com.sleepycat.db.SecondaryDatabase,%20com.sleepycat.db.Database,%20com.sleepycat.persist.PrimaryIndex,%20java.lang.Class,%20com.sleepycat.bind.EntryBinding)">SecondaryIndex</a></strong>(<a href="../../../com/sleepycat/db/SecondaryDatabase.html" title="class in com.sleepycat.db">SecondaryDatabase</a> database, + <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</a> keysDatabase, + <a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist">PrimaryIndex</a><<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">PK</a>,<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</a>> primaryIndex, + java.lang.Class<<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a>> secondaryKeyClass, + <a href="../../../com/sleepycat/bind/EntryBinding.html" title="interface in com.sleepycat.bind">EntryBinding</a><<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a>> secondaryKeyBinding)</code> +<div class="block">Creates a secondary index without using an <code>EntityStore</code>.</div> +</td> +</tr> +</table> +</li> +</ul> <!-- ========== 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/SecondaryIndex.html#contains(K)">contains</A></B>(K 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/SecondaryIndex.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, - K 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/SecondaryIndex.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/SecondaryIndex.html#delete(K)">delete</A></B>(K 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/SecondaryIndex.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, - K 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><E></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/SecondaryIndex.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><E></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#entities(K, boolean, K, boolean)">entities</A></B>(K fromKey, - boolean fromInclusive, - K 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><E></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/SecondaryIndex.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><E></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/SecondaryIndex.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, - K fromKey, - boolean fromInclusive, - K 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/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#get(SK)">get</A></B>(<A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</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/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#get(com.sleepycat.db.Transaction, SK, 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/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</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/db/SecondaryDatabase.html" title="class in com.sleepycat.db">SecondaryDatabase</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#getDatabase()">getDatabase</A></B>()</CODE> - -<BR> - Returns the underlying secondary database for this index.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/bind/EntryBinding.html" title="interface in com.sleepycat.bind">EntryBinding</A><<A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#getKeyBinding()">getKeyBinding</A></B>()</CODE> - -<BR> - Returns the secondary key binding for the 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/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><<A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#getKeyClass()">getKeyClass</A></B>()</CODE> - -<BR> - Returns the secondary key class for this index.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#getKeysDatabase()">getKeysDatabase</A></B>()</CODE> - -<BR> - Returns the underlying secondary database that is not associated with - the primary database and is used for the <A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#keysIndex"><CODE>keysIndex</CODE></A>.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist">PrimaryIndex</A><<A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">PK</A>,<A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#getPrimaryIndex()">getPrimaryIndex</A></B>()</CODE> - -<BR> - Returns the primary index associated with this secondary 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><K></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/SecondaryIndex.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><K></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#keys(K, boolean, K, boolean)">keys</A></B>(K fromKey, - boolean fromInclusive, - K 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><K></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/SecondaryIndex.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><K></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/SecondaryIndex.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, - K fromKey, - boolean fromInclusive, - K 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="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</A><<A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</A>,<A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">PK</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#keysIndex()">keysIndex</A></B>()</CODE> - -<BR> - Returns a read-only keys index that maps secondary key to primary key.</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/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</A>,<A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/SecondaryIndex.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/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</A>,<A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#sortedMap()">sortedMap</A></B>()</CODE> - -<BR> - Returns a standard Java sorted 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="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</A><<A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">PK</A>,<A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#subIndex(SK)">subIndex</A></B>(<A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</A> key)</CODE> - -<BR> - Returns an index that maps primary key to entity for the subset of - entities having a given secondary key (duplicates).</TD> -</TR> -</TABLE> - <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> -</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/SecondaryIndex.html#contains(K)">contains</a></strong>(K 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/SecondaryIndex.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, + K 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/SecondaryIndex.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/SecondaryIndex.html#delete(K)">delete</a></strong>(K 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/SecondaryIndex.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, + K 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><E></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.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><E></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#entities(K,%20boolean,%20K,%20boolean)">entities</a></strong>(K fromKey, + boolean fromInclusive, + K 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><E></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.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><E></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.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, + K fromKey, + boolean fromInclusive, + K 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/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#get(SK)">get</a></strong>(<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</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/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#get(com.sleepycat.db.Transaction,%20SK,%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/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</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/db/SecondaryDatabase.html" title="class in com.sleepycat.db">SecondaryDatabase</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#getDatabase()">getDatabase</a></strong>()</code> +<div class="block">Returns the underlying secondary database for this index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/bind/EntryBinding.html" title="interface in com.sleepycat.bind">EntryBinding</a><<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#getKeyBinding()">getKeyBinding</a></strong>()</code> +<div class="block">Returns the secondary key binding for the index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#getKeyClass()">getKeyClass</a></strong>()</code> +<div class="block">Returns the secondary key class for this index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#getKeysDatabase()">getKeysDatabase</a></strong>()</code> +<div class="block">Returns the underlying secondary database that is not associated with + the primary database and is used for the <a href="../../../com/sleepycat/persist/SecondaryIndex.html#keysIndex"><code>keysIndex</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist">PrimaryIndex</a><<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">PK</a>,<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#getPrimaryIndex()">getPrimaryIndex</a></strong>()</code> +<div class="block">Returns the primary index associated with this secondary 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><K></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#keys()">keys</a></strong>()</code> +<div class="block">Opens a cursor for traversing all keys in 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><K></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#keys(K,%20boolean,%20K,%20boolean)">keys</a></strong>(K fromKey, + boolean fromInclusive, + K toKey, + boolean toInclusive)</code> +<div class="block">Opens a cursor for traversing keys in a key range.</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><K></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.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="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><K></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.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, + K fromKey, + boolean fromInclusive, + K 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="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a>,<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">PK</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#keysIndex()">keysIndex</a></strong>()</code> +<div class="block">Returns a read-only keys index that maps secondary key to primary key.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Map<<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a>,<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.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/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a>,<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#sortedMap()">sortedMap</a></strong>()</code> +<div class="block">Returns a standard Java sorted map based on this entity index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">PK</a>,<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</a>></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/persist/SecondaryIndex.html#subIndex(SK)">subIndex</a></strong>(<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a> key)</code> +<div class="block">Returns an index that maps primary key to entity for the subset of + entities having a given secondary key (duplicates).</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> <!-- ========= CONSTRUCTOR DETAIL ======== --> - -<A NAME="constructor_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>Constructor Detail</B></FONT></TH> -</TR> -</TABLE> - -<A NAME="SecondaryIndex(com.sleepycat.db.SecondaryDatabase, com.sleepycat.db.Database, com.sleepycat.persist.PrimaryIndex, java.lang.Class, com.sleepycat.bind.EntryBinding)"><!-- --></A><H3> -SecondaryIndex</H3> -<PRE> -public <B>SecondaryIndex</B>(<A HREF="../../../com/sleepycat/db/SecondaryDatabase.html" title="class in com.sleepycat.db">SecondaryDatabase</A> database, - <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A> keysDatabase, - <A HREF="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist">PrimaryIndex</A><<A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">PK</A>,<A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</A>> primaryIndex, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><<A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</A>> secondaryKeyClass, - <A HREF="../../../com/sleepycat/bind/EntryBinding.html" title="interface in com.sleepycat.bind">EntryBinding</A><<A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</A>> secondaryKeyBinding) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Creates a secondary index without using an <code>EntityStore</code>. - When using an <A HREF="../../../com/sleepycat/persist/EntityStore.html" title="class in com.sleepycat.persist"><CODE>EntityStore</CODE></A>, call <A HREF="../../../com/sleepycat/persist/EntityStore.html#getSecondaryIndex(com.sleepycat.persist.PrimaryIndex, java.lang.Class, java.lang.String)"><CODE>getSecondaryIndex</CODE></A> instead. +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="SecondaryIndex(com.sleepycat.db.SecondaryDatabase, com.sleepycat.db.Database, com.sleepycat.persist.PrimaryIndex, java.lang.Class, com.sleepycat.bind.EntryBinding)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SecondaryIndex</h4> +<pre>public SecondaryIndex(<a href="../../../com/sleepycat/db/SecondaryDatabase.html" title="class in com.sleepycat.db">SecondaryDatabase</a> database, + <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</a> keysDatabase, + <a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist">PrimaryIndex</a><<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">PK</a>,<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</a>> primaryIndex, + java.lang.Class<<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a>> secondaryKeyClass, + <a href="../../../com/sleepycat/bind/EntryBinding.html" title="interface in com.sleepycat.bind">EntryBinding</a><<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a>> secondaryKeyBinding) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Creates a secondary index without using an <code>EntityStore</code>. + When using an <a href="../../../com/sleepycat/persist/EntityStore.html" title="class in com.sleepycat.persist"><code>EntityStore</code></a>, call <a href="../../../com/sleepycat/persist/EntityStore.html#getSecondaryIndex(com.sleepycat.persist.PrimaryIndex,%20java.lang.Class,%20java.lang.String)"><code>getSecondaryIndex</code></a> instead. <p>This constructor is not normally needed and is provided for applications that wish to use custom bindings along with the Direct - Persistence Layer. Normally, <A HREF="../../../com/sleepycat/persist/EntityStore.html#getSecondaryIndex(com.sleepycat.persist.PrimaryIndex, java.lang.Class, java.lang.String)"><CODE>getSecondaryIndex</CODE></A> is used instead.</p> -<P> -<DL> -<DT><B>Parameters:</B><DD><CODE>database</CODE> - the secondary database used for all access other than - via a <A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#keysIndex"><CODE>keysIndex</CODE></A>.<DD><CODE>keysDatabase</CODE> - another handle on the secondary database, opened + Persistence Layer. Normally, <a href="../../../com/sleepycat/persist/EntityStore.html#getSecondaryIndex(com.sleepycat.persist.PrimaryIndex,%20java.lang.Class,%20java.lang.String)"><code>getSecondaryIndex</code></a> is used instead.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>database</code> - the secondary database used for all access other than + via a <a href="../../../com/sleepycat/persist/SecondaryIndex.html#keysIndex"><code>keysIndex</code></a>.</dd><dd><code>keysDatabase</code> - another handle on the secondary database, opened without association to the primary, and used only for access via a - <A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#keysIndex"><CODE>keysIndex</CODE></A>. If this argument is null and the <A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#keysIndex"><CODE>keysIndex</CODE></A> + <a href="../../../com/sleepycat/persist/SecondaryIndex.html#keysIndex"><code>keysIndex</code></a>. If this argument is null and the <a href="../../../com/sleepycat/persist/SecondaryIndex.html#keysIndex"><code>keysIndex</code></a> method is called, then the keys database will be opened automatically; however, the user is then responsible for closing the keys database. To - get the keys database in order to close it, call <A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#getKeysDatabase()"><CODE>getKeysDatabase()</CODE></A>.<DD><CODE>primaryIndex</CODE> - the primary index associated with this secondary - index.<DD><CODE>secondaryKeyClass</CODE> - the class of the secondary key.<DD><CODE>secondaryKeyBinding</CODE> - the binding to be used for secondary keys. -<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> -</DL> - + get the keys database in order to close it, call <a href="../../../com/sleepycat/persist/SecondaryIndex.html#getKeysDatabase()"><code>getKeysDatabase()</code></a>.</dd><dd><code>primaryIndex</code> - the primary index associated with this secondary + index.</dd><dd><code>secondaryKeyClass</code> - the class of the secondary key.</dd><dd><code>secondaryKeyBinding</code> - the binding to be used for secondary keys.</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> +</li> +</ul> <!-- ============ 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="getDatabase()"><!-- --></A><H3> -getDatabase</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/SecondaryDatabase.html" title="class in com.sleepycat.db">SecondaryDatabase</A> <B>getDatabase</B>()</PRE> -<DL> -<DD>Returns the underlying secondary database for this index. -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>the secondary database.</DL> -</DD> -</DL> -<HR> - -<A NAME="getKeysDatabase()"><!-- --></A><H3> -getKeysDatabase</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A> <B>getKeysDatabase</B>()</PRE> -<DL> -<DD>Returns the underlying secondary database that is not associated with - the primary database and is used for the <A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#keysIndex"><CODE>keysIndex</CODE></A>. -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>the keys database.</DL> -</DD> -</DL> -<HR> - -<A NAME="getPrimaryIndex()"><!-- --></A><H3> -getPrimaryIndex</H3> -<PRE> -public <A HREF="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist">PrimaryIndex</A><<A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">PK</A>,<A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</A>> <B>getPrimaryIndex</B>()</PRE> -<DL> -<DD>Returns the primary index associated with this secondary index. -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>the primary index.</DL> -</DD> -</DL> -<HR> - -<A NAME="getKeyClass()"><!-- --></A><H3> -getKeyClass</H3> -<PRE> -public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><<A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</A>> <B>getKeyClass</B>()</PRE> -<DL> -<DD>Returns the secondary key class for this index. -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>the class.</DL> -</DD> -</DL> -<HR> - -<A NAME="getKeyBinding()"><!-- --></A><H3> -getKeyBinding</H3> -<PRE> -public <A HREF="../../../com/sleepycat/bind/EntryBinding.html" title="interface in com.sleepycat.bind">EntryBinding</A><<A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</A>> <B>getKeyBinding</B>()</PRE> -<DL> -<DD>Returns the secondary key binding for the index. -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>the key binding.</DL> -</DD> -</DL> -<HR> - -<A NAME="keysIndex()"><!-- --></A><H3> -keysIndex</H3> -<PRE> -public <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</A><<A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</A>,<A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">PK</A>> <B>keysIndex</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Returns a read-only keys index that maps secondary key to primary key. +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getDatabase()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDatabase</h4> +<pre>public <a href="../../../com/sleepycat/db/SecondaryDatabase.html" title="class in com.sleepycat.db">SecondaryDatabase</a> getDatabase()</pre> +<div class="block">Returns the underlying secondary database for this index.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the secondary database.</dd></dl> +</li> +</ul> +<a name="getKeysDatabase()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getKeysDatabase</h4> +<pre>public <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</a> getKeysDatabase()</pre> +<div class="block">Returns the underlying secondary database that is not associated with + the primary database and is used for the <a href="../../../com/sleepycat/persist/SecondaryIndex.html#keysIndex"><code>keysIndex</code></a>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the keys database.</dd></dl> +</li> +</ul> +<a name="getPrimaryIndex()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPrimaryIndex</h4> +<pre>public <a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist">PrimaryIndex</a><<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">PK</a>,<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</a>> getPrimaryIndex()</pre> +<div class="block">Returns the primary index associated with this secondary index.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the primary index.</dd></dl> +</li> +</ul> +<a name="getKeyClass()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getKeyClass</h4> +<pre>public java.lang.Class<<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a>> getKeyClass()</pre> +<div class="block">Returns the secondary key class for this index.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the class.</dd></dl> +</li> +</ul> +<a name="getKeyBinding()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getKeyBinding</h4> +<pre>public <a href="../../../com/sleepycat/bind/EntryBinding.html" title="interface in com.sleepycat.bind">EntryBinding</a><<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a>> getKeyBinding()</pre> +<div class="block">Returns the secondary key binding for the index.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the key binding.</dd></dl> +</li> +</ul> +<a name="keysIndex()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>keysIndex</h4> +<pre>public <a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a>,<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">PK</a>> keysIndex() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Returns a read-only keys index that maps secondary key to primary key. When accessing the keys index, the primary key is returned rather than the entity. When only the primary key is needed and not the entire entity, using the keys index is less expensive than using the secondary @@ -1228,551 +1169,536 @@ public <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="interfac database, a second database handle for the secondary database, if it is not already open. In this case, if you are <em>not</em> using an <code>EntityStore</code>, then you are responsible for closing the - database returned by <A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#getKeysDatabase()"><CODE>getKeysDatabase()</CODE></A> before closing the + database returned by <a href="../../../com/sleepycat/persist/SecondaryIndex.html#getKeysDatabase()"><code>getKeysDatabase()</code></a> before closing the environment. If you <em>are</em> using an <code>EntityStore</code>, the - keys database will be closed automatically by <A HREF="../../../com/sleepycat/persist/EntityStore.html#close()"><CODE>EntityStore.close()</CODE></A>.</p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>the keys 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="subIndex(java.lang.Object)"><!-- --></A><A NAME="subIndex(SK)"><!-- --></A><H3> -subIndex</H3> -<PRE> -public <A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</A><<A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">PK</A>,<A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</A>> <B>subIndex</B>(<A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</A> key) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Returns an index that maps primary key to entity for the subset of + keys database will be closed automatically by <a href="../../../com/sleepycat/persist/EntityStore.html#close()"><code>EntityStore.close()</code></a>.</p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the keys 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="subIndex(java.lang.Object)"> +<!-- --> +</a><a name="subIndex(SK)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>subIndex</h4> +<pre>public <a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">PK</a>,<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</a>> subIndex(<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a> key) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Returns an index that maps primary key to entity for the subset of entities having a given secondary key (duplicates). A sub-index is convenient when you are interested in working with the subset of entities having a particular secondary key value. - <p>When using a <A HREF="../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_ONE"><CODE>MANY_TO_ONE</CODE></A> or <A HREF="../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_MANY"><CODE>MANY_TO_MANY</CODE></A> secondary key, the sub-index - represents the left (MANY) side of a relationship.</p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>key</CODE> - the secondary key that identifies the entities in the - sub-index. -<DT><B>Returns:</B><DD>the sub-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(SK)"><!-- --></A><H3> -get</H3> -<PRE> -public <A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</A> <B>get</B>(<A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</A> key) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD><B>Description copied from interface: <CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html#get(K)">EntityIndex</A></CODE></B></DD> -<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, SK, com.sleepycat.db.LockMode)"><!-- --></A><H3> -get</H3> -<PRE> -public <A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</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/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</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><B>Description copied from interface: <CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html#get(com.sleepycat.db.Transaction, K, com.sleepycat.db.LockMode)">EntityIndex</A></CODE></B></DD> -<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="map()"><!-- --></A><H3> -map</H3> -<PRE> -public <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/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</A>,<A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</A>> <B>map</B>()</PRE> -<DL> -<DD><B>Description copied from interface: <CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html#map()">EntityIndex</A></CODE></B></DD> -<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> -public <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/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</A>,<A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</A>> <B>sortedMap</B>()</PRE> -<DL> -<DD><B>Description copied from interface: <CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html#sortedMap()">EntityIndex</A></CODE></B></DD> -<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> -<HR> - -<A NAME="contains(java.lang.Object)"><!-- --></A><A NAME="contains(K)"><!-- --></A><H3> -contains</H3> -<PRE> -public boolean <B>contains</B>(K key) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD><B>Description copied from interface: <CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html#contains(K)">EntityIndex</A></CODE></B></DD> -<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>Specified by:</B><DD><CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html#contains(K)">contains</A></CODE> in interface <CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</A><K,E></CODE></DL> -</DD> -<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> -public boolean <B>contains</B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - K 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><B>Description copied from interface: <CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html#contains(com.sleepycat.db.Transaction, K, com.sleepycat.db.LockMode)">EntityIndex</A></CODE></B></DD> -<DD>Checks for existence of a key in this index. -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html#contains(com.sleepycat.db.Transaction, K, com.sleepycat.db.LockMode)">contains</A></CODE> in interface <CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</A><K,E></CODE></DL> -</DD> -<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="count()"><!-- --></A><H3> -count</H3> -<PRE> -public long <B>count</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD><B>Description copied from interface: <CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html#count()">EntityIndex</A></CODE></B></DD> -<DD>Returns a non-transactional count of the entities in this index. + <p>When using a <a href="../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_ONE"><code>MANY_TO_ONE</code></a> or <a href="../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_MANY"><code>MANY_TO_MANY</code></a> secondary key, the sub-index + represents the left (MANY) side of a relationship.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the secondary key that identifies the entities in the + sub-index.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the sub-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(SK)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</a> get(<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a> key) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#get(K)">EntityIndex</a></code></strong></div> +<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, SK, com.sleepycat.db.LockMode)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</a> get(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + <a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</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"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#get(com.sleepycat.db.Transaction,%20K,%20com.sleepycat.db.LockMode)">EntityIndex</a></code></strong></div> +<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="map()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>map</h4> +<pre>public java.util.Map<<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a>,<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</a>> map()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#map()">EntityIndex</a></code></strong></div> +<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="blockList"> +<li class="blockList"> +<h4>sortedMap</h4> +<pre>public java.util.SortedMap<<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">SK</a>,<a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="type parameter in SecondaryIndex">E</a>> sortedMap()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#sortedMap()">EntityIndex</a></code></strong></div> +<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> +<a name="contains(java.lang.Object)"> +<!-- --> +</a><a name="contains(K)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>contains</h4> +<pre>public boolean contains(K key) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#contains(K)">EntityIndex</a></code></strong></div> +<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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../com/sleepycat/persist/EntityIndex.html#contains(K)">contains</a></code> in interface <code><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><K,E></code></dd> +<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>public boolean contains(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + K 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"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#contains(com.sleepycat.db.Transaction,%20K,%20com.sleepycat.db.LockMode)">EntityIndex</a></code></strong></div> +<div class="block">Checks for existence of a key in this index.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../com/sleepycat/persist/EntityIndex.html#contains(com.sleepycat.db.Transaction,%20K,%20com.sleepycat.db.LockMode)">contains</a></code> in interface <code><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><K,E></code></dd> +<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="count()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>count</h4> +<pre>public long count() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#count()">EntityIndex</a></code></strong></div> +<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>Specified by:</B><DD><CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html#count()">count</A></CODE> in interface <CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</A><K,E></CODE></DL> -</DD> -<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> -public boolean <B>delete</B>(K key) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD><B>Description copied from interface: <CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html#delete(K)">EntityIndex</A></CODE></B></DD> -<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>Specified by:</B><DD><CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html#delete(K)">delete</A></CODE> in interface <CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</A><K,E></CODE></DL> -</DD> -<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> -public boolean <B>delete</B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - K key) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD><B>Description copied from interface: <CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html#delete(com.sleepycat.db.Transaction, K)">EntityIndex</A></CODE></B></DD> -<DD>Deletes all entities with a given index key. -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html#delete(com.sleepycat.db.Transaction, K)">delete</A></CODE> in interface <CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</A><K,E></CODE></DL> -</DD> -<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> -public <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</A><K> <B>keys</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD><B>Description copied from interface: <CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html#keys()">EntityIndex</A></CODE></B></DD> -<DD>Opens a cursor for traversing all keys in this index. + operation.</p></div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../com/sleepycat/persist/EntityIndex.html#count()">count</a></code> in interface <code><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><K,E></code></dd> +<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>public boolean delete(K key) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#delete(K)">EntityIndex</a></code></strong></div> +<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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../com/sleepycat/persist/EntityIndex.html#delete(K)">delete</a></code> in interface <code><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><K,E></code></dd> +<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>public boolean delete(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + K key) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#delete(com.sleepycat.db.Transaction,%20K)">EntityIndex</a></code></strong></div> +<div class="block">Deletes all entities with a given index key.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../com/sleepycat/persist/EntityIndex.html#delete(com.sleepycat.db.Transaction,%20K)">delete</a></code> in interface <code><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><K,E></code></dd> +<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>public <a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><K> keys() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#keys()">EntityIndex</a></code></strong></div> +<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>Specified by:</B><DD><CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html#keys()">keys</A></CODE> in interface <CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</A><K,E></CODE></DL> -</DD> -<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> -public <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</A><K> <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><B>Description copied from interface: <CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html#keys(com.sleepycat.db.Transaction, com.sleepycat.db.CursorConfig)">EntityIndex</A></CODE></B></DD> -<DD>Opens a cursor for traversing all keys in this index. -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html#keys(com.sleepycat.db.Transaction, com.sleepycat.db.CursorConfig)">keys</A></CODE> in interface <CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</A><K,E></CODE></DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>txn</CODE> - the transaction used to protect all operations performed with + entities.</p></div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../com/sleepycat/persist/EntityIndex.html#keys()">keys</a></code> in interface <code><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><K,E></code></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, com.sleepycat.db.CursorConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>keys</h4> +<pre>public <a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><K> 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"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#keys(com.sleepycat.db.Transaction,%20com.sleepycat.db.CursorConfig)">EntityIndex</a></code></strong></div> +<div class="block">Opens a cursor for traversing all keys in this index.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../com/sleepycat/persist/EntityIndex.html#keys(com.sleepycat.db.Transaction,%20com.sleepycat.db.CursorConfig)">keys</a></code> in interface <code><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><K,E></code></dd> +<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> -public <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</A><E> <B>entities</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD><B>Description copied from interface: <CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html#entities()">EntityIndex</A></CODE></B></DD> -<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>public <a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><E> entities() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#entities()">EntityIndex</a></code></strong></div> +<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>Specified by:</B><DD><CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html#entities()">entities</A></CODE> in interface <CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</A><K,E></CODE></DL> -</DD> -<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> -public <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</A><E> <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><B>Description copied from interface: <CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html#entities(com.sleepycat.db.Transaction, com.sleepycat.db.CursorConfig)">EntityIndex</A></CODE></B></DD> -<DD>Opens a cursor for traversing all entities in this index. -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html#entities(com.sleepycat.db.Transaction, com.sleepycat.db.CursorConfig)">entities</A></CODE> in interface <CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</A><K,E></CODE></DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>txn</CODE> - the transaction used to protect all operations performed with + entities.</p></div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../com/sleepycat/persist/EntityIndex.html#entities()">entities</a></code> in interface <code><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><K,E></code></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, com.sleepycat.db.CursorConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>entities</h4> +<pre>public <a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><E> 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"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#entities(com.sleepycat.db.Transaction,%20com.sleepycat.db.CursorConfig)">EntityIndex</a></code></strong></div> +<div class="block">Opens a cursor for traversing all entities in this index.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../com/sleepycat/persist/EntityIndex.html#entities(com.sleepycat.db.Transaction,%20com.sleepycat.db.CursorConfig)">entities</a></code> in interface <code><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><K,E></code></dd> +<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> -public <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</A><K> <B>keys</B>(K fromKey, - boolean fromInclusive, - K toKey, - boolean toInclusive) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD><B>Description copied from interface: <CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html#keys(K, boolean, K, boolean)">EntityIndex</A></CODE></B></DD> -<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>public <a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><K> keys(K fromKey, + boolean fromInclusive, + K toKey, + boolean toInclusive) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#keys(K,%20boolean,%20K,%20boolean)">EntityIndex</a></code></strong></div> +<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>Specified by:</B><DD><CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html#keys(K, boolean, K, boolean)">keys</A></CODE> in interface <CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</A><K,E></CODE></DL> -</DD> -<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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../com/sleepycat/persist/EntityIndex.html#keys(K,%20boolean,%20K,%20boolean)">keys</a></code> in interface <code><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><K,E></code></dd> +<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> -public <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</A><K> <B>keys</B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - K fromKey, - boolean fromInclusive, - K 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><B>Description copied from interface: <CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html#keys(com.sleepycat.db.Transaction, K, boolean, K, boolean, com.sleepycat.db.CursorConfig)">EntityIndex</A></CODE></B></DD> -<DD>Opens a cursor for traversing keys in a key range. -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html#keys(com.sleepycat.db.Transaction, K, boolean, K, boolean, com.sleepycat.db.CursorConfig)">keys</A></CODE> in interface <CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</A><K,E></CODE></DL> -</DD> -<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>public <a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><K> keys(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + K fromKey, + boolean fromInclusive, + K 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"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#keys(com.sleepycat.db.Transaction,%20K,%20boolean,%20K,%20boolean,%20com.sleepycat.db.CursorConfig)">EntityIndex</a></code></strong></div> +<div class="block">Opens a cursor for traversing keys in a key range.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../com/sleepycat/persist/EntityIndex.html#keys(com.sleepycat.db.Transaction,%20K,%20boolean,%20K,%20boolean,%20com.sleepycat.db.CursorConfig)">keys</a></code> in interface <code><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><K,E></code></dd> +<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> -public <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</A><E> <B>entities</B>(K fromKey, - boolean fromInclusive, - K toKey, - boolean toInclusive) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD><B>Description copied from interface: <CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html#entities(K, boolean, K, boolean)">EntityIndex</A></CODE></B></DD> -<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>public <a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><E> entities(K fromKey, + boolean fromInclusive, + K toKey, + boolean toInclusive) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#entities(K,%20boolean,%20K,%20boolean)">EntityIndex</a></code></strong></div> +<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>Specified by:</B><DD><CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html#entities(K, boolean, K, boolean)">entities</A></CODE> in interface <CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</A><K,E></CODE></DL> -</DD> -<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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../com/sleepycat/persist/EntityIndex.html#entities(K,%20boolean,%20K,%20boolean)">entities</a></code> in interface <code><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><K,E></code></dd> +<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> -public <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</A><E> <B>entities</B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - K fromKey, - boolean fromInclusive, - K 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><B>Description copied from interface: <CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html#entities(com.sleepycat.db.Transaction, K, boolean, K, boolean, com.sleepycat.db.CursorConfig)">EntityIndex</A></CODE></B></DD> -<DD>Opens a cursor for traversing entities in a key range. -<P> -<DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html#entities(com.sleepycat.db.Transaction, K, boolean, K, boolean, com.sleepycat.db.CursorConfig)">entities</A></CODE> in interface <CODE><A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</A><K,E></CODE></DL> -</DD> -<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="blockListLast"> +<li class="blockList"> +<h4>entities</h4> +<pre>public <a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><E> entities(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + K fromKey, + boolean fromInclusive, + K 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"><strong>Description copied from interface: <code><a href="../../../com/sleepycat/persist/EntityIndex.html#entities(com.sleepycat.db.Transaction,%20K,%20boolean,%20K,%20boolean,%20com.sleepycat.db.CursorConfig)">EntityIndex</a></code></strong></div> +<div class="block">Opens a cursor for traversing entities in a key range.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../com/sleepycat/persist/EntityIndex.html#entities(com.sleepycat.db.Transaction,%20K,%20boolean,%20K,%20boolean,%20com.sleepycat.db.CursorConfig)">entities</a></code> in interface <code><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><K,E></code></dd> +<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> + 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> +</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/SecondaryIndex.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/PrimaryIndex.html" title="class in com.sleepycat.persist"><B>PREV CLASS</B></A> - <A HREF="../../../com/sleepycat/persist/StoreConfig.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/SecondaryIndex.html" target="_top"><B>FRAMES</B></A> - <A HREF="SecondaryIndex.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/SecondaryIndex.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/PrimaryIndex.html" title="class in com.sleepycat.persist"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/sleepycat/persist/StoreConfig.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/SecondaryIndex.html" target="_top">Frames</a></li> +<li><a href="SecondaryIndex.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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> |