Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authortle2011-05-07 18:32:20 +0000
committertle2011-05-07 18:32:20 +0000
commita8673f6baebda2516d00b06844ebc0653612223c (patch)
tree5a758bc0bec36beee61393ccfad6a3e4f07fd002 /jpa_diagram_editor
parente56f6ad0f89aeb94c096bd66b6368d55ba5aad28 (diff)
downloadwebtools.dali-a8673f6baebda2516d00b06844ebc0653612223c.tar.gz
webtools.dali-a8673f6baebda2516d00b06844ebc0653612223c.tar.xz
webtools.dali-a8673f6baebda2516d00b06844ebc0653612223c.zip
Initial check-in
Diffstat (limited to 'jpa_diagram_editor')
-rw-r--r--jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/.project22
-rw-r--r--jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/META-INF/MANIFEST.MF8
-rw-r--r--jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/build.properties8
-rw-r--r--jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/getting_started.html67
-rw-r--r--jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/reference_project_page.html69
-rw-r--r--jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_20_support.html48
-rw-r--r--jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_configuring_editor.html66
-rw-r--r--jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_manage_entities.html107
-rw-r--r--jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_open_diagram.html62
-rw-r--r--jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_open_miniature_view.html43
-rw-r--r--jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_refactor_entities.html105
-rw-r--r--jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_remove_entities.html57
-rw-r--r--jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/toc.html13
-rw-r--r--jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/img/jpa_diagram_delete_attribute.gifbin0 -> 5379 bytes
-rw-r--r--jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/img/jpa_diagram_editor.gifbin0 -> 11668 bytes
-rw-r--r--jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/img/jpa_diagram_entity_operations.gifbin0 -> 7342 bytes
-rw-r--r--jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/img/jpa_miniature_view.gifbin0 -> 6940 bytes
-rw-r--r--jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/img/jpaeditor_entity.gifbin0 -> 1775 bytes
-rw-r--r--jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/plugin.properties13
-rw-r--r--jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/plugin.xml16
-rw-r--r--jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/toc.xml31
21 files changed, 735 insertions, 0 deletions
diff --git a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/.project b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/.project
new file mode 100644
index 0000000000..a3843373af
--- /dev/null
+++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/.project
@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+ <name>org.eclipse.jpt.jpadiagrameditor.doc.user</name>
+ <comment></comment>
+ <projects>
+ </projects>
+ <buildSpec>
+ <buildCommand>
+ <name>org.eclipse.pde.ManifestBuilder</name>
+ <arguments>
+ </arguments>
+ </buildCommand>
+ <buildCommand>
+ <name>org.eclipse.pde.SchemaBuilder</name>
+ <arguments>
+ </arguments>
+ </buildCommand>
+ </buildSpec>
+ <natures>
+ <nature>org.eclipse.pde.PluginNature</nature>
+ </natures>
+</projectDescription>
diff --git a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/META-INF/MANIFEST.MF b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/META-INF/MANIFEST.MF
new file mode 100644
index 0000000000..3fa9ba8037
--- /dev/null
+++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/META-INF/MANIFEST.MF
@@ -0,0 +1,8 @@
+Manifest-Version: 1.0
+Bundle-ManifestVersion: 2
+Bundle-Name: %pluginName
+Bundle-Vendor: %providerName
+Bundle-SymbolicName: org.eclipse.jpt.jpadiagrameditor.doc.user; singleton:=true
+Bundle-Version: 1.0.0.qualifier
+Bundle-Localization: plugin
+Require-Bundle: org.eclipse.help;bundle-version="[3.3.100,4.0.0)"
diff --git a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/build.properties b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/build.properties
new file mode 100644
index 0000000000..e78e8a8c5e
--- /dev/null
+++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/build.properties
@@ -0,0 +1,8 @@
+bin.includes = .,\
+ META-INF/,\
+ img/,\
+ plugin.properties,\
+ plugin.xml,\
+ html/,\
+ *.xml
+generateSourceBundle=false
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
new file mode 100644
index 0000000000..78b9f045d3
--- /dev/null
+++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/getting_started.html
@@ -0,0 +1,67 @@
+<!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>Getting started</title>
+
+<!-- contents -->
+</head>
+<body>
+
+ <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>
+ <div>
+ <p>
+ <b>Example:</b>
+ </p>
+ <p>The following JPA diagram represents the data model of
+ employees participating in various projects, that is, two entities
+ with a bidirectional many-to-many relationship:</p>
+ <div>
+ <p>
+ <img src="../img/jpa_diagram_editor.gif"
+ alt="This graphic is explained in the accompanying text."
+ title="This graphic is explained in the accompanying text." />
+ </p>
+ <br />
+ </div>
+ </div>
+ <div>
+ <h2>Features</h2>
+ <p>The JPA diagram editor comprises the following general
+ features:</p>
+ <div>
+ <ul>
+ <li><p>Ability to create entities and define relationships
+ between them.</p></li>
+ <li><p>Ability to import existing entities 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
+ the objects on the diagram, the corresponding application code
+ updates automatically, and the opposite.</p></li>
+ <li><p>
+ Error and warning markers with informative quick info text. You
+ can view details on the marked errors and warnings in the <i>Problems</i>
+ view.
+ </p></li>
+ <li><p>
+ Integration with the <i>JPA Details</i> view and the <i>Miniature
+ View</i>.
+ </p></li>
+ </ul>
+ </div>
+ </div>
+ </div>
+</body>
+</html>
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
new file mode 100644
index 0000000000..4651f3b8d2
--- /dev/null
+++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/reference_project_page.html
@@ -0,0 +1,69 @@
+<!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>Property page &ndash; JPA Diagram Editor Options</title>
+<!-- contents -->
+</head>
+<body>
+<div class="sect2"><!-- infolevel="all" infotype="General" -->
+<h1>Property page &ndash; 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>
+</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
new file mode 100644
index 0000000000..0a63e72189
--- /dev/null
+++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_20_support.html
@@ -0,0 +1,48 @@
+<!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>JPA diagram editor partial support for JPA 2.0</title>
+
+<!-- contents -->
+</head>
+<body>
+
+ <div class="sect1">
+ <!-- infolevel="all" infotype="General" -->
+ <h1>JPA diagram editor partial 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>
+ annotation, so that the corresponding DB schema will be created
+ without additional join table.
+ </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>
+</html>
+
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
new file mode 100644
index 0000000000..4fe6a34147
--- /dev/null
+++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_configuring_editor.html
@@ -0,0 +1,66 @@
+<!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>Configuring the JPA diagram editor</title>
+
+<!-- contents -->
+</head>
+<body>
+
+ <div class="sect1">
+ <!-- infolevel="all" infotype="General" -->
+ <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> -&gt; <i>Preferences</i> </span> in
+ the main menu.</li>
+ <li><p>
+ Select <span><i>General</i> -&gt; <i>Editors</i> -&gt; <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> -&gt; <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>
+ </div>
+ </td>
+ </div>
+</body>
+</html>
+
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
new file mode 100644
index 0000000000..c88450ea07
--- /dev/null
+++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_manage_entities.html
@@ -0,0 +1,107 @@
+<!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_open_diagram.html b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_open_diagram.html
new file mode 100644
index 0000000000..f319e6ea9d
--- /dev/null
+++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_open_diagram.html
@@ -0,0 +1,62 @@
+<!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>Open JPA Diagram, create and display entities</title>
+
+<!-- contents -->
+</head>
+<body>
+
+ <div class="sect1">
+ <!-- infolevel="all" infotype="General" -->
+ <h2>Opening 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>
+ <li><p>
+ In the context menu, choose <span title="Navigation path">
+ <i>JPA Tools</i> -&grt; <i>Open Diagram</i>
+ </span>.
+ </p>
+ </li>
+ </ol>
+ </div></td>
+ <h2>Creating new entities</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.
+ </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>
+ <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>
+ <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>
+ </ul>
+ </div></td>
+ </div>
+</body>
+</html>
+
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
new file mode 100644
index 0000000000..88b01f8714
--- /dev/null
+++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_open_miniature_view.html
@@ -0,0 +1,43 @@
+<!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>Opening the Miniature view or the JPA Details view</title>
+
+<!-- contents -->
+</head>
+<body>
+
+ <div class="sect1">
+ <!-- infolevel="all" infotype="General" -->
+ <h2>Opening the Miniature view or the JPA Details view</h2>
+ <td><div>
+ <ol>
+ <li><p>Click 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>,
+ respectively.
+ </p></li>
+ <li><p>
+ To save the diagram as an image, choose <i>Save as Image</i>.
+ </p></li>
+ </ol>
+ </div>
+ <div>
+ <p>
+ <img src="../img/jpa_miniature_view.gif"
+ alt="JPA Editor Miniature view."
+ title="JPA Editor Miniature view." />
+ </p>
+ <br />
+ </div>
+ </td>
+ </div>
+</body>
+</html>
+
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
new file mode 100644
index 0000000000..4f52fd2296
--- /dev/null
+++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_refactor_entities.html
@@ -0,0 +1,105 @@
+<!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>Refactor, view, edit and remove entities and their
+ attributes</title>
+
+<!-- contents -->
+</head>
+<body>
+
+ <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>
+ <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> -&gt; <i>Rename</i>
+ </span>, 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> -&gt; <i>Move</i>
+ </span>, 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>
+ </ul>
+ </div></td>
+
+ <h2>Viewing and editing entities' source code</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>
+ <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>
+ <div>
+ <ol>
+ <li><p>Click 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> -&gt; <i>...and Save Changes</i>
+ </span>
+ </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> -&gt; <i>...and Discard Changes</i>
+ </span>.
+ </p>
+ </li>
+ </ol>
+ </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
new file mode 100644
index 0000000000..1b560bbfff
--- /dev/null
+++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/task_remove_entities.html
@@ -0,0 +1,57 @@
+<!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 and removing relationships between entities</title>
+
+<!-- contents -->
+</head>
+<body>
+
+ <div class="sect1">
+ <!-- infolevel="all" infotype="General" -->
+ <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
+ relationship type.
+ </p>
+ </li>
+ <li><p>
+ Click the source entity of the relationship with the primary
+ mouse button or choose
+ <kbd title="Keyboard button">ESCAPE</kbd>
+ to cancel.
+ </p>
+ </li>
+ <li><p>
+ Click the target entity of the relationship with the primary
+ mouse button or choose
+ <kbd title="Keyboard button">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 choose
+ <kbd title="Keyboard button">DELETE</kbd>
+ , or choose <i>Delete</i> in 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>
+
diff --git a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/toc.html b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/toc.html
new file mode 100644
index 0000000000..59b9631b7c
--- /dev/null
+++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/html/toc.html
@@ -0,0 +1,13 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<title>Table of Contents</title>
+</head>
+
+<body>
+ <h1>Table of Contents</h1>
+ Please enter your text here.
+</body>
+</html> \ No newline at end of file
diff --git a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/img/jpa_diagram_delete_attribute.gif b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/img/jpa_diagram_delete_attribute.gif
new file mode 100644
index 0000000000..fdb53f11db
--- /dev/null
+++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/img/jpa_diagram_delete_attribute.gif
Binary files differ
diff --git a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/img/jpa_diagram_editor.gif b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/img/jpa_diagram_editor.gif
new file mode 100644
index 0000000000..f6c95e656b
--- /dev/null
+++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/img/jpa_diagram_editor.gif
Binary files differ
diff --git a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/img/jpa_diagram_entity_operations.gif b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/img/jpa_diagram_entity_operations.gif
new file mode 100644
index 0000000000..d800a1b8f1
--- /dev/null
+++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/img/jpa_diagram_entity_operations.gif
Binary files differ
diff --git a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/img/jpa_miniature_view.gif b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/img/jpa_miniature_view.gif
new file mode 100644
index 0000000000..fd3e2547a2
--- /dev/null
+++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/img/jpa_miniature_view.gif
Binary files differ
diff --git a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/img/jpaeditor_entity.gif b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/img/jpaeditor_entity.gif
new file mode 100644
index 0000000000..9c495ff163
--- /dev/null
+++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/img/jpaeditor_entity.gif
Binary files differ
diff --git a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/plugin.properties b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/plugin.properties
new file mode 100644
index 0000000000..3260a3f582
--- /dev/null
+++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/plugin.properties
@@ -0,0 +1,13 @@
+# ====================================================================
+# To code developer:
+# Do NOT change the properties between this line and the
+# "%%% END OF TRANSLATED PROPERTIES %%%" line.
+# Make a new property name, append to the end of the file and change
+# the code to use the new property.
+# ====================================================================
+
+# ====================================================================
+# %%% END OF TRANSLATED PROPERTIES %%%
+# ====================================================================
+pluginName=Dali Java Persistence Tools - Documentation
+providerName = Eclipse Web Tools Platform
diff --git a/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/plugin.xml b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/plugin.xml
new file mode 100644
index 0000000000..145c6ac998
--- /dev/null
+++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/plugin.xml
@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<?eclipse version="3.4"?>
+<plugin>
+
+ <!-- =========== -->
+ <!-- Define TOC -->
+ <!-- =========== -->
+ <extension
+ point="org.eclipse.help.toc">
+ <toc
+ file="toc.xml"
+ primary="true">
+ </toc>
+ </extension>
+
+</plugin>
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
new file mode 100644
index 0000000000..5abbf62374
--- /dev/null
+++ b/jpa_diagram_editor/plugins/org.eclipse.jpt.jpadiagrameditor.doc.user/toc.xml
@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<?NLS TYPE="org.eclipse.help.toc"?>
+
+<toc label="JPA Diagram Editor Project User Guide">
+
+ <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>
+ <topic href="html/task_remove_entities.html" label="Defining and removing relationships between entities">
+ </topic>
+ <topic href="html/task_manage_entities.html" label="Managing entities">
+ </topic>
+ <topic href="html/task_refactor_entities.html" label="Refactor, view, edit and remove entities and their attributes">
+ </topic>
+ <topic href="html/task_open_miniature_view.html" label="Opening the Miniature view or the JPA Details view">
+ </topic>
+ <topic href="html/task_20_support.html" label="JPA diagram editor partial support for JPA 2.0">
+ </topic>
+ </topic>
+ <topic label="Reference">
+ <topic href="html/reference_project_page.html" label="Property page - JPA Diagram Editor Options">
+ </topic>
+ </topic>
+
+</toc>

Back to the top