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