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> 7PrimaryKeyMetadata (Oracle - Berkeley DB Java API) 8</TITLE> 9 10<META NAME="keywords" CONTENT="com.sleepycat.persist.model.PrimaryKeyMetadata 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="PrimaryKeyMetadata (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/PrimaryKeyMetadata.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/PrimaryKey.html" title="annotation in com.sleepycat.persist.model"><B>PREV CLASS</B></A> 56 <A HREF="../../../../com/sleepycat/persist/model/Relationship.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/PrimaryKeyMetadata.html" target="_top"><B>FRAMES</B></A> 59 <A HREF="PrimaryKeyMetadata.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 PrimaryKeyMetadata</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 "><A HREF="../../../../com/sleepycat/persist/model/FieldMetadata.html" title="class in com.sleepycat.persist.model">com.sleepycat.persist.model.FieldMetadata</A> 94 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.persist.model.PrimaryKeyMetadata</B> 95</PRE> 96<DL> 97<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> 98</DL> 99<HR> 100<DL> 101<DT><PRE>public class <B>PrimaryKeyMetadata</B><DT>extends <A HREF="../../../../com/sleepycat/persist/model/FieldMetadata.html" title="class in com.sleepycat.persist.model">FieldMetadata</A></DL> 102</PRE> 103 104<P> 105The metadata for a primary key field. A primary key may be specified with 106 the <A HREF="../../../../com/sleepycat/persist/model/PrimaryKey.html" title="annotation in com.sleepycat.persist.model"><CODE>PrimaryKey</CODE></A> annotation. 107 108 <p><code>PrimaryKeyMetadata</code> objects are thread-safe. Multiple threads may 109 safely call the methods of a shared <code>PrimaryKeyMetadata</code> object.</p> 110<P> 111 112<P> 113<DL> 114<DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#com.sleepycat.persist.model.PrimaryKeyMetadata">Serialized Form</A></DL> 115<HR> 116 117<P> 118 119<!-- ======== CONSTRUCTOR SUMMARY ======== --> 120 121<A NAME="constructor_summary"><!-- --></A> 122<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 123<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 124<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 125<B>Constructor Summary</B></FONT></TH> 126</TR> 127<TR BGCOLOR="white" CLASS="TableRowColor"> 128<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/PrimaryKeyMetadata.html#PrimaryKeyMetadata(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">PrimaryKeyMetadata</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> name, 129 <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, 130 <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> declaringClassName, 131 <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> sequenceName)</CODE> 132 133<BR> 134 Used by an <code>EntityModel</code> to construct primary key metadata.</TD> 135</TR> 136</TABLE> 137 138<!-- ========== METHOD SUMMARY =========== --> 139 140<A NAME="method_summary"><!-- --></A> 141<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 142<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 143<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 144<B>Method Summary</B></FONT></TH> 145</TR> 146<TR BGCOLOR="white" CLASS="TableRowColor"> 147<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 148<CODE> boolean</CODE></FONT></TD> 149<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/PrimaryKeyMetadata.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> 150 151<BR> 152 </TD> 153</TR> 154<TR BGCOLOR="white" CLASS="TableRowColor"> 155<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 156<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> 157<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/PrimaryKeyMetadata.html#getSequenceName()">getSequenceName</A></B>()</CODE> 158 159<BR> 160 Returns the name of the sequence for assigning key values.</TD> 161</TR> 162<TR BGCOLOR="white" CLASS="TableRowColor"> 163<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 164<CODE> int</CODE></FONT></TD> 165<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/PrimaryKeyMetadata.html#hashCode()">hashCode</A></B>()</CODE> 166 167<BR> 168 </TD> 169</TR> 170</TABLE> 171 <A NAME="methods_inherited_from_class_com.sleepycat.persist.model.FieldMetadata"><!-- --></A> 172<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 173<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 174<TH ALIGN="left"><B>Methods inherited from class com.sleepycat.persist.model.<A HREF="../../../../com/sleepycat/persist/model/FieldMetadata.html" title="class in com.sleepycat.persist.model">FieldMetadata</A></B></TH> 175</TR> 176<TR BGCOLOR="white" CLASS="TableRowColor"> 177<TD><CODE><A HREF="../../../../com/sleepycat/persist/model/FieldMetadata.html#getClassName()">getClassName</A>, <A HREF="../../../../com/sleepycat/persist/model/FieldMetadata.html#getDeclaringClassName()">getDeclaringClassName</A>, <A HREF="../../../../com/sleepycat/persist/model/FieldMetadata.html#getName()">getName</A></CODE></TD> 178</TR> 179</TABLE> 180 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 181<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 182<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 183<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> 184</TR> 185<TR BGCOLOR="white" CLASS="TableRowColor"> 186<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> 187</TR> 188</TABLE> 189 190<P> 191 192<!-- ========= CONSTRUCTOR DETAIL ======== --> 193 194<A NAME="constructor_detail"><!-- --></A> 195<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 196<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 197<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 198<B>Constructor Detail</B></FONT></TH> 199</TR> 200</TABLE> 201 202<A NAME="PrimaryKeyMetadata(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> 203PrimaryKeyMetadata</H3> 204<PRE> 205public <B>PrimaryKeyMetadata</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> name, 206 <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, 207 <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> declaringClassName, 208 <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> sequenceName)</PRE> 209<DL> 210<DD>Used by an <code>EntityModel</code> to construct primary key metadata. 211<P> 212</DL> 213 214<!-- ============ METHOD DETAIL ========== --> 215 216<A NAME="method_detail"><!-- --></A> 217<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 218<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 219<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 220<B>Method Detail</B></FONT></TH> 221</TR> 222</TABLE> 223 224<A NAME="getSequenceName()"><!-- --></A><H3> 225getSequenceName</H3> 226<PRE> 227public <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>getSequenceName</B>()</PRE> 228<DL> 229<DD>Returns the name of the sequence for assigning key values. This may be 230 specified using the <A HREF="../../../../com/sleepycat/persist/model/PrimaryKey.html#sequence()"><CODE>PrimaryKey.sequence()</CODE></A> annotation. 231<P> 232<DD><DL> 233</DL> 234</DD> 235</DL> 236<HR> 237 238<A NAME="equals(java.lang.Object)"><!-- --></A><H3> 239equals</H3> 240<PRE> 241public 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> 242<DL> 243<DD><DL> 244<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/sleepycat/persist/model/FieldMetadata.html#equals(java.lang.Object)">equals</A></CODE> in class <CODE><A HREF="../../../../com/sleepycat/persist/model/FieldMetadata.html" title="class in com.sleepycat.persist.model">FieldMetadata</A></CODE></DL> 245</DD> 246<DD><DL> 247</DL> 248</DD> 249</DL> 250<HR> 251 252<A NAME="hashCode()"><!-- --></A><H3> 253hashCode</H3> 254<PRE> 255public int <B>hashCode</B>()</PRE> 256<DL> 257<DD><DL> 258<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../com/sleepycat/persist/model/FieldMetadata.html#hashCode()">hashCode</A></CODE> in class <CODE><A HREF="../../../../com/sleepycat/persist/model/FieldMetadata.html" title="class in com.sleepycat.persist.model">FieldMetadata</A></CODE></DL> 259</DD> 260<DD><DL> 261</DL> 262</DD> 263</DL> 264<!-- ========= END OF CLASS DATA ========= --> 265<HR> 266 267 268<!-- ======= START OF BOTTOM NAVBAR ====== --> 269<A NAME="navbar_bottom"><!-- --></A> 270<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 271<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 272<TR> 273<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 274<A NAME="navbar_bottom_firstrow"><!-- --></A> 275<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 276 <TR ALIGN="center" VALIGN="top"> 277 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 278 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 279 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 280 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PrimaryKeyMetadata.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 281 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 282 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 283 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 284 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 285 </TR> 286</TABLE> 287</TD> 288<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 289<b>Berkeley DB</b><br><font size="-1"> version 4.7.25</font></EM> 290</TD> 291</TR> 292 293<TR> 294<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 295 <A HREF="../../../../com/sleepycat/persist/model/PrimaryKey.html" title="annotation in com.sleepycat.persist.model"><B>PREV CLASS</B></A> 296 <A HREF="../../../../com/sleepycat/persist/model/Relationship.html" title="enum in com.sleepycat.persist.model"><B>NEXT CLASS</B></A></FONT></TD> 297<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 298 <A HREF="../../../../index.html?com/sleepycat/persist/model/PrimaryKeyMetadata.html" target="_top"><B>FRAMES</B></A> 299 <A HREF="PrimaryKeyMetadata.html" target="_top"><B>NO FRAMES</B></A> 300 <SCRIPT type="text/javascript"> 301 <!-- 302 if(window==top) { 303 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 304 } 305 //--> 306</SCRIPT> 307<NOSCRIPT> 308 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 309</NOSCRIPT> 310 311 312</FONT></TD> 313</TR> 314<TR> 315<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 316 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 317<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 318DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 319</TR> 320</TABLE> 321<A NAME="skip-navbar_bottom"></A> 322<!-- ======== END OF BOTTOM NAVBAR ======= --> 323 324<HR> 325<font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font> 326</BODY> 327</HTML> 328
