| <!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> |
| <!-- Run date = May 21, 2008 14:42:03 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" /> |
| <title>Creating a JPA Entity</title> |
| |
| <meta http-equiv="Content-Style-Type" content="text/css" /> |
| <meta http-equiv="Content-Script-Type" content="text/javascript" /> |
| <meta name="generator" content="Oracle DARB XHTML Converter (Mode = ohj/ohw) - Version 5.0" /> |
| <meta name="date" content="2005-07-10T12:57:20+08:00" /> |
| <meta name="robots" content="noarchive" /> |
| <meta name="doctitle" content="Creating a JPA Entity" /> |
| <meta name="relnum" content="Release 2.0" /> |
| <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" /> |
| <link rel="start" href="../../index.htm" title="Home" type="text/html" /> |
| <link rel="contents" href="toc.htm" title="Contents" type="text/html" /> |
| </head> |
| <body> |
| <p><a id="BABFBJBG" name="BABFBJBG"></a></p> |
| <div class="sect1"><!-- infolevel="all" infotype="General" --> |
| <h1><a id="sthref28" name="sthref28"></a>Creating a JPA Entity</h1> |
| <p>Use this procedure to create a JPA entity:</p> |
| <ol start="1"> |
| <li> |
| <p>From the Navigator or Package Explorer, select the JPA project and then <span class="bold">File > New > Other</span>. The Select a Wizard dialog appears.</p> |
| <div class="figure"><a id="sthref29" name="sthref29"></a> |
| <p class="titleinfigure">Selecting the Create a JPA Entity Wizard</p> |
| <img src="img/select_a_wizard_entity.png" alt="The Select a Wizard dialog with Entity selected." title="The Select a Wizard dialog with Entity selected." /><br /></div> |
| <!-- class="figure" --></li> |
| <li> |
| <p>Select <span class="bold">Entity</span> and then click <span class="bold">Next</span>. The <a href="reference003.htm#CIAFEIGF">Entity Class page</a> appears.</p> |
| <div class="figure"><a id="sthref30" name="sthref30"></a> |
| <p class="titleinfigure">The Entity Class Page</p> |
| <img src="img/create_jpa_entity_wizard.png" alt="The Entity Class page of the Create a JPA Entity wizard." title="The Entity Class page of the Create a JPA Entity wizard." /><br /></div> |
| <!-- class="figure" --> |
| <p>Complete this page as follows:</p> |
| <ul> |
| <li> |
| <p>Select the JPA project in the Project field.</p> |
| </li> |
| <li> |
| <p>In the Source Folder field, select, or enter, the location of the JPA project's src folder.</p> |
| </li> |
| <li> |
| <p>Select, or enter, the name of the class package for this entity in the Java Package field.</p> |
| </li> |
| <li> |
| <p>Enter the name of the Java class in the Class name field.</p> |
| </li> |
| <li> |
| <p>If needed, enter, or select a superclass.</p> |
| </li> |
| <li> |
| <p>If needed, complete the Inheritance section as follows (these properties are optional):</p> |
| <ul> |
| <li> |
| <p>Accept the <span class="bold">Entity</span> option (the default) to create a Java class with the <code>@Entity</code> option.</p> |
| </li> |
| <li> |
| <p>Alternatively, select <a href="tasks008.htm#BABDAGCI">Mapped superclass</a> (if you defined a super class).</p> |
| </li> |
| <li> |
| <p>Select <span class="bold">Inheritance</span> and then select one of the JSR 220 inheritance mapping strategies (SINGLE_TABLE, TABLE_PER_CLASS, JOINED).</p> |
| </li> |
| <li> |
| <p>Select <span class="bold">Add</span> to entity mappings in XML to create XML mappings in <code>orm.xml</code>, rather than annotations.</p> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li> |
| <p>Click <span class="bold">Next</span> to proceed to the <a href="reference004.htm#CIADECIA">Entity Properties page</a> where you define the persistent fields for the entity.</p> |
| <div class="figure"><a id="sthref31" name="sthref31"></a> |
| <p class="titleinfigure">The Entity Properties Page</p> |
| <img src="img/create_jpa_fields.png" alt="The Entity Properties page of the Create JPA Entity wizard." title="The Entity Properties page of the Create JPA Entity wizard." /><br /></div> |
| <!-- class="figure" --> |
| <p>Alternatively, click <span class="bold">Finish</span> to complete the entity.</p> |
| </li> |
| <li> |
| <p>Complete the page as follows:</p> |
| <ol start="1"> |
| <li> |
| <p>If needed, enter a new name for the entity. Doing so results in adding a <code>name</code> attribute to the <code>@Entity</code> notation (<code>@Entity(name="EntityName")</code>).</p> |
| </li> |
| <li> |
| <p>Accept <span class="bold">Use default</span> (the default setting) to use the default value for the name of the mapped table. Entering a different name results in adding the <code>@Table</code> notation with its <code>name</code> attribute defined as the new table (<code>@Table(name="TableName")</code>).</p> |
| <div align="center"> |
| <div class="inftblnote"><br /> |
| <table class="Note oac_no_warn" summary="" cellpadding="3" cellspacing="0"> |
| <tbody> |
| <tr> |
| <td align="left"> |
| <p class="notep1">Note:</p> |
| The Entity Name-related options are not available if you selected <a href="tasks008.htm#BABDAGCI">Mapped superclass</a> on the <a href="reference003.htm#CIAFEIGF">Entity Class page</a></td> |
| </tr> |
| </tbody> |
| </table> |
| <br /></div> |
| <!-- class="inftblnote" --></div> |
| </li> |
| <li> |
| <p>Add persistence fields to the entity by clicking <span class="bold">Add</span>. The Entity Fields dialog appears.</p> |
| <div class="figure"><a id="sthref32" name="sthref32"></a> |
| <p class="titleinfigure">The Entity Fields Dialog</p> |
| <img src="img/jpa_wizard_create_fields.png" alt="The Entity Fields dialog." title="The Entity Fields dialog." /><br /></div> |
| <!-- class="figure" --></li> |
| <li> |
| <p>Select a persistence type from the Type list. You can retrieve additional types using the <span class="bold">Browse</span> function.</p> |
| </li> |
| <li> |
| <p>Enter the field name and then click <span class="bold">OK</span>. Repeat this procedure for each field.</p> |
| </li> |
| <li> |
| <p>If needed, select <span class="bold">Key</span> to designate the field as a primary key.</p> |
| </li> |
| <li> |
| <p>Select either the <span class="bold">Field-based</span> access type (the default) or <span class="bold">Property-based</span> access type.</p> |
| </li> |
| </ol> |
| </li> |
| </ol> |
| <p> </p> |
| <img src="img/ngrelr.png" alt="Related reference" title="Related reference" /><br /> |
| <br /> |
| <a href="reference002.htm#CIAGGGDF">Create JPA Entity wizard</a><br /> |
| <a href="ref_new_jpa_project_wizard.htm#CACBJGBG">Create New JPA Project wizard</a><br /> |
| <a href="ref_persistence_perspective.htm#BABIFBDB">JPA Development perspective</a> |
| <p> </p> |
| <img src="img/ngrelt.png" alt="Related tasks" title="Related tasks" /><br /> |
| <br /> |
| <a href="task_manage_persistence.htm#CIHDAJID">Managing the persistence.xml file</a><br /> |
| <a href="task_add_persistence.htm#BABHICAI">Adding persistence to a class</a> |
| <p> </p> |
| <img src="img/ngrelc.png" alt="Related concept" title="Related concept" /><br /> |
| <br /> |
| <a href="concept_persistence.htm#BABCAHIC">Understanding Java persistence</a><br /> |
| <a href="concepts002.htm#CHDHAGIH">The persistence.xml file</a><br /> |
| <p> </p> |
| </div> |
| <!-- class="sect1" --> |
| <!-- Start Footer --> |
| <div class="footer"> |
| <table class="simple oac_no_warn" summary="" cellspacing="0" cellpadding="0" width="100%"> |
| <tr> |
| <td align="left" width="86%"><a href="dcommon/html/cpyr.htm"><span class="copyrightlogo">Copyright © 2006, 2008, Oracle. All rights reserved.</span></a></td> |
| </tr> |
| </table> |
| </div> |
| <!-- class="footer" --> |
| </body> |
| </html> |