← Back to branch summary

~raginggoblin/infolog/infolog

« back to all changes in this revision

Viewing changes to InfologServer/lib/hibernate-annotations-3.4.0.GA/doc/api/org/hibernate/annotations/MapKey.html

  • Committer: Raging Goblin
  • Date: 2013-11-16 16:51:32 UTC
  • Revision ID: raging_goblin-20131116165132-weujnptzc88uy4ah
Mavenized the project, now using shared project InfologSync

Show diffs side-by-side

added added

removed removed

Lines of Context:
InfologServer/lib/hibernate-annotations-3.4.0.GA/doc/api/org/hibernate/annotations/MapKey.html
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_06) on Wed Aug 20 10:31:32 CEST 2008 -->
6
 
<TITLE>
7
 
MapKey (Hibernate Annotations API Documentation)
8
 
</TITLE>
9
 
 
10
 
<META NAME="keywords" CONTENT="org.hibernate.annotations.MapKey class">
11
 
 
12
 
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../jdstyle.css" TITLE="Style">
13
 
 
14
 
<SCRIPT type="text/javascript">
15
 
function windowTitle()
16
 
{
17
 
    parent.document.title="MapKey (Hibernate Annotations API Documentation)";
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/MapKey.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
 
</EM>
50
 
</TD>
51
 
</TR>
52
 
 
53
 
<TR>
54
 
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55
 
&nbsp;<A HREF="../../../org/hibernate/annotations/ManyToAny.html" title="annotation in org.hibernate.annotations"><B>PREV CLASS</B></A>&nbsp;
56
 
&nbsp;<A HREF="../../../org/hibernate/annotations/MapKeyManyToMany.html" title="annotation in org.hibernate.annotations"><B>NEXT CLASS</B></A></FONT></TD>
57
 
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
58
 
  <A HREF="../../../index.html?org/hibernate/annotations/MapKey.html" target="_top"><B>FRAMES</B></A>  &nbsp;
59
 
&nbsp;<A HREF="MapKey.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;REQUIRED&nbsp;|&nbsp;<A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD>
77
 
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
78
 
DETAIL:&nbsp;<A HREF="#annotation_type_element_detail">ELEMENT</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">
88
 
org.hibernate.annotations</FONT>
89
 
<BR>
90
 
Annotation Type MapKey</H2>
91
 
<HR>
92
 
<DL>
93
 
<DT><PRE><FONT SIZE="-1"><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/annotation.Target.html" title="class or interface in java.lang">@Target</A>(value={METHOD,FIELD})
94
 
<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/annotation.Retention.html" title="class or interface in java.lang">@Retention</A>(value=RUNTIME)
95
 
</FONT>public @interface <B>MapKey</B></DL>
96
 
</PRE>
97
 
 
98
 
<P>
99
 
Define the map key columns as an explicit column holding the map key
100
 
 This is completly different from <CODE>MapKey</CODE> which use an existing column
101
 
 This annotation and <CODE>MapKey</CODE> are mutually exclusive
102
 
<P>
103
 
 
104
 
<P>
105
 
<DL>
106
 
<DT><B>Author:</B></DT>
107
 
  <DD>Emmanuel Bernard</DD>
108
 
</DL>
109
 
<HR>
110
 
 
111
 
<P>
112
 
<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
113
 
 
114
 
<A NAME="annotation_type_optional_element_summary"><!-- --></A>
115
 
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
116
 
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
117
 
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
118
 
<B>Optional Element Summary</B></FONT></TH>
119
 
</TR>
120
 
<TR BGCOLOR="white" CLASS="TableRowColor">
121
 
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
122
 
<CODE>&nbsp;javax.persistence.Column[]</CODE></FONT></TD>
123
 
<TD><CODE><B><A HREF="../../../org/hibernate/annotations/MapKey.html#columns()">columns</A></B></CODE>
124
 
 
125
 
<BR>
126
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
127
 
</TR>
128
 
<TR BGCOLOR="white" CLASS="TableRowColor">
129
 
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
130
 
<CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A></CODE></FONT></TD>
131
 
<TD><CODE><B><A HREF="../../../org/hibernate/annotations/MapKey.html#targetElement()">targetElement</A></B></CODE>
132
 
 
133
 
<BR>
134
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Represent the key class in a Map
135
 
 Only useful if the collection does not use generics</TD>
136
 
</TR>
137
 
<TR BGCOLOR="white" CLASS="TableRowColor">
138
 
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
139
 
<CODE>&nbsp;<A HREF="../../../org/hibernate/annotations/Type.html" title="annotation in org.hibernate.annotations">Type</A></CODE></FONT></TD>
140
 
<TD><CODE><B><A HREF="../../../org/hibernate/annotations/MapKey.html#type()">type</A></B></CODE>
141
 
 
142
 
<BR>
143
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The optional map key type.</TD>
144
 
</TR>
145
 
</TABLE>
146
 
&nbsp;
147
 
<P>
148
 
<A NAME="columns()"><!-- --></A><H3>
149
 
columns</H3>
150
 
<PRE>
151
 
public abstract javax.persistence.Column[] <B>columns</B></PRE>
152
 
<DL>
153
 
<DD><DL>
154
 
</DL>
155
 
</DD>
156
 
<DD><DL>
157
 
</DL>
158
 
<DL>
159
 
<DT><B>Default:</B><DD>{}</DD>
160
 
</DL>
161
 
</DL>
162
 
<HR>
163
 
 
164
 
<A NAME="targetElement()"><!-- --></A><H3>
165
 
targetElement</H3>
166
 
<PRE>
167
 
public abstract <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> <B>targetElement</B></PRE>
168
 
<DL>
169
 
<DD>Represent the key class in a Map
170
 
 Only useful if the collection does not use generics
171
 
<P>
172
 
<DD><DL>
173
 
</DL>
174
 
</DD>
175
 
<DD><DL>
176
 
</DL>
177
 
<DL>
178
 
<DT><B>Default:</B><DD>void.class</DD>
179
 
</DL>
180
 
</DL>
181
 
<HR>
182
 
 
183
 
<A NAME="type()"><!-- --></A><H3>
184
 
type</H3>
185
 
<PRE>
186
 
public abstract <A HREF="../../../org/hibernate/annotations/Type.html" title="annotation in org.hibernate.annotations">Type</A> <B>type</B></PRE>
187
 
<DL>
188
 
<DD>The optional map key type. Guessed if default
189
 
<P>
190
 
<DD><DL>
191
 
</DL>
192
 
</DD>
193
 
<DD><DL>
194
 
</DL>
195
 
<DL>
196
 
<DT><B>Default:</B><DD>@org.hibernate.annotations.Type(type="")</DD>
197
 
</DL>
198
 
</DL>
199
 
<!-- ========= END OF CLASS DATA ========= -->
200
 
<HR>
201
 
 
202
 
 
203
 
<!-- ======= START OF BOTTOM NAVBAR ====== -->
204
 
<A NAME="navbar_bottom"><!-- --></A>
205
 
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
206
 
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
207
 
<TR>
208
 
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
209
 
<A NAME="navbar_bottom_firstrow"><!-- --></A>
210
 
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
211
 
  <TR ALIGN="center" VALIGN="top">
212
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
213
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
214
 
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
215
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/MapKey.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
216
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
217
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
218
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
219
 
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
220
 
  </TR>
221
 
</TABLE>
222
 
</TD>
223
 
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
224
 
</EM>
225
 
</TD>
226
 
</TR>
227
 
 
228
 
<TR>
229
 
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
230
 
&nbsp;<A HREF="../../../org/hibernate/annotations/ManyToAny.html" title="annotation in org.hibernate.annotations"><B>PREV CLASS</B></A>&nbsp;
231
 
&nbsp;<A HREF="../../../org/hibernate/annotations/MapKeyManyToMany.html" title="annotation in org.hibernate.annotations"><B>NEXT CLASS</B></A></FONT></TD>
232
 
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
233
 
  <A HREF="../../../index.html?org/hibernate/annotations/MapKey.html" target="_top"><B>FRAMES</B></A>  &nbsp;
234
 
&nbsp;<A HREF="MapKey.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
235
 
&nbsp;<SCRIPT type="text/javascript">
236
 
  <!--
237
 
  if(window==top) {
238
 
    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
239
 
  }
240
 
  //-->
241
 
</SCRIPT>
242
 
<NOSCRIPT>
243
 
  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
244
 
</NOSCRIPT>
245
 
 
246
 
 
247
 
</FONT></TD>
248
 
</TR>
249
 
<TR>
250
 
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
251
 
  SUMMARY:&nbsp;REQUIRED&nbsp;|&nbsp;<A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD>
252
 
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
253
 
DETAIL:&nbsp;<A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD>
254
 
</TR>
255
 
</TABLE>
256
 
<A NAME="skip-navbar_bottom"></A>
257
 
<!-- ======== END OF BOTTOM NAVBAR ======= -->
258
 
 
259
 
<HR>
260
 
 
261
 
</BODY>
262
 
</HTML>