1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!--NewPage--> 3<HTML> 4<HEAD> 5<!-- Generated by javadoc (build 1.6.0_03) on Mon Apr 12 16:25:50 EDT 2010 --> 6<TITLE> 7ClassMetadata (Oracle - Berkeley DB Java API) 8</TITLE> 9 10<META NAME="date" CONTENT="2010-04-12"> 11 12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../style.css" TITLE="Style"> 13 14<SCRIPT type="text/javascript"> 15function windowTitle() 16{ 17 if (location.href.indexOf('is-external=true') == -1) { 18 parent.document.title="ClassMetadata (Oracle - Berkeley DB Java API)"; 19 } 20} 21</SCRIPT> 22<NOSCRIPT> 23</NOSCRIPT> 24 25</HEAD> 26 27<BODY BGCOLOR="white" onload="windowTitle();"> 28<HR> 29 30 31<!-- ========= START OF TOP NAVBAR ======= --> 32<A NAME="navbar_top"><!-- --></A> 33<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 34<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 35<TR> 36<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 37<A NAME="navbar_top_firstrow"><!-- --></A> 38<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 39 <TR ALIGN="center" VALIGN="top"> 40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ClassMetadata.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 48 </TR> 49</TABLE> 50</TD> 51<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 52<b>Berkeley DB</b><br><font size="-1"> version 4.8.30</font></EM> 53</TD> 54</TR> 55 56<TR> 57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 58 <A HREF="../../../../com/sleepycat/persist/model/ClassEnhancer.html" title="class in com.sleepycat.persist.model"><B>PREV CLASS</B></A> 59 <A HREF="../../../../com/sleepycat/persist/model/DeleteAction.html" title="enum in com.sleepycat.persist.model"><B>NEXT CLASS</B></A></FONT></TD> 60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 61 <A HREF="../../../../index.html?com/sleepycat/persist/model/ClassMetadata.html" target="_top"><B>FRAMES</B></A> 62 <A HREF="ClassMetadata.html" target="_top"><B>NO FRAMES</B></A> 63 <SCRIPT type="text/javascript"> 64 <!-- 65 if(window==top) { 66 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 67 } 68 //--> 69</SCRIPT> 70<NOSCRIPT> 71 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 72</NOSCRIPT> 73 74 75</FONT></TD> 76</TR> 77<TR> 78<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 79 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 81DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 82</TR> 83</TABLE> 84<A NAME="skip-navbar_top"></A> 85<!-- ========= END OF TOP NAVBAR ========= --> 86 87<HR> 88<!-- ======== START OF CLASS DATA ======== --> 89<H2> 90<FONT SIZE="-1"> 91com.sleepycat.persist.model</FONT> 92<BR> 93Class ClassMetadata</H2> 94<PRE> 95<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> 96 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.persist.model.ClassMetadata</B> 97</PRE> 98<DL> 99<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></DD> 100</DL> 101<HR> 102<DL> 103<DT><PRE>public class <B>ClassMetadata</B><DT>extends <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></DL> 104</PRE> 105 106<P> 107The metadata for a persistent class. A persistent class may be specified 108 with the <A HREF="../../../../com/sleepycat/persist/model/Entity.html" title="annotation in com.sleepycat.persist.model"><CODE>Entity</CODE></A> or <A HREF="../../../../com/sleepycat/persist/model/Persistent.html" title="annotation in com.sleepycat.persist.model"><CODE>Persistent</CODE></A> annotation. 109 110 <p><code>ClassMetadata</code> objects are thread-safe. Multiple threads may 111 safely call the methods of a shared <code>ClassMetadata</code> object.</p> 112 113 <p>This and other metadata classes are classes rather than interfaces to 114 allow adding properties to the model at a future date without causing 115 incompatibilities. Any such property will be given a default value and 116 its use will be optional.</p> 117<P> 118 119<P> 120<DL> 121<DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#com.sleepycat.persist.model.ClassMetadata">Serialized Form</A></DL> 122<HR> 123 124<P> 125 126<!-- ======== CONSTRUCTOR SUMMARY ======== --> 127 128<A NAME="constructor_summary"><!-- --></A> 129<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 130<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 131<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 132<B>Constructor Summary</B></FONT></TH> 133</TR> 134<TR BGCOLOR="white" CLASS="TableRowColor"> 135<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/ClassMetadata.html#ClassMetadata(java.lang.String, int, java.lang.String, boolean, com.sleepycat.persist.model.PrimaryKeyMetadata, java.util.Map, java.util.List)">ClassMetadata</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> className, 136 int version, 137 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> proxiedClassName, 138 boolean entityClass, 139 <A HREF="../../../../com/sleepycat/persist/model/PrimaryKeyMetadata.html" title="class in com.sleepycat.persist.model">PrimaryKeyMetadata</A> primaryKey, 140 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="../../../../com/sleepycat/persist/model/SecondaryKeyMetadata.html" title="class in com.sleepycat.persist.model">SecondaryKeyMetadata</A>> secondaryKeys, 141 <A HREF="http://java.sun.com/j2se/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/model/FieldMetadata.html" title="class in com.sleepycat.persist.model">FieldMetadata</A>> compositeKeyFields)</CODE> 142 143<BR> 144 Used by an <code>EntityModel</code> to construct persistent class metadata.</TD> 145</TR> 146<TR BGCOLOR="white" CLASS="TableRowColor"> 147<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/ClassMetadata.html#ClassMetadata(java.lang.String, int, java.lang.String, boolean, com.sleepycat.persist.model.PrimaryKeyMetadata, java.util.Map, java.util.List, java.util.Collection)">ClassMetadata</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> className, 148 int version, 149 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> proxiedClassName, 150 boolean entityClass, 151 <A HREF="../../../../com/sleepycat/persist/model/PrimaryKeyMetadata.html" title="class in com.sleepycat.persist.model">PrimaryKeyMetadata</A> primaryKey, 152 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="../../../../com/sleepycat/persist/model/SecondaryKeyMetadata.html" title="class in com.sleepycat.persist.model">SecondaryKeyMetadata</A>> secondaryKeys, 153 <A HREF="http://java.sun.com/j2se/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/model/FieldMetadata.html" title="class in com.sleepycat.persist.model">FieldMetadata</A>> compositeKeyFields, 154 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="../../../../com/sleepycat/persist/model/FieldMetadata.html" title="class in com.sleepycat.persist.model">FieldMetadata</A>> persistentFields)</CODE> 155 156<BR> 157 Used by an <code>EntityModel</code> to construct persistent class metadata.</TD> 158</TR> 159</TABLE> 160 161<!-- ========== METHOD SUMMARY =========== --> 162 163<A NAME="method_summary"><!-- --></A> 164<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 165<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 166<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 167<B>Method Summary</B></FONT></TH> 168</TR> 169<TR BGCOLOR="white" CLASS="TableRowColor"> 170<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 171<CODE> boolean</CODE></FONT></TD> 172<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/ClassMetadata.html#equals(java.lang.Object)">equals</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> other)</CODE> 173 174<BR> 175 </TD> 176</TR> 177<TR BGCOLOR="white" CLASS="TableRowColor"> 178<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 179<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> 180<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/ClassMetadata.html#getClassName()">getClassName</A></B>()</CODE> 181 182<BR> 183 Returns the name of the persistent class.</TD> 184</TR> 185<TR BGCOLOR="white" CLASS="TableRowColor"> 186<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 187<CODE> <A HREF="http://java.sun.com/j2se/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/model/FieldMetadata.html" title="class in com.sleepycat.persist.model">FieldMetadata</A>></CODE></FONT></TD> 188<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/ClassMetadata.html#getCompositeKeyFields()">getCompositeKeyFields</A></B>()</CODE> 189 190<BR> 191 Returns an unmodifiable list of metadata for the fields making up a 192 composite key, or null if this is a not a composite key class.</TD> 193</TR> 194<TR BGCOLOR="white" CLASS="TableRowColor"> 195<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 196<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="../../../../com/sleepycat/persist/model/FieldMetadata.html" title="class in com.sleepycat.persist.model">FieldMetadata</A>></CODE></FONT></TD> 197<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/ClassMetadata.html#getPersistentFields()">getPersistentFields</A></B>()</CODE> 198 199<BR> 200 Returns an unmodifiable list of metadata for the persistent fields in 201 this class, or null if the default rules for persistent fields should be 202 used.</TD> 203</TR> 204<TR BGCOLOR="white" CLASS="TableRowColor"> 205<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 206<CODE> <A HREF="../../../../com/sleepycat/persist/model/PrimaryKeyMetadata.html" title="class in com.sleepycat.persist.model">PrimaryKeyMetadata</A></CODE></FONT></TD> 207<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/ClassMetadata.html#getPrimaryKey()">getPrimaryKey</A></B>()</CODE> 208 209<BR> 210 Returns the primary key metadata for a key declared in this class, or 211 null if none is declared.</TD> 212</TR> 213<TR BGCOLOR="white" CLASS="TableRowColor"> 214<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 215<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> 216<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/ClassMetadata.html#getProxiedClassName()">getProxiedClassName</A></B>()</CODE> 217 218<BR> 219 Returns the class name of the proxied class if this class is a <A HREF="../../../../com/sleepycat/persist/model/PersistentProxy.html" title="interface in com.sleepycat.persist.model"><CODE>PersistentProxy</CODE></A>, or null otherwise.</TD> 220</TR> 221<TR BGCOLOR="white" CLASS="TableRowColor"> 222<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 223<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="../../../../com/sleepycat/persist/model/SecondaryKeyMetadata.html" title="class in com.sleepycat.persist.model">SecondaryKeyMetadata</A>></CODE></FONT></TD> 224<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/ClassMetadata.html#getSecondaryKeys()">getSecondaryKeys</A></B>()</CODE> 225 226<BR> 227 Returns an unmodifiable map of key name (which may be different from 228 field name) to secondary key metadata for all secondary keys declared in 229 this class, or null if no secondary keys are declared in this class.</TD> 230</TR> 231<TR BGCOLOR="white" CLASS="TableRowColor"> 232<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 233<CODE> int</CODE></FONT></TD> 234<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/ClassMetadata.html#getVersion()">getVersion</A></B>()</CODE> 235 236<BR> 237 Returns the version of this persistent class.</TD> 238</TR> 239<TR BGCOLOR="white" CLASS="TableRowColor"> 240<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 241<CODE> int</CODE></FONT></TD> 242<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/ClassMetadata.html#hashCode()">hashCode</A></B>()</CODE> 243 244<BR> 245 </TD> 246</TR> 247<TR BGCOLOR="white" CLASS="TableRowColor"> 248<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 249<CODE> boolean</CODE></FONT></TD> 250<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/ClassMetadata.html#isEntityClass()">isEntityClass</A></B>()</CODE> 251 252<BR> 253 Returns whether this class is an entity class.</TD> 254</TR> 255</TABLE> 256 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 257<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 258<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 259<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> 260</TR> 261<TR BGCOLOR="white" CLASS="TableRowColor"> 262<TD><CODE><A HREF="http://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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> 263</TR> 264</TABLE> 265 266<P> 267 268<!-- ========= CONSTRUCTOR DETAIL ======== --> 269 270<A NAME="constructor_detail"><!-- --></A> 271<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 272<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 273<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 274<B>Constructor Detail</B></FONT></TH> 275</TR> 276</TABLE> 277 278<A NAME="ClassMetadata(java.lang.String, int, java.lang.String, boolean, com.sleepycat.persist.model.PrimaryKeyMetadata, java.util.Map, java.util.List)"><!-- --></A><H3> 279ClassMetadata</H3> 280<PRE> 281public <B>ClassMetadata</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> className, 282 int version, 283 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> proxiedClassName, 284 boolean entityClass, 285 <A HREF="../../../../com/sleepycat/persist/model/PrimaryKeyMetadata.html" title="class in com.sleepycat.persist.model">PrimaryKeyMetadata</A> primaryKey, 286 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="../../../../com/sleepycat/persist/model/SecondaryKeyMetadata.html" title="class in com.sleepycat.persist.model">SecondaryKeyMetadata</A>> secondaryKeys, 287 <A HREF="http://java.sun.com/j2se/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/model/FieldMetadata.html" title="class in com.sleepycat.persist.model">FieldMetadata</A>> compositeKeyFields)</PRE> 288<DL> 289<DD>Used by an <code>EntityModel</code> to construct persistent class metadata. 290 The optional <A HREF="../../../../com/sleepycat/persist/model/ClassMetadata.html#getPersistentFields()"><CODE>getPersistentFields()</CODE></A> property will be set to null. 291<P> 292</DL> 293<HR> 294 295<A NAME="ClassMetadata(java.lang.String, int, java.lang.String, boolean, com.sleepycat.persist.model.PrimaryKeyMetadata, java.util.Map, java.util.List, java.util.Collection)"><!-- --></A><H3> 296ClassMetadata</H3> 297<PRE> 298public <B>ClassMetadata</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> className, 299 int version, 300 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> proxiedClassName, 301 boolean entityClass, 302 <A HREF="../../../../com/sleepycat/persist/model/PrimaryKeyMetadata.html" title="class in com.sleepycat.persist.model">PrimaryKeyMetadata</A> primaryKey, 303 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="../../../../com/sleepycat/persist/model/SecondaryKeyMetadata.html" title="class in com.sleepycat.persist.model">SecondaryKeyMetadata</A>> secondaryKeys, 304 <A HREF="http://java.sun.com/j2se/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/model/FieldMetadata.html" title="class in com.sleepycat.persist.model">FieldMetadata</A>> compositeKeyFields, 305 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="../../../../com/sleepycat/persist/model/FieldMetadata.html" title="class in com.sleepycat.persist.model">FieldMetadata</A>> persistentFields)</PRE> 306<DL> 307<DD>Used by an <code>EntityModel</code> to construct persistent class metadata. 308<P> 309</DL> 310 311<!-- ============ METHOD DETAIL ========== --> 312 313<A NAME="method_detail"><!-- --></A> 314<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 315<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 316<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 317<B>Method Detail</B></FONT></TH> 318</TR> 319</TABLE> 320 321<A NAME="getClassName()"><!-- --></A><H3> 322getClassName</H3> 323<PRE> 324public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getClassName</B>()</PRE> 325<DL> 326<DD>Returns the name of the persistent class. 327<P> 328<DD><DL> 329</DL> 330</DD> 331<DD><DL> 332</DL> 333</DD> 334</DL> 335<HR> 336 337<A NAME="getVersion()"><!-- --></A><H3> 338getVersion</H3> 339<PRE> 340public int <B>getVersion</B>()</PRE> 341<DL> 342<DD>Returns the version of this persistent class. This may be specified 343 using the <A HREF="../../../../com/sleepycat/persist/model/Entity.html#version()"><CODE>Entity.version()</CODE></A> or <A HREF="../../../../com/sleepycat/persist/model/Persistent.html#version()"><CODE>Persistent.version()</CODE></A> 344 annotation. 345<P> 346<DD><DL> 347</DL> 348</DD> 349<DD><DL> 350</DL> 351</DD> 352</DL> 353<HR> 354 355<A NAME="getProxiedClassName()"><!-- --></A><H3> 356getProxiedClassName</H3> 357<PRE> 358public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getProxiedClassName</B>()</PRE> 359<DL> 360<DD>Returns the class name of the proxied class if this class is a <A HREF="../../../../com/sleepycat/persist/model/PersistentProxy.html" title="interface in com.sleepycat.persist.model"><CODE>PersistentProxy</CODE></A>, or null otherwise. 361<P> 362<DD><DL> 363</DL> 364</DD> 365<DD><DL> 366</DL> 367</DD> 368</DL> 369<HR> 370 371<A NAME="isEntityClass()"><!-- --></A><H3> 372isEntityClass</H3> 373<PRE> 374public boolean <B>isEntityClass</B>()</PRE> 375<DL> 376<DD>Returns whether this class is an entity class. 377<P> 378<DD><DL> 379</DL> 380</DD> 381<DD><DL> 382</DL> 383</DD> 384</DL> 385<HR> 386 387<A NAME="getPrimaryKey()"><!-- --></A><H3> 388getPrimaryKey</H3> 389<PRE> 390public <A HREF="../../../../com/sleepycat/persist/model/PrimaryKeyMetadata.html" title="class in com.sleepycat.persist.model">PrimaryKeyMetadata</A> <B>getPrimaryKey</B>()</PRE> 391<DL> 392<DD>Returns the primary key metadata for a key declared in this class, or 393 null if none is declared. This may be specified using the <A HREF="../../../../com/sleepycat/persist/model/PrimaryKey.html" title="annotation in com.sleepycat.persist.model"><CODE>PrimaryKey</CODE></A> annotation. 394<P> 395<DD><DL> 396</DL> 397</DD> 398<DD><DL> 399</DL> 400</DD> 401</DL> 402<HR> 403 404<A NAME="getSecondaryKeys()"><!-- --></A><H3> 405getSecondaryKeys</H3> 406<PRE> 407public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="../../../../com/sleepycat/persist/model/SecondaryKeyMetadata.html" title="class in com.sleepycat.persist.model">SecondaryKeyMetadata</A>> <B>getSecondaryKeys</B>()</PRE> 408<DL> 409<DD>Returns an unmodifiable map of key name (which may be different from 410 field name) to secondary key metadata for all secondary keys declared in 411 this class, or null if no secondary keys are declared in this class. 412 This metadata may be specified using <A HREF="../../../../com/sleepycat/persist/model/SecondaryKey.html" title="annotation in com.sleepycat.persist.model"><CODE>SecondaryKey</CODE></A> annotations. 413<P> 414<DD><DL> 415</DL> 416</DD> 417<DD><DL> 418</DL> 419</DD> 420</DL> 421<HR> 422 423<A NAME="getCompositeKeyFields()"><!-- --></A><H3> 424getCompositeKeyFields</H3> 425<PRE> 426public <A HREF="http://java.sun.com/j2se/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/model/FieldMetadata.html" title="class in com.sleepycat.persist.model">FieldMetadata</A>> <B>getCompositeKeyFields</B>()</PRE> 427<DL> 428<DD>Returns an unmodifiable list of metadata for the fields making up a 429 composite key, or null if this is a not a composite key class. The 430 order of the fields in the returned list determines their stored order 431 and may be specified using the <A HREF="../../../../com/sleepycat/persist/model/KeyField.html" title="annotation in com.sleepycat.persist.model"><CODE>KeyField</CODE></A> annotation. When the 432 composite key class does not implement <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang"><CODE>Comparable</CODE></A>, the order of 433 the fields is the relative sort order. 434<P> 435<DD><DL> 436</DL> 437</DD> 438<DD><DL> 439</DL> 440</DD> 441</DL> 442<HR> 443 444<A NAME="getPersistentFields()"><!-- --></A><H3> 445getPersistentFields</H3> 446<PRE> 447public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="../../../../com/sleepycat/persist/model/FieldMetadata.html" title="class in com.sleepycat.persist.model">FieldMetadata</A>> <B>getPersistentFields</B>()</PRE> 448<DL> 449<DD>Returns an unmodifiable list of metadata for the persistent fields in 450 this class, or null if the default rules for persistent fields should be 451 used. All fields returned must be declared in this class and must be 452 non-static. 453 454 <p>By default (if null is returned) the persistent fields of a class 455 will be all declared instance fields that are non-transient (are not 456 declared with the <code>transient</code> keyword). The default rules 457 may be overridden by an <A HREF="../../../../com/sleepycat/persist/model/EntityModel.html" title="class in com.sleepycat.persist.model"><CODE>EntityModel</CODE></A>. For example, the <A HREF="../../../../com/sleepycat/persist/model/AnnotationModel.html" title="class in com.sleepycat.persist.model"><CODE>AnnotationModel</CODE></A> overrides the default rules when the <A HREF="../../../../com/sleepycat/persist/model/NotPersistent.html" title="annotation in com.sleepycat.persist.model"><CODE>NotPersistent</CODE></A> or <A HREF="../../../../com/sleepycat/persist/model/NotTransient.html" title="annotation in com.sleepycat.persist.model"><CODE>NotTransient</CODE></A> annotation is specified.</p> 458<P> 459<DD><DL> 460</DL> 461</DD> 462<DD><DL> 463</DL> 464</DD> 465</DL> 466<HR> 467 468<A NAME="equals(java.lang.Object)"><!-- --></A><H3> 469equals</H3> 470<PRE> 471public boolean <B>equals</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> other)</PRE> 472<DL> 473<DD><DL> 474<DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/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></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL> 475</DD> 476<DD><DL> 477</DL> 478</DD> 479</DL> 480<HR> 481 482<A NAME="hashCode()"><!-- --></A><H3> 483hashCode</H3> 484<PRE> 485public int <B>hashCode</B>()</PRE> 486<DL> 487<DD><DL> 488<DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL> 489</DD> 490<DD><DL> 491</DL> 492</DD> 493</DL> 494<!-- ========= END OF CLASS DATA ========= --> 495<HR> 496 497 498<!-- ======= START OF BOTTOM NAVBAR ====== --> 499<A NAME="navbar_bottom"><!-- --></A> 500<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 501<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 502<TR> 503<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 504<A NAME="navbar_bottom_firstrow"><!-- --></A> 505<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 506 <TR ALIGN="center" VALIGN="top"> 507 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 508 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 509 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 510 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ClassMetadata.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 511 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 512 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 513 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 514 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 515 </TR> 516</TABLE> 517</TD> 518<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 519<b>Berkeley DB</b><br><font size="-1"> version 4.8.30</font></EM> 520</TD> 521</TR> 522 523<TR> 524<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 525 <A HREF="../../../../com/sleepycat/persist/model/ClassEnhancer.html" title="class in com.sleepycat.persist.model"><B>PREV CLASS</B></A> 526 <A HREF="../../../../com/sleepycat/persist/model/DeleteAction.html" title="enum in com.sleepycat.persist.model"><B>NEXT CLASS</B></A></FONT></TD> 527<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 528 <A HREF="../../../../index.html?com/sleepycat/persist/model/ClassMetadata.html" target="_top"><B>FRAMES</B></A> 529 <A HREF="ClassMetadata.html" target="_top"><B>NO FRAMES</B></A> 530 <SCRIPT type="text/javascript"> 531 <!-- 532 if(window==top) { 533 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 534 } 535 //--> 536</SCRIPT> 537<NOSCRIPT> 538 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 539</NOSCRIPT> 540 541 542</FONT></TD> 543</TR> 544<TR> 545<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 546 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 547<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 548DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 549</TR> 550</TABLE> 551<A NAME="skip-navbar_bottom"></A> 552<!-- ======== END OF BOTTOM NAVBAR ======= --> 553 554<HR> 555<font size=1>Copyright (c) 1996-2009 Oracle. All rights reserved.</font> 556</BODY> 557</HTML> 558
