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