Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Dali Developer Documentation"

(Examples)
m (Development Workspace)
(21 intermediate revisions by the same user not shown)
Line 13: Line 13:
 
*** The basic Eclipse Java IDE (http://download.eclipse.org/eclipse/downloads/)
 
*** The basic Eclipse Java IDE (http://download.eclipse.org/eclipse/downloads/)
 
*** [Optional] The Eclipse Modeling Framework (http://www.eclipse.org/modeling/emf/downloads/)
 
*** [Optional] The Eclipse Modeling Framework (http://www.eclipse.org/modeling/emf/downloads/)
** A reasonable command-line for executing the ''host'' platform might look like this:<br>
 
 
<pre>eclipse.exe -vm C:\jdk\1.6.0_23\bin\javaw.exe -data C:\dev\dali -vmargs -Xmx768M -XX:MaxPermSize=256M</pre>
 
  
 
* Add the appropriate Execution Environment to the ''host'' platform
 
* Add the appropriate Execution Environment to the ''host'' platform
** If necessary, download and install the final J2SE 1.5 JRE or JDK (http://www.oracle.com/technetwork/java/javase/downloads/index.html)
+
** Like the base Eclipse platform, Dali requires JavaSE-1.8
** Start the ''host'' platform
+
** Add an Installed JRE (Preferences > Java > Installed JREs)
+
*** <Standard VM>
+
*** Select the directory holding the just-installed JRE/JDK
+
**'''NB:''' This Java installation ''must'' be version '''1.5'''. Installing and using a 1.5 JRE/JDK reduces the possibility of any errors slipping through (e.g. using classes or methods added in later versions of Java). The ''host'' platform can be run on a later version of Java; but the Dali plug-ins ''must'' be compiled against and capable of executing on Java 1.5. Each Dali project's build path and project-specific Java compiler settings ensure Dali is compiled with Java 1.5 compliance; but there must be a Java 1.5 installation present for the compiler to compile against the correct Java jars.
+
**'''NB:''' As of the Luna release, parts of the Eclipse Platform needed by Dali require a Java 1.6 Execution Environment. As a result, Dali requires a Java 1.6 Execution Environment to execute. Despite this requirement, Dali will continue to be compiled against and require only a Java 1.5 Execution Environment, until an irresistable Java feature compels Dali to move to a higher version of Java.
+
  
 
* Set up a ''target'' platform
 
* Set up a ''target'' platform
Line 36: Line 27:
 
*** Graphiti
 
*** Graphiti
 
*** Orbit
 
*** Orbit
*** WTP SDK
+
*** WTP
** Unzip all the downloaded files (except the Graphiti and Orbit files) into the same directory (This directory is different than the directory holding the ''host'' platform created above.)
+
** Unzip all the downloaded files that are not update repositories:
 +
*** '''Mac:''' Extract the Eclipse SDK Mac application bundle tar first; then unzip the non-repository files into the subdirectory <code>Eclipse.app/Contents</code>.
 +
*** Eclipse SDK
 +
*** EMF and XSD SDK
 +
*** EMF Transaction
 +
*** EMF Validation
  
 
* Configure the ''host'' platform to use the ''target'' platform for building plug-ins
 
* Configure the ''host'' platform to use the ''target'' platform for building plug-ins
Line 46: Line 42:
 
*** <Add...> a new location for the ''target'' platform
 
*** <Add...> a new location for the ''target'' platform
 
**** <Directory>
 
**** <Directory>
**** Select the directory holding the ''target'' platform (i.e. the directory holding the just-unzipped WTP files and pre-requisites)
+
**** Select the directory holding the ''target'' platform (i.e. the directory holding the just-unzipped files)
**** NB: The new location should indicate it has over 1000 plug-ins available
+
***** '''Mac:''' Select the subdirectory <code>Eclipse.app/Contents/Eclipse</code>.
 +
**** NB: The new location should indicate it has over 500 plug-ins available
 
*** <Add...> another location for the Orbit repository
 
*** <Add...> another location for the Orbit repository
 
**** <Software Site>
 
**** <Software Site>
Line 65: Line 62:
 
**** '''NB:''' Make sure <Include required software> is unchecked. (Graphiti requires the EMF Transaction plug-in, which is already part of the target platform location added above.)
 
**** '''NB:''' Make sure <Include required software> is unchecked. (Graphiti requires the EMF Transaction plug-in, which is already part of the target platform location added above.)
 
**** Select "Graphiti SDK"  (or "Graphiti" => "Graphiti SDK" if grouped by categories.)
 
**** Select "Graphiti SDK"  (or "Graphiti" => "Graphiti SDK" if grouped by categories.)
 +
**** NB: The new location should indicate it has 48 plug-ins available
 +
*** <Add...> another location for the DTP repository
 +
**** <Software Site>
 +
**** <Add...> a new repository
 +
***** <Archive...>
 +
***** Select the just-downloaded DTP zip file
 +
**** <Work with:> the just-added DTP repository
 +
**** '''NB:'''  Make sure <Group by Category> is checked.
 +
**** Click on <Select All>
 +
**** NB: The new location should indicate it has over 200 plug-ins available
 +
*** <Add...> another location for the GEF repository
 +
**** <Software Site>
 +
**** <Add...> a new repository
 +
***** <Archive...>
 +
***** Select the just-downloaded GEF zip file
 +
**** <Work with:> the just-added GEF repository
 +
**** '''NB:'''  Make sure <Group by Category> is checked.
 +
**** Click on <Select All>
 
**** NB: The new location should indicate it has 20 plug-ins available
 
**** NB: The new location should indicate it has 20 plug-ins available
 +
*** <Add...> another location for the WTP repository
 +
**** <Software Site>
 +
**** <Add...> a new repository
 +
***** <Archive...>
 +
***** Select the just-downloaded WTP zip file
 +
**** <Work with:> the just-added WTP repository
 +
**** '''NB:'''  Make sure <Group by Category> is checked.
 +
**** Click on <Select All>
 +
**** NB: The new location should indicate it has over 500 plug-ins available
 
*** <Finish> the wizard to create the new ''target'' platform
 
*** <Finish> the wizard to create the new ''target'' platform
  
Line 72: Line 96:
 
* Clone the Eclipse Foundation-hosted Dali Git repository and import the Dali projects
 
* Clone the Eclipse Foundation-hosted Dali Git repository and import the Dali projects
 
** Ensure the Eclipse network proxy is configured, if applicable (Preferences > General > Network Connections)
 
** Ensure the Eclipse network proxy is configured, if applicable (Preferences > General > Network Connections)
** Open the Git Repository Exploring perspective
+
** Open the Git perspective
 
** Clone the Dali repository using the appropriate URL from http://git.eclipse.org/c/dali/webtools.dali.git
 
** Clone the Dali repository using the appropriate URL from http://git.eclipse.org/c/dali/webtools.dali.git
 
** Import the plug-in and test plug-in projects in the repository's working directory (The projects are named <code>org.eclipse.jpt.*</code>.):
 
** Import the plug-in and test plug-in projects in the repository's working directory (The projects are named <code>org.eclipse.jpt.*</code>.):
Line 230: Line 254:
 
'''Attribute Mapping''': A specific way of persisting a ''persistent attribute''. For example: <code>Basic</code>, <code>ManyToOne</code>, <code>OneToMany</code>. All JPA metadata specified at the attribute (field or property) level will be contained by an ''attribute mapping''.
 
'''Attribute Mapping''': A specific way of persisting a ''persistent attribute''. For example: <code>Basic</code>, <code>ManyToOne</code>, <code>OneToMany</code>. All JPA metadata specified at the attribute (field or property) level will be contained by an ''attribute mapping''.
  
=== Model Structure ===
+
=== Model ===
  
 
The main entry point for the Dali model is the <code>JpaWorkspace</code>, which corresponds to the Eclipse workspace (i.e. <code>org.eclipse.core.resources.IWorkspace</code>). The <code>JpaWorkspace</code> can be obtained by ''adapting'' the Eclipse workspace:
 
The main entry point for the Dali model is the <code>JpaWorkspace</code>, which corresponds to the Eclipse workspace (i.e. <code>org.eclipse.core.resources.IWorkspace</code>). The <code>JpaWorkspace</code> can be obtained by ''adapting'' the Eclipse workspace:
Line 295: Line 319:
 
     }
 
     }
  
     JpaRootContextNode rootContextNode = jpaProject.getRootContextNode();
+
     JpaContextRoot root = jpaProject.getContextRoot();
     PersistenceXml persistenceXml = rootContextNode.getPersistenceXml();
+
     PersistenceXml persistenceXml = root.getPersistenceXml();
 
     if (persistenceXml == null) {
 
     if (persistenceXml == null) {
 
         return Collections.emptySet();
 
         return Collections.emptySet();
 
     }
 
     }
  
     Persistence persistence = persistenceXml.getPersistence();
+
     Persistence persistence = persistenceXml.getRoot();
 
     if (persistence == null) {
 
     if (persistence == null) {
 
         return Collections.emptySet();
 
         return Collections.emptySet();
Line 312: Line 336:
 
     PersistenceUnit persistenceUnit = persistence.getPersistenceUnit(0);
 
     PersistenceUnit persistenceUnit = persistence.getPersistenceUnit(0);
 
     ArrayList<PersistentType> entities = new ArrayList<PersistentType>();
 
     ArrayList<PersistentType> entities = new ArrayList<PersistentType>();
     for (PersistentType persistentTypes : persistenceUnit.getPersistentTypes()) {
+
     for (PersistentType persistentType : persistenceUnit.getPersistentTypes()) {
         if (persistentTypes.getMappingKey() == MappingKeys.ENTITY_TYPE_MAPPING_KEY) {
+
         if (persistentType.getMappingKey() == MappingKeys.ENTITY_TYPE_MAPPING_KEY) {
             entities.add(persistentTypes);
+
             entities.add(persistentType);
 
         }
 
         }
 
     }
 
     }
Line 321: Line 345:
 
</pre>
 
</pre>
  
* Changing the Context model programatically
+
* Modify the ''context model'' programatically
  
 +
The Dali ''context model'' can be modified directly on the UI thread; but any cascading changes to the ''context model'' happen in a background job. As a result, simple, write-only modifications can be performed on the UI thread without much hassle; but any code that changes the ''context model'' and wants any cascading changes to be immediately accessible (i.e. with the next line of code) must use a special API. To force these background, cascading changes to occur synchronously, use the method <code>JpaProjectManager.execute(Command, ExtendedCommandContext)</code>. The command is a client-defined command that will execute the model-modifying code; while the context allows the modification of any documents that are open in the UI (typically the context can be the <code>SynchronousUiCommandContext.instance()</code>). (This context is most likely necessary because of an Eclpse platform bug....) Dali has several internal examples of using this method (e.g. the code that synchronizes the Persistence Unit's list of classes with the currently JPA annotated Java classes in the project).
  
If you are changing the model outside the UI thread you will need to configure the JPA project to make modifications on the UI thread as necessary. See JpaProject#setThreadLocalModifySharedDocumentCommandExecutor(CommandExecutor).
+
=== UI ===
  
Also note the model is "updated" asynchronously with every change. If you want these updates to happen synchronously, you will need to set the JPA project's "updater". See JpaProject#setUpdater(Updater). Note the comments in SynchronousJpaProjectUpdater.
+
The main entry point for the Dali UI is the <code>JpaWorkbench</code>, which corresponds to the Eclipse workbench (i.e. <code>org.eclipse.ui.IWorkbench</code>). The <code>JpaWorkbench</code> can be obtained by ''adapting'' the Eclipse workbench:
 
+
<pre>
=== UI Structure ===
+
IWorkbench workbench = PlatformUI.getWorkbench();
 +
JpaWorkbench jpaWorkbench = (JpaWorkbench) Platform.getAdapterManager().getAdapter(workbench, JpaWorkbench.class);
 +
</pre>
 +
'''NB:''' Even though <code>IWorkbench</code> extends <code>IAdaptable</code>, it does not delegate to the <code>Platform</code> adapter manager; so registered adapter factories are ''not'' used, and clients must directly use the <code>Platform</code> adapter manager.
  
 +
The primary use of the <code>JpaWorkbench</code> is gaining access to the <code>JpaPlatformUiManager</code>. The <code>JpaPlatformUiManager</code> holds the current set of <code>JpaPlatformUi</code>s. Each <code>JpaPlatformUi</code> corresponds to a specific <code>JpaPlatform</code> and provides the UI components necessary to support the models derived from that <code>JpaPlatform</code>. The UI also provides behavior the various Dali menu commands and wizards.
  
 
== JAXB ==
 
== JAXB ==
 
Under construction...
 
Under construction...
  
= Core Dali Plug-ins =
+
= Plug-ins =
  
== org.eclipse.jpt.*.core ==
+
* <code>org.eclipse.jpt.*.core</code> - ''resource model'' and ''context model'' interfaces and implementations
Description:  Resource model and Context model interfaces and implementations
+
* <code>org.eclipse.jpt.jpa.db</code> - DTP wrapper model, Dali’s interface to the DTP database metadata model
 +
* <code>org.eclipse.jpt.jpa.db.ui</code> - Dali UI for DTP Connection Wizard
 +
* <code>org.eclipse.jpt.jpa.gen</code> - model and generator code for generating Entities from database tables
 +
* <code>org.eclipse.jpt.*.ui</code> - Dali UI actions, composites, data models, wizards, views, and perspectives
 +
* <code>org.eclipse.jpt.utility</code> - Dali utility classes: model/event/listener sets, iterables, closures, commands, transformers, predicates, factories, references, collections, value models, etc.
 +
* <code>org.eclipse.jpt.*.eclipselink.core</code> - EclipseLink extension, including an EclipseLink <code>JpaPlatform</code> and associated EclipseLink ''resource model'' and ''context model''.
 +
* <code>org.eclipse.jpt.*.eclipselink.ui</code> - EclipseLink UI extension, including an EclipseLink <code>JpaPlatformUI</code> and associated EclipseLink UI composites
 +
* <code>org.eclipse.jpt.*.core.tests</code> - headless JUnit plug-in test suites for the core plug-ins
 +
* <code>org.eclipse.jpt.utility.tests</code> - JUnit test suites for the utility plug-in
 +
* <code>org.eclipse.jpt.doc.isv</code> - Javadoc plug-in
 +
* <code>org.eclipse.jpt.doc.user</code> - Dali user docs and infopop
  
== org.eclipse.jpt.jpa.db ==
+
= Major Integration points =
Description:  DTP wrapper model, serves as Dali’s interface to the DTP DB model.
+
  
== org.eclipse.jpt.jpa.db.ui ==
+
== JPA ==
Description:  Dali UI for DTP Connection Wizard
+
  
== org.eclipse.jpt.doc.isv ==
+
=== Eclipse Platform ===
Description: Javadoc plugin
+
* Content types
 +
** <code>persistence.xml</code>
 +
** Mapping file/<code>orm.xml</code>
 +
* Markers (errors/warnings)
 +
* Refactoring participants
 +
* At startup, Dali adds a resource change listener to the Eclipse workspace:
 +
** detect the presence of JPA Facet on any workspace project
 +
** files added or removed from any workspace project
 +
** "clean" builds will trigger the rebuilding of the appropriate JPA projects
 +
=== JDT ===
 +
* At startup, Dali adds a Java element change listener to the Java model manager:
 +
** detect the presence of the JPA annotations in any Java source files
 +
** classpath changes will trigger the rebuilding of the appropriate JPA project
 +
* The Dali ''resource model'' makes extensive use of the JDT core model and utilities to manipulate Java source code.
 +
=== EMF ===
 +
* The Dali XML ''resource model'' is generated from an EMF model defined to correspond to the JPA XML files:
 +
** <code>persistence.xml</code>
 +
** <code>orm.xml</code>
 +
=== DTP ===
 +
* Manage database connections
 +
* Database metadata is used for validation and to populate drop-down list-boxes
 +
* Entity generation uses database metadata and the data definitino model
 +
* The Datasource Explorer view is part of the Dali Persistence Perspective
 +
=== WTP ===
 +
* Faceted Project Framework
 +
* EMF-XML Translator Framework
 +
* Validation Framework
 +
* Library providers
 +
=== Eclipse Platform UI ===
 +
* "New" wizards
 +
* JPA Perspective
 +
* Views
 +
** JPA Structure
 +
** JPA Details
 +
* JPA Project Properties
 +
* Project Explorer (Common Navigator)
 +
* Completion proposals (content assist, Intellisense)
 +
** Database metadata
 +
** JPQL
 +
* Commands/Handlers/Menus
 +
* Editors
 +
** <code>persistence.xml</code>
 +
** Mapping file/<code>orm.xml</code>
  
== org.eclipse.jpt.doc.user ==
+
== JAXB ==
Description:  User docs and infopop for Dali
+
Under construction...
  
== org.eclipse.jpt.jpa.gen ==
+
= Extension =
Description:  Contains model and generator code for generating Entities from tables
+
  
== org.eclipse.jpt.*.ui ==
+
== JPA ==
Description:  Contains the actions, composites, data models, wizards, views, and perspective that make up the Dali UI.
+
  
== org.eclipse.jpt.utility ==
+
=== JpaPlatform ===
Description:  A set of utility classes for the Dali plug-in.  Contains a set of advanced iterators, change support, SWT Value Models, plus utilities for dealing with Files, Strings, Collections, etc.
+
  
No Dependencies.
+
Dali's main extension mechanism is the JPA Platforms (<code>org.eclipse.jpt.jpa.core.jpaPlatforms</code>) extension point, which adopters can use to specify implementations of the <code>JpaPlatformFactory</code> interface.
  
== org.eclipse.jpt.*.eclipselink.core ==
+
The <code>JpaPlatformFactory</code> interface is to be implemented by a JPA adopter to provide extensions to the core JPA model. Dali supplies a JPA Platform that supports JPA spec-defined Java annotations, <code>persistence.xml</code> and mapping (<code>orm.xml</code>) files.  The <code>org.eclipse.jpt.jpa.core.generic</code> extension supplies ''resource models'' for those file types.
Description:  EclipseLink extension, including an EclipseLinkPlatform and the EclipseLink context model.
+
  
== org.eclipse.jpt.*.eclipselink.ui ==
+
Example:
Description: EclipseLink UI extension, including an EclipseLinkPlatformUI and associated EclipseLink UI composites.
+
  
== org.eclipse.jpt.*.core.tests ==
+
<pre>
Description:  Contains a suite of headless JUnit tests for the core plug-ins.
+
<extension
 +
    point="org.eclipse.jpt.jpa.core.jpaPlatforms">
  
== org.eclipse.jpt.utility.tests ==
+
    <jpaPlatform
Description:  Contains a comprehensive set of tests for the Utility classes.
+
        id="generic"
 +
        label="%GENERIC_1_0_PLATFORM_LABEL"
 +
        factoryClass="org.eclipse.jpt.jpa.core.internal.GenericJpaPlatformFactory"
 +
        group="generic"
 +
        jpaFacetVersion="1.0"
 +
        default="false"/>
  
= Major Integration points =
+
</extension>
 +
</pre>
  
== JDT ==
+
Dali also provides an exemplary impelementation for EclipseLink which provides support for EclipseLink-specific Java annotations, <code>persistence.xml</code> settings and mapping file settings. See the <code>org.eclipse.jpt.jpa.eclipselink.core</code>) plug-in.
*The Dali Core makes extensive use of the JDT Core model and utilities for the purpose of reading and writing Java class metadata.
+
*Code Completion
+
  
== EMF ==
+
=== JpaPlatformUi ===
  
== DTP ==
+
Similar to the JPA Platform, the Dali UI can be extended via the JPA Platform UIs (<code>org.eclipse.jpt.jpa.ui.jpaPlatformUis</code>) extension point, which adopters can use to specify implementations of the <code>JpaPlatformUiFactory</code> interface. This interface must be implemented for any models defined in a JPA Platform extension to be correctly displayed in the UI.
The Dali DB and DDL plug-ins make use of the data definition mode and the New Connection Wizard. The Datasource Explorer view is an integral part of the Dali Persistence Perspective.
+
  
== WTP ==
+
<pre>
* Facets
+
<extension
* EMF-XML Translator Framework
+
    point="org.eclipse.jpt.jpa.ui.jpaPlatformUis">
* Validation Framework
+
  
== Platform ==
+
    <jpaPlatformUi
*Project Explorer
+
        id="generic.ui"
 +
        jpaPlatform="generic"
 +
        factoryClass="org.eclipse.jpt.jpa.ui.internal.platform.generic.GenericJpaPlatformUiFactory"/>
  
= Extension =
+
</extension>
 
+
Dali's main extension mechanism is the JpaPlatform Interface and extension point.
+
 
+
This interface is to be implemented by a JPA vendor to provide extensions to the core JPA model.  The core JPA model will provide functionality for JPA spec annotations in java, persistence.xml and (orm.xml) mapping files.  The org.eclipse.jpt.core.genericPlatform extension supplies resource models for those file types.  As another vendor option you will have to supply those resource models as well or different ones as necessary.
+
 
+
The extension designates a Platform ID, Label, Class (implemenation of JpaPlatform), and an option to set the platform as a "Default" platform.
+
 
+
Extension Example:
+
 
+
<pre>
+
  <extension
+
        point="org.eclipse.jpt.core.jpaPlatform">
+
      <jpaPlatform
+
            class="org.eclipse.jpt.eclipselink.core.internal.EclipseLinkPlatform"
+
            id="org.eclipse.eclipselink.platform"
+
            label="EclipseLink">
+
      </jpaPlatform>
+
  </extension>
+
 
</pre>
 
</pre>
  
See the EclipseLinkPlatform included in Dali as an exemplary implementation.
+
== JAXB ==
 +
 
 +
Under construction....
  
 
= API =
 
= API =
Provisional API is available as of the 2.0 release.
+
 
 +
''Provisional'' API is available as of the 2.0 release.
  
 
= Miscellaneous =
 
= Miscellaneous =
 
Archives
 
Archives
 
*[[Dali Developer Documentation v0.5]]
 
*[[Dali Developer Documentation v0.5]]

Revision as of 16:30, 15 January 2016

Repository

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

NB: Ensure the Eclipse network proxy is configured, if applicable (Preferences > General > Network Connections)

Development Workspace

To set up an Eclipse IDE workspace for working on Dali, perform the following steps:

  • Add the appropriate Execution Environment to the host platform
    • Like the base Eclipse platform, Dali requires JavaSE-1.8
  • Set up a target platform
    • Download the latest WTP Integration Build and all of its dependencies (http://download.eclipse.org/webtools/downloads/)
      • Eclipse SDK
      • EMF and XSD SDK
      • GEF SDK
      • DTP SDK
      • EMF Transaction
      • EMF Validation
      • Graphiti
      • Orbit
      • WTP
    • Unzip all the downloaded files that are not update repositories:
      • Mac: Extract the Eclipse SDK Mac application bundle tar first; then unzip the non-repository files into the subdirectory Eclipse.app/Contents.
      • Eclipse SDK
      • EMF and XSD SDK
      • EMF Transaction
      • EMF Validation
  • Configure the host platform to use the target platform for building plug-ins
    • Start the host platform
    • Add a target platform (Preferences > Plug-in Development > Target Platform)
      • <Add...> a new Target definition
      • Initialize the target definition with <Nothing>
      • <Add...> a new location for the target platform
        • <Directory>
        • Select the directory holding the target platform (i.e. the directory holding the just-unzipped files)
          • Mac: Select the subdirectory Eclipse.app/Contents/Eclipse.
        • NB: The new location should indicate it has over 500 plug-ins available
      • <Add...> another location for the Orbit repository
        • <Software Site>
        • <Add...> a new repository
          • <Archive...>
          • Select the just-downloaded Orbit zip file
        • <Work with:> the just-added Orbit repository
        • NB: Make sure <Group by Category> is checked.
        • Select "All Orbit Bundles" => "EasyMock"
        • NB: The new location should indicate it has 2 plug-ins available
      • <Add...> another location for the Graphiti repository
        • <Software Site>
        • <Add...> a new repository
          • <Archive...>
          • Select the just-downloaded Graphiti zip file
        • <Work with:> the just-added Graphiti repository
        • NB: Make sure <Include required software> is unchecked. (Graphiti requires the EMF Transaction plug-in, which is already part of the target platform location added above.)
        • Select "Graphiti SDK" (or "Graphiti" => "Graphiti SDK" if grouped by categories.)
        • NB: The new location should indicate it has 48 plug-ins available
      • <Add...> another location for the DTP repository
        • <Software Site>
        • <Add...> a new repository
          • <Archive...>
          • Select the just-downloaded DTP zip file
        • <Work with:> the just-added DTP repository
        • NB: Make sure <Group by Category> is checked.
        • Click on <Select All>
        • NB: The new location should indicate it has over 200 plug-ins available
      • <Add...> another location for the GEF repository
        • <Software Site>
        • <Add...> a new repository
          • <Archive...>
          • Select the just-downloaded GEF zip file
        • <Work with:> the just-added GEF repository
        • NB: Make sure <Group by Category> is checked.
        • Click on <Select All>
        • NB: The new location should indicate it has 20 plug-ins available
      • <Add...> another location for the WTP repository
        • <Software Site>
        • <Add...> a new repository
          • <Archive...>
          • Select the just-downloaded WTP zip file
        • <Work with:> the just-added WTP repository
        • NB: Make sure <Group by Category> is checked.
        • Click on <Select All>
        • NB: The new location should indicate it has over 500 plug-ins available
      • <Finish> the wizard to create the new target platform
  • Optional (but very helpful): Configure the host platform to include the classes from the target platform (Preferences > Plug-in Development > Include all plug-ins from target in Java search)
  • Clone the Eclipse Foundation-hosted Dali Git repository and import the Dali projects
    • Ensure the Eclipse network proxy is configured, if applicable (Preferences > General > Network Connections)
    • Open the Git perspective
    • Clone the Dali repository using the appropriate URL from http://git.eclipse.org/c/dali/webtools.dali.git
    • Import the plug-in and test plug-in projects in the repository's working directory (The projects are named org.eclipse.jpt.*.):
      • common/plugins - the *.branding projects are optional
      • common/tests
      • jaxb/plugins - the *.branding projects are optional
      • jaxb/tests
      • jpa/plugins - the *.branding projects are optional
      • jpa/tests
      • jpa_diagram_editor/plugins
      • jpa_diagram_editor/tests

JUnit Tests

Once the development workspace is configured and the Dali plug-ins built, it is possible to execute the Dali tests.

Generic JPA Core Tests

  • Add a run configuration (Run > Run Configurations... > JUnit Plug-in Test > New)
    • <Test> tab
      • <Run a single test>
        • Project: org.eclipse.jpt.jpa.core.tests
        • Test Class: org.eclipse.jpt.jpa.core.tests.internal.JptJpaCoreTests
      • Test Runner: JUnit 3 or 4
    • <Main> tab
      • <Program to run>
        • Run an application: [No Application] - Headless mode
    • <Arguments> tab
      • VM arguments:
-Xmx768M
-XX:MaxPermSize=256M
-Dorg.eclipse.jpt.jpa.jar=<path to jar containing javax.persistence packages>
  • <Run>

NB: These tests may take on the order of 30 minutes to complete.

EclipseLink JPA Core Tests

Duplicate the Generic JPA Core Tests configuration described above and make the following modifications:

  • <Test> tab
    • Project: org.eclipse.jpt.jpa.eclipselink.core.tests
    • Test class: org.eclipse.jpt.jpa.eclipselink.core.tests.internal.JptJpaEclipseLinkCoreTests
  • <Arguments> tab
    • Add the following VM argument:
-Dorg.eclipse.jpt.eclipselink.jar=<path to eclipselink.jar>

Generic JAXB Core Tests

Duplicate the Generic JPA Core Tests configuration described above and make the following modifications:

  • <Test> tab
    • Project: org.eclipse.jpt.jaxb.core.tests
    • Test class: org.eclipse.jpt.jaxb.core.tests.internal.JaxbCoreTests
  • <Arguments> tab
    • Add the following VM argument:
-Dorg.eclipse.jpt.jaxb.jar=<path to eclipselink.jar>

EclipseLink JAXB Core Tests

Duplicate the Generic JAXB Core Tests configuration described above and make the following modifications:

  • <Test> tab
    • Project: org.eclipse.jpt.jaxb.eclipselink.core.tests
    • Test class: org.eclipse.jpt.jaxb.eclipselink.core.tests.internal.ELJaxbCoreTests
  • <Arguments> tab
    • Add the following VM argument:
-Dorg.eclipse.jpt.jaxb.jar=<path to eclipselink.jar>
-Dorg.eclipse.jpt.eclipselink.jar=<path to eclipselink.jar>

Common Core Tests

Duplicate the Generic JPA Core Tests configuration described above and make the following modifications:

  • <Test> tab
    • Project: org.eclipse.jpt.common.core.tests
    • Test class: org.eclipse.jpt.common.core.tests.internal.JptCommonCoreTests

Common Utility Tests

  • Add a run configuration (Run > Run Configurations... > JUnit > New)
    • <Test> tab
      • <Run a single test>
        • Project: org.eclipse.jpt.common.utility.tests
        • Test Class: org.eclipse.jpt.common.utility.tests.internal.JptCommonUtilityTests

Other Tests

There are a number of other test suites that should be reasonably straightforward to configure:

  • Common UI
  • Generic JPA UI
  • Generic JPA Generation
  • JPA Diagram Editor

Major User Features

JPA

JPA Structure View

The JPA Structure View is much like the standard Eclipse Outline View; it is associated with the current editor's file and is an outline of the JPA model corresponding to the file's JPA content. The JPA Structure View is active only for files in JPA projects (i.e. projects with a JPA Facet). Typical files:

  • the project's META-INF/persistence.xml file
  • any mapping (typically orm.xml) files referenced by the persistence.xml file
  • any Java files with JPA annotations

JPA Details View

The JPA Details View provides a rich UI for the editing of JPA-related metadata. It provides the user with all the settings appropriate for the current state of the current selection. It also displays all the JPA spec-defined defaults for each setting. The JPA Details View also attempts to provide a similar set of settings for both Java and orm.xml mappings.

JPA Validation

Like the Java compiler, every time the user saves a file Dali will validate the file's JPA project. In particular, Dali validates the project's JPA settings against a user-specified database and generates Eclipse "Problems" for any settings that do not match the database's metadata. The severity of these errors can be configured by the user in the workspace and/or project-specific preferences.

JPQL content assistance

Dali provides content assistance for JPQL queries edited in a Java source file, an orm.xml file, or the JPA Details View.

JPA Entity generation from tables

Dali can generate JPA spec-compliant Entities from tables defined in a DTP-accessible database.

JPA Canonical metamodel generation

As of JPA 2.0, Dali can be configured to dynamically generate JPA spec-compliant Canonical Metamodel classes based on the current state of a JPA project. This happens continuously, as the user edits JPA Entities etc. This allows the user to immediately use the current Entities etc. in the Criteria API, without waiting for the invocation of an external Annotation Processor. (In particular, Dali will re-generate the Canonical Metamodel with changes to the various JPA XML files; while, typically, annotation processors will not detect changes to XML files.) This generation will also reveal, immediately, as the Entities etc. are changed, any errors in existing usages of the Criteria API.

JAXB

Under construction...

Design

JPA

Terminology

Resource Model: A resource model is a direct representation of a particular Eclipse resource (typically a Java or XML source file). Dali currently maintains three resource models:

  • persistence.xml file
  • XML mapping file(s) (orm.xml)
  • Java source files

For XML resources (persistence.xml and orm.xml), the model is an EMF-generated model that uses the WTP translator framework to read/write the XML source file. For Java resources, the model is a hand-coded, non-EMF model that uses the JDT AST framework and various Dali utility classes to read/write the JPA annotations in the Java source file.

Context Model: A context model typically corresponds to a resource model but adds context by determining default values and the relationships among all the context models. As with resource models, Dali maintains three context models:

  • persistence.xml file
  • XML mapping file(s) (orm.xml)
  • Java source files

The context model also provides and uses common API, when possible, across the Java and XML persistent types and attributes. The context model is the model used directly by the Dali UI and clients.

Persistent Type: Any Java type to be persisted (i.e. a Java type that has JPA annotations or has been listed explicitly in a mapping file.

Persistent Attribute: Any Java attribute (field or property) to be persisted.

Mapping: A collection of related JPA metadata that consists of a persistence strategy for a type or attribute (field or property).

Type Mapping: A specific way of persisting a persistent type. For example: Entity, MappedSuperclass, Embeddable. All JPA metadata specified at the type level will be contained by a type mapping.

Attribute Mapping: A specific way of persisting a persistent attribute. For example: Basic, ManyToOne, OneToMany. All JPA metadata specified at the attribute (field or property) level will be contained by an attribute mapping.

Model

The main entry point for the Dali model is the JpaWorkspace, which corresponds to the Eclipse workspace (i.e. org.eclipse.core.resources.IWorkspace). The JpaWorkspace can be obtained by adapting the Eclipse workspace:

IWorkspace workspace = ResourcesPlugin.getWorkspace();
JpaWorkspace jpaWorkspace = (JpaWorkspace) workspace.getAdapter(JpaWorkspace.class);

The primary use of the JpaWorkspace is gaining access to the JpaProjectManager. The JpaProjectManager holds the current set of JpaProjects. Dali builds a JpaProject for each Eclipse project that has a JPA facet. (Refer to the WTP Faceted Project Framework for more information.) A JpaProject holds the resource model corresponding to the project's persistence.xml file, mapping (orm.xml) files, and Java source files. The JpaProject also holds the context model that represents the JPA metadata, as derived from spec-defined defaults, Java source code annotations, and XML descriptors. A JpaProject can be obtained directly by adapting the corresponding Eclipse project:

IProject project = ResourcesPlugin.getWorkspace().getRoot().getProject("Foo Project");
JpaProject jpaProject = (JpaProject) project.getAdapter(JpaProject.class);

The JpaProject's context model is used to:

  • validate the Java annotations and mapping files against the user-specified database metadata; any errors are reported as Eclipse problems and/or warnings (i.e. markers)
  • populate the Dali UI; the UI keeps in sync with the model via the event/listener mechanism defined by the Dali org.eclipse.jpt.common.utility.model.Model interface.

The "root" of the context model is the JpaProject's JpaContextRoot. This root provides access to the project's single PersistenceXml, whose root XML element is a Persistence. Although the JPA spec provides for the existence of multiple Persistence Units in the Persistence element, to simplify the user interface, Dali only supports the Persistence element containing a single PersistenceUnit.

The PersistenceUnit holds the significant JPA mapping data:

  • mapping files (typicall orm.xml files)
  • JAR files
  • mapped Java classes
  • database connection settings
  • transaction settings

In the case of a Java annotation-only project, the PersistenceUnit directly holds all the resolved JavaManagedTypes (which are typically JavaPersistentTypes). These are held by the PersistenceUnit's ClassRefs, which each hold the corresponding JavaPersistentType if the ref's class name can be resolved. Predictably, the JavaPersistentTypes hold the JavaPersistentAttributes.

In the case of a project that maps Java types via mapping files (either exclusively or in addition to Java annotations), the PersistenceUnit directly holds all the resolved mapping files. These are held by the PersistenceUnit's MappingFileRefs, which each hold the corresponding MappingFile if the ref's file name can be resolved. Each mapping file holds a set of PersistentTypes (typically OrmPersistentTypes). Again, the PersistentTypes hold the PersistentAttributes. In addition, an OrmPersistentType holds a reference to its corresponding JavaPersistentType.

Examples

  • Traverse the context model for JPA metadata:

To access the JPA metadata for a type listed in the persistence.xml file:

IProject.getAdapter(JpaProject.class) : JpaProject
  JpaProject.getContextRoot() : JpaContextRoot
    JpaContextRoot.getPersistenceXml() : PersistenceXml
      PersistenceXml.getRoot() : Persistence
        Persistence.getPersistenceUnits() : Iterable<PersistenceUnit>
              (this will contain 0 or 1 PersistenceUnits as Dali does not support multiple persistence units)
          PersistenceUnit.getClassRefs() : Iterable<ClassRef>
            ClassRef.getJavaPersistentType() : JavaPersistentType
              JavaPersistentType.getMapping() : JavaTypeMapping
              JavaPersistentType.getAttributes() : Iterable<JavaSpecifiedPersistentAttribute>
                JavaSpecifiedPersistentAttribute.getMapping() : JavaAttributeMapping

To access the JPA metadata for a type listed in an orm.xml file:

...
PersistenceUnit.getMappingFileRefs() : Iterable<MappingFileRef>
  MappingFileRef.getMappingFile() : MappingFile
    MappingFile.getPersistentTypes() : Iterable<PersistentType>
...
  • Retrieve the JPA Entities for a Project
public static Iterable<PersistentType> getEntities(IProject project) {
    JpaProject jpaProject = (JpaProject) project.getAdapter(JpaProject.class);
    if (jpaProject == null) {
        return Collections.emptySet();
    }

    JpaContextRoot root = jpaProject.getContextRoot();
    PersistenceXml persistenceXml = root.getPersistenceXml();
    if (persistenceXml == null) {
        return Collections.emptySet();
    }

    Persistence persistence = persistenceXml.getRoot();
    if (persistence == null) {
        return Collections.emptySet();
    }

    if (persistence.getPersistenceUnitsSize() == 0) {
        return Collections.emptySet();
    }

    PersistenceUnit persistenceUnit = persistence.getPersistenceUnit(0);
    ArrayList<PersistentType> entities = new ArrayList<PersistentType>();
    for (PersistentType persistentType : persistenceUnit.getPersistentTypes()) {
        if (persistentType.getMappingKey() == MappingKeys.ENTITY_TYPE_MAPPING_KEY) {
            entities.add(persistentType);
        }
    }
    return entities;
}
  • Modify the context model programatically

The Dali context model can be modified directly on the UI thread; but any cascading changes to the context model happen in a background job. As a result, simple, write-only modifications can be performed on the UI thread without much hassle; but any code that changes the context model and wants any cascading changes to be immediately accessible (i.e. with the next line of code) must use a special API. To force these background, cascading changes to occur synchronously, use the method JpaProjectManager.execute(Command, ExtendedCommandContext). The command is a client-defined command that will execute the model-modifying code; while the context allows the modification of any documents that are open in the UI (typically the context can be the SynchronousUiCommandContext.instance()). (This context is most likely necessary because of an Eclpse platform bug....) Dali has several internal examples of using this method (e.g. the code that synchronizes the Persistence Unit's list of classes with the currently JPA annotated Java classes in the project).

UI

The main entry point for the Dali UI is the JpaWorkbench, which corresponds to the Eclipse workbench (i.e. org.eclipse.ui.IWorkbench). The JpaWorkbench can be obtained by adapting the Eclipse workbench:

IWorkbench workbench = PlatformUI.getWorkbench();
JpaWorkbench jpaWorkbench = (JpaWorkbench) Platform.getAdapterManager().getAdapter(workbench, JpaWorkbench.class);

NB: Even though IWorkbench extends IAdaptable, it does not delegate to the Platform adapter manager; so registered adapter factories are not used, and clients must directly use the Platform adapter manager.

The primary use of the JpaWorkbench is gaining access to the JpaPlatformUiManager. The JpaPlatformUiManager holds the current set of JpaPlatformUis. Each JpaPlatformUi corresponds to a specific JpaPlatform and provides the UI components necessary to support the models derived from that JpaPlatform. The UI also provides behavior the various Dali menu commands and wizards.

JAXB

Under construction...

Plug-ins

  • org.eclipse.jpt.*.core - resource model and context model interfaces and implementations
  • org.eclipse.jpt.jpa.db - DTP wrapper model, Dali’s interface to the DTP database metadata model
  • org.eclipse.jpt.jpa.db.ui - Dali UI for DTP Connection Wizard
  • org.eclipse.jpt.jpa.gen - model and generator code for generating Entities from database tables
  • org.eclipse.jpt.*.ui - Dali UI actions, composites, data models, wizards, views, and perspectives
  • org.eclipse.jpt.utility - Dali utility classes: model/event/listener sets, iterables, closures, commands, transformers, predicates, factories, references, collections, value models, etc.
  • org.eclipse.jpt.*.eclipselink.core - EclipseLink extension, including an EclipseLink JpaPlatform and associated EclipseLink resource model and context model.
  • org.eclipse.jpt.*.eclipselink.ui - EclipseLink UI extension, including an EclipseLink JpaPlatformUI and associated EclipseLink UI composites
  • org.eclipse.jpt.*.core.tests - headless JUnit plug-in test suites for the core plug-ins
  • org.eclipse.jpt.utility.tests - JUnit test suites for the utility plug-in
  • org.eclipse.jpt.doc.isv - Javadoc plug-in
  • org.eclipse.jpt.doc.user - Dali user docs and infopop

Major Integration points

JPA

Eclipse Platform

  • Content types
    • persistence.xml
    • Mapping file/orm.xml
  • Markers (errors/warnings)
  • Refactoring participants
  • At startup, Dali adds a resource change listener to the Eclipse workspace:
    • detect the presence of JPA Facet on any workspace project
    • files added or removed from any workspace project
    • "clean" builds will trigger the rebuilding of the appropriate JPA projects

JDT

  • At startup, Dali adds a Java element change listener to the Java model manager:
    • detect the presence of the JPA annotations in any Java source files
    • classpath changes will trigger the rebuilding of the appropriate JPA project
  • The Dali resource model makes extensive use of the JDT core model and utilities to manipulate Java source code.

EMF

  • The Dali XML resource model is generated from an EMF model defined to correspond to the JPA XML files:
    • persistence.xml
    • orm.xml

DTP

  • Manage database connections
  • Database metadata is used for validation and to populate drop-down list-boxes
  • Entity generation uses database metadata and the data definitino model
  • The Datasource Explorer view is part of the Dali Persistence Perspective

WTP

  • Faceted Project Framework
  • EMF-XML Translator Framework
  • Validation Framework
  • Library providers

Eclipse Platform UI

  • "New" wizards
  • JPA Perspective
  • Views
    • JPA Structure
    • JPA Details
  • JPA Project Properties
  • Project Explorer (Common Navigator)
  • Completion proposals (content assist, Intellisense)
    • Database metadata
    • JPQL
  • Commands/Handlers/Menus
  • Editors
    • persistence.xml
    • Mapping file/orm.xml

JAXB

Under construction...

Extension

JPA

JpaPlatform

Dali's main extension mechanism is the JPA Platforms (org.eclipse.jpt.jpa.core.jpaPlatforms) extension point, which adopters can use to specify implementations of the JpaPlatformFactory interface.

The JpaPlatformFactory interface is to be implemented by a JPA adopter to provide extensions to the core JPA model. Dali supplies a JPA Platform that supports JPA spec-defined Java annotations, persistence.xml and mapping (orm.xml) files. The org.eclipse.jpt.jpa.core.generic extension supplies resource models for those file types.

Example:

<extension
    point="org.eclipse.jpt.jpa.core.jpaPlatforms">

    <jpaPlatform
        id="generic"
        label="%GENERIC_1_0_PLATFORM_LABEL"
        factoryClass="org.eclipse.jpt.jpa.core.internal.GenericJpaPlatformFactory"
        group="generic"
        jpaFacetVersion="1.0"
        default="false"/>

</extension>

Dali also provides an exemplary impelementation for EclipseLink which provides support for EclipseLink-specific Java annotations, persistence.xml settings and mapping file settings. See the org.eclipse.jpt.jpa.eclipselink.core) plug-in.

JpaPlatformUi

Similar to the JPA Platform, the Dali UI can be extended via the JPA Platform UIs (org.eclipse.jpt.jpa.ui.jpaPlatformUis) extension point, which adopters can use to specify implementations of the JpaPlatformUiFactory interface. This interface must be implemented for any models defined in a JPA Platform extension to be correctly displayed in the UI.

<extension
    point="org.eclipse.jpt.jpa.ui.jpaPlatformUis">

    <jpaPlatformUi
        id="generic.ui"
        jpaPlatform="generic"
        factoryClass="org.eclipse.jpt.jpa.ui.internal.platform.generic.GenericJpaPlatformUiFactory"/>

</extension>

JAXB

Under construction....

API

Provisional API is available as of the 2.0 release.

Miscellaneous

Archives

Back to the top