Jump to: navigation, search

Difference between revisions of "JPA Diagram Editor Project"

m (Project Status)
m
(36 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
== Overview  ==
 
== Overview  ==
RC1
+
 
The JPA Diagram Editor project enables the JPA developers to create, view, and edit their business data model as graphical diagram. Currently, this is a [http://eclipse.org/webtools/incubator/ WTP incubator] project. For detailed information, see the [http://wiki.eclipse.org/WTP/JPA_Diagram_Editor/Proposal project proposal].
+
The JPA Diagram Editor enables the JPA developers to create, view, and edit their business data model as graphical diagram. For detailed information, see the [http://wiki.eclipse.org/WTP/JPA_Diagram_Editor/Proposal project proposal].
 +
 
 +
The JPA Diagram Editor recently passed successfully a Move Review. The code and the infrastructure of the project was successfully moved from the WTP Incubator to the WTP Dali project.
  
 
== Project Status  ==
 
== Project Status  ==
  
* First official release (0.5) planned for October 2010. This release will include only bugfixes for the initial contribution.
+
JPA Diagram editor is a component of Dali. It's part of the Indigo and later releases of the eclipse. It's also compatible with Helios.
** 0.5 RC1 (August 18th, 2010), [https://bugs.eclipse.org/bugs/buglist.cgi?classification=WebTools;query_based_on=JPA%20Editor;query_format=advanced;component=wtp.inc.jpaeditor;product=WTP%20Incubator;target_milestone=0.5%20RC1;known_name=JPA%20Editor bugs fixed] (14)
+
** 0.5 RC2 (September 15th, 2010), [https://bugs.eclipse.org/bugs/buglist.cgi?classification=WebTools;query_based_on=JPA%20Editor;query_format=advanced;component=wtp.inc.jpaeditor;target_milestone=0.5%20RC2;product=WTP%20Incubator;known_name=JPA%20Editor bugs fixed] (18)
+
** 0.5 RC3 (October 19th, 2010), [https://bugs.eclipse.org/bugs/buglist.cgi?classification=WebTools;query_based_on=JPA%20Editor;query_format=advanced;component=wtp.inc.jpaeditor;target_milestone=0.5%20RC3;product=WTP%20Incubator;known_name=JPA%20Editor bugs fixed] (7)
+
** 0.5 RC4, [https://bugs.eclipse.org/bugs/buglist.cgi?classification=WebTools;query_based_on=JPA%20Editor;query_format=advanced;component=wtp.inc.jpaeditor;target_milestone=0.5%20RC4;product=WTP%20Incubator;known_name=JPA%20Editor bugs targeted] (~3)
+
* Next feature release (0.7) planned for mid of December 2010. This release will include new enhancements.
+
** [https://bugs.eclipse.org/bugs/buglist.cgi?classification=WebTools;query_based_on=JPA%20Editor;query_format=advanced;component=wtp.inc.jpaeditor;target_milestone=0.7%20M1;target_milestone=0.7%20M2;target_milestone=0.7%20M3;target_milestone=0.7%20M4;product=WTP%20Incubator;known_name=JPA%20Editor Bugs targeted for 0.7] (~13)
+
  
 +
JPA diagram editor offers full support for JPA 1.0. JPA 2.0 support development is in progress as well as support of additional JPA artifacts like embeddable classes and mapped superclasses.
  
Bugzilla bookkeeping:
+
The editor already supports the new (JPA 2.0) style One-to-Many unidirectional relationship. I.e. - in JPA 2.0 projects the corresponding relationship attribute will be created with additional @JoinColumn(s) annotation, which means that the corresponding DB schema will be created without additional join table.
* [https://bugs.eclipse.org/bugs/buglist.cgi?classification=WebTools;query_based_on=JPA%20Editor;query_format=advanced;bug_status=UNCONFIRMED;bug_status=NEW;bug_status=ASSIGNED;bug_status=REOPENED;component=wtp.inc.jpaeditor;target_milestone=---;product=WTP%20Incubator;known_name=JPA%20Editor Untargeted open bugs]
+
 
* [https://bugs.eclipse.org/bugs/buglist.cgi?classification=WebTools;query_based_on=JPA%20Editor;emailtype1=exact;query_format=advanced;emailassigned_to1=1;bug_status=UNCONFIRMED;bug_status=NEW;bug_status=ASSIGNED;bug_status=REOPENED;email1=wtp.inc.jpaeditor-inbox%40eclipse.org;component=wtp.inc.jpaeditor;product=WTP%20Incubator;known_name=JPA%20Editor Unassigned open bugs]
+
This behavior is optional. The user 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 @JoinColumn(s) annotation.
* [https://bugs.eclipse.org/bugs/buglist.cgi?classification=WebTools&query_based_on=JPA%20Editor&query_format=advanced&bug_status=RESOLVED&component=wtp.inc.jpaeditor&product=WTP%20Incubator&known_name=JPA%20Editor Resolved bugs, but not verified]
+
 
* [https://bugs.eclipse.org/bugs/buglist.cgi?classification=WebTools;query_based_on=JPA%20Editor;query_format=advanced;bug_status=VERIFIED;component=wtp.inc.jpaeditor;product=WTP%20Incubator;known_name=JPA%20Editor Verified bugs, but not closed]
+
<br>Bugzilla bookkeeping:  
 +
 
 +
*[https://bugs.eclipse.org/bugs/buglist.cgi?classification=WebTools;query_based_on=JPA%20Editor;query_format=advanced;bug_status=UNCONFIRMED;bug_status=NEW;bug_status=ASSIGNED;bug_status=REOPENED;component=Diagram%20Editor;target_milestone=---;product=Dali%20JPA%20Tools;known_name=JPA%20Editor Untargeted open bugs]  
 +
*[https://bugs.eclipse.org/bugs/buglist.cgi?classification=WebTools;query_based_on=JPA%20Editor;emailtype1=exact;emailassigned_to1=1;query_format=advanced;bug_status=UNCONFIRMED;bug_status=NEW;bug_status=ASSIGNED;bug_status=REOPENED;email1=dali.diagrameditor-inbox%40eclipse.org;component=Diagram%20Editor;product=Dali%20JPA%20Tools;known_name=JPA%20Editor Unassigned open bugs]  
 +
*[https://bugs.eclipse.org/bugs/buglist.cgi?classification=WebTools;query_based_on=JPA%20Editor;query_format=advanced;bug_status=RESOLVED;component=Diagram%20Editor;product=Dali%20JPA%20Tools;known_name=JPA%20Editor Resolved bugs, but not verified]  
 +
*[https://bugs.eclipse.org/bugs/buglist.cgi?classification=WebTools;query_based_on=JPA%20Editor;query_format=advanced;bug_status=VERIFIED;component=Diagram%20Editor;product=Dali%20JPA%20Tools;known_name=JPA%20Editor Verified bugs, but not closed]
  
 
== How to Install  ==
 
== How to Install  ==
 +
 +
[[Image:JPA Editor P2 Repo.png|thumb]]
 +
 +
If you are using Indigo or greater eclipse versions you may skip this section
  
 
Download and extract [http://www.eclipse.org/downloads/download.php?file=/technology/epp/downloads/release/helios/R/eclipse-jee-helios-win32.zip Eclipse for Java EE Developers Helios].  
 
Download and extract [http://www.eclipse.org/downloads/download.php?file=/technology/epp/downloads/release/helios/R/eclipse-jee-helios-win32.zip Eclipse for Java EE Developers Helios].  
Line 26: Line 32:
 
Start the Eclipse IDE.  
 
Start the Eclipse IDE.  
  
Install the Graphiti project:  
+
Install the project:  
  
*Go to '''''Help -&gt; Install New Software''''' and choose the '''''Add...''''' button.
+
#Go to '''''Help -&gt; Install New Software'''''.
*In the '''''Add Site''''' dialog enter following information:
+
#Paste the following URL in the '''''Works with''''' field and hit '''''Enter''''': http://download.eclipse.org/webtools/incubator/repository/jpaeditor/helios/  
**Name field: Graphiti
+
#You need to select only the features from the JPA Diagram Editor category. The install manager will automatically pick-up the necessary Graphiti features.  
**Location field: [http://download.eclipse.org/graphiti/updates/0.7.0/ http://download.eclipse.org/graphiti/updates/0.7.0/]
+
#Follow the next steps of the wizard to install it.
*Select everything from the site and follow the next steps of the wizard to install it.  
+
  
Install the JPA Diagram Editor project:
+
== Using the JPA Diagram Editor&nbsp;  ==
  
*Go to '''''Help -&gt; Install New Software''''' and&nbsp;choose the '''''Add...''''' button.
+
[http://wiki.eclipse.org/JPA_Diagram_Editor_Project_Tutorial Getting Started Tutorial]  
*In the '''''Add Site''''' dialog enter following information:
+
**Name field: JPA Diagram Editor
+
**Location field: [http://download.eclipse.org/webtools/incubator/repository/jpaeditor/milestones/ http://download.eclipse.org/webtools/incubator/repository/jpaeditor/milestones/]
+
*Select everything from the site and follow the next steps of the wizard to install it.
+
  
== Using the JPA Diagram Editor&nbsp; ==
+
[http://www.youtube.com/watch?v=xZf6pOHX178 Watch demo on YouTube]  
 
+
[http://wiki.eclipse.org/JPA_Diagram_Editor_Project_Tutorial Getting Started Tutorial]
+
 
+
[http://www.youtube.com/watch?v=xZf6pOHX178 Watch demo on YouTube]
+
  
 
== Where I can get help and information?  ==
 
== Where I can get help and information?  ==
  
[http://www.eclipse.org/forums/index.php?t=thread&frm_id=114 WTP Incubator Forum]  
+
[http://www.eclipse.org/forums/index.php/f/113/ Dali Forum]  
  
[https://dev.eclipse.org/mailman/listinfo/wtp-incubator-dev WTP Incubator Dev mailing list]
+
[https://dev.eclipse.org/mailman/listinfo/dali-dev Dali Dev mailing list]  
  
[https://bugs.eclipse.org/bugs/enter_bug.cgi?product=WTP%20Incubator Report bugs in Bugzilla], component '''wtp.inc.jpaeditor'''
+
[https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Dali%20JPA%20Tools&component=Diagram%20Editor Report bugs in Bugzilla]
* [https://bugs.eclipse.org/bugs/buglist.cgi?query_format=advanced;component=wtp.inc.jpaeditor;product=WTP%20Incubator;classification=WebTools Known bugs]
+
  
 
== How do I get sources?  ==
 
== How do I get sources?  ==
  
The source code is in the following CVS repository:
+
The source code is in the following GIT repository:  
 +
 
 +
git://git.eclipse.org/gitroot/dali/webtools.dali.git
 +
 
 +
ssh://git.eclipse.org/gitroot/dali/webtools.dali.git
 +
 
 +
http://git.eclipse.org/gitroot/dali/webtools.dali.git
 +
 
 +
'''master''':/jpa_diagram_editor/plugins/org.eclipse.jpt.ui.diagrameditor
 +
 
 +
See the [http://wiki.eclipse.org/EGit/User_Guide EGit User Guide] for help using EGit.
 +
 
 +
== Build Infrastructure  ==
 +
 
 +
The build is based on Maven+Tycho, executed on [[Hudson]] server, hosted at Eclipse Foundation. New build is triggered automatically after a change committed in GIT.
  
''':pserver:anonymous@dev.eclipse.org/cvsroot/webtools'''
+
[https://hudson.eclipse.org/hudson/view/WTP/job/cbi-wtp.jpaeditor/ Hudson build job]
  
'''HEAD''':/incubator/org.eclipse.jpt/plugins/org.eclipse.jpt.ui.diagrameditor
+
[https://hudson.eclipse.org/hudson/view/WTP/job/cbi-wtp.jpaeditor/lastSuccessfulBuild/artifact/targetPlatform/ P2 repository of the latest build]
  
See the [[CVS Howto]] for help using CVS.
+
== Limitations ==
  
== Build Infrastructure ==
+
*Registering of JPA entities in persistence.xml causes inconsistent editor behavior – Eclipse bug #[https://bugs.eclipse.org/bugs/show_bug.cgi?id=257530 257530]
  
The build is based on Maven+Tycho, executed on [[Hudson]] server, hosted at Eclipse Foundation. New build is triggered automatically after a change submitted in CVS.
+
*Refactoring entity class (from outside the diagram editor) causes disappearing of the corresponding pictogram from the diagram - Eclipse bug #[https://bugs.eclipse.org/bugs/show_bug.cgi?id=324026 324026]
  
[https://hudson.eclipse.org/hudson/view/WTP/job/cbi-wtp.inc-jpaeditor/ Hudson build job]
+
*Currently only pure Java entities are supported. There is no mapping XML entities support yet.
  
[https://hudson.eclipse.org/hudson/view/WTP/job/cbi-wtp.inc-jpaeditor/lastSuccessfulBuild/artifact/targetPlatform/ P2 repository of the latest build]
+
*Still no support for Undo/Redo

Revision as of 03:37, 30 October 2012

Overview

The JPA Diagram Editor enables the JPA developers to create, view, and edit their business data model as graphical diagram. For detailed information, see the project proposal.

The JPA Diagram Editor recently passed successfully a Move Review. The code and the infrastructure of the project was successfully moved from the WTP Incubator to the WTP Dali project.

Project Status

JPA Diagram editor is a component of Dali. It's part of the Indigo and later releases of the eclipse. It's also compatible with Helios.

JPA diagram editor offers full support for JPA 1.0. JPA 2.0 support development is in progress as well as support of additional JPA artifacts like embeddable classes and mapped superclasses.

The editor already supports the new (JPA 2.0) style One-to-Many unidirectional relationship. I.e. - in JPA 2.0 projects the corresponding relationship attribute will be created with additional @JoinColumn(s) annotation, which means that the corresponding DB schema will be created without additional join table.

This behavior is optional. The user 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 @JoinColumn(s) annotation.


Bugzilla bookkeeping:

How to Install

JPA Editor P2 Repo.png

If you are using Indigo or greater eclipse versions you may skip this section

Download and extract Eclipse for Java EE Developers Helios.

Start the Eclipse IDE.

Install the project:

  1. Go to Help -> Install New Software.
  2. Paste the following URL in the Works with field and hit Enter: http://download.eclipse.org/webtools/incubator/repository/jpaeditor/helios/
  3. You need to select only the features from the JPA Diagram Editor category. The install manager will automatically pick-up the necessary Graphiti features.
  4. Follow the next steps of the wizard to install it.

Using the JPA Diagram Editor 

Getting Started Tutorial

Watch demo on YouTube

Where I can get help and information?

Dali Forum

Dali Dev mailing list

Report bugs in Bugzilla

How do I get sources?

The source code is in the following GIT repository:

git://git.eclipse.org/gitroot/dali/webtools.dali.git

ssh://git.eclipse.org/gitroot/dali/webtools.dali.git

http://git.eclipse.org/gitroot/dali/webtools.dali.git

master:/jpa_diagram_editor/plugins/org.eclipse.jpt.ui.diagrameditor

See the EGit User Guide for help using EGit.

Build Infrastructure

The build is based on Maven+Tycho, executed on Hudson server, hosted at Eclipse Foundation. New build is triggered automatically after a change committed in GIT.

Hudson build job

P2 repository of the latest build

Limitations

  • Registering of JPA entities in persistence.xml causes inconsistent editor behavior – Eclipse bug #257530
  • Refactoring entity class (from outside the diagram editor) causes disappearing of the corresponding pictogram from the diagram - Eclipse bug #324026
  • Currently only pure Java entities are supported. There is no mapping XML entities support yet.
  • Still no support for Undo/Redo