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