diff options
| author | Petya Sabeva | 2013-04-23 15:07:12 +0000 |
|---|---|---|
| committer | Petya Sabeva | 2013-04-23 15:09:41 +0000 |
| commit | 75863a96f331ee9e0d03a62e8e1dfd309297d9e5 (patch) | |
| tree | 5a7e38317d06ff4a7aa22393bac9f63c86d005d4 /jpa_diagram_editor/plugins | |
| parent | 3aaafeecbc8c051d9e46c52f5d31f7de57db4c13 (diff) | |
| download | webtools.dali-75863a96f331ee9e0d03a62e8e1dfd309297d9e5.tar.gz webtools.dali-75863a96f331ee9e0d03a62e8e1dfd309297d9e5.tar.xz webtools.dali-75863a96f331ee9e0d03a62e8e1dfd309297d9e5.zip | |
Bug 392717 - Add and update user documentation
Change-Id: Ib5f0b7dcc25900b5f40c72a2489cbd4ee56e5ad6
Diffstat (limited to 'jpa_diagram_editor/plugins')
19 files changed, 987 insertions, 355 deletions
diff --git a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/derived_identifiers.html b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/derived_identifiers.html new file mode 100644 index 0000000000..18d0a05b69 --- /dev/null +++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/derived_identifiers.html @@ -0,0 +1,64 @@ +<!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" />
+<style>
+kbd.keyboard {
+ font-weight: bold;
+ color: white;
+ background-color: #BEBEBE;
+}
+</style>
+<title>Derived Identifiers</title>
+
+<!-- contents -->
+</head>
+<body>
+
+ <div class="sect1">
+ <!-- infolevel="all" infotype="General" -->
+ <h1>Derived Identifiers</h1>
+ <p>
+ When there is a <b>uni-</b> or <b>bi-directional</b> relationship of
+ type <b>one-to-one</b> and <b>many-to-one</b>, the owner of the
+ relationship can derive identity from the target entity.
+ </p>
+ <td><div>
+ <ol>
+ <li><p>
+ In the <i>Derived Identifiers</i> list of <i>Palette</i>, choose
+ a relationship type.
+ </p></li>
+ <li><p>
+ Click on the source entity of the relationship or press
+ <kbd class="keyboard">ESCAPE</kbd>
+ to cancel.
+ </p></li>
+ <li><p>
+ Click on the target entity of the relationship or press
+ <kbd class="keyboard">ESCAPE</kbd>
+ to cancel.
+ </p>
+ <p>The Eclipse IDE creates and visualizes the relationship, as
+ well as the relevant relationship attributes of the entities,
+ depending on the type of relation.</p></li>
+ <li><p>
+ To remove a particular relationship, select the relation on the
+ JPA diagram and press
+ <kbd class="keyboard">DELETE</kbd>
+ , or choose <i>Delete</i> from the context menu.
+ </p>
+ <div>
+ <p>Removing a relationship via the JPA diagram also removes
+ it from the application data model and deletes the relationship
+ attributes of the two related entities.</p>
+ </div></li>
+ </ol>
+ </div></td>
+ </div>
+</body>
+</html>
\ No newline at end of file diff --git a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/element_collection.html b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/element_collection.html new file mode 100644 index 0000000000..ef0e094c11 --- /dev/null +++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/element_collection.html @@ -0,0 +1,72 @@ +<!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" />
+<style>
+span.courier {
+ font-family: "Courier New", Courier, monospace;
+ font-size: 12pt;
+}
+kbd.keyboard {
+ font-weight: bold;
+ color: white;
+ background-color: #BEBEBE;
+}
+</style>
+<title>Adding Attribute of Type element-collection</title>
+
+<!-- contents -->
+</head>
+<body>
+
+ <div class="sect1">
+ <!-- infolevel="all" infotype="General" -->
+ <h1>Adding Attribute of Type element-collection</h1>
+ <h2>Overview</h2>
+ <p>The JPA diagram editor supports collections of embeddables and
+ primitives.</p>
+
+ <ul>
+ <li><p>
+ To add an element-collection attribute of primitives, position the
+ mouse cursor over the entity you want to manage and choose the <i>Create
+ Collection Attribute</i> button. Each button has an informative
+ tooltip that describes the relevant operation.
+ </p></li>
+ <li><p>
+ To add an element-collection attribute of embeddables, a collection
+ of embeddable should be pinned to an entity or to another
+ embeddable. In the <i>Composition</i> list of <i>Palette</i>,
+ choose <i>Embed Collection of Elements</i>.
+ </p></li>
+ </ul>
+
+ <h2>Procedure</h2>
+ <ol>
+ <li><p>
+ Click on the source entity or the embeddable of the Has-A
+ relationship or press
+ <kbd class="keyboard">ESCAPE</kbd>
+ to cancel.
+ </p></li>
+ <li><p>
+ Click on the target embeddable of the Has-A relationship or press
+ <kbd class="keyboard">ESCAPE</kbd>
+ to cancel.
+ </p>
+ <p>The Eclipse IDE creates and visualizes the Has-A relationship
+ as well as the relevant embedded attribute in the entity, in which
+ the embeddable is set.</p></li>
+ </ol>
+ <p>
+ The attribute will be mapped with <span class="courier">@ElementCollection</span>
+ annotation.
+ </p>
+
+ </div>
+</body>
+</html>
\ No newline at end of file diff --git a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/embeddable_relationships.html b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/embeddable_relationships.html new file mode 100644 index 0000000000..d9b6443f8b --- /dev/null +++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/embeddable_relationships.html @@ -0,0 +1,93 @@ +<!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" />
+<style>
+p.notep {
+ font-weight: bold;
+}
+
+table.note {
+ background: #FFFFC0;
+ border: 1px solid #000000;
+ width: 100%;
+}
+
+span.courier {
+ font-family: "Courier New", Courier, monospace;
+ font-size: 12pt;
+}
+
+kbd.keyboard {
+ font-weight: bold;
+ color: white;
+ background-color: #BEBEBE;
+}
+</style>
+<title>Defining and Removing Relationships between Embeddables
+ and Entities</title>
+
+<!-- contents -->
+</head>
+<body>
+
+ <div class="sect1">
+ <!-- infolevel="all" infotype="General" -->
+ <h1>Defining and Removing Relationships between Embeddables and
+ Entities</h1>
+ <td><div>
+ <ol>
+ <li><p>
+ In the <i>Relations</i> list of <i>Palette</i>, choose a
+ relationship type.
+ </p></li>
+ <li><p>
+ <a href="embeddables.html">Embed the embeddable</a> in an entity.
+ </p>
+
+
+ <table class="note" summary="" cellpadding="3" cellspacing="0">
+ <tbody>
+ <tr>
+ <td align="left">
+ <p class="notep">Note:</p>
+ <p>To create a bi-directional relationship from embeddable
+ to an entity, the embeddable must be pinned to exactly one
+ entity.</p>
+ <p>Also, bear in mind that JPA diagram editor supports
+ only one bidirectional relationship per embeddable.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table></li>
+ <li><p>
+ Click on the embeddable or press
+ <kbd class="keyboard">ESCAPE</kbd>
+ to cancel.
+ </p></li>
+ <li><p>
+ Click on the target entity of the relationship or press
+ <kbd class="keyboard">ESCAPE</kbd>
+ to cancel.
+ </p>
+ <p>The Eclipse IDE creates and visualizes the relationship, as
+ well as the relevant relationship attributes of the entity and
+ the embeddable, depending on the type of relation.</p></li>
+ <li><p>
+ To remove a particular relationship, select the relation on the
+ JPA diagram and press
+ <kbd class="keyboard">DELETE</kbd>
+ , or choose <i>Delete</i> from the context menu.
+ </p>
+ <p>Removing a relationship via the JPA diagram also removes it
+ from the application data model and deletes the relationship
+ attributes of the related entity and embeddable.</p></li>
+ </ol>
+ </div></td>
+ </div>
+</body>
+</html>
diff --git a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/embeddables.html b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/embeddables.html new file mode 100644 index 0000000000..4b97070ba9 --- /dev/null +++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/embeddables.html @@ -0,0 +1,104 @@ +<!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" />
+<style>
+span.courier {
+ font-family: "Courier New", Courier, monospace;
+ font-size: 12pt;
+}
+
+kbd.keyboard {
+ font-weight: bold;
+ color: white;
+ background-color: #BEBEBE;
+}
+</style>
+<title>Embedding an Embeddable</title>
+
+<!-- contents -->
+</head>
+<body>
+
+ <div class="sect1">
+ <!-- infolevel="all" infotype="General" -->
+ <h1>Embedding an Embeddable</h1>
+ <h2>Overview</h2>
+ <p>An embeddable class can be pinned either to an entity, or to
+ another embeddable.</p>
+ <p>You can embed a single instance of the embeddable class, or a
+ collection of the embeddable class.</p>
+
+ <h2>Embedding a Single Element</h2>
+ <td><div>
+ <ol>
+ <li><p>
+ In the <i>Composition</i> list of <i>Palette</i>, choose <i>Embed
+ Single Element</i>.
+ </p></li>
+ <li><p>
+ Click on the source entity or the embeddable of the Has-A
+ relationship or press
+ <kbd class="keyboard">ESCAPE</kbd>
+ to cancel.
+ </p></li>
+ <li><p>
+ Click on the target embeddable of the Has-A relationship or press
+ <kbd class="keyboard">ESCAPE</kbd>
+ to cancel.
+ </p>
+ <p>The Eclipse IDE creates and visualizes the Has-A
+ relationship, as well as the relevant embedded attribute in the
+ entity, in which the embeddable is set.</p>
+ <p>
+ The attribute will be mapped with the <span class="sourier">@Embedded</span>
+ annotation.
+ </p></li>
+ </ol>
+
+ <h2>Embedding Collection of Elements</h2>
+ <ol>
+ <li><p>
+ In the <i>Composition</i> list of <i>Palette</i>, choose <i>Embed
+ Collection of Elements</i>.
+ </p></li>
+ <li><p>
+ Click on the source entity or the embeddable of the Has-A
+ relationship or press
+ <kbd class="keyboard">ESCAPE</kbd>
+ to cancel.
+ </p></li>
+ <li><p>
+ Click on the target embeddable of the Has-A relationship or press
+ <kbd class="keyboard">ESCAPE</kbd>
+ to cancel.
+ </p>
+ <p>The Eclipse IDE creates and visualizes the Has-A
+ relationship, as well as the relevant embedded attribute in the
+ entity, in which the embeddable is set.</p>
+ <p>
+ The attribute will be mapped with the <span class="courier">@ElementCollection</span>
+ annotation.
+ </p></li>
+ </ol>
+
+ <h2>Removing Has-A Relationships</h2>
+ <p>
+ To remove a particular Has-A relationship, select the relation on
+ the JPA diagram and press
+ <kbd class="keyboard">DELETE</kbd>
+ , or choose <i>Delete</i> from the context menu.
+ </p>
+ <div>
+ <p>Removing a relationship via the JPA diagram also removes it
+ from the application data model and deletes the embedded
+ attributes of the embedding entity.</p>
+ </div>
+ </div></td>
+ </div>
+</body>
+</html>
\ No newline at end of file diff --git a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/entity_inheritance.html b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/entity_inheritance.html new file mode 100644 index 0000000000..4b43cdb54d --- /dev/null +++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/entity_inheritance.html @@ -0,0 +1,81 @@ +<!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" />
+<style>
+kbd.keyboard {
+ font-weight: bold;
+ color: white;
+ background-color: #BEBEBE;
+}
+</style>
+<title>Managing Entity Inheritance</title>
+
+<!-- contents -->
+</head>
+<body>
+
+ <div class="sect1">
+ <!-- infolevel="all" infotype="General" -->
+ <h1>Managing Entity Inheritance</h1>
+ <td><div>
+ <h2>Inheriting Persistent Types</h2>
+ <ol>
+ <li><p>
+ In the <i>Inheritance</i> list of <i>Palette</i>, choose <i>Inherit
+ Persistent Type</i>.
+ </p></li>
+ <li><p>
+ Click on the source entity or the mapped superclass of the Is-A
+ relationship or press
+ <kbd class="keyboard">ESCAPE</kbd>
+ to cancel.
+ </p></li>
+ <li><p>
+ Click on the target entity of the Is-A relationship or press
+ <kbd class="keyboard">ESCAPE</kbd>
+ to cancel.
+ </p>
+ <p>The Eclipse IDE creates and visualizes the Is-A
+ relationship.</p></li>
+ </ol>
+
+ <h2>Inheriting Entities</h2>
+ <ol>
+ <li><p>
+ In the <i>Inheritance</i> list of the <i>Palette</i>, choose <i>Inherited
+ Entity</i>.
+ </p></li>
+ <li><p>
+ Click on the source entity or the mapped superclass of the Is-A
+ relationship or press
+ <kbd class="keyboard">ESCAPE</kbd>
+ to cancel.
+ </p></li>
+ <li><p>
+ Click somewhere in the diagram or press
+ <kbd class="keyboard">ESCAPE</kbd>
+ to cancel.
+ </p>
+ <p>The Eclipse IDE creates and visualizes a new inherited
+ entity, as well as the relevant Is-A relationship.</p></li>
+ </ol>
+ <h2>Removing Is-A Relationships</h2>
+ <p>
+ To remove a particular Is-A relationship, select the relation on
+ the JPA diagram and press
+ <kbd class="keyboard">DELETE</kbd>
+ , or choose <i>Delete</i> from the context menu.
+ </p>
+ <div>
+ <p>Removing a relationship via the JPA diagram also removes it
+ from the application data model.</p>
+ </div>
+ </div></td>
+ </div>
+</body>
+</html>
\ No newline at end of file diff --git a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/getting_started.html b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/getting_started.html index 78b9f045d3..780ed71dc4 100644 --- a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/getting_started.html +++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/getting_started.html @@ -6,7 +6,7 @@ <meta http-equiv="Content-Style-Type" content="text/css" /> <meta http-equiv="Content-Script-Type" content="text/javascript" /> -<title>Getting started</title> +<title>Getting Started</title> <!-- contents --> </head> @@ -14,12 +14,12 @@ <div class="sect1"> <!-- infolevel="all" infotype="General" --> - <h1>Getting started</h1> - <p>The Eclipse IDE provides a JPA diagram editor tool that allows - you to create, edit, and display the application data model (entities - and their relationships) in a graphical environment.</p> - <p>You can use only one JPA diagram per project, and you cannot - visualize entities from different projects in one JPA diagram.</p> + <h1>Getting Started</h1> + <p>The Eclipse IDE provides a JPA diagram editor that allows + you to create, edit, and display the application data model (persistent + types and their relationships) in a graphical environment.</p> + <p>You can only use one JPA diagram per project, and you cannot + visualize entities from different projects in one and the same JPA diagram.</p> <div> <p> <b>Example:</b> @@ -42,12 +42,12 @@ features:</p> <div> <ul> - <li><p>Ability to create entities and define relationships + <li><p>Ability to create persistent types and define relationships between them.</p></li> - <li><p>Ability to import existing entities together with + <li><p>Ability to import existing persistent types together with their relationships.</p></li> <li><p>Full synchronization with the underlying - application code, that is, whenever you apply a change to any of + application code. That means, whenever you apply a change to any of the objects on the diagram, the corresponding application code updates automatically, and the opposite.</p></li> <li><p> diff --git a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/reference_project_page.html b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/reference_project_page.html index 4651f3b8d2..b150f38305 100644 --- a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/reference_project_page.html +++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/reference_project_page.html @@ -3,67 +3,120 @@ <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>Property page – JPA Diagram Editor Options</title> +<style> +span.courier { + font-family: "Courier New", Courier, monospace; + font-size: 12pt; +} + +</style> +<title>Property Page – JPA Diagram Editor Options</title> <!-- contents --> </head> <body> -<div class="sect2"><!-- infolevel="all" infotype="General" --> -<h1>Property page – JPA Diagram Editor Options</h1> -<p>This table lists the properties available in the <span class="gui-object-title">JPA Diagram Editor settings page</span>.</p> -<div class="inftblinformal"> -<table class="Informal" title="This table describes the options on the JPA Diagram Editor Properties page." summary="This table describes the options on the JPA Diagram Editor Properties page." dir="ltr" border="1" width="100%" frame="border" rules="all" cellpadding="3" cellspacing="0"> -<col width="32%" /> -<col width="*" /> -<thead> -<tr align="left" valign="top"> -<th align="left" valign="bottom" id="r1c1-t37">Property</th> -<th align="left" valign="bottom" id="r1c2-t37">Description</th> -</tr> -</thead> -<tbody> -<tr align="left" valign="top"> -<td align="left" id="r2c1-t37" headers="r1c1-t37"><a id="sthref277" name="sthref277"></a><a id="sthref278" name="sthref278"></a><a id="sthref279" name="sthref279"></a><a id="sthref280" name="sthref280"></a>Folder for diagrams</td> -<td align="left" headers="r2c1-t37 r1c2-t37">Specify the folder where the diagram.xmi file will be created.</td> -</tr> -<tr align="left" valign="top"> -<td align="left" id="r3c1-t37" headers="r1c1-t37">Default Java Package</td> -<td align="left" headers="r3c1-t37 r1c2-t37">Specify the java package where the entities will be created by default. -</td> -</tr> -<tr align="left" valign="top"> -<td align="left" id="r3c1-t37" headers="r1c1-t37">Default table name prefix</td> -<td align="left" headers="r3c1-t37 r1c2-t37">Specify the prefix with which the tables will be created by default. -</td> -</tr> -<tr align="left" valign="top"> -<td align="left" id="r4c1-t37" headers="r1c1-t37">Editing entity name</td> -<td align="left" headers="r4c1-t37 r1c2-t37">Determine if the editing of the entity name in the diagram should affect the class name in the source file. -</td> -</tr> -<tr align="left" valign="top"> -<td align="left" id="r3c1-t37" headers="r1c1-t37">Entity access type</td> -<td align="left" headers="r3c1-t37 r1c2-t37">Select an entity access type. -<p>To add annotations on the field level choose <span><b>Field-based</b></span>.</p> -<p>To add annotations on the property level choose <span><b>Property-based</b></span>.</p> -</td> -</tr> -<tr align="left" valign="top"> -<td align="left" id="r3c1-t37" headers="r1c1-t37">Default collection type</td> -<td align="left" headers="r3c1-t37 r1c2-t37">Select a collection type of which the relation attributes to be created by default: -<p>Choose <span><b>java.util.Collection</b></span>, so that the relation attributes to be of type Collection.</p> -</td> -</tr> -<tr align="left" valign="top"> -<td align="left" id="r4c1-t37" headers="r1c1-t37">One-to-Many unidirectional old style relationship</td> -<td align="left" headers="r4c1-t37 r1c2-t37">Specify if the old style One-to-Many unidirectional relationship (supported by JPA 1.0) to be used. -</td> -</tr> -</tbody> -</table> -<br /></div> -</div> + <div class="sect2"> + <!-- infolevel="all" infotype="General" --> + <h1>Property Page – JPA Diagram Editor Options</h1> + <p> + This table lists the properties available in the <span + class="gui-object-title">JPA Diagram Editor Settings page</span>. + </p> + <div class="inftblinformal"> + <table class="Informal" + title="This table describes the options on the JPA Diagram Editor Properties page." + summary="This table describes the options on the JPA Diagram Editor Properties page." + dir="ltr" border="1" width="100%" frame="border" rules="all" + cellpadding="3" cellspacing="0"> + <col width="32%" /> + <col width="*" /> + <thead> + <tr align="left" valign="top"> + <th align="left" valign="bottom" id="r1c1-t37">Property</th> + <th align="left" valign="bottom" id="r1c2-t37">Description/Action</th> + </tr> + </thead> + <tbody> + <tr align="left" valign="top"> + <td align="left" id="r2c1-t37" headers="r1c1-t37"><a + id="sthref277" name="sthref277"></a><a id="sthref278" + name="sthref278"></a><a id="sthref279" name="sthref279"></a><a + id="sthref280" name="sthref280"></a>Folder for diagrams</td> + <td align="left" headers="r2c1-t37 r1c2-t37">Specifies the + folder where the <i>diagram.xmi</i> file will be created. + </td> + </tr> + <tr align="left" valign="top"> + <td align="left" id="r3c1-t37" headers="r1c1-t37">Default + Java package</td> + <td align="left" headers="r3c1-t37 r1c2-t37">Specifies the + Java package where the persistent types will be created by + default.</td> + </tr> + <tr align="left" valign="top"> + <td align="left" id="r3c1-t37" headers="r1c1-t37">Default + table name prefix</td> + <td align="left" headers="r3c1-t37 r1c2-t37">Specifies the + prefix with which the tables will be created by default.</td> + </tr> + <tr align="left" valign="top"> + <td align="left" id="r4c1-t37" headers="r1c1-t37">Editing + persistent type name</td> + <td align="left" headers="r4c1-t37 r1c2-t37">Determines if + the editing of the persistent type name in the diagram should + affect the class name in the source file.</td> + </tr> + <tr align="left" valign="top"> + <td align="left" id="r3c1-t37" headers="r1c1-t37">Persistent + access type</td> + <td align="left" headers="r3c1-t37 r1c2-t37">Specifies a + persistent access type. + <ul> + <li> + <p> + To add annotations on a field level, choose <span><i>Field-based</i></span>. + </p> + </li> + <li> + <p> + To add annotations on a property level, choose <span><i>Property-based</i></span>. + </p> + </li> + </ul> + </td> + </tr> + <tr align="left" valign="top"> + <td align="left" id="r3c1-t37" headers="r1c1-t37">Default + collection type</td> + <td align="left" headers="r3c1-t37 r1c2-t37">Specifies a + collection type in which the relation attributes to be created by + default: + <p> + Choose <span><i>java.util.Collection</i></span>, so that the + relation attributes to be of type <span class="courier">Collection</span>. + </p> + </td> + </tr> + <tr align="left" valign="top"> + <td align="left" id="r4c1-t37" headers="r1c1-t37">One-to-Many + unidirectional old style relationship</td> + <td align="left" headers="r4c1-t37 r1c2-t37">Determines if the + old-style <i>One-to-Many</i> unidirectional relationship (supported by + JPA 1.0) to be used.</td> + </tr> + <tr align="left" valign="top"> + <td align="left" id="r3c1-t37" headers="r1c1-t37">XML entity + mappings</td> + <td align="left" headers="r4c1-t37 r1c2-t37">Determines + if the persistent type should be added in the specified + <i>orm.xml</i> file.</td> + </tr> + </tbody> + </table> + <br /> + </div> + </div> </body> </html> diff --git a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_20_support.html b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_20_support.html index 0a63e72189..9b3ad1c719 100644 --- a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_20_support.html +++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_20_support.html @@ -6,7 +6,23 @@ <meta http-equiv="Content-Style-Type" content="text/css" /> <meta http-equiv="Content-Script-Type" content="text/javascript" /> -<title>JPA diagram editor partial support for JPA 2.0</title> +<style> +p.notep { + font-weight: bold; +} + +table.note { + background: #FFFFC0; + border: 1px solid #000000; + width: 100%; +} + +span.courier { + font-family: "Courier New", Courier, monospace; + font-size: 12pt; +} +</style> +<title>JPA Diagram Editor Support for JPA 2.0</title> <!-- contents --> </head> @@ -14,33 +30,54 @@ <div class="sect1"> <!-- infolevel="all" infotype="General" --> - <h1>JPA diagram editor partial support for JPA 2.0</h1> + <h1>JPA Diagram Editor Support for JPA 2.0</h1> <td><div> <ul> <li><p> The JPA diagram editor supports the new style <i>One-to-Many</i> unidirectional relationship. It means that in JPA 2.0 projects the corresponding relationship attribute will be created with - additional - <tt title="Output">@JoinColumns(s)</tt> + additional <span class="courier">@JoinColumns(s)</span> annotation, so that the corresponding DB schema will be created without additional join table. </p> - </li> + <table class="note" summary="" cellpadding="3" cellspacing="0"> + <tbody> + <tr> + <td align="left"> + <p class="notep">Note:</p> + <p> + This behavior is optional. You may choose from the editor + preference page or project property page to create this + relationship (in JPA 2.0 projects) compliant with JPA 1.0 + specification, i.e. - without the additional <span + class="sourier">@JoinColumns(s)</span> annotation. + </p> + + </td> + </tr> + </tbody> + </table></li> + <li><p> + The JPA diagram editor supports <a href="embeddables.html">embedding + an embeddable</a> either in an entity or in another embeddable. + </p></li> + <li><p> + The JPA diagram editor supports <a href="element_collection.html">collections + of embeddables and primitives</a>. It means that when a new + attribute of collection type is added, it will be annotated with + the <span class="courier"> @ElementCollection</span> annotation. + </p></li> + <li><p> + The JPA diagram editor supports creation and visualization of <a + href="embeddable_relationships.html">relationships</a> between + embeddables and entities. + </p></li> + <li><p> + The JPA diagram editor supports <a + href="derived_identifiers.html">derived identifiers</a>. + </p></li> </ul> - </div> - <div> - <p> - <b>Note:</b> - </p> - <p> - This behavior is optional. You may choose from the editor - preference page or project property page to create this - relationship (in JPA 2.0 projects) compliant with JPA 1.0 - specification, i.e. - without the additional - <tt title="Output">@JoinColumns(s)</tt> - annotation. - </p> </div></td> </div> </body> diff --git a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_configuring_editor.html b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_configuring_editor.html index 4fe6a34147..c4ac5f8811 100644 --- a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_configuring_editor.html +++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_configuring_editor.html @@ -6,58 +6,58 @@ <meta http-equiv="Content-Style-Type" content="text/css" /> <meta http-equiv="Content-Script-Type" content="text/javascript" /> -<title>Configuring the JPA diagram editor</title> +<style> +</style> +<title>Configuring the JPA Diagram Editor</title> <!-- contents --> </head> <body> - <div class="sect1"> <!-- infolevel="all" infotype="General" --> - <h1>Configuring the JPA diagram editor</h1> + <h1>Configuring the JPA Diagram Editor</h1> <td><div> - <ul> - <li><p>Configure the global default settings of the JPA - diagram editor</p> - <div> - <ol> - <li>Choose <span><i>Window</i> -> <i>Preferences</i> </span> in - the main menu.</li> - <li><p> - Select <span><i>General</i> -> <i>Editors</i> -> <i>JPA Diagram Editor</i> </span> in the - properties tree. - </p></li> - <li><p> - Specify the JPA diagram editor settings. To restore the global - predefined values, choose <i>Restore Defaults</i>. - </p></li> - <li><p> - Choose <i>Apply</i>, then choose <i>OK</i>. - </p></li> - </ol> - </div> - </li> - <li><p>Configure the JPA diagram editor per project</p> - <div> - <ol> - <li><p> - In the context menu of the project in the <i>Project - Explorer</i>, choose <i>Properties</i>. - </p></li> - <li><p> - Select <span><i>JPA</i> -> <i>JPA Diagram Editor</i> </span>. - </p></li> - <li><p> - Specify the JPA diagram editor settings. To restore the global - default settings, choose <i>Restore Defaults</i>. - </p></li> - <li><p> - Choose <i>Apply</i>, then choose <i>OK</i>. - </p></li> - </ol> - </div> - </li> - </ul> + <h2>Configure the global default settings of the JPA diagram + editor</h2> + <div> + <ol> + <li><p> + From the main menu, choose <span><i>Window</i> → <i>Preferences</i> + </span>. + </p></li> + <li><p> + In the properties tree, select <span><i>General</i> → + <i>Editors</i> → <i>JPA Diagram Editor</i> </span>. + </p></li> + <li><p> + Specify the JPA diagram editor settings. To restore the global + predefined values, choose <i>Restore Defaults</i>. + </p></li> + <li><p> + Choose <i>Apply</i> and then <i>OK</i>. + </p></li> + </ol> + </div> + + <h2>Configure the JPA diagram editor per project</h2> + <div> + <ol> + <li><p> + From the project context menu in the <i>Project Explorer</i>, + choose <i>Properties</i>. + </p></li> + <li><p> + Select <span><i>JPA</i> → <i>JPA Diagram Editor</i> </span>. + </p></li> + <li><p> + Specify the JPA diagram editor settings. To restore the global + default settings, choose <i>Restore Defaults</i>. + </p></li> + <li><p> + Choose <i>Apply</i> and then <i>OK</i>. + </p></li> + </ol> + </div> </div> </td> </div> diff --git a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_manage_entities.html b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_manage_entities.html deleted file mode 100644 index c88450ea07..0000000000 --- a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_manage_entities.html +++ /dev/null @@ -1,107 +0,0 @@ -<!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>Managing entities</title> - -<!-- contents --> -</head> -<body> - - <div class="sect1"> - <!-- infolevel="all" infotype="General" --> - <h1>Managing entities</h1> - <td><p>You can perform the following operations on a - particular entity graphical model:</p> - <div> - <ul> - <li><p>Rename entities</p> - <p> - In terms of source code, this operation changes the - <tt title="Output">name</tt> - attribute of the - <tt title="Output">@Entity</tt> - annotation only. - </p> - </li> - <li><p>Add, rename, or remove attributes</p> - <div> - <p> - <b>Note:</b> - </p> - <p> - The Eclipse IDE automatically generates getter and setter - methods for new attributes. The default data type for new - attributes is - <tt title="Output">java.lang.String</tt> - . - </p> - <p>In terms of source code, renaming attributes changes the - field names of entities, together with the fields' getter and - setter methods.</p> - <p>Removing attributes removes them from the data model also.</p> - <div>End of the note.</div> - </div> - </li> - <li><p>Collapse or expand entities or attribute groups</p></li> - <li><p>Save or discard your changes</p></li> - <li><p>Save or discard your changes and remove the entity - from the diagram without removing it from the application data - model</p></li> - <li><p>Remove the entity from the diagram and delete it - from the application data model</p></li> - </ul> - </div> - <p>To perform the actions described above, follow the steps:</p> - <div> - <ol> - <li><p>Position the mouse cursor over the entity you want - to manage.</p> - <p>A button bar appears by the entity.</p> - <div> - <p> - <img src="../img/jpa_diagram_entity_operations.gif" - alt="This graphic is explained in the accompanying text." - title="This graphic is explained in the accompanying text." /> - </p> - <br /> - </div> - </li> - <li><p>Choose the relevant pushbutton. Each button has an - informative tooltip that describes the relevant operation.</p></li> - <li><p> - To rename an entity or an attribute, double-click the title of an - entity or the attribute, change the name, and choose - <kbd title="Keyboard button">ENTER</kbd> - . - </p></li> - <li><p> - To remove an attribute, click the attribute and choose - <kbd title="Keyboard button">DELETE</kbd> - or choose <i>Delete</i> in the context menu. - </p> - <p> - You can also remove an attribute by positioning the mouse cursor - over the attribute and choosing the <i>Delete Attribute</i> - pushbutton. - </p> - <div> - <p> - <img src="../img/jpa_diagram_delete_attribute.gif" - alt="This graphic is explained in the accompanying text." - title="This graphic is explained in the accompanying text." /> - </p> - <p /> - </div> - </li> - </ol> - </div> - </td> - </div> -</body> -</html> - diff --git a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_manage_types.html b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_manage_types.html new file mode 100644 index 0000000000..20deb866da --- /dev/null +++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_manage_types.html @@ -0,0 +1,143 @@ +<!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" /> +<style> +p.notep { + font-weight: bold; +} + +table.note { + background: #FFFFC0; + border: 1px solid #000000; + width: 100%; +} + +span.courier { + font-family: "Courier New", Courier, monospace; + font-size: 12pt; +} + +kbd.keyboard { + font-weight: bold; + color: white; + background-color: #BEBEBE; +} +</style> +<title>Managing Persistent Types</title> + +<!-- contents --> +</head> +<body> + + <div class="sect1"> + <!-- infolevel="all" infotype="General" --> + <h1>Managing Persistent Types</h1> + <h2>Overview</h2> + <td><p>You can perform the following operations on a + particular entity graphical model:</p> + <div> + <ul> + <li><p>Rename entities</p> + <p> + In terms of source code, this operation changes the <span + class="courier">name</span> attribute of the <span + class="courier">@Entity</span> annotation only. + </p></li> + <li><p>Add, rename, or remove attributes</p> + <table class="note" summary="" cellpadding="3" cellspacing="0"> + <tbody> + <tr> + <td align="left"> + <p class="notep">Note:</p> + <p> + The Eclipse IDE automatically generates <span class="courier">getter</span> + and <span class="courier">setter</span> methods for new + attributes. The default data type for new attributes is <span + class="courier">java.lang.String</span> . + </p> + <p> + In terms of source code, renaming attributes changes the + field names of entities, together with the fields' <span + class="courier">getter</span> and <span class="courier">setter</span> + methods. + </p> + <p>Removing attributes removes them from the data model + also.</p> + </td> + </tr> + </tbody> + </table></li> + <li><p>Collapse or expand entities or attribute groups</p></li> + <li><p>Save or discard your changes, as also remove the + entity from the diagram without removing it from the application + data model</p></li> + <li><p>Remove the entity from the diagram and delete it + from the application data model</p></li> + </ul> + </div> + + <h2>Procedure</h2> + <p>To perform the actions described above, follow the steps:</p> + <div> + <ol> + <li><p>Position the mouse cursor over the entity you want + to manage.</p> + <p>A button bar appears by the entity.</p> + <div> + <p> + <img src="../img/jpa_diagram_entity_operations.gif" + alt="This graphic is explained in the accompanying text." + title="This graphic is explained in the accompanying text." /> + </p> + <br /> + </div></li> + <li><p>Choose the relevant pushbutton. Each button has an + informative tooltip that describes the relevant operation.</p></li> + <li><p> + To rename an entity or an attribute, double-click the title of an + entity or the attribute, change the name, and press + <kbd class="keyboard">ENTER</kbd> + . + </p></li> + <li><p> + To remove an attribute, click the attribute and press + <kbd class="keyboard">DELETE</kbd> + or choose <i>Delete</i> from the context menu. + </p> + <p> + You can also remove an attribute by positioning the mouse cursor + over the attribute and choosing the <i>Delete Attribute</i> + pushbutton. + </p> + <div> + <p> + <img src="../img/jpa_diagram_delete_attribute.gif" + alt="This graphic is explained in the accompanying text." + title="This graphic is explained in the accompanying text." /> + </p> + <p /> + </div></li> + </ol> + </div></td> + </div> + + <table class="note" summary="" cellpadding="3" cellspacing="0"> + <tbody> + <tr> + <td align="left"> + <p class="notep">Note:</p> + <p>All operations can be performed on embeddable, as well + mapped superclass graphical models.</p> + </td> + </tr> + </tbody> + </table> + +</body> +</html> + diff --git a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_open_diagram.html b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_open_diagram.html index f319e6ea9d..65b755be9b 100644 --- a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_open_diagram.html +++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_open_diagram.html @@ -6,7 +6,7 @@ <meta http-equiv="Content-Style-Type" content="text/css" /> <meta http-equiv="Content-Script-Type" content="text/javascript" /> -<title>Open JPA Diagram, create and display entities</title> +<title>Creating and Displaying Persistent Types</title> <!-- contents --> </head> @@ -14,46 +14,68 @@ <div class="sect1"> <!-- infolevel="all" infotype="General" --> - <h2>Opening JPA Diagram Editor</h2> + <h2>Opening the JPA Diagram Editor</h2> <td><div> <ol> <li><p> - In the <i>Project Explorer</i>, select the project that you are - using or want to use for your entities. - </p> - </li> + In the <i>Project Explorer</i>, select the project that you want + to use for your entities. + </p></li> <li><p> - In the context menu, choose <span title="Navigation path"> - <i>JPA Tools</i> -&grt; <i>Open Diagram</i> + From the project context menu, choose <span + title="Navigation path"> <i>JPA Tools</i> → <i>Open + Diagram</i> </span>. - </p> - </li> + </p></li> </ol> </div></td> - <h2>Creating new entities</h2> + + <h2>Creating New Entity</h2> <td><p> In the <i>Entities</i> list of the <i>Palette</i>, choose <span><img src="../img/jpaeditor_entity.gif" alt="Entity" title="Entity" /> (<i - title="Quick info">Entity</i>)</span>, then click the diagram area. + title="Quick info">Entity</i>)</span>, and then click upon the diagram + area. </p> <p>The Eclipse IDE creates the new entity with a predefined name and a primary key.</p></td> - <h2>Displaying existing entities (if any) within a project on the - diagram</h2> + + <h2>Creating New Embeddable</h2> + <td><p> + In the <i>Entities</i> list of the <i>Palette</i>, choose <span><img + src="../img/jpaeditor_embeddable.gif" alt="Embeddable" + title="Embeddable" /> (<i title="Quick info">Embeddable</i>)</span>, and + then click upon the diagram area. + </p> + <p>The Eclipse IDE creates the new embeddable with a predefined + name.</p></td> + + <h2>Creating New Mapped Superclass</h2> + <td><p> + In the <i>Entities</i> list of the <i>Palette</i>, choose <span><img + src="../img/jpaeditor_mapped_superclass.gif" + alt="Mapped Superclass" title="Mapped Superclass" /> (<i + title="Quick info">Mapped Superclass</i>)</span>, and then click upon the + diagram area. + </p> + <p>The Eclipse IDE creates the new mapped superclass with a + predefined name.</p></td> + + <h2>Displaying Existing Persistent Types within a Project on the Diagram</h2> <td><div> <ul> <li><p> - To display a single entity, copy the entity using drag and drop - from the <i>Project Explorer</i> to the JPA diagram. - </p> - </li> + To display a single persistent type, copy the persistent type, + using drag and drop, from the <i>Project Explorer</i> to the JPA + diagram. + </p></li> <li><p> - To display all entities, click the JPA diagram with the secondary - mouse button and choose <i>Show All Entities</i>, or copy the <i>JPA - Content</i> node from the project in the <i>Project Explorer</i> to - the JPA diagram, using drag and drop. - </p> - </li> + To display all persistent types, click on the JPA diagram with the + secondary mouse button and choose <i>Show all Persistent + Types</i>. The alternative way is to copy the <i>JPA Content</i> + node from the project, in the <i>Project Explorer</i>, to the JPA + diagram, using drag and drop. + </p></li> </ul> </div></td> </div> diff --git a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_open_miniature_view.html b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_open_miniature_view.html index 88b01f8714..489dab269d 100644 --- a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_open_miniature_view.html +++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_open_miniature_view.html @@ -6,7 +6,7 @@ <meta http-equiv="Content-Style-Type" content="text/css" /> <meta http-equiv="Content-Script-Type" content="text/javascript" /> -<title>Opening the Miniature view or the JPA Details view</title> +<title>Opening the Miniature View and the JPA Details View</title> <!-- contents --> </head> @@ -14,10 +14,10 @@ <div class="sect1"> <!-- infolevel="all" infotype="General" --> - <h2>Opening the Miniature view or the JPA Details view</h2> + <h1>Opening the Miniature View and the JPA Details View</h1> <td><div> <ol> - <li><p>Click the JPA diagram with the secondary mouse + <li><p>Click upon the JPA diagram with the secondary mouse button.</p></li> <li><p> Choose <i>Open Miniature View</i> or <i>Open JPA Details View</i>, diff --git a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_refactor_entities.html b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_refactor_entities.html index 4f52fd2296..4cf7afc69d 100644 --- a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_refactor_entities.html +++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_refactor_entities.html @@ -6,8 +6,18 @@ <meta http-equiv="Content-Style-Type" content="text/css" /> <meta http-equiv="Content-Script-Type" content="text/javascript" /> -<title>Refactor, view, edit and remove entities and their - attributes</title> +<style> +p.notep { + font-weight: bold; +} + +table.note { + background: #FFFFC0; + border: 1px solid #000000; + width: 100%; +} +</style> +<title>Refactoring, Configuring and Removing Persistent Types</title> <!-- contents --> </head> @@ -15,90 +25,99 @@ <div class="sect1"> <!-- infolevel="all" infotype="General" --> - <h2>Refactoring entities and attribute types</h2> - <td><div> - <p> - <b>Caution:</b> - </p> - <div> - <ul> - <li><p> - If you rename or move an entity using a different approach (for - example, via the <i>Project Explorer</i>), the entity disappears - from the JPA diagram. - </p> - </li> - <li><p>When you refactor an attribute type, any existing - business logic within the attribute's access methods is deleted.</p> - </li> - </ul> - </div> - </div> + <h2>Refactoring Persistent Types and Attribute Types</h2> + <td> + <table class="note" summary="" cellpadding="3" cellspacing="0"> + <tbody> + <tr> + <td align="left"> + <p class="notep">Caution:</p> + <div> + <ul> + <li><p> + If you rename or move a persistent type using a different + approach (for example, via the <i>Project Explorer</i>), the + persistent type disappears from the JPA diagram. + </p></li> + <li><p>When you refactor an attribute type, any + existing business logic within the attribute's access methods + is deleted.</p></li> + </ul> + </div> + </td> + </tr> + </tbody> + </table> + + <h2>Overview</h2> <p>Using the JPA diagram editor, you can perform the following refactoring operations:</p> <div> <ul> <li><p> - Rename the entity class - in the context menu of the entity name, - choose <span><i>Refactor Entity Class</i> -> <i>Rename</i> - </span>, then complete the wizard. - </p> - </li> + Rename the persistent type class: from the context menu of the + persistent type name, choose <span><i>Refactor + Persistent Type Class</i> → <i>Rename</i> </span>, and then complete + the wizard. + </p></li> <li><p> - Move the entity to another source package - in the context menu - of the entity name, choose <span><i>Refactor Entity - Class</i> -> <i>Move</i> - </span>, then complete the wizard. - </p> - </li> + Move the persistent type to another source package: from the + context menu of the persistent type name, choose <span><i>Refactor + Persistent Type Class</i> → <i>Move</i> </span>, and then complete + the wizard. + </p></li> <li><p> - Refactor an attribute type - in the context menu of an attribute, - choose <i>Refactor Attribute Type</i>, change the type, and - choose <i>OK</i>. - </p> - </li> + Refactor an attribute type: from the context menu of an + attribute, choose <i>Refactor Attribute Type</i>, change the + type, and then choose <i>OK</i>. + </p></li> </ul> - </div></td> + </div> + </td> - <h2>Viewing and editing entities' source code</h2> + <h2>Viewing and Editing the Source Code of Persistent Types</h2> <td><p>To view and edit the source code of a particular - entity, double-click the title of the corresponding entity block on - the diagram.</p> - <p>The Eclipse IDE opens the entity class in the standard source - code editor.</p> + persistent type, double-click on the title of the corresponding + persistent type block on the diagram.</p> + <p>The Eclipse IDE opens the persistent type class in the + standard source code editor.</p> <p>When you apply changes to the source code, they are automatically synchronized with the diagram.</p></td> - <h2>Removing all entities from the diagram</h2> - <td><div> - <p> - <b>Note:</b> - </p> - <p>This operation removes the entities from the JPA diagram - only, that is, they are not removed from the underlying application - data model.</p> - </div> + <h2>Removing All Persistent Types from a Diagram</h2> + <td> + <table class="note" summary="" cellpadding="3" cellspacing="0"> + <tbody> + <tr> + <td align="left"> + <p class="notep">Note:</p> + <p>This operation removes the persistent types from the JPA + diagram only, that is, they are not removed from the underlying + application data model.</p> + </td> + </tr> + </tbody> + </table> <div> <ol> - <li><p>Click the JPA diagram with the secondary mouse - button.</p> - </li> + <li><p>Click upon the JPA diagram with the secondary mouse + button.</p></li> <li><p> To save any unsaved changes to the application data model, and - remove all entities from the diagram, choose <span> <i>Remove - All Entities from Diagram</i> -> <i>...and Save Changes</i> + remove all persistent types from the diagram, choose <span> + <i>Remove all Persistent Types from Diagram</i> → <i>...and + Save Changes</i> </span> - </p> - </li> + </p></li> <li><p> - To remove all entities from the diagram without saving any - unsaved changes to the data model, choose <span><i>Remove - All Entities from Diagram</i> -> <i>...and Discard Changes</i> - </span>. - </p> - </li> + To remove all persistent types from the diagram without saving + any unsaved changes to the data model, choose <span><i>Remove + all Persistent Types from Diagram</i> → <i>...and Discard + Changes</i> </span>. + </p></li> </ol> - </div></td> + </div> + </td> </div> </body> </html> diff --git a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_remove_entities.html b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_remove_entities.html index 1b560bbfff..93d00169d7 100644 --- a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_remove_entities.html +++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_remove_entities.html @@ -6,7 +6,14 @@ <meta http-equiv="Content-Style-Type" content="text/css" /> <meta http-equiv="Content-Script-Type" content="text/javascript" /> -<title>Defining and removing relationships between entities</title> +<style> +kbd.keyboard { + font-weight: bold; + color: white; + background-color: #BEBEBE; +} +</style> +<title>Defining and Removing Relationships between Entities</title> <!-- contents --> </head> @@ -14,25 +21,22 @@ <div class="sect1"> <!-- infolevel="all" infotype="General" --> - <h1>Defining and removing relationships between entities</h1> + <h1>Defining and Removing Relationships between Entities</h1> <td><div> <ol> <li><p> - In the <i>Relations</i> list of the <i>Palette</i>, choose a + In the <i>Relations</i> list of <i>Palette</i>, choose a relationship type. - </p> - </li> + </p></li> <li><p> - Click the source entity of the relationship with the primary - mouse button or choose - <kbd title="Keyboard button">ESCAPE</kbd> + Click on the source entity of the relationship or press + <kbd class="keyboard">ESCAPE</kbd> to cancel. - </p> - </li> + </p></li> <li><p> Click the target entity of the relationship with the primary - mouse button or choose - <kbd title="Keyboard button">ESCAPE</kbd> + mouse button or press + <kbd class="keyboard">ESCAPE</kbd> to cancel. </p> <p>The Eclipse IDE creates and visualizes the relationship, as @@ -40,9 +44,9 @@ depending on the type of relation.</p></li> <li><p> To remove a particular relationship, select the relation on the - JPA diagram and choose - <kbd title="Keyboard button">DELETE</kbd> - , or choose <i>Delete</i> in the context menu. + JPA diagram and press + <kbd class="keyboard">DELETE</kbd> + , or choose <i>Delete</i> from the context menu. </p> <div> <p>Removing a relationship via the JPA diagram also removes diff --git a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/xml_entities.html b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/xml_entities.html new file mode 100644 index 0000000000..2c7da363ea --- /dev/null +++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/xml_entities.html @@ -0,0 +1,39 @@ +<!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>Defining Persistent Types in orm.xml</title>
+
+<!-- contents -->
+</head>
+<body>
+
+ <div class="sect1">
+ <h1>Defining Persistent Types in orm.xml</h1>
+
+ <div>
+ <ol>
+ <li><p>
+ In <i>Project Explorer</i>, from the project context menu, choose
+ <i>Properties</i>.
+ </p></li>
+ <li><p>
+ Choose <span><i>JPA</i> → <i>JPA Diagram Editor</i> </span>.
+ </p></li>
+ <li><p>
+ Select the <i>Add to entity mappings in XML</i> checkbox, to
+ determine to which <i>orm.xml</i> file the persistent type and its
+ attributes should be registered.
+ </p></li>
+ <li><p>
+ Choose <i>Apply</i>, and then choose <i>OK</i>.
+ </p></li>
+ </ol>
+ </div>
+ </div>
+</body>
+</html>
diff --git a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/img/jpaeditor_embeddable.gif b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/img/jpaeditor_embeddable.gif Binary files differnew file mode 100644 index 0000000000..56fa623eed --- /dev/null +++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/img/jpaeditor_embeddable.gif diff --git a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/img/jpaeditor_mapped_superclass.gif b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/img/jpaeditor_mapped_superclass.gif Binary files differnew file mode 100644 index 0000000000..139585f3cf --- /dev/null +++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/img/jpaeditor_mapped_superclass.gif diff --git a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/toc.xml b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/toc.xml index 5abbf62374..08601cebce 100644 --- a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/toc.xml +++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/toc.xml @@ -3,28 +3,36 @@ <toc label="JPA Diagram Editor Project User Guide"> - <topic label="Getting started" href="html/getting_started.html"/> + <topic label="Getting Started" href="html/getting_started.html"/> <topic label="Tasks"> <topic href="PLUGINS_ROOT/org.eclipse.jpt.doc.user/getting_started003.htm" label="Create new JPA project"> </topic> - <topic href="html/task_configuring_editor.html" label="Configuring the JPA diagram editor"> - </topic> - <topic href="html/task_open_diagram.html" label="Open JPA Diagram, create and display entities"> + <topic href="html/task_configuring_editor.html" label="Configuring the JPA Diagram Editor"> </topic> - <topic href="html/task_remove_entities.html" label="Defining and removing relationships between entities"> + <topic href="html/task_open_diagram.html" label="Creating and Displaying Persistent Types"> </topic> - <topic href="html/task_manage_entities.html" label="Managing entities"> + <topic href="html/entity_inheritance.html" label="Managing Entity Inheritance"> </topic> - <topic href="html/task_refactor_entities.html" label="Refactor, view, edit and remove entities and their attributes"> + <topic href="html/task_remove_entities.html" label="Defining and Removing Relationships between Entities"> </topic> - <topic href="html/task_open_miniature_view.html" label="Opening the Miniature view or the JPA Details view"> + <topic href="html/task_manage_types.html" label="Managing Persistent Types"> </topic> - <topic href="html/task_20_support.html" label="JPA diagram editor partial support for JPA 2.0"> + <topic href="html/task_refactor_entities.html" label="Refactoring, Configuring and Removing Persistent Types"> + </topic> + <topic href="html/task_open_miniature_view.html" label="Opening the Miniature View and the JPA Details View"> + </topic> + <topic href="html/xml_entities.html" label="Defining Persistent Types in orm.xml"> + </topic> + <topic href="html/task_20_support.html" label="JPA Diagram Editor Support for JPA 2.0"> + <topic href="html/embeddables.html" label="Embedding an Embeddable"/> + <topic href="html/element_collection.html" label="Adding Attribute of Type element-collection"/> + <topic href="html/embeddable_relationships.html" label="Defining and Removing Relationships between Embeddables and Entities"/> + <topic href="html/derived_identifiers.html" label="Derived Identifiers"/> </topic> </topic> <topic label="Reference"> - <topic href="html/reference_project_page.html" label="Property page - JPA Diagram Editor Options"> + <topic href="html/reference_project_page.html" label="Property Page - JPA Diagram Editor Options"> </topic> </topic> |
