Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRick Sapir2012-09-11 08:02:35 -0400
committerRick Sapir2012-09-11 08:02:35 -0400
commit8e0365779296d9be8fc41a2f70b35f664037c59c (patch)
treeeee45362bee52cded0193714a39eae0cdffc01f4 /jpa/plugins/org.eclipse.jpt.doc.user/reference006.htm
parentafcbd30b7682e576495f1c2069cdf9fe719aeacf (diff)
downloadwebtools.dali-8e0365779296d9be8fc41a2f70b35f664037c59c.tar.gz
webtools.dali-8e0365779296d9be8fc41a2f70b35f664037c59c.tar.xz
webtools.dali-8e0365779296d9be8fc41a2f70b35f664037c59c.zip
Updated docs, preliminary review
Diffstat (limited to 'jpa/plugins/org.eclipse.jpt.doc.user/reference006.htm')
-rw-r--r--jpa/plugins/org.eclipse.jpt.doc.user/reference006.htm149
1 files changed, 75 insertions, 74 deletions
diff --git a/jpa/plugins/org.eclipse.jpt.doc.user/reference006.htm b/jpa/plugins/org.eclipse.jpt.doc.user/reference006.htm
index 31bc24dbb3..51eaf2c862 100644
--- a/jpa/plugins/org.eclipse.jpt.doc.user/reference006.htm
+++ b/jpa/plugins/org.eclipse.jpt.doc.user/reference006.htm
@@ -3,120 +3,121 @@
<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" />
+<title>Customize Individual Entities</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="2012-09-11T7:44:6Z" />
<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" />
+<meta name="doctitle" content="Customize Individual Entities" />
+<meta name="relnum" content="Release 3.2" />
+<meta name="partnum" content="Release 3.2" />
<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="CACCAGGC" name="CACCAGGC"></a></p>
+<p class="betadraftsubtitle">Beta Draft: 2012-09-11</p>
+<p><a id="CACDGDIC" name="CACDGDIC"></a></p>
<div class="sect3"><!-- infolevel="all" infotype="General" -->
-<h1>General information</h1>
-<p>This table lists the General information fields available in the <span class="gui-object-title">JPA Details</span> view for each entity type.</p>
-<div class="inftblinformal">
-<table class="Informal" title="This table describes the options on the Persistence Properties view, General tab." summary="This table describes the options on the Persistence Properties view, General tab." dir="ltr" border="1" width="100%" frame="border" rules="all" cellpadding="3" cellspacing="0">
-<col width="16%" />
+<h1>Customize Individual Entities</h1>
+<p><a id="sthref315" name="sthref315"></a>Use this page to customize each generated entity. Select an item in the <span class="bold">Table and columns</span> area, then complete the following fields for each item.</p>
+<div class="inftblhruleinformal">
+<table class="HRuleInformal" title="Options on the Individual Entities page of the Generate Entities from Tables wizard" summary="Options on the Individual Entities page of the Generate Entities from Tables wizard" dir="ltr" border="1" width="100%" frame="hsides" rules="rows" cellpadding="3" cellspacing="0">
+<col width="32%" />
<col width="*" />
-<col width="17%" />
-<col width="25%" />
<thead>
<tr align="left" valign="top">
-<th align="left" valign="bottom" id="r1c1-t13">Property</th>
-<th align="left" valign="bottom" id="r1c2-t13">Description</th>
-<th align="left" valign="bottom" id="r1c3-t13">Default</th>
-<th align="left" valign="bottom" id="r1c4-t13">Available for Entity&nbsp;Type</th>
+<th align="left" valign="bottom" id="r1c1-t9">Property</th>
+<th align="left" valign="bottom" id="r1c2-t9">Description</th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
-<td align="left" id="r2c1-t13" headers="r1c1-t13">Mapping Type Hyperlink</td>
-<td align="left" headers="r2c1-t13 r1c2-t13">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 entity: Mapped Superclass, Embeddable or the default mapping type.</td>
-<td align="left" headers="r2c1-t13 r1c3-t13">Entity</td>
-<td align="left" headers="r2c1-t13 r1c4-t13"><a href="tasks006.htm#BABGBIEE">Entity</a>, <a href="tasks007.htm#BABFEICE">Embeddable</a>, and <a href="tasks008.htm#BABDAGCI">Mapped superclass</a></td>
-</tr>
-<tr align="left" valign="top">
-<td align="left" id="r3c1-t13" headers="r1c1-t13">Table</td>
-<td align="left" headers="r3c1-t13 r1c2-t13">The default database table information for this entity. These fields can be overridden by the information in the <a href="reference007.htm#CACIJBGH">Attribute overrides</a> area.</td>
-<td align="left" headers="r3c1-t13 r1c3-t13"><br /></td>
-<td align="left" headers="r3c1-t13 r1c4-t13"><a href="tasks006.htm#BABGBIEE">Entity</a><br /></td>
-</tr>
-<tr align="left" valign="top">
-<td align="left" id="r4c1-t13" headers="r1c1-t13">&nbsp;&nbsp;Name</td>
-<td align="left" headers="r4c1-t13 r1c2-t13">The name of the primary database table associated with the entity.</td>
-<td align="left" headers="r4c1-t13 r1c3-t13"><br /></td>
-<td align="left" headers="r4c1-t13 r1c4-t13"><a href="tasks006.htm#BABGBIEE">Entity</a><br /></td>
-</tr>
-<tr align="left" valign="top">
-<td align="left" id="r5c1-t13" headers="r1c1-t13">&nbsp;&nbsp;Catalog</td>
-<td align="left" headers="r5c1-t13 r1c2-t13">The database catalog that contains the <span class="bold">Table</span>.</td>
-<td align="left" headers="r5c1-t13 r1c3-t13">As defined in <code>orm.xml</code>.</td>
-<td align="left" headers="r5c1-t13 r1c4-t13"><a href="tasks006.htm#BABGBIEE">Entity</a><br /></td>
+<td align="left" id="r2c1-t9" headers="r1c1-t9">
+<p><span class="bold">Mapping defaults</span></p>
+</td>
+<td align="left" headers="r2c1-t9 r1c2-t9">
+<p>Use these options to define the table mapping information for the entity.</p>
+</td>
</tr>
<tr align="left" valign="top">
-<td align="left" id="r6c1-t13" headers="r1c1-t13">&nbsp;&nbsp;Schema</td>
-<td align="left" headers="r6c1-t13 r1c2-t13">The database schema that contains the <span class="bold">Table</span>.</td>
-<td align="left" headers="r6c1-t13 r1c3-t13">As defined in <code>orm.xml</code>.</td>
-<td align="left" headers="r6c1-t13 r1c4-t13"><a href="tasks006.htm#BABGBIEE">Entity</a><br /></td>
+<td align="left" id="r3c1-t9" headers="r1c1-t9">
+<p>Class name</p>
+</td>
+<td align="left" headers="r3c1-t9 r1c2-t9"><br /></td>
</tr>
<tr align="left" valign="top">
-<td align="left" id="r7c1-t13" headers="r1c1-t13">Name</td>
-<td align="left" headers="r7c1-t13 r1c2-t13">The name of this entity. By default, the class name is used as the entity name.</td>
-<td align="left" headers="r7c1-t13 r1c3-t13"><br /></td>
-<td align="left" headers="r7c1-t13 r1c4-t13"><a href="tasks006.htm#BABGBIEE">Entity</a><br /></td>
+<td align="left" id="r4c1-t9" headers="r1c1-t9">
+<p>Key&nbsp;generator</p>
+</td>
+<td align="left" headers="r4c1-t9 r1c2-t9">
+<p>Select the generator used for this mapping.</p>
+</td>
</tr>
<tr align="left" valign="top">
-<td align="left" id="r8c1-t13" headers="r1c1-t13">Access</td>
-<td align="left" headers="r8c1-t13 r1c2-t13">The access method for this entity.</td>
-<td align="left" headers="r8c1-t13 r1c3-t13">Field</td>
-<td align="left" headers="r8c1-t13 r1c4-t13"><a href="tasks006.htm#BABGBIEE">Entity</a><br /></td>
+<td align="left" id="r5c1-t9" headers="r1c1-t9">
+<p>Sequence&nbsp;name</p>
+</td>
+<td align="left" headers="r5c1-t9 r1c2-t9">
+<p>Enter a name for the sequence.</p>
+<p>You can use <span class="bold">$table</span> and <span class="bold">$pk</span> as variables in the name. These will be replaced by the table name and primary key column name (respectively) when Dali generates a table mapping.</p>
+</td>
</tr>
<tr align="left" valign="top">
-<td align="left" id="r9c1-t13" headers="r1c1-t13">Primary&nbsp;key&nbsp;class</td>
-<td align="left" headers="r9c1-t13 r1c2-t13">Click <span class="bold">Browse</span> and select the primary key for the entity. Clicking the field name, which is represented as a hyperlink, allows you to create a new class.</td>
-<td align="left" headers="r9c1-t13 r1c3-t13"><br /></td>
-<td align="left" headers="r9c1-t13 r1c4-t13"><br /></td>
+<td align="left" id="r6c1-t9" headers="r1c1-t9">
+<p>Entity&nbsp;access</p>
+</td>
+<td align="left" headers="r6c1-t9 r1c2-t9">
+<p>Specify the default entity access method: <span class="bold">Field</span> (default) or <span class="bold">Property</span>.</p>
+</td>
</tr>
<tr align="left" valign="top">
-<td align="left" id="r10c1-t13" headers="r1c1-t13">Cachable</td>
-<td align="left" headers="r10c1-t13 r1c2-t13">Specifies if the entity is cachable.
-<p>This field corresponds to the <code>@Cachable</code> annotation.</p>
+<td align="left" id="r7c1-t9" headers="r1c1-t9">
+<p><span class="bold">Domain Java Class</span></p>
+</td>
+<td align="left" headers="r7c1-t9 r1c2-t9">
+<p>Use these options to define the class information (<span class="bold">Superclass</span> and <span class="bold">Interfaces</span>) for the entity.</p>
</td>
-<td align="left" headers="r10c1-t13 r1c3-t13">@Cachable(false)</td>
-<td align="left" headers="r10c1-t13 r1c4-t13"><a href="tasks006.htm#BABGBIEE">Entity</a><br /></td>
</tr>
</tbody>
</table>
<br /></div>
-<!-- class="inftblinformal" -->
-<p>&nbsp;</p>
-<img src="img/ngrelt.png" alt="Related task" title="Related task" /><br />
-<br />
-<a href="task_add_persistence.htm#BABHICAI">Adding persistence to a class</a>
-<p>&nbsp;</p>
-<img src="img/ngrelr.png" alt="Related reference" title="Related reference" /><br />
-<br />
-<a href="ref_persistence_prop_view.htm#BABFAEBB">JPA Details view (for entities)</a></div>
+<!-- class="inftblhruleinformal" -->
+<a id="sthref316" name="sthref316"></a>
+<p class="subhead2">Related tasks</p>
+<ul>
+<li>
+<p><a href="task_create_jpa_entity.htm#BABFBJBG">Creating a JPA entity</a></p>
+</li>
+<li>
+<p><a href="tasks023.htm#CIHHFGIG">Generating dynamic entities from tables</a></p>
+</li>
+<li>
+<p><a href="ref_persistence_prop_view.htm#BABFAEBB">JPA Details view (for entities)</a></p>
+</li>
+</ul>
+<a id="sthref317" name="sthref317"></a>
+<p class="subhead2">Related reference</p>
+<ul>
+<li>
+<p><a href="reference002.htm#CACGDFDJ">Generate Dynamic Entities from Tables wizard</a></p>
+</li>
+</ul>
+</div>
<!-- class="sect3" -->
+<!-- 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;2006, 2010,&nbsp;Oracle&nbsp;and/or&nbsp;its&nbsp;affiliates.&nbsp;All&nbsp;rights&nbsp;reserved.</span><br />
+<td align="left"><span class="copyrightlogo">Copyright&nbsp;&copy;&nbsp;2011, 2012,&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>
+</html> \ No newline at end of file

Back to the top