diff options
Diffstat (limited to 'docs/java/com/sleepycat/persist/package-summary.html')
| -rw-r--r-- | docs/java/com/sleepycat/persist/package-summary.html | 497 |
1 files changed, 248 insertions, 249 deletions
diff --git a/docs/java/com/sleepycat/persist/package-summary.html b/docs/java/com/sleepycat/persist/package-summary.html index 3c167263..764b14f0 100644 --- a/docs/java/com/sleepycat/persist/package-summary.html +++ b/docs/java/com/sleepycat/persist/package-summary.html @@ -1,187 +1,198 @@ <!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:09 EDT 2012 --> -<TITLE> -com.sleepycat.persist (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>com.sleepycat.persist (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="com.sleepycat.persist (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="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.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/db/package-summary.html"><B>PREV PACKAGE</B></A> - <A HREF="../../../com/sleepycat/persist/evolve/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../index.html?com/sleepycat/persist/package-summary.html" target="_top"><B>FRAMES</B></A> - <A HREF="package-summary.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 class="navBarCell1Rev">Package</li> +<li>Class</li> +<li><a href="package-use.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/db/package-summary.html">Prev Package</a></li> +<li><a href="../../../com/sleepycat/persist/evolve/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/sleepycat/persist/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> -</TABLE> -<A NAME="skip-navbar_top"></A> +</script> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> <!-- ========= END OF TOP NAVBAR ========= --> - -<HR> -<H2> -Package com.sleepycat.persist -</H2> -The Direct Persistence Layer (DPL) adds a persistent object model to the -Berkeley DB transactional engine. -<P> -<B>See:</B> -<BR> - <A HREF="#package_description"><B>Description</B></A> -<P> - -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Interface Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD WIDTH="15%"><B><A HREF="../../../com/sleepycat/persist/DatabaseNamer.html" title="interface in com.sleepycat.persist">DatabaseNamer</A></B></TD> -<TD>Determines the file names to use for primary and secondary databases.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD WIDTH="15%"><B><A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor<V></A></B></TD> -<TD>Traverses entity values or key values and allows deleting or updating the - entity at the current cursor position.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD WIDTH="15%"><B><A HREF="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex<K,V></A></B></TD> -<TD>The interface for accessing keys and entities via a primary or secondary - index.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD WIDTH="15%"><B><A HREF="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor<V></A></B></TD> -<TD>Cursor operations limited to traversing forward.</TD> -</TR> -</TABLE> - - -<P> - -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Class Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD WIDTH="15%"><B><A HREF="../../../com/sleepycat/persist/EntityJoin.html" title="class in com.sleepycat.persist">EntityJoin<PK,E></A></B></TD> -<TD>Performs an equality join on two or more secondary keys.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD WIDTH="15%"><B><A HREF="../../../com/sleepycat/persist/EntityStore.html" title="class in com.sleepycat.persist">EntityStore</A></B></TD> -<TD>A store for managing persistent entity objects.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD WIDTH="15%"><B><A HREF="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist">PrimaryIndex<PK,E></A></B></TD> -<TD>The primary index for an entity class and its primary key.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD WIDTH="15%"><B><A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="class in com.sleepycat.persist">SecondaryIndex<SK,PK,E></A></B></TD> -<TD>The secondary index for an entity class and a secondary key.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD WIDTH="15%"><B><A HREF="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</A></B></TD> -<TD>Configuration properties used with an <A HREF="../../../com/sleepycat/persist/EntityStore.html" title="class in com.sleepycat.persist"><CODE>EntityStore</CODE></A> or <A HREF="../../../com/sleepycat/persist/raw/RawStore.html" title="class in com.sleepycat.persist.raw"><CODE>RawStore</CODE></A>.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD WIDTH="15%"><B><A HREF="../../../com/sleepycat/persist/StoreConfigBeanInfo.html" title="class in com.sleepycat.persist">StoreConfigBeanInfo</A></B></TD> -<TD> </TD> -</TR> -</TABLE> - - -<P> - -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Exception Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD WIDTH="15%"><B><A HREF="../../../com/sleepycat/persist/IndexNotAvailableException.html" title="class in com.sleepycat.persist">IndexNotAvailableException</A></B></TD> -<TD>Thrown by the <A HREF="../../../com/sleepycat/persist/EntityStore.html#getPrimaryIndex(java.lang.Class, java.lang.Class)"><CODE>getPrimaryIndex</CODE></A>, <A HREF="../../../com/sleepycat/persist/EntityStore.html#getSecondaryIndex(com.sleepycat.persist.PrimaryIndex, java.lang.Class, java.lang.String)"><CODE>getSecondaryIndex</CODE></A> and <A HREF="../../../com/sleepycat/persist/EntityStore.html#getSubclassIndex(com.sleepycat.persist.PrimaryIndex, java.lang.Class, java.lang.Class, java.lang.String)"><CODE>getSubclassIndex</CODE></A> when an index has not yet - been created.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD WIDTH="15%"><B><A HREF="../../../com/sleepycat/persist/StoreExistsException.html" title="class in com.sleepycat.persist">StoreExistsException</A></B></TD> -<TD>Thrown by the <A HREF="../../../com/sleepycat/persist/EntityStore.html" title="class in com.sleepycat.persist"><CODE>EntityStore</CODE></A> constructor when the <A HREF="../../../com/sleepycat/persist/StoreConfig.html#setExclusiveCreate(boolean)"><CODE>ExclusiveCreate</CODE></A> configuration parameter is - true and the store's internal catalog database already exists.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD WIDTH="15%"><B><A HREF="../../../com/sleepycat/persist/StoreNotFoundException.html" title="class in com.sleepycat.persist">StoreNotFoundException</A></B></TD> -<TD>Thrown by the <A HREF="../../../com/sleepycat/persist/EntityStore.html" title="class in com.sleepycat.persist"><CODE>EntityStore</CODE></A> constructor when the <A HREF="../../../com/sleepycat/persist/StoreConfig.html#setAllowCreate(boolean)"><CODE>AllowCreate</CODE></A> configuration parameter is false and - the store's internal catalog database does not exist.</TD> -</TR> -</TABLE> - - -<P> -<A NAME="package_description"><!-- --></A><H2> -Package com.sleepycat.persist Description -</H2> - -<P> -The Direct Persistence Layer (DPL) adds a persistent object model to the +<div class="header"> +<h1 title="Package" class="title">Package com.sleepycat.persist</h1> +<div class="docSummary"> +<div class="block">The Direct Persistence Layer (DPL) adds a persistent object model to the +Berkeley DB transactional engine.</div> +</div> +<p>See: <a href="#package_description">Description</a></p> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> +<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Interface</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/sleepycat/persist/DatabaseNamer.html" title="interface in com.sleepycat.persist">DatabaseNamer</a></td> +<td class="colLast"> +<div class="block">Determines the file names to use for primary and secondary databases.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist">EntityCursor</a><V></td> +<td class="colLast"> +<div class="block">Traverses entity values or key values and allows deleting or updating the + entity at the current cursor position.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/sleepycat/persist/EntityIndex.html" title="interface in com.sleepycat.persist">EntityIndex</a><K,V></td> +<td class="colLast"> +<div class="block">The interface for accessing keys and entities via a primary or secondary + index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../com/sleepycat/persist/ForwardCursor.html" title="interface in com.sleepycat.persist">ForwardCursor</a><V></td> +<td class="colLast"> +<div class="block">Cursor operations limited to traversing forward.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> +<caption><span>Class Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Class</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/sleepycat/persist/EntityJoin.html" title="class in com.sleepycat.persist">EntityJoin</a><PK,E></td> +<td class="colLast"> +<div class="block">Performs an equality join on two or more secondary keys.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../com/sleepycat/persist/EntityStore.html" title="class in com.sleepycat.persist">EntityStore</a></td> +<td class="colLast"> +<div class="block">A store for managing persistent entity objects.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist">PrimaryIndex</a><PK,E></td> +<td class="colLast"> +<div class="block">The primary index for an entity class and its primary key.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="class in com.sleepycat.persist">SecondaryIndex</a><SK,PK,E></td> +<td class="colLast"> +<div class="block">The secondary index for an entity class and a secondary key.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a></td> +<td class="colLast"> +<div class="block">Configuration properties used with an <a href="../../../com/sleepycat/persist/EntityStore.html" title="class in com.sleepycat.persist"><code>EntityStore</code></a> or <a href="../../../com/sleepycat/persist/raw/RawStore.html" title="class in com.sleepycat.persist.raw"><code>RawStore</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../com/sleepycat/persist/StoreConfigBeanInfo.html" title="class in com.sleepycat.persist">StoreConfigBeanInfo</a></td> +<td class="colLast"> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation"> +<caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Exception</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/sleepycat/persist/IndexNotAvailableException.html" title="class in com.sleepycat.persist">IndexNotAvailableException</a></td> +<td class="colLast"> +<div class="block">Thrown by the <a href="../../../com/sleepycat/persist/EntityStore.html#getPrimaryIndex(java.lang.Class,%20java.lang.Class)"><code>getPrimaryIndex</code></a>, <a href="../../../com/sleepycat/persist/EntityStore.html#getSecondaryIndex(com.sleepycat.persist.PrimaryIndex,%20java.lang.Class,%20java.lang.String)"><code>getSecondaryIndex</code></a> and <a href="../../../com/sleepycat/persist/EntityStore.html#getSubclassIndex(com.sleepycat.persist.PrimaryIndex,%20java.lang.Class,%20java.lang.Class,%20java.lang.String)"><code>getSubclassIndex</code></a> when an index has not yet + been created.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../com/sleepycat/persist/StoreExistsException.html" title="class in com.sleepycat.persist">StoreExistsException</a></td> +<td class="colLast"> +<div class="block">Thrown by the <a href="../../../com/sleepycat/persist/EntityStore.html" title="class in com.sleepycat.persist"><code>EntityStore</code></a> constructor when the <a href="../../../com/sleepycat/persist/StoreConfig.html#setExclusiveCreate(boolean)"><code>ExclusiveCreate</code></a> configuration parameter is + true and the store's internal catalog database already exists.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../com/sleepycat/persist/StoreNotFoundException.html" title="class in com.sleepycat.persist">StoreNotFoundException</a></td> +<td class="colLast"> +<div class="block">Thrown by the <a href="../../../com/sleepycat/persist/EntityStore.html" title="class in com.sleepycat.persist"><code>EntityStore</code></a> constructor when the <a href="../../../com/sleepycat/persist/StoreConfig.html#setAllowCreate(boolean)"><code>AllowCreate</code></a> configuration parameter is false and + the store's internal catalog database does not exist.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package_description"> +<!-- --> +</a> +<h2 title="Package com.sleepycat.persist Description">Package com.sleepycat.persist Description</h2> +<div class="block">The Direct Persistence Layer (DPL) adds a persistent object model to the Berkeley DB transactional engine. <h1>Package Specification</h1> @@ -270,7 +281,7 @@ class Address { private Address() {} }</pre> Many incompatible class changes, such as renaming fields or refactoring a -single class, can be performed using <A HREF="../../../com/sleepycat/persist/evolve/Mutations.html" title="class in com.sleepycat.persist.evolve"><CODE>Mutations</CODE></A>. Mutations are automatically +single class, can be performed using <a href="../../../com/sleepycat/persist/evolve/Mutations.html" title="class in com.sleepycat.persist.evolve"><code>Mutations</code></a>. Mutations are automatically applied lazily as data is accessed, avoiding downtime to convert large databases during a software upgrade. <p>Complex refactoring involving multiple classes may be performed using the a @@ -282,9 +293,9 @@ changes have been made to persistent classes.</p> <li>The performance of the Berkeley DB transactional engine is not compromised. Operations are internally mapped directly to the engine API, object bindings are lightweight, and all engine tuning parameters are available. For example, -a "dirty read" may be performed using an optional <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db"><CODE>LockMode</CODE></A> parameter: +a "dirty read" may be performed using an optional <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db"><code>LockMode</code></a> parameter: <pre class="code">Employer employer = employerByName.get(null, "Gizmo Inc", LockMode.READ_UNCOMMITTED);</pre> -For high performance applications, <A HREF="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db"><CODE>DatabaseConfig</CODE></A> parameters may be used to tune the performance of the Berkeley +For high performance applications, <a href="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db"><code>DatabaseConfig</code></a> parameters may be used to tune the performance of the Berkeley DB engine. For example, the size of an internal Btree node can be specified as follows: <pre class="code"> @@ -302,9 +313,9 @@ that has a primary key and is stored and accessed using a primary index. It may also have any number of secondary keys, and entities may be accessed by secondary key using a secondary index.</p> -<p>An entity class may be defined with the <A HREF="../../../com/sleepycat/persist/model/Entity.html" title="annotation in com.sleepycat.persist.model"><CODE>Entity</CODE></A> annotation. For each entity class, -its primary key may be defined using the <A HREF="../../../com/sleepycat/persist/model/PrimaryKey.html" title="annotation in com.sleepycat.persist.model"><CODE>PrimaryKey</CODE></A> annotation and any number of -secondary keys may be defined using the <A HREF="../../../com/sleepycat/persist/model/SecondaryKey.html" title="annotation in com.sleepycat.persist.model"><CODE>SecondaryKey</CODE></A> annotation.</p> +<p>An entity class may be defined with the <a href="../../../com/sleepycat/persist/model/Entity.html" title="annotation in com.sleepycat.persist.model"><code>Entity</code></a> annotation. For each entity class, +its primary key may be defined using the <a href="../../../com/sleepycat/persist/model/PrimaryKey.html" title="annotation in com.sleepycat.persist.model"><code>PrimaryKey</code></a> annotation and any number of +secondary keys may be defined using the <a href="../../../com/sleepycat/persist/model/SecondaryKey.html" title="annotation in com.sleepycat.persist.model"><code>SecondaryKey</code></a> annotation.</p> <p>In the following example, the <code>Person.ssn</code> (social security number) field is the primary key and the <code>Person.employerIds</code> field is a @@ -327,7 +338,7 @@ class Person { <p>A set of entity classes constitutes an <em>entity model</em>. In addition to isolated entity classes, an entity model may contain relationships between -entities. Relationships may be defined using the <A HREF="../../../com/sleepycat/persist/model/SecondaryKey.html" title="annotation in com.sleepycat.persist.model"><CODE>SecondaryKey</CODE></A> annotation. +entities. Relationships may be defined using the <a href="../../../com/sleepycat/persist/model/SecondaryKey.html" title="annotation in com.sleepycat.persist.model"><code>SecondaryKey</code></a> annotation. Many-to-one, one-to-many, many-to-many and one-to-one relationships are supported, as well as foreign key constraints.</p> @@ -336,9 +347,9 @@ supported, as well as foreign key constraints.</p> key constraints to guarantee that every element of the <code>employerIds</code> set is a valid <code>Employer</code> primary key.</p> -<p>For more information on the entity model, see the <A HREF="../../../com/sleepycat/persist/model/AnnotationModel.html" title="class in com.sleepycat.persist.model"><CODE>AnnotationModel</CODE></A> and the <A HREF="../../../com/sleepycat/persist/model/Entity.html" title="annotation in com.sleepycat.persist.model"><CODE>Entity</CODE></A> annotation.</p> +<p>For more information on the entity model, see the <a href="../../../com/sleepycat/persist/model/AnnotationModel.html" title="class in com.sleepycat.persist.model"><code>AnnotationModel</code></a> and the <a href="../../../com/sleepycat/persist/model/Entity.html" title="annotation in com.sleepycat.persist.model"><code>Entity</code></a> annotation.</p> -<p>The root object in the DPL is the <A HREF="../../../com/sleepycat/persist/EntityStore.html" title="class in com.sleepycat.persist"><CODE>EntityStore</CODE></A>. An entity store manages any number of objects for each entity +<p>The root object in the DPL is the <a href="../../../com/sleepycat/persist/EntityStore.html" title="class in com.sleepycat.persist"><code>EntityStore</code></a>. An entity store manages any number of objects for each entity class defined in the model. The store provides access to the primary and secondary indices for each entity class, for example:</p> @@ -623,7 +634,7 @@ Btree operations of the Berkeley DB engine. Unlike other persistence approaches, keys and indices are exposed for direct access and performance tuning. <p>Queries are implemented by calling methods of the primary and secondary -indices. An <A HREF="../../../com/sleepycat/persist/EntityJoin.html" title="class in com.sleepycat.persist"><CODE>EntityJoin</CODE></A> class is also +indices. An <a href="../../../com/sleepycat/persist/EntityJoin.html" title="class in com.sleepycat.persist"><code>EntityJoin</code></a> class is also available for performing equality joins. For example, the following code queries all of Bob's children that work for Gizmo Inc: <pre class="code"> @@ -644,7 +655,7 @@ try { <li>Object relationships are based on keys. When a <code>Person</code> with a given employer ID in its <code>employerIds</code> set is stored, the <code>Person</code> object becomes part of the collection of employees for that employer. This collection -of employees is accessed using a <A HREF="../../../com/sleepycat/persist/SecondaryIndex.html#subIndex(SK)"><CODE>SecondaryIndex.subIndex</CODE></A> for the +of employees is accessed using a <a href="../../../com/sleepycat/persist/SecondaryIndex.html#subIndex(SK)"><code>SecondaryIndex.subIndex</code></a> for the employer ID, as shown below: <pre class="code"> EntityCursor<Person> employees = @@ -667,7 +678,7 @@ bindings, provides maximum performance.</li> <a name="whichAPI"><h2>Which API to use?</h2></a> -<p>The Berkeley DB engine has a <A HREF="../../../com/sleepycat/db/package-summary.html"><CODE>Base API</CODE></A>, a <A HREF="../../../com/sleepycat/collections/package-summary.html"><CODE>Collections API</CODE></A> and a <A HREF="../../../com/sleepycat/persist/package-summary.html"><CODE>Direct Persistence Layer (DPL)</CODE></A>. Follow these guidelines if you are not sure +<p>The Berkeley DB engine has a <a href="../../../com/sleepycat/db/package-summary.html"><code>Base API</code></a>, a <a href="../../../com/sleepycat/collections/package-summary.html"><code>Collections API</code></a> and a <a href="../../../com/sleepycat/persist/package-summary.html"><code>Direct Persistence Layer (DPL)</code></a>. Follow these guidelines if you are not sure which API to use:</p> <ul> <li>When Java classes are used to represent domain objects in an application, @@ -694,7 +705,7 @@ for doing so.</p> <a name="genericTypes"><h3>Generic Types</h3></a> -<p>Generic types are used to provide type safety, especially for the <A HREF="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><CODE>PrimaryIndex</CODE></A>, <A HREF="../../../com/sleepycat/persist/SecondaryIndex.html" title="class in com.sleepycat.persist"><CODE>SecondaryIndex</CODE></A>, and <A HREF="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist"><CODE>EntityCursor</CODE></A> classes. If you don't wish to +<p>Generic types are used to provide type safety, especially for the <a href="../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><code>PrimaryIndex</code></a>, <a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="class in com.sleepycat.persist"><code>SecondaryIndex</code></a>, and <a href="../../../com/sleepycat/persist/EntityCursor.html" title="interface in com.sleepycat.persist"><code>EntityCursor</code></a> classes. If you don't wish to use generic types, you can simply not declare your index and cursor objects using generic type parameters. This is the same as using the Java 1.5 Collections Framework without using generic types.</p> @@ -702,7 +713,7 @@ Collections Framework without using generic types.</p> <a name="annotations"><h3>Annotations</h3></a> <p>If you don't wish to use annotations, you can provide another source of -metadata by implementing an <A HREF="../../../com/sleepycat/persist/model/EntityModel.html" title="class in com.sleepycat.persist.model"><CODE>EntityModel</CODE></A> class. For example, naming conventions, static members, or an XML +metadata by implementing an <a href="../../../com/sleepycat/persist/model/EntityModel.html" title="class in com.sleepycat.persist.model"><code>EntityModel</code></a> class. For example, naming conventions, static members, or an XML configuration file might be used as a source of metadata. However, if you don't use annotations then you won't be able to use bytecode enhancement, which is described next.</p> @@ -724,12 +735,12 @@ files are enhanced during a post-compilation step. Enhanced classes are used to efficiently access all fields and default constructors, including non-public members.</p> -<p>See <A HREF="../../../com/sleepycat/persist/model/ClassEnhancer.html" title="class in com.sleepycat.persist.model"><CODE>ClassEnhancer</CODE></A> for +<p>See <a href="../../../com/sleepycat/persist/model/ClassEnhancer.html" title="class in com.sleepycat.persist.model"><code>ClassEnhancer</code></a> for bytecode enhancement configuration details.</p> <p>If bytecode enhancement is not used as described above, the DPL will use reflection for accessing persistent fields and the default constructor. The -<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/reflect/AccessibleObject.html?is-external=true#setAccessible(java.lang.reflect.AccessibleObject[], boolean)" title="class or interface in java.lang.reflect"><CODE>AccessibleObject.setAccessible</CODE></A> method is called by the DPL to enable access to +<code>AccessibleObject.setAccessible</code> method is called by the DPL to enable access to non-public fields and constructors. If you are running under a Java security manager you must configure your security policy to allow the following permission:</p> @@ -757,66 +768,54 @@ However, this performance difference may or may not impact a given application since it may be overshadowed by other factors. Performance testing in a realistic usage scenario is the best way to determine the impact. If you are determined to avoid the use of reflection then option 3 above is -recommended.</p> -<P> - -<P> -<DL> -</DL> -<HR> - - +recommended.</p></div> +</div> <!-- ======= 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="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.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/db/package-summary.html"><B>PREV PACKAGE</B></A> - <A HREF="../../../com/sleepycat/persist/evolve/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../index.html?com/sleepycat/persist/package-summary.html" target="_top"><B>FRAMES</B></A> - <A HREF="package-summary.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 class="navBarCell1Rev">Package</li> +<li>Class</li> +<li><a href="package-use.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/db/package-summary.html">Prev Package</a></li> +<li><a href="../../../com/sleepycat/persist/evolve/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/sleepycat/persist/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> -</TABLE> -<A NAME="skip-navbar_bottom"></A> +</script> +</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> |