diff options
Diffstat (limited to 'docs/java/com/sleepycat/persist/model/EntityModel.html')
| -rw-r--r-- | docs/java/com/sleepycat/persist/model/EntityModel.html | 1133 |
1 files changed, 540 insertions, 593 deletions
diff --git a/docs/java/com/sleepycat/persist/model/EntityModel.html b/docs/java/com/sleepycat/persist/model/EntityModel.html index 9e9d3ea8..b31fd2fb 100644 --- a/docs/java/com/sleepycat/persist/model/EntityModel.html +++ b/docs/java/com/sleepycat/persist/model/EntityModel.html @@ -1,123 +1,122 @@ <!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> -EntityModel (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>EntityModel (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="EntityModel (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/EntityModel.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/EntityMetadata.html" title="class in com.sleepycat.persist.model"><B>PREV CLASS</B></A> - <A HREF="../../../../com/sleepycat/persist/model/FieldMetadata.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/EntityModel.html" target="_top"><B>FRAMES</B></A> - <A HREF="EntityModel.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/EntityModel.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/EntityMetadata.html" title="class in com.sleepycat.persist.model"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/sleepycat/persist/model/FieldMetadata.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/EntityModel.html" target="_top">Frames</a></li> +<li><a href="EntityModel.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.model</FONT> -<BR> -Class EntityModel</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.model.EntityModel</B> -</PRE> -<DL> -<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../com/sleepycat/persist/model/AnnotationModel.html" title="class in com.sleepycat.persist.model">AnnotationModel</A></DD> -</DL> -<HR> -<DL> -<DT><PRE>public abstract class <B>EntityModel</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 base class for classes that provide entity model metadata. An <A HREF="../../../../com/sleepycat/persist/model/EntityModel.html" title="class in com.sleepycat.persist.model"><CODE>EntityModel</CODE></A> defines entity classes, primary keys, secondary keys, and +<div class="header"> +<div class="subTitle">com.sleepycat.persist.model</div> +<h2 title="Class EntityModel" class="title">Class EntityModel</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.sleepycat.persist.model.EntityModel</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../com/sleepycat/persist/model/AnnotationModel.html" title="class in com.sleepycat.persist.model">AnnotationModel</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">EntityModel</span> +extends java.lang.Object</pre> +<div class="block">The base class for classes that provide entity model metadata. An <a href="../../../../com/sleepycat/persist/model/EntityModel.html" title="class in com.sleepycat.persist.model"><code>EntityModel</code></a> defines entity classes, primary keys, secondary keys, and relationships between entities. For each entity class that is part of the - model, a single <A HREF="../../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><CODE>PrimaryIndex</CODE></A> object and zero or more <A HREF="../../../../com/sleepycat/persist/SecondaryIndex.html" title="class in com.sleepycat.persist"><CODE>SecondaryIndex</CODE></A> objects may be accessed via an <A HREF="../../../../com/sleepycat/persist/EntityStore.html" title="class in com.sleepycat.persist"><CODE>EntityStore</CODE></A>. + model, a single <a href="../../../../com/sleepycat/persist/PrimaryIndex.html" title="class in com.sleepycat.persist"><code>PrimaryIndex</code></a> object and zero or more <a href="../../../../com/sleepycat/persist/SecondaryIndex.html" title="class in com.sleepycat.persist"><code>SecondaryIndex</code></a> objects may be accessed via an <a href="../../../../com/sleepycat/persist/EntityStore.html" title="class in com.sleepycat.persist"><code>EntityStore</code></a>. - <p>The built-in entity model, the <A HREF="../../../../com/sleepycat/persist/model/AnnotationModel.html" title="class in com.sleepycat.persist.model"><CODE>AnnotationModel</CODE></A>, is based on + <p>The built-in entity model, the <a href="../../../../com/sleepycat/persist/model/AnnotationModel.html" title="class in com.sleepycat.persist.model"><code>AnnotationModel</code></a>, is based on annotations that are added to entity classes and their key fields. Annotations are used in the examples in this package, and it is expected that annotations will normally be used; most readers should therefore skip - to the <A HREF="../../../../com/sleepycat/persist/model/AnnotationModel.html" title="class in com.sleepycat.persist.model"><CODE>AnnotationModel</CODE></A> class. However, a custom entity model class + to the <a href="../../../../com/sleepycat/persist/model/AnnotationModel.html" title="class in com.sleepycat.persist.model"><code>AnnotationModel</code></a> class. However, a custom entity model class may define its own metadata. This can be used to define entity classes and keys using mechanisms other than annotations.</p> <p>A concrete entity model class should extend this class and implement the - <A HREF="../../../../com/sleepycat/persist/model/EntityModel.html#getClassMetadata(java.lang.String)"><CODE>getClassMetadata(java.lang.String)</CODE></A>, <A HREF="../../../../com/sleepycat/persist/model/EntityModel.html#getEntityMetadata(java.lang.String)"><CODE>getEntityMetadata(java.lang.String)</CODE></A> and <A HREF="../../../../com/sleepycat/persist/model/EntityModel.html#getKnownClasses()"><CODE>getKnownClasses()</CODE></A> methods.</p> + <a href="../../../../com/sleepycat/persist/model/EntityModel.html#getClassMetadata(java.lang.String)"><code>getClassMetadata(java.lang.String)</code></a>, <a href="../../../../com/sleepycat/persist/model/EntityModel.html#getEntityMetadata(java.lang.String)"><code>getEntityMetadata(java.lang.String)</code></a> and <a href="../../../../com/sleepycat/persist/model/EntityModel.html#getKnownClasses()"><code>getKnownClasses()</code></a> methods.</p> <p>This is an abstract class rather than an interface to allow adding capabilities to the model at a future date without causing @@ -125,232 +124,209 @@ The base class for classes that provide entity model metadata. An <A HREF="../. returning new information about the model and subclasses may override this method to return the new information. Any new methods will have default implementations that return default values, and the use of the new - information will be optional.</p> -<P> - -<P> -<HR> - -<P> - + information will be optional.</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 ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>protected </CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/EntityModel.html#EntityModel()">EntityModel</A></B>()</CODE> - -<BR> - The default constructor for use by subclasses.</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="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/model/EntityModel.html#EntityModel()">EntityModel</a></strong>()</code> +<div class="block">The default constructor for use by subclasses.</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>static <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/EntityModel.html#classForName(java.lang.String)">classForName</A></B>(<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> className)</CODE> - -<BR> - <B>Deprecated.</B> <I>use <A HREF="../../../../com/sleepycat/persist/model/EntityModel.html#resolveClass(java.lang.String)"><CODE>resolveClass(java.lang.String)</CODE></A> instead. This method does not - use the environment's ClassLoader property.</I></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/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/EntityModel.html#convertRawObject(com.sleepycat.persist.raw.RawObject)">convertRawObject</A></B>(<A HREF="../../../../com/sleepycat/persist/raw/RawObject.html" title="class in com.sleepycat.persist.raw">RawObject</A> raw)</CODE> - -<BR> - Converts a given raw object to a live object according to the current - class definitions.</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/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../com/sleepycat/persist/raw/RawType.html" title="interface in com.sleepycat.persist.raw">RawType</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/EntityModel.html#getAllRawTypes()">getAllRawTypes</A></B>()</CODE> - -<BR> - Returns all versions of all known types.</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/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../com/sleepycat/persist/raw/RawType.html" title="interface in com.sleepycat.persist.raw">RawType</A>></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/EntityModel.html#getAllRawTypeVersions(java.lang.String)">getAllRawTypeVersions</A></B>(<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> className)</CODE> - -<BR> - Returns all known versions of type information for a given class name, - or null if no persistent version of the class is known.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>abstract <A HREF="../../../../com/sleepycat/persist/model/ClassMetadata.html" title="class in com.sleepycat.persist.model">ClassMetadata</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/EntityModel.html#getClassMetadata(java.lang.String)">getClassMetadata</A></B>(<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> className)</CODE> - -<BR> - Returns the metadata for a given persistent class name, including proxy - classes and entity classes.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>abstract <A HREF="../../../../com/sleepycat/persist/model/EntityMetadata.html" title="class in com.sleepycat.persist.model">EntityMetadata</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/EntityModel.html#getEntityMetadata(java.lang.String)">getEntityMetadata</A></B>(<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> className)</CODE> - -<BR> - Returns the metadata for a given entity class name.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>abstract <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">Set</A><<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/EntityModel.html#getKnownClasses()">getKnownClasses</A></B>()</CODE> - -<BR> - Returns the names of all known persistent classes.</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/Set.html?is-external=true" title="class or interface in java.util">Set</A><<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/EntityModel.html#getKnownSpecialClasses()">getKnownSpecialClasses</A></B>()</CODE> - -<BR> - Returns the names of all known persistent enum and array classes that - may be used to store persistent data.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../../com/sleepycat/persist/raw/RawType.html" title="interface in com.sleepycat.persist.raw">RawType</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/EntityModel.html#getRawType(java.lang.String)">getRawType</A></B>(<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> className)</CODE> - -<BR> - Returns the type information for the current version of a given class, - or null if the class is not currently persistent.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../../com/sleepycat/persist/raw/RawType.html" title="interface in com.sleepycat.persist.raw">RawType</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/EntityModel.html#getRawTypeVersion(java.lang.String, int)">getRawTypeVersion</A></B>(<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> className, - int version)</CODE> - -<BR> - Returns the type information for a given version of a given class, - or null if the given version of the class is unknown.</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/model/EntityModel.html#isOpen()">isOpen</A></B>()</CODE> - -<BR> - Returns whether the model is associated with an open store.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/EntityModel.html#registerClass(java.lang.Class)">registerClass</A></B>(<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> persistentClass)</CODE> - -<BR> - Registers a persistent class, most importantly, a <A HREF="../../../../com/sleepycat/persist/model/PersistentProxy.html" title="interface in com.sleepycat.persist.model"><CODE>PersistentProxy</CODE></A> class or entity subclass.</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/EntityModel.html#resolveClass(java.lang.String)">resolveClass</A></B>(<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> className)</CODE> - -<BR> - Should be called by entity model implementations instead of calling - Class.forName whenever loading an application class.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>protected void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/EntityModel.html#setCatalog(com.sleepycat.persist.impl.PersistCatalog)">setCatalog</A></B>(com.sleepycat.persist.impl.PersistCatalog newCatalog)</CODE> - -<BR> - Internal access method that should not be used by applications.</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>static java.lang.Class</code></td> +<td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/model/EntityModel.html#classForName(java.lang.String)">classForName</a></strong>(java.lang.String className)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>use <a href="../../../../com/sleepycat/persist/model/EntityModel.html#resolveClass(java.lang.String)"><code>resolveClass(java.lang.String)</code></a> instead. This method does not + use the environment's ClassLoader property.</i></div> +</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/model/EntityModel.html#convertRawObject(com.sleepycat.persist.raw.RawObject)">convertRawObject</a></strong>(<a href="../../../../com/sleepycat/persist/raw/RawObject.html" title="class in com.sleepycat.persist.raw">RawObject</a> raw)</code> +<div class="block">Converts a given raw object to a live object according to the current + class definitions.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/sleepycat/persist/raw/RawType.html" title="interface in com.sleepycat.persist.raw">RawType</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/model/EntityModel.html#getAllRawTypes()">getAllRawTypes</a></strong>()</code> +<div class="block">Returns all versions of all known types.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../com/sleepycat/persist/raw/RawType.html" title="interface in com.sleepycat.persist.raw">RawType</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/model/EntityModel.html#getAllRawTypeVersions(java.lang.String)">getAllRawTypeVersions</a></strong>(java.lang.String className)</code> +<div class="block">Returns all known versions of type information for a given class name, + or null if no persistent version of the class is known.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract <a href="../../../../com/sleepycat/persist/model/ClassMetadata.html" title="class in com.sleepycat.persist.model">ClassMetadata</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/model/EntityModel.html#getClassMetadata(java.lang.String)">getClassMetadata</a></strong>(java.lang.String className)</code> +<div class="block">Returns the metadata for a given persistent class name, including proxy + classes and entity classes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract <a href="../../../../com/sleepycat/persist/model/EntityMetadata.html" title="class in com.sleepycat.persist.model">EntityMetadata</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/model/EntityModel.html#getEntityMetadata(java.lang.String)">getEntityMetadata</a></strong>(java.lang.String className)</code> +<div class="block">Returns the metadata for a given entity class name.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract java.util.Set<java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/model/EntityModel.html#getKnownClasses()">getKnownClasses</a></strong>()</code> +<div class="block">Returns the names of all known persistent classes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Set<java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/model/EntityModel.html#getKnownSpecialClasses()">getKnownSpecialClasses</a></strong>()</code> +<div class="block">Returns the names of all known persistent enum and array classes that + may be used to store persistent data.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/sleepycat/persist/raw/RawType.html" title="interface in com.sleepycat.persist.raw">RawType</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/model/EntityModel.html#getRawType(java.lang.String)">getRawType</a></strong>(java.lang.String className)</code> +<div class="block">Returns the type information for the current version of a given class, + or null if the class is not currently persistent.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/sleepycat/persist/raw/RawType.html" title="interface in com.sleepycat.persist.raw">RawType</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/model/EntityModel.html#getRawTypeVersion(java.lang.String,%20int)">getRawTypeVersion</a></strong>(java.lang.String className, + int version)</code> +<div class="block">Returns the type information for a given version of a given class, + or null if the given version of the class is unknown.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/model/EntityModel.html#isOpen()">isOpen</a></strong>()</code> +<div class="block">Returns whether the model is associated with an open store.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/model/EntityModel.html#registerClass(java.lang.Class)">registerClass</a></strong>(java.lang.Class persistentClass)</code> +<div class="block">Registers a persistent class, most importantly, a <a href="../../../../com/sleepycat/persist/model/PersistentProxy.html" title="interface in com.sleepycat.persist.model"><code>PersistentProxy</code></a> class or entity subclass.</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/EntityModel.html#resolveClass(java.lang.String)">resolveClass</a></strong>(java.lang.String className)</code> +<div class="block">Should be called by entity model implementations instead of calling + Class.forName whenever loading an application class.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/model/EntityModel.html#setCatalog(com.sleepycat.persist.impl.PersistCatalog)">setCatalog</a></strong>(com.sleepycat.persist.impl.PersistCatalog newCatalog)</code> +<div class="block">Internal access method that should not be used by applications.</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="EntityModel()"><!-- --></A><H3> -EntityModel</H3> -<PRE> -protected <B>EntityModel</B>()</PRE> -<DL> -<DD>The default constructor for use by subclasses. -<P> -</DL> - +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="EntityModel()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>EntityModel</h4> +<pre>protected EntityModel()</pre> +<div class="block">The default constructor for use by subclasses.</div> +</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="isOpen()"><!-- --></A><H3> -isOpen</H3> -<PRE> -public final boolean <B>isOpen</B>()</PRE> -<DL> -<DD>Returns whether the model is associated with an open store. - - <p>The <A HREF="../../../../com/sleepycat/persist/model/EntityModel.html#registerClass(java.lang.Class)"><CODE>registerClass(java.lang.Class)</CODE></A> method may only be called when the model +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="isOpen()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isOpen</h4> +<pre>public final boolean isOpen()</pre> +<div class="block">Returns whether the model is associated with an open store. + + <p>The <a href="../../../../com/sleepycat/persist/model/EntityModel.html#registerClass(java.lang.Class)"><code>registerClass(java.lang.Class)</code></a> method may only be called when the model is not yet open. Certain other methods may only be called when the model is open:</p> <ul> - <li><A HREF="../../../../com/sleepycat/persist/model/EntityModel.html#convertRawObject(com.sleepycat.persist.raw.RawObject)"><CODE>convertRawObject(com.sleepycat.persist.raw.RawObject)</CODE></A></li> - <li><A HREF="../../../../com/sleepycat/persist/model/EntityModel.html#getAllRawTypeVersions(java.lang.String)"><CODE>getAllRawTypeVersions(java.lang.String)</CODE></A></li> - <li><A HREF="../../../../com/sleepycat/persist/model/EntityModel.html#getRawType(java.lang.String)"><CODE>getRawType(java.lang.String)</CODE></A></li> - <li><A HREF="../../../../com/sleepycat/persist/model/EntityModel.html#getRawTypeVersion(java.lang.String, int)"><CODE>getRawTypeVersion(java.lang.String, int)</CODE></A></li> - </ul> -<P> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="registerClass(java.lang.Class)"><!-- --></A><H3> -registerClass</H3> -<PRE> -public final void <B>registerClass</B>(<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> persistentClass)</PRE> -<DL> -<DD>Registers a persistent class, most importantly, a <A HREF="../../../../com/sleepycat/persist/model/PersistentProxy.html" title="interface in com.sleepycat.persist.model"><CODE>PersistentProxy</CODE></A> class or entity subclass. Also registers an enum or + <li><a href="../../../../com/sleepycat/persist/model/EntityModel.html#convertRawObject(com.sleepycat.persist.raw.RawObject)"><code>convertRawObject(com.sleepycat.persist.raw.RawObject)</code></a></li> + <li><a href="../../../../com/sleepycat/persist/model/EntityModel.html#getAllRawTypeVersions(java.lang.String)"><code>getAllRawTypeVersions(java.lang.String)</code></a></li> + <li><a href="../../../../com/sleepycat/persist/model/EntityModel.html#getRawType(java.lang.String)"><code>getRawType(java.lang.String)</code></a></li> + <li><a href="../../../../com/sleepycat/persist/model/EntityModel.html#getRawTypeVersion(java.lang.String,%20int)"><code>getRawTypeVersion(java.lang.String, int)</code></a></li> + </ul></div> +</li> +</ul> +<a name="registerClass(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>registerClass</h4> +<pre>public final void registerClass(java.lang.Class persistentClass)</pre> +<div class="block">Registers a persistent class, most importantly, a <a href="../../../../com/sleepycat/persist/model/PersistentProxy.html" title="interface in com.sleepycat.persist.model"><code>PersistentProxy</code></a> class or entity subclass. Also registers an enum or array class. <p>Any persistent class , enum class or array may be registered in @@ -358,8 +334,8 @@ public final void <B>registerClass</B>(<A HREF="http://download.oracle.com/javas database when an instance of the class is first stored. This method <em>must</em> be called in three cases:</p> <ol> - <li>to register all <A HREF="../../../../com/sleepycat/persist/model/PersistentProxy.html" title="interface in com.sleepycat.persist.model"><CODE>PersistentProxy</CODE></A> classes, and</li> - <li>to register an entity subclass defining a secondary key, if <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> is not called for the + <li>to register all <a href="../../../../com/sleepycat/persist/model/PersistentProxy.html" title="interface in com.sleepycat.persist.model"><code>PersistentProxy</code></a> classes, and</li> + <li>to register an entity subclass defining a secondary key, if <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> is not called for the subclass, and</li> <li>to register all new enum or array classes, if the these enum or array classes are unknown for DPL but will be used in a Converter @@ -383,291 +359,262 @@ public final void <B>registerClass</B>(<A HREF="http://download.oracle.com/javas EntityStore store = new EntityStore(..., config);</pre> <p>This method must be called before opening a store based on this - model.</p> -<P> -<DD><DL> - -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if this method is called for a model that - is associated with an open store. -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the given class is not persistent - or has a different class loader than previously registered classes.</DL> -</DD> -</DL> -<HR> - -<A NAME="setCatalog(com.sleepycat.persist.impl.PersistCatalog)"><!-- --></A><H3> -setCatalog</H3> -<PRE> -protected void <B>setCatalog</B>(com.sleepycat.persist.impl.PersistCatalog newCatalog)</PRE> -<DL> -<DD>Internal access method that should not be used by applications. + model.</p></div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if this method is called for a model that + is associated with an open store.</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if the given class is not persistent + or has a different class loader than previously registered classes.</dd></dl> +</li> +</ul> +<a name="setCatalog(com.sleepycat.persist.impl.PersistCatalog)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCatalog</h4> +<pre>protected void setCatalog(com.sleepycat.persist.impl.PersistCatalog newCatalog)</pre> +<div class="block">Internal access method that should not be used by applications. This method is used to initialize the model when catalog creation is complete, and reinitialize it when a Replica refresh occurs. See - Store.refresh. -<P> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="getClassMetadata(java.lang.String)"><!-- --></A><H3> -getClassMetadata</H3> -<PRE> -public abstract <A HREF="../../../../com/sleepycat/persist/model/ClassMetadata.html" title="class in com.sleepycat.persist.model">ClassMetadata</A> <B>getClassMetadata</B>(<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> className)</PRE> -<DL> -<DD>Returns the metadata for a given persistent class name, including proxy - classes and entity classes. -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>the metadata or null if the class is not persistent or does not - exist.</DL> -</DD> -</DL> -<HR> - -<A NAME="getEntityMetadata(java.lang.String)"><!-- --></A><H3> -getEntityMetadata</H3> -<PRE> -public abstract <A HREF="../../../../com/sleepycat/persist/model/EntityMetadata.html" title="class in com.sleepycat.persist.model">EntityMetadata</A> <B>getEntityMetadata</B>(<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> className)</PRE> -<DL> -<DD>Returns the metadata for a given entity class name. -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>the metadata or null if the class is not an entity class or does - not exist.</DL> -</DD> -</DL> -<HR> - -<A NAME="getKnownClasses()"><!-- --></A><H3> -getKnownClasses</H3> -<PRE> -public abstract <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">Set</A><<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>getKnownClasses</B>()</PRE> -<DL> -<DD>Returns the names of all known persistent classes. A type becomes known + Store.refresh.</div> +</li> +</ul> +<a name="getClassMetadata(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getClassMetadata</h4> +<pre>public abstract <a href="../../../../com/sleepycat/persist/model/ClassMetadata.html" title="class in com.sleepycat.persist.model">ClassMetadata</a> getClassMetadata(java.lang.String className)</pre> +<div class="block">Returns the metadata for a given persistent class name, including proxy + classes and entity classes.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the metadata or null if the class is not persistent or does not + exist.</dd></dl> +</li> +</ul> +<a name="getEntityMetadata(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEntityMetadata</h4> +<pre>public abstract <a href="../../../../com/sleepycat/persist/model/EntityMetadata.html" title="class in com.sleepycat.persist.model">EntityMetadata</a> getEntityMetadata(java.lang.String className)</pre> +<div class="block">Returns the metadata for a given entity class name.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the metadata or null if the class is not an entity class or does + not exist.</dd></dl> +</li> +</ul> +<a name="getKnownClasses()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getKnownClasses</h4> +<pre>public abstract java.util.Set<java.lang.String> getKnownClasses()</pre> +<div class="block">Returns the names of all known persistent classes. A type becomes known when an instance of the type is stored for the first time or metadata or - type information is queried for a specific class name. -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>an unmodifiable set of class names. -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if this method is called for a model that - is not associated with an open store.</DL> -</DD> -</DL> -<HR> - -<A NAME="getKnownSpecialClasses()"><!-- --></A><H3> -getKnownSpecialClasses</H3> -<PRE> -public <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">Set</A><<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>getKnownSpecialClasses</B>()</PRE> -<DL> -<DD>Returns the names of all known persistent enum and array classes that + type information is queried for a specific class name.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an unmodifiable set of class names.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if this method is called for a model that + is not associated with an open store.</dd></dl> +</li> +</ul> +<a name="getKnownSpecialClasses()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getKnownSpecialClasses</h4> +<pre>public java.util.Set<java.lang.String> getKnownSpecialClasses()</pre> +<div class="block">Returns the names of all known persistent enum and array classes that may be used to store persistent data. This differs from - <A HREF="../../../../com/sleepycat/persist/model/EntityModel.html#getKnownClasses()"><CODE>getKnownClasses()</CODE></A>, which does not return enum and array classes - because they have no metadata. -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>an unmodifiable set of enum and array class names. -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if this method is called for a model that - is not associated with an open store.</DL> -</DD> -</DL> -<HR> - -<A NAME="getRawType(java.lang.String)"><!-- --></A><H3> -getRawType</H3> -<PRE> -public final <A HREF="../../../../com/sleepycat/persist/raw/RawType.html" title="interface in com.sleepycat.persist.raw">RawType</A> <B>getRawType</B>(<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> className)</PRE> -<DL> -<DD>Returns the type information for the current version of a given class, - or null if the class is not currently persistent. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>className</CODE> - the name of the current version of the class. -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if this method is called for a model that - is not associated with an open store.</DL> -</DD> -</DL> -<HR> - -<A NAME="getRawTypeVersion(java.lang.String, int)"><!-- --></A><H3> -getRawTypeVersion</H3> -<PRE> -public final <A HREF="../../../../com/sleepycat/persist/raw/RawType.html" title="interface in com.sleepycat.persist.raw">RawType</A> <B>getRawTypeVersion</B>(<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> className, - int version)</PRE> -<DL> -<DD>Returns the type information for a given version of a given class, - or null if the given version of the class is unknown. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>className</CODE> - the name of the latest version of the class.<DD><CODE>version</CODE> - the desired version of the class. -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if this method is called for a model that - is not associated with an open store.</DL> -</DD> -</DL> -<HR> - -<A NAME="getAllRawTypeVersions(java.lang.String)"><!-- --></A><H3> -getAllRawTypeVersions</H3> -<PRE> -public final <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../com/sleepycat/persist/raw/RawType.html" title="interface in com.sleepycat.persist.raw">RawType</A>> <B>getAllRawTypeVersions</B>(<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> className)</PRE> -<DL> -<DD>Returns all known versions of type information for a given class name, - or null if no persistent version of the class is known. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>className</CODE> - the name of the latest version of the class. -<DT><B>Returns:</B><DD>an unmodifiable list of types for the given class name in order - from most recent to least recent. -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if this method is called for a model that - is not associated with an open store.</DL> -</DD> -</DL> -<HR> - -<A NAME="getAllRawTypes()"><!-- --></A><H3> -getAllRawTypes</H3> -<PRE> -public final <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../com/sleepycat/persist/raw/RawType.html" title="interface in com.sleepycat.persist.raw">RawType</A>> <B>getAllRawTypes</B>()</PRE> -<DL> -<DD>Returns all versions of all known types. -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>an unmodifiable list of types. -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if this method is called for a model that - is not associated with an open store.</DL> -</DD> -</DL> -<HR> - -<A NAME="convertRawObject(com.sleepycat.persist.raw.RawObject)"><!-- --></A><H3> -convertRawObject</H3> -<PRE> -public final <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>convertRawObject</B>(<A HREF="../../../../com/sleepycat/persist/raw/RawObject.html" title="class in com.sleepycat.persist.raw">RawObject</A> raw)</PRE> -<DL> -<DD>Converts a given raw object to a live object according to the current + <a href="../../../../com/sleepycat/persist/model/EntityModel.html#getKnownClasses()"><code>getKnownClasses()</code></a>, which does not return enum and array classes + because they have no metadata.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an unmodifiable set of enum and array class names.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if this method is called for a model that + is not associated with an open store.</dd></dl> +</li> +</ul> +<a name="getRawType(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRawType</h4> +<pre>public final <a href="../../../../com/sleepycat/persist/raw/RawType.html" title="interface in com.sleepycat.persist.raw">RawType</a> getRawType(java.lang.String className)</pre> +<div class="block">Returns the type information for the current version of a given class, + or null if the class is not currently persistent.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>className</code> - the name of the current version of the class.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if this method is called for a model that + is not associated with an open store.</dd></dl> +</li> +</ul> +<a name="getRawTypeVersion(java.lang.String, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRawTypeVersion</h4> +<pre>public final <a href="../../../../com/sleepycat/persist/raw/RawType.html" title="interface in com.sleepycat.persist.raw">RawType</a> getRawTypeVersion(java.lang.String className, + int version)</pre> +<div class="block">Returns the type information for a given version of a given class, + or null if the given version of the class is unknown.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>className</code> - the name of the latest version of the class.</dd><dd><code>version</code> - the desired version of the class.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if this method is called for a model that + is not associated with an open store.</dd></dl> +</li> +</ul> +<a name="getAllRawTypeVersions(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAllRawTypeVersions</h4> +<pre>public final java.util.List<<a href="../../../../com/sleepycat/persist/raw/RawType.html" title="interface in com.sleepycat.persist.raw">RawType</a>> getAllRawTypeVersions(java.lang.String className)</pre> +<div class="block">Returns all known versions of type information for a given class name, + or null if no persistent version of the class is known.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>className</code> - the name of the latest version of the class.</dd> +<dt><span class="strong">Returns:</span></dt><dd>an unmodifiable list of types for the given class name in order + from most recent to least recent.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if this method is called for a model that + is not associated with an open store.</dd></dl> +</li> +</ul> +<a name="getAllRawTypes()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAllRawTypes</h4> +<pre>public final java.util.List<<a href="../../../../com/sleepycat/persist/raw/RawType.html" title="interface in com.sleepycat.persist.raw">RawType</a>> getAllRawTypes()</pre> +<div class="block">Returns all versions of all known types.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an unmodifiable list of types.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if this method is called for a model that + is not associated with an open store.</dd></dl> +</li> +</ul> +<a name="convertRawObject(com.sleepycat.persist.raw.RawObject)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>convertRawObject</h4> +<pre>public final java.lang.Object convertRawObject(<a href="../../../../com/sleepycat/persist/raw/RawObject.html" title="class in com.sleepycat.persist.raw">RawObject</a> raw)</pre> +<div class="block">Converts a given raw object to a live object according to the current class definitions. <p>The given raw object must conform to the current class definitions. - However, the raw type (<A HREF="../../../../com/sleepycat/persist/raw/RawObject.html#getType()"><CODE>RawObject.getType()</CODE></A>) is allowed to be from + However, the raw type (<a href="../../../../com/sleepycat/persist/raw/RawObject.html#getType()"><code>RawObject.getType()</code></a>) is allowed to be from a different store, as long as the class names and the value types match. This allows converting raw objects that are read from one store to live - objects in another store, for example, in a conversion program.</p> -<P> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="resolveClass(java.lang.String)"><!-- --></A><H3> -resolveClass</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> <B>resolveClass</B>(<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> className) - throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/ClassNotFoundException.html?is-external=true" title="class or interface in java.lang">ClassNotFoundException</A></PRE> -<DL> -<DD>Should be called by entity model implementations instead of calling + objects in another store, for example, in a conversion program.</p></div> +</li> +</ul> +<a name="resolveClass(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>resolveClass</h4> +<pre>public java.lang.Class resolveClass(java.lang.String className) + throws java.lang.ClassNotFoundException</pre> +<div class="block">Should be called by entity model implementations instead of calling Class.forName whenever loading an application class. This method honors - the BDB JE environment's ClassLoader property and uses <A HREF="../../../../com/sleepycat/util/ClassResolver.html" title="class in com.sleepycat.util"><CODE>ClassResolver</CODE></A> to implement the class loading policy. -<P> -<DD><DL> - -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/ClassNotFoundException.html?is-external=true" title="class or interface in java.lang">ClassNotFoundException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="classForName(java.lang.String)"><!-- --></A><H3> -classForName</H3> -<PRE> -public static <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>classForName</B>(<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> className) - throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/ClassNotFoundException.html?is-external=true" title="class or interface in java.lang">ClassNotFoundException</A></PRE> -<DL> -<DD><B>Deprecated.</B> <I>use <A HREF="../../../../com/sleepycat/persist/model/EntityModel.html#resolveClass(java.lang.String)"><CODE>resolveClass(java.lang.String)</CODE></A> instead. This method does not - use the environment's ClassLoader property.</I> -<P> -<DD><DL> - -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/ClassNotFoundException.html?is-external=true" title="class or interface in java.lang">ClassNotFoundException</A></CODE></DL> -</DD> -</DL> + the BDB JE environment's ClassLoader property and uses <a href="../../../../com/sleepycat/util/ClassResolver.html" title="class in com.sleepycat.util"><code>ClassResolver</code></a> to implement the class loading policy.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.ClassNotFoundException</code></dd></dl> +</li> +</ul> +<a name="classForName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>classForName</h4> +<pre>public static java.lang.Class classForName(java.lang.String className) + throws java.lang.ClassNotFoundException</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>use <a href="../../../../com/sleepycat/persist/model/EntityModel.html#resolveClass(java.lang.String)"><code>resolveClass(java.lang.String)</code></a> instead. This method does not + use the environment's ClassLoader property.</i></div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.ClassNotFoundException</code></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/EntityModel.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/EntityMetadata.html" title="class in com.sleepycat.persist.model"><B>PREV CLASS</B></A> - <A HREF="../../../../com/sleepycat/persist/model/FieldMetadata.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/EntityModel.html" target="_top"><B>FRAMES</B></A> - <A HREF="EntityModel.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/EntityModel.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/EntityMetadata.html" title="class in com.sleepycat.persist.model"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/sleepycat/persist/model/FieldMetadata.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/EntityModel.html" target="_top">Frames</a></li> +<li><a href="EntityModel.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> |