diff options
Diffstat (limited to 'docs/java/com/sleepycat/persist/model/SecondaryKey.html')
| -rw-r--r-- | docs/java/com/sleepycat/persist/model/SecondaryKey.html | 602 |
1 files changed, 292 insertions, 310 deletions
diff --git a/docs/java/com/sleepycat/persist/model/SecondaryKey.html b/docs/java/com/sleepycat/persist/model/SecondaryKey.html index 913d9643..b6581504 100644 --- a/docs/java/com/sleepycat/persist/model/SecondaryKey.html +++ b/docs/java/com/sleepycat/persist/model/SecondaryKey.html @@ -1,108 +1,97 @@ <!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:08 EDT 2012 --> -<TITLE> -SecondaryKey (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>SecondaryKey (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="SecondaryKey (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/SecondaryKey.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/model/Relationship.html" title="enum in com.sleepycat.persist.model"><B>PREV CLASS</B></A> - <A HREF="../../../../com/sleepycat/persist/model/SecondaryKeyMetadata.html" title="class in com.sleepycat.persist.model"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../index.html?com/sleepycat/persist/model/SecondaryKey.html" target="_top"><B>FRAMES</B></A> - <A HREF="SecondaryKey.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/SecondaryKey.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/model/Relationship.html" title="enum in com.sleepycat.persist.model"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/sleepycat/persist/model/SecondaryKeyMetadata.html" title="class in com.sleepycat.persist.model"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/sleepycat/persist/model/SecondaryKey.html" target="_top">Frames</a></li> +<li><a href="SecondaryKey.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: <A HREF="#annotation_type_required_element_summary">REQUIRED</A> | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_top"></A> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#annotation_type_required_element_summary">Required</a> | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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.model</FONT> -<BR> -Annotation Type SecondaryKey</H2> -<HR> -<DL> -<DT><PRE><FONT SIZE="-1"><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Documented.html?is-external=true" title="class or interface in java.lang.annotation">@Documented</A> -<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Retention.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</A>=<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</A>) -<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Target.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</A>=<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation">FIELD</A>) -</FONT>public @interface <B>SecondaryKey</B></DL> -</PRE> - -<P> -Indicates a secondary key field of an entity class. The value of the +<div class="header"> +<div class="subTitle">com.sleepycat.persist.model</div> +<h2 title="Annotation Type SecondaryKey" class="title">Annotation Type SecondaryKey</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>@Documented +@Retention(value=RUNTIME) +@Target(value=FIELD) +public @interface <span class="strong">SecondaryKey</span></pre> +<div class="block">Indicates a secondary key field of an entity class. The value of the secondary key field is a unique or non-unique identifier for the entity and - is accessed via a <A HREF="../../../../com/sleepycat/persist/SecondaryIndex.html" title="class in com.sleepycat.persist"><CODE>SecondaryIndex</CODE></A>. + is accessed via a <a href="../../../../com/sleepycat/persist/SecondaryIndex.html" title="class in com.sleepycat.persist"><code>SecondaryIndex</code></a>. <p><code>SecondaryKey</code> may appear on any number of fields in an entity class, subclasses and superclasses. For a secondary key field in the entity @@ -118,20 +107,20 @@ Indicates a secondary key field of an entity class. The value of the <p>For a given entity class and its superclasses and subclasses, no two secondary keys may have the same name. By default, the field name identifies the secondary key and the secondary index for a given entity - class. <A HREF="../../../../com/sleepycat/persist/model/SecondaryKey.html#name()"><CODE>name()</CODE></A> may be specified to override this default.</p> + class. <a href="../../../../com/sleepycat/persist/model/SecondaryKey.html#name()"><code>name()</code></a> may be specified to override this default.</p> - <p>Using <A HREF="../../../../com/sleepycat/persist/model/SecondaryKey.html#relate()"><CODE>relate()</CODE></A>, instances of the entity class are related to + <p>Using <a href="../../../../com/sleepycat/persist/model/SecondaryKey.html#relate()"><code>relate()</code></a>, instances of the entity class are related to secondary keys in a many-to-one, one-to-many, many-to-many, or one-to-one relationship. This required property specifies the <em>cardinality</em> of each side of the relationship.</p> <p>A secondary key may optionally be used to form a relationship with - instances of another entity class using <A HREF="../../../../com/sleepycat/persist/model/SecondaryKey.html#relatedEntity()"><CODE>relatedEntity()</CODE></A> and <A HREF="../../../../com/sleepycat/persist/model/SecondaryKey.html#onRelatedEntityDelete()"><CODE>onRelatedEntityDelete()</CODE></A>. This establishes <em>foreign key constraints</em> + instances of another entity class using <a href="../../../../com/sleepycat/persist/model/SecondaryKey.html#relatedEntity()"><code>relatedEntity()</code></a> and <a href="../../../../com/sleepycat/persist/model/SecondaryKey.html#onRelatedEntityDelete()"><code>onRelatedEntityDelete()</code></a>. This establishes <em>foreign key constraints</em> for the secondary key.</p> <p>The secondary key field type must be a Set, Collection or array type when a <em>x-to-many</em> relationship is used or a singular type when an - <em>x-to-one</em> relationship is used; see <A HREF="../../../../com/sleepycat/persist/model/SecondaryKey.html#relate()"><CODE>relate()</CODE></A>.</p> + <em>x-to-one</em> relationship is used; see <a href="../../../../com/sleepycat/persist/model/SecondaryKey.html#relate()"><code>relate()</code></a>.</p> <p>The field type (or element type, when a Set, Collection or array type is used) of a secondary key field must follow the same rules as for a <a href="PrimaryKey.html#keyTypes">primary key type</a>. The <a @@ -139,86 +128,91 @@ Indicates a secondary key field of an entity class. The value of the <p>For a secondary key field with a collection type, a type parameter must be used to specify the element type. For example <code>Collection<String></code> - is allowed but <code>Collection</code> is not.</p> -<P> - -<P> -<HR> - -<P> + is allowed but <code>Collection</code> is not.</p></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> <!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== --> - -<A NAME="annotation_type_required_element_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>Required Element Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../../com/sleepycat/persist/model/Relationship.html" title="enum in com.sleepycat.persist.model">Relationship</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/SecondaryKey.html#relate()">relate</A></B></CODE> - -<BR> - Defines the relationship between instances of the entity class and the - secondary keys.</TD> -</TR> -</TABLE> - <!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> - -<A NAME="annotation_type_optional_element_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>Optional Element Summary</B></FONT></TH> -</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/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/SecondaryKey.html#name()">name</A></B></CODE> - -<BR> - Specifies the name of the key in order to use a name that is different - than the field name.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../../com/sleepycat/persist/model/DeleteAction.html" title="enum in com.sleepycat.persist.model">DeleteAction</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/SecondaryKey.html#onRelatedEntityDelete()">onRelatedEntityDelete</A></B></CODE> - -<BR> - Specifies the action to take when a related entity is deleted having a - primary key value that exists as a secondary key value for this entity.</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></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/SecondaryKey.html#relatedEntity()">relatedEntity</A></B></CODE> - -<BR> - Specifies the entity to which this entity is related, for establishing - foreign key constraints.</TD> -</TR> -</TABLE> - -<P> - +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_required_element_summary"> +<!-- --> +</a> +<h3>Required Element Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation"> +<caption><span>Required Elements</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Required Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/sleepycat/persist/model/Relationship.html" title="enum in com.sleepycat.persist.model">Relationship</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/model/SecondaryKey.html#relate()">relate</a></strong></code> +<div class="block">Defines the relationship between instances of the entity class and the + secondary keys.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_optional_element_summary"> +<!-- --> +</a> +<h3>Optional Element Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> +<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Optional Element and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/model/SecondaryKey.html#name()">name</a></strong></code> +<div class="block">Specifies the name of the key in order to use a name that is different + than the field name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/sleepycat/persist/model/DeleteAction.html" title="enum in com.sleepycat.persist.model">DeleteAction</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/model/SecondaryKey.html#onRelatedEntityDelete()">onRelatedEntityDelete</a></strong></code> +<div class="block">Specifies the action to take when a related entity is deleted having a + primary key value that exists as a secondary key value for this entity.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class</code></td> +<td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/model/SecondaryKey.html#relatedEntity()">relatedEntity</a></strong></code> +<div class="block">Specifies the entity to which this entity is related, for establishing + foreign key constraints.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> - -<A NAME="annotation_type_element_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>Element Detail</B></FONT></TH> -</TR> -</TABLE> - -<A NAME="relate()"><!-- --></A><H3> -relate</H3> -<PRE> -public abstract <A HREF="../../../../com/sleepycat/persist/model/Relationship.html" title="enum in com.sleepycat.persist.model">Relationship</A> <B>relate</B></PRE> -<DL> -<DD>Defines the relationship between instances of the entity class and the +<ul class="blockList"> +<li class="blockList"><a name="annotation_type_element_detail"> +<!-- --> +</a> +<h3>Element Detail</h3> +<a name="relate()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>relate</h4> +<pre>public abstract <a href="../../../../com/sleepycat/persist/model/Relationship.html" title="enum in com.sleepycat.persist.model">Relationship</a> relate</pre> +<div class="block">Defines the relationship between instances of the entity class and the secondary keys. <p>The table below summarizes how to create all four variations of @@ -230,23 +224,23 @@ public abstract <A HREF="../../../../com/sleepycat/persist/model/Relationship.ht <th>Key type</th> <th>Example</th> </tr> - <tr><td><A HREF="../../../../com/sleepycat/persist/model/Relationship.html#ONE_TO_ONE"><CODE>Relationship.ONE_TO_ONE</CODE></A></td> + <tr><td><a href="../../../../com/sleepycat/persist/model/Relationship.html#ONE_TO_ONE"><code>Relationship.ONE_TO_ONE</code></a></td> <td>Singular</td> <td>Unique</td> <td>A person record with a unique social security number key.</td> </tr> - <tr><td><A HREF="../../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_ONE"><CODE>Relationship.MANY_TO_ONE</CODE></A></td> + <tr><td><a href="../../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_ONE"><code>Relationship.MANY_TO_ONE</code></a></td> <td>Singular</td> <td>Duplicates</td> <td>A person record with a non-unique employer key.</td> </tr> - <tr><td><A HREF="../../../../com/sleepycat/persist/model/Relationship.html#ONE_TO_MANY"><CODE>Relationship.ONE_TO_MANY</CODE></A></td> + <tr><td><a href="../../../../com/sleepycat/persist/model/Relationship.html#ONE_TO_MANY"><code>Relationship.ONE_TO_MANY</code></a></td> <td>Set/Collection/array</td> <td>Unique</td> <td>A person record with multiple unique email address keys.</td> </tr> - <tr><td><A HREF="../../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_MANY"><CODE>Relationship.MANY_TO_MANY</CODE></A></td> + <tr><td><a href="../../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_MANY"><code>Relationship.MANY_TO_MANY</code></a></td> <td>Set/Collection/array</td> <td>Duplicates</td> <td>A person record with multiple non-unique organization @@ -264,28 +258,25 @@ public abstract <A HREF="../../../../com/sleepycat/persist/model/Relationship.ht singular; in other words, it may not be a Set, Collection or array type. Conversely, for a <em>x-to-many</em> relationship, the secondary key field must be a Set, Collection or array type. A collection type is any - implementation of <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><CODE>Collection</CODE></A>.</p> + implementation of <code>Collection</code>.</p> <p>For a <em>x-to-many</em> relationship, the field type should normally - be <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util"><CODE>Set</CODE></A> (or a subtype of this interface). This + be <code>Set</code> (or a subtype of this interface). This accurately expresses the fact that an Entity may not have two identical - secondary keys. For flexibility, a <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><CODE>Collection</CODE></A> (or a + secondary keys. For flexibility, a <code>Collection</code> (or a subtype of this interface) or an array type may also be used. In that case, any duplicate key values in the Collection or array are - ignored.</p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DL> -<A NAME="relatedEntity()"><!-- --></A><H3> -relatedEntity</H3> -<PRE> -public abstract <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> <B>relatedEntity</B></PRE> -<DL> -<DD>Specifies the entity to which this entity is related, for establishing + ignored.</p></div> +</li> +</ul> +<a name="relatedEntity()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>relatedEntity</h4> +<pre>public abstract java.lang.Class relatedEntity</pre> +<div class="block">Specifies the entity to which this entity is related, for establishing foreign key constraints. Values of this secondary key will be constrained to the set of primary key values for the given entity class. @@ -298,73 +289,65 @@ public abstract <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/l <p>Whenever a new secondary key value is stored for this entity, it is checked to ensure it exists as a primary key value of the related - entity. If it does not, an exception is thrown by the <A HREF="../../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><CODE>PrimaryIndex</CODE></A> <code>put</code> method. + entity. If it does not, an exception is thrown by the <a href="../../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><code>PrimaryIndex</code></a> <code>put</code> method. </p> <p>Whenever a related entity is deleted and its primary key value exists as a secondary key value for this entity, the action is taken that is - specified using the <A HREF="../../../../com/sleepycat/persist/model/SecondaryKey.html#onRelatedEntityDelete()"><CODE>onRelatedEntityDelete()</CODE></A> property.</p> + specified using the <a href="../../../../com/sleepycat/persist/model/SecondaryKey.html#onRelatedEntityDelete()"><code>onRelatedEntityDelete()</code></a> property.</p> <p>Together, these two checks guarantee that a secondary key value for this entity will always exist as a primary key value for the related entity. Note, however, that a transactional store must be configured - to guarantee this to be true in the face of a crash; see <A HREF="../../../../com/sleepycat/persist/StoreConfig.html#setTransactional(boolean)"><CODE>StoreConfig.setTransactional(boolean)</CODE></A>.</p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -<DL> -<DT><B>Default:</B><DD>void.class</DD> -</DL> -</DL> -<HR> - -<A NAME="onRelatedEntityDelete()"><!-- --></A><H3> -onRelatedEntityDelete</H3> -<PRE> -public abstract <A HREF="../../../../com/sleepycat/persist/model/DeleteAction.html" title="enum in com.sleepycat.persist.model">DeleteAction</A> <B>onRelatedEntityDelete</B></PRE> -<DL> -<DD>Specifies the action to take when a related entity is deleted having a + to guarantee this to be true in the face of a crash; see <a href="../../../../com/sleepycat/persist/StoreConfig.html#setTransactional(boolean)"><code>StoreConfig.setTransactional(boolean)</code></a>.</p></div> +<dl> +<dt>Default:</dt> +<dd>void.class</dd> +</dl> +</li> +</ul> +<a name="onRelatedEntityDelete()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onRelatedEntityDelete</h4> +<pre>public abstract <a href="../../../../com/sleepycat/persist/model/DeleteAction.html" title="enum in com.sleepycat.persist.model">DeleteAction</a> onRelatedEntityDelete</pre> +<div class="block">Specifies the action to take when a related entity is deleted having a primary key value that exists as a secondary key value for this entity. - <p><em>Note:</em> This property only applies when <A HREF="../../../../com/sleepycat/persist/model/SecondaryKey.html#relatedEntity()"><CODE>relatedEntity()</CODE></A> + <p><em>Note:</em> This property only applies when <a href="../../../../com/sleepycat/persist/model/SecondaryKey.html#relatedEntity()"><code>relatedEntity()</code></a> is specified to define the related entity.</p> - <p>The default action, <A HREF="../../../../com/sleepycat/persist/model/DeleteAction.html#ABORT"><CODE>ABORT</CODE></A>, means that an + <p>The default action, <a href="../../../../com/sleepycat/persist/model/DeleteAction.html#ABORT"><code>ABORT</code></a>, means that an exception is thrown in order to abort the current transaction. </p> - <p>If <A HREF="../../../../com/sleepycat/persist/model/DeleteAction.html#CASCADE"><CODE>CASCADE</CODE></A> is specified, then this + <p>If <a href="../../../../com/sleepycat/persist/model/DeleteAction.html#CASCADE"><code>CASCADE</code></a> is specified, then this entity will be deleted also. This in turn could trigger further deletions, causing a cascading effect.</p> - <p>If <A HREF="../../../../com/sleepycat/persist/model/DeleteAction.html#NULLIFY"><CODE>NULLIFY</CODE></A> is specified, then the + <p>If <a href="../../../../com/sleepycat/persist/model/DeleteAction.html#NULLIFY"><code>NULLIFY</code></a> is specified, then the secondary key in this entity is set to null and this entity is updated. If the key field type is singular, the field value is set to null; therefore, to specify <code>NULLIFY</code> for a singular key field type, a primitive wrapper type must be used instead of a primitive type. If the key field type is an array or collection type, the key is deleted from - the array (the array is resized) or from the collection (using <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true#remove(java.lang.Object)" title="class or interface in java.util"><CODE>Collection.remove</CODE></A>).</p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -<DL> -<DT><B>Default:</B><DD>com.sleepycat.persist.model.DeleteAction.ABORT</DD> -</DL> -</DL> -<HR> - -<A NAME="name()"><!-- --></A><H3> -name</H3> -<PRE> -public abstract <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>name</B></PRE> -<DL> -<DD>Specifies the name of the key in order to use a name that is different + the array (the array is resized) or from the collection (using <code>Collection.remove</code>).</p></div> +<dl> +<dt>Default:</dt> +<dd>com.sleepycat.persist.model.DeleteAction.ABORT</dd> +</dl> +</li> +</ul> +<a name="name()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>name</h4> +<pre>public abstract java.lang.String name</pre> +<div class="block">Specifies the name of the key in order to use a name that is different than the field name. <p>This is convenient when prefixes or suffices are used on field names. @@ -380,78 +363,77 @@ public abstract <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/l an entity class and its subclass may both have a field named 'date', and both fields are used as secondary keys. The <code>name</code> property can be specified for one or both fields to give each key a unique - name.</p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -<DL> -<DT><B>Default:</B><DD>""</DD> -</DL> -</DL> + name.</p></div> +<dl> +<dt>Default:</dt> +<dd>""</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/SecondaryKey.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/model/Relationship.html" title="enum in com.sleepycat.persist.model"><B>PREV CLASS</B></A> - <A HREF="../../../../com/sleepycat/persist/model/SecondaryKeyMetadata.html" title="class in com.sleepycat.persist.model"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../index.html?com/sleepycat/persist/model/SecondaryKey.html" target="_top"><B>FRAMES</B></A> - <A HREF="SecondaryKey.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/SecondaryKey.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/model/Relationship.html" title="enum in com.sleepycat.persist.model"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/sleepycat/persist/model/SecondaryKeyMetadata.html" title="class in com.sleepycat.persist.model"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/sleepycat/persist/model/SecondaryKey.html" target="_top">Frames</a></li> +<li><a href="SecondaryKey.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: <A HREF="#annotation_type_required_element_summary">REQUIRED</A> | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_bottom"></A> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#annotation_type_required_element_summary">Required</a> | </li> +<li><a href="#annotation_type_optional_element_summary">Optional</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#annotation_type_element_detail">Element</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> |