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 "Teneo/EclipseLink"

m (Getting Started with Teneo-EclipseLink in Eclipse 3.4 (Ganymede))
(Getting Started with Teneo-EclipseLink in Eclipse 3.4 (Ganymede))
Line 6: Line 6:
 
= Getting Started with Teneo-EclipseLink in Eclipse 3.4 (Ganymede) =
 
= Getting Started with Teneo-EclipseLink in Eclipse 3.4 (Ganymede) =
  
1. [http://www.eclipse.org/eclipselink/downloads Download EclipseLink packaged as OSGi Bundles]
+
== Configuring your Development Environment ==
  
2. Place all the bundles into <ECLIPSE_HOME>/dropins.
+
1. Download a build of Eclipse 3.4 that includes EMF and PDE, e.g. [http://www.eclipse.org/downloads/download.php?file=/technology/epp/downloads/release/ganymede/SR2/eclipse-modeling-ganymede-SR2-incubation-win32.zip Eclipse Modeling Tools], [http://www.eclipse.org/downloads/download.php?file=/eclipse/downloads/drops/R-3.4.2-200902111700/eclipse-SDK-3.4.2-win32.zip Eclipse Classic], or [http://www.eclipse.org/downloads/download.php?file=/technology/epp/downloads/release/ganymede/SR2/eclipse-jee-ganymede-SR2-win32.zip Eclipse IDE for Java EE Developers].
  
3. Until we get downloadble zips available you'll have to checkout the following projects from Teneo CVS
+
2. [http://www.eclipse.org/eclipselink/downloads Download EclipseLink packaged as OSGi Bundles] and place all the bundles into <ECLIPSE_HOME>/dropins.
dev.eclipse.org:/cvsroot/modeling/org.eclipse.emf/org.eclipse.emf/teneo
+
  
: examples/
+
3. [http://www.eclipse.org/modeling/emf/downloads/?project=teneo Download Teneo EclipseLink Runtime] and extract it into your Eclipse install.
:: org.eclipse.emf.teneo.eclipselink.examples.derby
+
:: org.eclipse.emf.teneo.eclipselink.examples.library
+
:: org.eclipse.emf.teneo.eclipselink.examples.library.edit
+
:: org.eclipse.emf.teneo.eclipselink.examples.library.editor
+
:: org.eclipse.emf.teneo.eclipselink.examples.library.orm
+
: plugins/
+
:: org.eclipse.emf.teneo.eclipselink
+
:: org.eclipse.emf.teneo.eclipselink.common
+
:: org.eclipse.emf.teneo.eclipselink.common.ui
+
:: org.eclipse.emf.teneo.eclipselink.elistfactory
+
:: org.eclipse.emf.teneo.eclipselink.ui
+
: tests/
+
:: org.eclipse.emf.teneo.eclipselink.examples.library.orm.tests
+
:: org.eclipse.emf.teneo.eclipselink.elistfactory.tests
+
:: org.eclipse.emf.teneo.eclipselink.tests
+
  
 +
You now have all the necessary components installed to begin developing with Teneo EclipseLink.
  
:You will see a compilation error on org.eclipse.emf.teneo.eclipselink.examples.derby--Don't Panic.  This is expected.  See the [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.emf/org.eclipse.emf.teneo/examples/org.eclipse.emf.teneo.eclipselink.examples.derby/ReadMe.txt?revision=1.1&root=Modeling_Project&view=markup ReadMe.txt] for details.
+
== Running the Example ==
  
4. Setup the Database
+
UNDER CONSTRUCTION
The examples are built to run against Apache Derby. 
+
* You'll need to download the latest release of Derby from apache.org and startup the network server by running <DERBY_HOME>/bin/startNetworkServer[.bat] (at least this is path in Derby 10.3.2.1). 
+
* Define DERBY_HOME in your environment and then start, or restart Eclipse.  See the Derby plugin [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.emf/org.eclipse.emf.teneo/examples/org.eclipse.emf.teneo.eclipselink.examples.derby/ReadMe.txt?revision=1.1&root=Modeling_Project&view=markup ReadMe.txt] for details.
+
  
 
= Generating the orm.xml from the model (top-to-bottom mapping) =
 
= Generating the orm.xml from the model (top-to-bottom mapping) =

Revision as of 11:16, 5 April 2009

Introduction

Teneo provides integration with EclipseLink JPA to support persistence of arbitrary EMF models with JPA. The original goal of this integration was to allow developers to map EMF generated classes with standard JPA. In future, model driven development will be supported to generate the classes, JPA mappings, and database schema from an EMF model.

Under Construction

Getting Started with Teneo-EclipseLink in Eclipse 3.4 (Ganymede)

Configuring your Development Environment

1. Download a build of Eclipse 3.4 that includes EMF and PDE, e.g. Eclipse Modeling Tools, Eclipse Classic, or Eclipse IDE for Java EE Developers.

2. Download EclipseLink packaged as OSGi Bundles and place all the bundles into <ECLIPSE_HOME>/dropins.

3. Download Teneo EclipseLink Runtime and extract it into your Eclipse install.

You now have all the necessary components installed to begin developing with Teneo EclipseLink.

Running the Example

UNDER CONSTRUCTION

Generating the orm.xml from the model (top-to-bottom mapping)

To support a top-to-bottom mapping approach Teneo makes it possible to generate the orm.xml from the ecore model. There are two ways to generate the orm.xml:

  1. By right-clicking the ecore file and selecting the submenu Teneo > Generate orm. See below for a full description.
  2. Programmatically by instantiating the org.eclipse.emf.teneo.jpa.convert.ORMGenerator class and calling a specific method on the class.

Each of these methods is discussed separately.

JPA Annotated Model

The input for both methods is a JPA annotated model. Teneo will automatically annotate the model with JPA annotations. So manual annotations are only required if certain default behavior needs to be overridden.

More documentation on how to annotate an Ecore model with annotations can be found here:

Note that for EclipseLink practically all standard JPA annotations are supported.

For more information see this presentation on EclipseLink - Teneo which was done at EclipseCon 2009.

Generating the orm.xml through the menu

To generate the orm.xml through the menu the following steps have to be setup/done:

  • generate the model code (standard EMF action), the generated model code will be present in a specific Java project, called the model project
  • add the following two dependencies to the model project: open the MANIFEST.MF file in the model project's META-INF directory and go to the dependency tab. Then add the following two dependencies:
    • org.apache.commons.logging
    • org.eclipse.emf.teneo.orm


ORMDependency.png


  • right-click on the ecore file and choose the Teneo > Generate orm submenu. The system now generates an orm.xml file in the same folder as the ecore file.


ORMResult.png


Note: the above logic assumes that the ecore file is present in the same Java project as the generated model code.

Generating the orm.xml through the menu is quick. The main disadvantage is that you can not pass specific persistence options to control the mapping behavior. The available persistence options are described here

Generating the orm.xml programmatically

Generating the orm.xml in a programmatic way has as main advantage that the mapping logic can be influenced by passing | Persistence Options. For more details on the PersistenceOptions check out the PersistenceOptions source code and javadoc.

To generate programmatically the class ORMGenerator (org.eclipse.emf.teneo.jpa.convert.ORMGenerator) class is used. The source code below gives an example of a possible use:

final Properties props = new Properties();
props.setProperty(PersistenceOptions.SQL_TABLE_NAME_PREFIX, "EMFLIB_");
final ORMGenerator converter = new ORMGenerator();
final String orm = converter.generateORM(
		new EPackage[] { DataPackage.eINSTANCE }, converter
				.getDefaultPersistenceOptions(props));
System.err.println(orm);

To walk you through the code. As the orm.xml is generated programmatically,there is the opportunity to set specific persistence options. In this case the table name prefix is set. Then a new instance of the ORMGenerator is created. In the generate call: converter.generateORM two arguments are passed:

  1. the array of EPackages for which an orm is generated
  • the properties, note the specific way to get the default persistence options from the GenerateORM instance itself. This is required if you want to make use of default settings which make sense for EclipseLink. The default Persistence Options are shown below.

The generateORM method returns the orm.xml as a String. This String can be saved to a file system.

The default persistenceoptions which are common in the ORMGenerator:

props.setProperty(PersistenceOptions.SQL_NAME_ESCAPE_CHARACTER, "");
props.setProperty(PersistenceOptions.EMAP_AS_TRUE_MAP, "false");
props.setProperty(PersistenceOptions.SET_DEFAULT_CASCADE_ON_NON_CONTAINMENT,"true");
props.setProperty(PersistenceOptions.CASCADE_POLICY_ON_NON_CONTAINMENT, "REFRESH,PERSIST,MERGE");
props.setProperty(PersistenceOptions.ID_FEATURE_AS_PRIMARY_KEY, "false");
props.setProperty(PersistenceOptions.SQL_CASE_STRATEGY, "uppercase");

Back to the top