Skip to main content
summaryrefslogtreecommitdiffstats
blob: a040988c649baa071134068182ac9f5a5fea040d (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
<!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>ID mapping</title>
<meta name="copyright" content="Copyright (c) 2000, 2009 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" />
<meta name="generator" content="Oracle DARB XHTML Converter (Mode = ohj/ohw) - Version 1.0.11" />
<meta name="date" content="2013-04-05T12:21:33Z" />
<meta name="robots" content="noarchive" />
<meta name="doctitle" content="ID mapping" />
<meta name="relnum" content="Release 3.3" />
<meta name="partnum" content="Release 3.3" />
<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" />
</head>
<body>
<p><a id="BABGCBHG" name="BABGCBHG"></a></p>
<div class="sect2"><!-- infolevel="all" infotype="General" -->
<h1>ID mapping</h1>
<p><a id="sthref232" name="sthref232"></a><a id="sthref233" name="sthref233"></a><a id="sthref234" name="sthref234"></a><a id="sthref235" name="sthref235"></a>Use an <span class="bold">ID Mapping</span> to specify the primary key of an entity. ID mappings may be used with a <a href="tasks004.htm#BABGBIEE">Entity</a> or <a href="tasks006.htm#BABDAGCI">Mapped superclass</a>. Each <a href="tasks004.htm#BABGBIEE">Entity</a> must have an ID mapping.</p>
<ol>
<li>
<p>In the <a href="ref_persistence_outline.htm#BABEGGFE">JPA Structure view</a>, select the field to map.</p>
</li>
<li>
<p>Right click the filed and then select <span class="bold">Map as &gt; ID</span>. The <a href="ref_persistence_map_view.htm#BABIFBAF">JPA Details view (for attributes)</a> displays the properties for the selected.</p>
<div class="figure"><a id="sthref236" name="sthref236"></a>
<p class="titleinfigure">JPA Details, ID mapping</p>
<img src="img/jpa_details_idmapping.png" alt="" title="" /><br /></div>
<!-- class="figure" --></li>
<li>
<p>Complete each field in the <a href="reference037.htm#CACIAEFI">ID Mapping</a> area.</p>
</li>
<li>
<p>Use the Primary Key Generation area to specify the strategy to use for generating primary keys.</p>
<div class="figure"><a id="sthref237" name="sthref237"></a>
<p class="titleinfigure">JPA Details, Primary key generation</p>
<img src="img/jpa_details_primarykeygeneration.png" alt="JPA Details, Primary key generation" title="JPA Details, Primary key generation" /><br /></div>
<!-- class="figure" --></li>
<li>
<p>Complete each field in the <a href="ref_primary_key.htm#CACFCCAB">Primary Key Generation information</a> area.</p>
</li>
<li>
<p>Complete the remaining areas in the <a href="ref_persistence_map_view.htm#BABIFBAF">JPA Details view (for attributes)</a>.</p>
</li>
</ol>
<p>Additional fields will appear in the <a href="ref_primary_key.htm#CACFCCAB">Primary Key Generation information</a> area, depending on the selected Strategy. See <a href="ref_persistence_map_view.htm#BABIFBAF">"JPA Details view (for attributes)"</a> for additional information.</p>
<p>Eclipse adds the following annotations to the field:</p>
<pre xml:space="preserve" class="oac_no_warn">
@Id
@Column(
    name="<span class="italic">&lt;COLUMN_NAME&gt;</span>", 
    table="<span class="italic">&lt;TABLE_NAME&gt;</span>", 
    insertable=<span class="italic">&lt;INSERTABLE&gt;</span>,
    updatable=<span class="italic">&lt;UPDATABLE&gt;</span>
)
@Temporal(<span class="italic">&lt;TEMPORAL&gt;</span>)
@GeneratedValue(
    strategy=GeneratorType.<span class="italic">&lt;STRATEGY&gt;</span>, 
    generator="<span class="italic">&lt;GENERATOR_NAME&gt;</span>"
)@TableGenerator(
    name="<span class="italic">&lt;TABLE_GENERATOR_NAME&gt;</span>", 
    table = "<span class="italic">&lt;TABLE_GENERATOR_TABLE&gt;</span>", 
    pkColumnName = "<span class="italic">&lt;TABLE_GENERATOR_PK&gt;</span>", 
    valueColumnName = "<span class="italic">&lt;TABLE_GENERATOR_VALUE_COLUMN&gt;</span>", 
    pkColumnValue = "<span class="italic">&lt;TABLE_GENERATOR_PK_COLUMN_VALUE&gt;</span>"
)@SequenceGenerator(name="<span class="italic">&lt;SEQUENCE_GENERATOR_NAME&gt;</span>", 
    sequenceName="<span class="italic">&lt;SEQUENCE_GENERATOR_SEQUENCE&gt;</span>")
</pre>
<a id="sthref238" name="sthref238"></a>
<p class="subhead2">Related tasks</p>
<ul>
<li>
<p><a href="task_mapping.htm#BABDGBIJ">Mapping an entity</a></p>
</li>
</ul>
<a id="sthref239" name="sthref239"></a>
<p class="subhead2">Related references</p>
<ul>
<li>
<p><a href="ref_persistence_outline.htm#BABEGGFE">JPA Structure view</a></p>
</li>
<li>
<p><a href="ref_persistence_map_view.htm#BABIFBAF">JPA Details view (for attributes)</a></p>
</li>
<li>
<p><a href="ref_primary_key.htm#CACFCCAB">Primary Key Generation information</a></p>
</li>
<li>
<p><a href="reference053.htm#CIADGCID">Converters</a></p>
</li>
<li>
<p><a href="reference043.htm#CACIHAAF">Type information</a></p>
</li>
</ul>
<a id="sthref240" name="sthref240"></a>
<p class="subhead2">Related concepts</p>
<ul>
<li>
<p><a href="concept_mapping.htm#BABBDJFI">Understanding OR mappings</a></p>
</li>
<li>
<p><a href="concepts001.htm#BABBGFJG">Understanding Java Persistence API</a></p>
</li>
</ul>
</div>
<!-- class="sect2" -->
<!-- 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;2011, 2013,&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