• Home
  • History
  • Annotate
  • Line#
  • Navigate
  • Raw
  • Download
  • only in /netgear-WNDR4500v2-V1.0.0.60_1.0.38/ap/gpl/timemachine/db-4.7.25.NC/docs/java/com/sleepycat/persist/model/
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>
7SecondaryKeyMetadata (Oracle - Berkeley DB Java API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="com.sleepycat.persist.model.SecondaryKeyMetadata 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="SecondaryKeyMetadata (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>&nbsp;</TD>
38  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
39  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
40  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/SecondaryKeyMetadata.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
42  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
43  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</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&nbsp;<A HREF="../../../../com/sleepycat/persist/model/SecondaryKey.html" title="annotation in com.sleepycat.persist.model"><B>PREV CLASS</B></A>&nbsp;
56&nbsp;NEXT CLASS</FONT></TD>
57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
58  <A HREF="../../../../index.html?com/sleepycat/persist/model/SecondaryKeyMetadata.html" target="_top"><B>FRAMES</B></A>  &nbsp;
59&nbsp;<A HREF="SecondaryKeyMetadata.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
60&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
77<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
78DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<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 SecondaryKeyMetadata</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.SecondaryKeyMetadata</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>SecondaryKeyMetadata</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 secondary key field.  A secondary key may be specified
106 with the <A HREF="../../../../com/sleepycat/persist/model/SecondaryKey.html" title="annotation in com.sleepycat.persist.model"><CODE>SecondaryKey</CODE></A> annotation.
107
108 <p><code>SecondaryKeyMetadata</code> objects are thread-safe.  Multiple threads
109 may safely call the methods of a shared <code>SecondaryKeyMetadata</code>
110 object.</p>
111<P>
112
113<P>
114<DL>
115<DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#com.sleepycat.persist.model.SecondaryKeyMetadata">Serialized Form</A></DL>
116<HR>
117
118<P>
119
120<!-- ======== CONSTRUCTOR SUMMARY ======== -->
121
122<A NAME="constructor_summary"><!-- --></A>
123<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
124<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
125<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
126<B>Constructor Summary</B></FONT></TH>
127</TR>
128<TR BGCOLOR="white" CLASS="TableRowColor">
129<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/SecondaryKeyMetadata.html#SecondaryKeyMetadata(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, com.sleepycat.persist.model.Relationship, java.lang.String, com.sleepycat.persist.model.DeleteAction)">SecondaryKeyMetadata</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>&nbsp;name,
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>&nbsp;className,
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>&nbsp;declaringClassName,
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>&nbsp;elementClassName,
133                     <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>&nbsp;keyName,
134                     <A HREF="../../../../com/sleepycat/persist/model/Relationship.html" title="enum in com.sleepycat.persist.model">Relationship</A>&nbsp;relationship,
135                     <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>&nbsp;relatedEntity,
136                     <A HREF="../../../../com/sleepycat/persist/model/DeleteAction.html" title="enum in com.sleepycat.persist.model">DeleteAction</A>&nbsp;deleteAction)</CODE>
137
138<BR>
139&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Used by an <code>EntityModel</code> to construct secondary key metadata.</TD>
140</TR>
141</TABLE>
142&nbsp;
143<!-- ========== METHOD SUMMARY =========== -->
144
145<A NAME="method_summary"><!-- --></A>
146<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
147<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
148<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
149<B>Method Summary</B></FONT></TH>
150</TR>
151<TR BGCOLOR="white" CLASS="TableRowColor">
152<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
153<CODE>&nbsp;boolean</CODE></FONT></TD>
154<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/SecondaryKeyMetadata.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>&nbsp;other)</CODE>
155
156<BR>
157&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
158</TR>
159<TR BGCOLOR="white" CLASS="TableRowColor">
160<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
161<CODE>&nbsp;<A HREF="../../../../com/sleepycat/persist/model/DeleteAction.html" title="enum in com.sleepycat.persist.model">DeleteAction</A></CODE></FONT></TD>
162<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/SecondaryKeyMetadata.html#getDeleteAction()">getDeleteAction</A></B>()</CODE>
163
164<BR>
165&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the action to take when a related entity is deleted having a
166 primary key value that exists as a secondary key value for this entity.</TD>
167</TR>
168<TR BGCOLOR="white" CLASS="TableRowColor">
169<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
170<CODE>&nbsp;<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>
171<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/SecondaryKeyMetadata.html#getElementClassName()">getElementClassName</A></B>()</CODE>
172
173<BR>
174&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the class name of the array or collection element for a <A HREF="../../../../com/sleepycat/persist/model/Relationship.html#ONE_TO_MANY"><CODE>ONE_TO_MANY</CODE></A> or <A HREF="../../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_MANY"><CODE>MANY_TO_MANY</CODE></A> relationship, or null for a
175 Relationship#ONE_TO_ONE ONE_TO_ONE} or <A HREF="../../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_ONE"><CODE>MANY_TO_ONE</CODE></A> relationship.</TD>
176</TR>
177<TR BGCOLOR="white" CLASS="TableRowColor">
178<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
179<CODE>&nbsp;<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>
180<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/SecondaryKeyMetadata.html#getKeyName()">getKeyName</A></B>()</CODE>
181
182<BR>
183&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the key name, which may be different from the field name.</TD>
184</TR>
185<TR BGCOLOR="white" CLASS="TableRowColor">
186<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
187<CODE>&nbsp;<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>
188<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/SecondaryKeyMetadata.html#getRelatedEntity()">getRelatedEntity</A></B>()</CODE>
189
190<BR>
191&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the class name of the related (foreign) entity, for which
192 foreign key constraints are specified using the <A HREF="../../../../com/sleepycat/persist/model/SecondaryKey.html#relatedEntity()"><CODE>SecondaryKey.relatedEntity()</CODE></A> annotation.</TD>
193</TR>
194<TR BGCOLOR="white" CLASS="TableRowColor">
195<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
196<CODE>&nbsp;<A HREF="../../../../com/sleepycat/persist/model/Relationship.html" title="enum in com.sleepycat.persist.model">Relationship</A></CODE></FONT></TD>
197<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/SecondaryKeyMetadata.html#getRelationship()">getRelationship</A></B>()</CODE>
198
199<BR>
200&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the relationship between instances of the entity class and the
201 secondary keys.</TD>
202</TR>
203<TR BGCOLOR="white" CLASS="TableRowColor">
204<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
205<CODE>&nbsp;int</CODE></FONT></TD>
206<TD><CODE><B><A HREF="../../../../com/sleepycat/persist/model/SecondaryKeyMetadata.html#hashCode()">hashCode</A></B>()</CODE>
207
208<BR>
209&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
210</TR>
211</TABLE>
212&nbsp;<A NAME="methods_inherited_from_class_com.sleepycat.persist.model.FieldMetadata"><!-- --></A>
213<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
214<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
215<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>
216</TR>
217<TR BGCOLOR="white" CLASS="TableRowColor">
218<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>
219</TR>
220</TABLE>
221&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
222<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
223<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
224<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>
225</TR>
226<TR BGCOLOR="white" CLASS="TableRowColor">
227<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>
228</TR>
229</TABLE>
230&nbsp;
231<P>
232
233<!-- ========= CONSTRUCTOR DETAIL ======== -->
234
235<A NAME="constructor_detail"><!-- --></A>
236<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
237<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
238<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
239<B>Constructor Detail</B></FONT></TH>
240</TR>
241</TABLE>
242
243<A NAME="SecondaryKeyMetadata(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, com.sleepycat.persist.model.Relationship, java.lang.String, com.sleepycat.persist.model.DeleteAction)"><!-- --></A><H3>
244SecondaryKeyMetadata</H3>
245<PRE>
246public <B>SecondaryKeyMetadata</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>&nbsp;name,
247                            <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>&nbsp;className,
248                            <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>&nbsp;declaringClassName,
249                            <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>&nbsp;elementClassName,
250                            <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>&nbsp;keyName,
251                            <A HREF="../../../../com/sleepycat/persist/model/Relationship.html" title="enum in com.sleepycat.persist.model">Relationship</A>&nbsp;relationship,
252                            <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>&nbsp;relatedEntity,
253                            <A HREF="../../../../com/sleepycat/persist/model/DeleteAction.html" title="enum in com.sleepycat.persist.model">DeleteAction</A>&nbsp;deleteAction)</PRE>
254<DL>
255<DD>Used by an <code>EntityModel</code> to construct secondary key metadata.
256<P>
257</DL>
258
259<!-- ============ METHOD DETAIL ========== -->
260
261<A NAME="method_detail"><!-- --></A>
262<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
263<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
264<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
265<B>Method Detail</B></FONT></TH>
266</TR>
267</TABLE>
268
269<A NAME="getElementClassName()"><!-- --></A><H3>
270getElementClassName</H3>
271<PRE>
272public <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>getElementClassName</B>()</PRE>
273<DL>
274<DD>Returns the class name of the array or collection element for a <A HREF="../../../../com/sleepycat/persist/model/Relationship.html#ONE_TO_MANY"><CODE>ONE_TO_MANY</CODE></A> or <A HREF="../../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_MANY"><CODE>MANY_TO_MANY</CODE></A> relationship, or null for a
275 Relationship#ONE_TO_ONE ONE_TO_ONE} or <A HREF="../../../../com/sleepycat/persist/model/Relationship.html#MANY_TO_ONE"><CODE>MANY_TO_ONE</CODE></A> relationship.
276<P>
277<DD><DL>
278</DL>
279</DD>
280</DL>
281<HR>
282
283<A NAME="getKeyName()"><!-- --></A><H3>
284getKeyName</H3>
285<PRE>
286public <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>getKeyName</B>()</PRE>
287<DL>
288<DD>Returns the key name, which may be different from the field name.
289<P>
290<DD><DL>
291</DL>
292</DD>
293</DL>
294<HR>
295
296<A NAME="getRelationship()"><!-- --></A><H3>
297getRelationship</H3>
298<PRE>
299public <A HREF="../../../../com/sleepycat/persist/model/Relationship.html" title="enum in com.sleepycat.persist.model">Relationship</A> <B>getRelationship</B>()</PRE>
300<DL>
301<DD>Returns the relationship between instances of the entity class and the
302 secondary keys.  This may be specified using the <A HREF="../../../../com/sleepycat/persist/model/SecondaryKey.html#relate()"><CODE>SecondaryKey.relate()</CODE></A> annotation.
303<P>
304<DD><DL>
305</DL>
306</DD>
307</DL>
308<HR>
309
310<A NAME="getRelatedEntity()"><!-- --></A><H3>
311getRelatedEntity</H3>
312<PRE>
313public <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>getRelatedEntity</B>()</PRE>
314<DL>
315<DD>Returns the class name of the related (foreign) entity, for which
316 foreign key constraints are specified using the <A HREF="../../../../com/sleepycat/persist/model/SecondaryKey.html#relatedEntity()"><CODE>SecondaryKey.relatedEntity()</CODE></A> annotation.
317<P>
318<DD><DL>
319</DL>
320</DD>
321</DL>
322<HR>
323
324<A NAME="getDeleteAction()"><!-- --></A><H3>
325getDeleteAction</H3>
326<PRE>
327public <A HREF="../../../../com/sleepycat/persist/model/DeleteAction.html" title="enum in com.sleepycat.persist.model">DeleteAction</A> <B>getDeleteAction</B>()</PRE>
328<DL>
329<DD>Returns the action to take when a related entity is deleted having a
330 primary key value that exists as a secondary key value for this entity.
331 This may be specified using the <A HREF="../../../../com/sleepycat/persist/model/SecondaryKey.html#onRelatedEntityDelete()"><CODE>SecondaryKey.onRelatedEntityDelete()</CODE></A> annotation.
332<P>
333<DD><DL>
334</DL>
335</DD>
336</DL>
337<HR>
338
339<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
340equals</H3>
341<PRE>
342public 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>&nbsp;other)</PRE>
343<DL>
344<DD><DL>
345<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>
346</DD>
347<DD><DL>
348</DL>
349</DD>
350</DL>
351<HR>
352
353<A NAME="hashCode()"><!-- --></A><H3>
354hashCode</H3>
355<PRE>
356public int <B>hashCode</B>()</PRE>
357<DL>
358<DD><DL>
359<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>
360</DD>
361<DD><DL>
362</DL>
363</DD>
364</DL>
365<!-- ========= END OF CLASS DATA ========= -->
366<HR>
367
368
369<!-- ======= START OF BOTTOM NAVBAR ====== -->
370<A NAME="navbar_bottom"><!-- --></A>
371<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
372<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
373<TR>
374<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
375<A NAME="navbar_bottom_firstrow"><!-- --></A>
376<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
377  <TR ALIGN="center" VALIGN="top">
378  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
379  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
380  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
381  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/SecondaryKeyMetadata.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
382  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
383  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
384  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
385  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
386  </TR>
387</TABLE>
388</TD>
389<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
390<b>Berkeley DB</b><br><font size="-1"> version 4.7.25</font></EM>
391</TD>
392</TR>
393
394<TR>
395<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
396&nbsp;<A HREF="../../../../com/sleepycat/persist/model/SecondaryKey.html" title="annotation in com.sleepycat.persist.model"><B>PREV CLASS</B></A>&nbsp;
397&nbsp;NEXT CLASS</FONT></TD>
398<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
399  <A HREF="../../../../index.html?com/sleepycat/persist/model/SecondaryKeyMetadata.html" target="_top"><B>FRAMES</B></A>  &nbsp;
400&nbsp;<A HREF="SecondaryKeyMetadata.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
401&nbsp;<SCRIPT type="text/javascript">
402  <!--
403  if(window==top) {
404    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
405  }
406  //-->
407</SCRIPT>
408<NOSCRIPT>
409  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
410</NOSCRIPT>
411
412
413</FONT></TD>
414</TR>
415<TR>
416<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
417  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
418<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
419DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
420</TR>
421</TABLE>
422<A NAME="skip-navbar_bottom"></A>
423<!-- ======== END OF BOTTOM NAVBAR ======= -->
424
425<HR>
426<font size=1>Copyright (c) 1996,2008 Oracle.  All rights reserved.</font>
427</BODY>
428</HTML>
429