Skip to main content
summaryrefslogtreecommitdiffstats
blob: 7b02bb68fd880f4864eac64fcc74bc889cfa9f1b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
 
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<title>General information</title>
<meta name="generator" content="Oracle DARB XHTML Converter (Mode = ohj/ohw) - Version 5.1.1" />
<meta name="date" content="2010-05-19T8:12:47Z" />
<meta name="robots" content="noarchive" />
<meta name="doctitle" content="General information" />
<meta name="relnum" content="Release 2.3" />
<meta name="copyright" content="Copyright (c) 2000, 2008 oracle . All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html. Contributors: Oracle - initial API and implementation" />
<link rel="copyright" href="dcommon/html/cpyr.htm" title="Copyright" type="text/html" />
<link rel="stylesheet" href="dcommon/css/blafdoc.css" title="Oracle BLAFDoc" type="text/css" />
<!-- contents -->
</head>
<body>
<p><a id="CACBHFIJ" name="CACBHFIJ"></a></p>
<div class="sect3"><!-- infolevel="all" infotype="General" -->
<h1>General information</h1>
<p>This table lists the General properties available in the <span class="gui-object-title">Java Details view</span> for each mapping type.</p>
<div class="inftblruleinformal">
<table class="RuleInformal" title="This table describes the options on the Persistence Properties view." summary="This table describes the options on the Persistence Properties view." dir="ltr" border="1" width="100%" frame="border" rules="all" cellpadding="3" cellspacing="0">
<col width="21%" />
<col width="*" />
<col width="27%" />
<col width="21%" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t16">Property</th>
<th align="left" valign="bottom" id="r1c2-t16">Description</th>
<th align="left" valign="bottom" id="r1c3-t16">Default</th>
<th align="left" valign="bottom" id="r1c4-t16">Available for Mapping Type</th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t16" headers="r1c1-t16">Mapping Type Hyperlink</td>
<td align="left" headers="r2c1-t16 r1c2-t16">Clicking the name of the mapping type, which is represented as a hyperlink, invokes the Mapping Type Selection dialog. Use this dialog to specify the type of attribute.</td>
<td align="left" headers="r2c1-t16 r1c3-t16">Basic</td>
<td align="left" headers="r2c1-t16 r1c4-t16">All mapping types</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t16" headers="r1c1-t16"><a id="CACGCBHB" name="CACGCBHB"></a>Column</td>
<td align="left" headers="r3c1-t16 r1c2-t16"><a id="sthref231" name="sthref231"></a><a id="sthref232" name="sthref232"></a>The database column that contains the value for the attribute. This field corresponds to the <code>@Column</code> annotation.</td>
<td align="left" headers="r3c1-t16 r1c3-t16">By default, the Column is assumed to be named identically to the attribute.</td>
<td align="left" headers="r3c1-t16 r1c4-t16"><a href="tasks010.htm#BABBABCE">Basic mapping</a>, <a href="tasks011.htm#BABCBHDF">Embedded mapping</a>, <a href="tasks013.htm#BABGCBHG">ID mapping</a>, <a href="tasks019.htm#BABHIBII">Version mapping</a></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r4c1-t16" headers="r1c1-t16">&nbsp;&nbsp;Name</td>
<td align="left" headers="r4c1-t16 r1c2-t16">Name of the database column.
<p>This field corresponds to the <code>@Column</code> annotation.</p>
</td>
<td align="left" headers="r4c1-t16 r1c3-t16"><br /></td>
<td align="left" headers="r4c1-t16 r1c4-t16"><a href="tasks010.htm#BABBABCE">Basic mapping</a>, <a href="tasks011.htm#BABCBHDF">Embedded mapping</a>, <a href="tasks013.htm#BABGCBHG">ID mapping</a></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r5c1-t16" headers="r1c1-t16">&nbsp;&nbsp;Table</td>
<td align="left" headers="r5c1-t16 r1c2-t16">Name of the database table that contains the selected column.</td>
<td align="left" headers="r5c1-t16 r1c3-t16"><br /></td>
<td align="left" headers="r5c1-t16 r1c4-t16"><a href="tasks010.htm#BABBABCE">Basic mapping</a>, <a href="tasks011.htm#BABCBHDF">Embedded mapping</a>, <a href="tasks013.htm#BABGCBHG">ID mapping</a></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r6c1-t16" headers="r1c1-t16">&nbsp;&nbsp;Insertable</td>
<td align="left" headers="r6c1-t16 r1c2-t16">Specifies if the column is always included in <code>SQL INSERT</code> statements.</td>
<td align="left" headers="r6c1-t16 r1c3-t16">True</td>
<td align="left" headers="r6c1-t16 r1c4-t16"><a href="tasks010.htm#BABBABCE">Basic mapping</a>, <a href="tasks011.htm#BABCBHDF">Embedded mapping</a>, <a href="tasks013.htm#BABGCBHG">ID mapping</a></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r7c1-t16" headers="r1c1-t16">&nbsp;&nbsp;Updatable</td>
<td align="left" headers="r7c1-t16 r1c2-t16">Specifies if this column is always included in <code>SQL UPDATE</code> statements.</td>
<td align="left" headers="r7c1-t16 r1c3-t16">True</td>
<td align="left" headers="r7c1-t16 r1c4-t16"><a href="tasks010.htm#BABBABCE">Basic mapping</a>, <a href="tasks011.htm#BABCBHDF">Embedded mapping</a>, <a href="tasks013.htm#BABGCBHG">ID mapping</a></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r8c1-t16" headers="r1c1-t16">&nbsp;&nbsp;Unique</td>
<td align="left" headers="r8c1-t16 r1c2-t16">Sets the <code>UNIQUE</code> constraint for the column.</td>
<td align="left" headers="r8c1-t16 r1c3-t16">False</td>
<td align="left" headers="r8c1-t16 r1c4-t16"><a href="tasks010.htm#BABBABCE">Basic mapping</a>, <a href="tasks011.htm#BABCBHDF">Embedded mapping</a>, <a href="tasks013.htm#BABGCBHG">ID mapping</a></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r9c1-t16" headers="r1c1-t16">&nbsp;&nbsp;Nullable</td>
<td align="left" headers="r9c1-t16 r1c2-t16">Specifies if the column allows null values.</td>
<td align="left" headers="r9c1-t16 r1c3-t16">True</td>
<td align="left" headers="r9c1-t16 r1c4-t16"><a href="tasks010.htm#BABBABCE">Basic mapping</a>, <a href="tasks011.htm#BABCBHDF">Embedded mapping</a>, <a href="tasks013.htm#BABGCBHG">ID mapping</a></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r10c1-t16" headers="r1c1-t16">&nbsp;&nbsp;Length</td>
<td align="left" headers="r10c1-t16 r1c2-t16">Sets the column length.</td>
<td align="left" headers="r10c1-t16 r1c3-t16">255</td>
<td align="left" headers="r10c1-t16 r1c4-t16"><a href="tasks010.htm#BABBABCE">Basic mapping</a>, <a href="tasks011.htm#BABCBHDF">Embedded mapping</a>, <a href="tasks013.htm#BABGCBHG">ID mapping</a></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r11c1-t16" headers="r1c1-t16">&nbsp;&nbsp;Precision</td>
<td align="left" headers="r11c1-t16 r1c2-t16">Sets the precision for the column values.</td>
<td align="left" headers="r11c1-t16 r1c3-t16">0</td>
<td align="left" headers="r11c1-t16 r1c4-t16"><a href="tasks010.htm#BABBABCE">Basic mapping</a>, <a href="tasks011.htm#BABCBHDF">Embedded mapping</a>, <a href="tasks013.htm#BABGCBHG">ID mapping</a></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r12c1-t16" headers="r1c1-t16">&nbsp;&nbsp;Scale</td>
<td align="left" headers="r12c1-t16 r1c2-t16">Sets the number of digits that appear to the right of the decimal point.</td>
<td align="left" headers="r12c1-t16 r1c3-t16">0</td>
<td align="left" headers="r12c1-t16 r1c4-t16"><a href="tasks010.htm#BABBABCE">Basic mapping</a>, <a href="tasks011.htm#BABCBHDF">Embedded mapping</a>, <a href="tasks013.htm#BABGCBHG">ID mapping</a></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r13c1-t16" headers="r1c1-t16">&nbsp;&nbsp;Column Definition</td>
<td align="left" headers="r13c1-t16 r1c2-t16">Define the DDL for a column. This is used when a table is being generated.</td>
<td align="left" headers="r13c1-t16 r1c3-t16"><br /></td>
<td align="left" headers="r13c1-t16 r1c4-t16"><a href="tasks010.htm#BABBABCE">Basic mapping</a>, <a href="tasks011.htm#BABCBHDF">Embedded mapping</a>, <a href="tasks013.htm#BABGCBHG">ID mapping</a></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r14c1-t16" headers="r1c1-t16"><a id="CACGGGHB" name="CACGGGHB"></a><a id="sthref233" name="sthref233"></a><a id="sthref234" name="sthref234"></a><a id="sthref235" name="sthref235"></a>Fetch Type</td>
<td align="left" headers="r14c1-t16 r1c2-t16">Defines how data is loaded from the database:
<ul>
<li>
<p>Eager &ndash; Data is loaded in before it is actually needed.</p>
</li>
<li>
<p>Lazy &ndash; Data is loaded only when required by the transaction.</p>
</li>
</ul>
</td>
<td align="left" headers="r14c1-t16 r1c3-t16">Eager</td>
<td align="left" headers="r14c1-t16 r1c4-t16"><a href="tasks010.htm#BABBABCE">Basic mapping</a>, <a href="tasks017.htm#BABFHBCJ">One-to-one mapping</a>, <a href="tasks014.htm#BABEIEGD">Many-to-many mapping</a>, <a href="tasks015.htm#BABHFAFJ">Many-to-one mapping</a></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r15c1-t16" headers="r1c1-t16">Optional</td>
<td align="left" headers="r15c1-t16 r1c2-t16">Specifies if this field is can be null.</td>
<td align="left" headers="r15c1-t16 r1c3-t16">Yes</td>
<td align="left" headers="r15c1-t16 r1c4-t16"><a href="tasks010.htm#BABBABCE">Basic mapping</a>, <a href="tasks017.htm#BABFHBCJ">One-to-one mapping</a>, <a href="tasks015.htm#BABHFAFJ">Many-to-one mapping</a></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r16c1-t16" headers="r1c1-t16"><a id="CACBBIBI" name="CACBBIBI"></a><a id="sthref236" name="sthref236"></a>Lob</td>
<td align="left" headers="r16c1-t16 r1c2-t16">Specify if the field is mapped to <code>java.sql.Clob</code> or <code>java.sql.Blob</code>.
<p>This field corresponds to the <code>@Lob</code> annotation.</p>
</td>
<td align="left" headers="r16c1-t16 r1c3-t16"><br /></td>
<td align="left" headers="r16c1-t16 r1c4-t16"><a href="tasks010.htm#BABBABCE">Basic mapping</a><br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r17c1-t16" headers="r1c1-t16"><a id="CACEAJGD" name="CACEAJGD"></a><a id="sthref237" name="sthref237"></a><a id="sthref238" name="sthref238"></a><a id="sthref239" name="sthref239"></a>Temporal</td>
<td align="left" headers="r17c1-t16 r1c2-t16">Specifies if this field is one of the following:
<ul>
<li>
<p>Date &ndash; <code>java.sql.Date</code></p>
</li>
<li>
<p>Time &ndash; <code>java.sql.Time</code></p>
</li>
<li>
<p>Timestamp &ndash; <code>java.sql.Timestamp</code></p>
</li>
</ul>
<p>This field corresponds to the <code>@Temporal</code> annotation.</p>
</td>
<td align="left" headers="r17c1-t16 r1c3-t16"><br /></td>
<td align="left" headers="r17c1-t16 r1c4-t16"><a href="tasks010.htm#BABBABCE">Basic mapping</a>, <a href="tasks013.htm#BABGCBHG">ID mapping</a></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r18c1-t16" headers="r1c1-t16"><a id="sthref240" name="sthref240"></a><a id="sthref241" name="sthref241"></a><a id="sthref242" name="sthref242"></a>Enumerated</td>
<td align="left" headers="r18c1-t16 r1c2-t16">Specify how to persist enumerated constraints if the <code>String</code> value suits your application requirements or to match an existing database schema.
<ul>
<li>
<p>ordinal</p>
</li>
<li>
<p><code>String</code></p>
</li>
</ul>
<p>This field corresponds to the <code>@Enumerated</code> annotation.</p>
</td>
<td align="left" headers="r18c1-t16 r1c3-t16">Ordinal</td>
<td align="left" headers="r18c1-t16 r1c4-t16"><br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r19c1-t16" headers="r1c1-t16">Target Entity</td>
<td align="left" headers="r19c1-t16 r1c2-t16">The persistent entity to which the attribute is mapped.</td>
<td align="left" headers="r19c1-t16 r1c3-t16"><br /></td>
<td align="left" headers="r19c1-t16 r1c4-t16"><a href="tasks017.htm#BABFHBCJ">One-to-one mapping</a>, <a href="tasks016.htm#BABHGEBD">One-to-many mapping</a> <a href="tasks014.htm#BABEIEGD">Many-to-many mapping</a>, <a href="tasks015.htm#BABHFAFJ">Many-to-one mapping</a></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r20c1-t16" headers="r1c1-t16"><a id="sthref243" name="sthref243"></a>ID</td>
<td align="left" headers="r20c1-t16 r1c2-t16">Specify if the entity's ID is derived from the identity of another entity.</td>
<td align="left" headers="r20c1-t16 r1c3-t16"><br /></td>
<td align="left" headers="r20c1-t16 r1c4-t16"><br /></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r21c1-t16" headers="r1c1-t16"><a id="CACJAIHB" name="CACJAIHB"></a>Cascade Type</td>
<td align="left" headers="r21c1-t16 r1c2-t16">Specify which operations are propagated throughout the entity.
<ul>
<li>
<p>All &ndash; All operations</p>
</li>
<li>
<p>Persist</p>
</li>
<li>
<p>Merge</p>
</li>
<li>
<p>Move</p>
</li>
<li>
<p>Remove</p>
</li>
<li>
<p>Refresh</p>
</li>
</ul>
</td>
<td align="left" headers="r21c1-t16 r1c3-t16"><br /></td>
<td align="left" headers="r21c1-t16 r1c4-t16"><a href="tasks017.htm#BABFHBCJ">One-to-one mapping</a>, <a href="tasks016.htm#BABHGEBD">One-to-many mapping</a>, <a href="tasks014.htm#BABEIEGD">Many-to-many mapping</a>, <a href="tasks015.htm#BABHFAFJ">Many-to-one mapping</a></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r22c1-t16" headers="r1c1-t16"><a id="CACJDJJA" name="CACJDJJA"></a>Mapped By</td>
<td align="left" headers="r22c1-t16 r1c2-t16">The field in the database table that "owns" the relationship. This field is required only on the non-owning side of the relationship.</td>
<td align="left" headers="r22c1-t16 r1c3-t16"><br /></td>
<td align="left" headers="r22c1-t16 r1c4-t16"><a href="tasks017.htm#BABFHBCJ">One-to-one mapping</a>, <a href="tasks016.htm#BABHGEBD">One-to-many mapping</a></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r23c1-t16" headers="r1c1-t16"><a id="CACDADIH" name="CACDADIH"></a><a id="sthref244" name="sthref244"></a><a id="sthref245" name="sthref245"></a>Order By</td>
<td align="left" headers="r23c1-t16 r1c2-t16">Specify the default order for objects returned from a query:
<ul>
<li>
<p>No ordering</p>
</li>
<li>
<p>Primary key</p>
</li>
<li>
<p>Custom ordering</p>
</li>
</ul>
<p>This field corresponds to the <code>@OrderBy</code> annotation.</p>
</td>
<td align="left" headers="r23c1-t16 r1c3-t16">Primary key</td>
<td align="left" headers="r23c1-t16 r1c4-t16"><a href="tasks016.htm#BABHGEBD">One-to-many mapping</a>. <a href="tasks014.htm#BABEIEGD">Many-to-many mapping</a>, <a href="tasks015.htm#BABHFAFJ">Many-to-one mapping</a></td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r24c1-t16" headers="r1c1-t16">Attribute Overrides</td>
<td align="left" headers="r24c1-t16 r1c2-t16">Overrides <span class="bold">Basic</span> mappings of a mapped superclass (for example, if the inherited column name is incompatible with a pre-existing data model, or invalid as a column name in your database).</td>
<td align="left" headers="r24c1-t16 r1c3-t16"><br /></td>
<td align="left" headers="r24c1-t16 r1c4-t16"><a href="tasks011.htm#BABCBHDF">Embedded mapping</a>
<p><a href="tasks011.htm#BABCBHDF">Embedded mapping</a></p>
<br /></td>
</tr>
</tbody>
</table>
<br /></div>
<!-- class="inftblruleinformal" -->
<p>&nbsp;</p>
<img src="img/ngrelt.png" alt="Related task" title="Related task" /><br />
<br />
<a href="task_mapping.htm#BABDGBIJ">Mapping an entity</a></div>
<!-- class="sect3" -->
<!-- Start Footer -->
<div class="footer">
<table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100%">
<col width="86%" />
<col width="*" />
<tr>
<td align="left"><span class="copyrightlogo">Copyright&nbsp;&copy;&nbsp;2006, 2010,&nbsp;Oracle&nbsp;and/or&nbsp;its&nbsp;affiliates.&nbsp;All&nbsp;rights&nbsp;reserved.</span><br />
<a href="dcommon/html/cpyr.htm"><span class="copyrightlogo">Legal Notices</span></a></td>
</tr>
</table>
</div>
<!-- class="footer" -->
</body>
</html>

Back to the top