| <!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="generator" content="Oracle DARB XHTML Converter (Mode = ohj/ohw) - Version 5.1.1 Build 004" /> |
| <meta name="date" content="2010-01-22T9:29:47Z" /> |
| <meta name="robots" content="noarchive" /> |
| <meta name="doctitle" content="ID mapping" /> |
| <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="BABGCBHG" name="BABGCBHG"></a></p> |
| <div class="sect2"><!-- infolevel="all" infotype="General" --> |
| <h1>ID mapping</h1> |
| <p><a id="sthref124" name="sthref124"></a><a id="sthref125" name="sthref125"></a><a id="sthref126" name="sthref126"></a><a id="sthref127" name="sthref127"></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="tasks005.htm#BABGBIEE">Entity</a> or <a href="tasks007.htm#BABDAGCI">Mapped superclass</a>. Each <a href="tasks005.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 > ID</span>. The <a href="ref_persistence_map_view.htm#BABIFBAF">JPA Details view (for attributes)</a> displays the properties for the selected.</p> |
| </li> |
| <li> |
| <p>Use this table to complete the <a href="ref_mapping_general.htm#CACBHFIJ">General information</a> fields in the <span class="gui-object-title">JPA Details</span> view.</p> |
| <div class="inftblruleinformal"> |
| <table class="RuleInformal" title="This table lists the fields in the Persistence Properties view for this mapping." summary="This table lists the fields in the Persistence Properties view for this mapping." dir="ltr" border="1" width="100%" frame="border" rules="all" cellpadding="3" cellspacing="0"> |
| <col width="22%" /> |
| <col width="*" /> |
| <col width="35%" /> |
| <thead> |
| <tr align="left" valign="top"> |
| <th align="left" valign="bottom" id="r1c1-t17">Property</th> |
| <th align="left" valign="bottom" id="r1c2-t17">Description</th> |
| <th align="left" valign="bottom" id="r1c3-t17">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr align="left" valign="top"> |
| <td align="left" id="r2c1-t17" headers="r1c1-t17">Entity Mapping Hyperlink</td> |
| <td align="left" headers="r2c1-t17 r1c2-t17">Defines this mapping as an <span class="bold">ID Mapping</span>. |
| <p>This field corresponds to the <code>@Id</code> annotation.</p> |
| </td> |
| <td align="left" headers="r2c1-t17 r1c3-t17">ID</td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r3c1-t17" headers="r1c1-t17">Column</td> |
| <td align="left" headers="r3c1-t17 r1c2-t17">The database column mapped to the entity attribute. See <a href="ref_mapping_general.htm#CACGCBHB">"Column"</a> for details.</td> |
| <td align="left" headers="r3c1-t17 r1c3-t17">By default, the Column is assumed to be named identically to the attribute.</td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r4c1-t17" headers="r1c1-t17">Table</td> |
| <td align="left" headers="r4c1-t17 r1c2-t17">The database table mapped to the entity attribute.</td> |
| <td align="left" headers="r4c1-t17 r1c3-t17">By default, the Table is assumed to be identical to the table associated with the entity.</td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r5c1-t17" headers="r1c1-t17">Temporal</td> |
| <td align="left" headers="r5c1-t17 r1c2-t17">Specifies the type of data. See <a href="ref_mapping_general.htm#CACEAJGD">"Temporal"</a> for details. |
| <ul> |
| <li> |
| <p>Date</p> |
| </li> |
| <li> |
| <p>Time</p> |
| </li> |
| <li> |
| <p>Timestamp</p> |
| </li> |
| </ul> |
| </td> |
| <td align="left" headers="r5c1-t17 r1c3-t17"><br /></td> |
| </tr> |
| </tbody> |
| </table> |
| <br /></div> |
| <!-- class="inftblruleinformal" --></li> |
| <li> |
| <p>Use this table to complete the fields in <a href="ref_primary_key.htm#CACFCCAB">Primary Key Generation information</a> area in the <span class="gui-object-title">JPA Details</span> view.</p> |
| <div class="inftblruleinformal"> |
| <table class="RuleInformal" title="This table lists the fields in the PK Generation tab." summary="This table lists the fields in the PK Generation tab." dir="ltr" border="1" width="100%" frame="border" rules="all" cellpadding="3" cellspacing="0"> |
| <col width="22%" /> |
| <col width="*" /> |
| <col width="35%" /> |
| <thead> |
| <tr align="left" valign="top"> |
| <th align="left" valign="bottom" id="r1c1-t18">Property</th> |
| <th align="left" valign="bottom" id="r1c2-t18">Description</th> |
| <th align="left" valign="bottom" id="r1c3-t18">Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr align="left" valign="top"> |
| <td align="left" id="r2c1-t18" headers="r1c1-t18">Primary Key Generation</td> |
| <td align="left" headers="r2c1-t18 r1c2-t18">These fields define how the primary key is generated.</td> |
| <td align="left" headers="r2c1-t18 r1c3-t18"><br /></td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r3c1-t18" headers="r1c1-t18"> Strategy</td> |
| <td align="left" headers="r3c1-t18 r1c2-t18">See <a href="ref_primary_key.htm#CACBAJBC">"Primary Key Generation"</a> for details. |
| <ul> |
| <li> |
| <p>Auto</p> |
| </li> |
| <li> |
| <p>Sequence</p> |
| </li> |
| <li> |
| <p>Identity</p> |
| </li> |
| <li> |
| <p>Table</p> |
| </li> |
| </ul> |
| </td> |
| <td align="left" headers="r3c1-t18 r1c3-t18">Auto</td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r4c1-t18" headers="r1c1-t18"> Generator Name</td> |
| <td align="left" headers="r4c1-t18 r1c2-t18">Name of the primary key generator specified in the <span class="bold">Strategy</span></td> |
| <td align="left" headers="r4c1-t18 r1c3-t18"><br /></td> |
| </tr> |
| </tbody> |
| </table> |
| <br /></div> |
| <!-- class="inftblruleinformal" --></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"><COLUMN_NAME></span>", table="<span class="italic"><TABLE_NAME></span>", insertable=<span class="italic"><INSERTABLE></span>, |
| updatable=<span class="italic"><UPDATABLE></span>) |
| @Temporal(<span class="italic"><TEMPORAL></span>) |
| @GeneratedValue(strategy=GeneratorType.<span class="italic"><STRATEGY></span>, generator="<span class="italic"><GENERATOR_NAME></span>")@TableGenerator(name="<span class="italic"><TABLE_GENERATOR_NAME></span>", table = "<span class="italic"><TABLE_GENERATOR_TABLE></span>", |
| pkColumnName = "<span class="italic"><TABLE_GENERATOR_PK></span>", |
| valueColumnName = "<span class="italic"><TABLE_GENERATOR_VALUE_COLUMN></span>", |
| pkColumnValue = "<span class="italic"><TABLE_GENERATOR_PK_COLUMN_VALUE></span>")@SequenceGenerator(name="<span class="italic"><SEQUENCE_GENERATOR_NAME></span>", |
| sequenceName="<span class="italic"><SEQUENCE_GENERATOR_SEQUENCE></span>") |
| </pre> |
| <p> </p> |
| <img src="img/ngrelt.png" alt="Related task" title="Related task" /><br /> |
| <br /> |
| <a href="task_mapping.htm#BABDGBIJ">Mapping an entity</a> |
| <p> </p> |
| <img src="img/ngrelr.png" alt="Related reference" title="Related reference" /><br /> |
| <br /> |
| <a href="ref_persistence_outline.htm#BABEGGFE">JPA Structure view</a><br /> |
| <a href="ref_persistence_map_view.htm#BABIFBAF">JPA Details view (for attributes)</a> |
| <p> </p> |
| <img src="img/ngrelc.png" alt="Related concept" title="Related concept" /><br /> |
| <br /> |
| <a href="concept_mapping.htm#BABBDJFI">Understanding OR mappings</a><br /> |
| <a href="concepts001.htm#BABBGFJG">Understanding EJB 3.0 Java Persistence API</a></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 © 2006, 2010, Oracle and/or its affiliates. All rights reserved.</span><br /> |
| <a href="dcommon/html/cpyr.htm"><span class="copyrightlogo">Legal Notices</span></a></td> |
| </tr> |
| </table> |
| </div> |
| <!-- class="footer" --> |
| </body> |
| </html> |
