Jump to: navigation, search

Difference between revisions of "Ecore ODA Driver"

m (Backport to Eclipse 3.2, EMF 2.2 and JDK 1.4)
(Introduction)
Line 3: Line 3:
 
The Ecore ODA Driver was created to allow an [[EMF ECore]] model to serve as an [[Connectivity#Open Data Access (ODA) Framework|ODA]] data source. This makes it simple for [[BIRT Project|BIRT]] reports to draw data from Ecore models.
 
The Ecore ODA Driver was created to allow an [[EMF ECore]] model to serve as an [[Connectivity#Open Data Access (ODA) Framework|ODA]] data source. This makes it simple for [[BIRT Project|BIRT]] reports to draw data from Ecore models.
  
This component is a [[DTP Incubator]] project. Its latest status can be found in [https://bugs.eclipse.org/bugs/show_bug.cgi?id=132958 Bugzilla 132958].
+
This component was originally created as a [[DTP Incubator]] project. Its latest status can be found in [https://bugs.eclipse.org/bugs/show_bug.cgi?id=132958 Bugzilla 132958].
 +
 
 +
A generic ODA driver has been added to EMF for Indigo M4. See [https://bugs.eclipse.org/bugs/show_bug.cgi?id=330988 bug 330988]
 +
for details.
  
 
== Tutorial ==
 
== Tutorial ==

Revision as of 11:55, 3 September 2011

Introduction

The Ecore ODA Driver was created to allow an EMF ECore model to serve as an ODA data source. This makes it simple for BIRT reports to draw data from Ecore models.

This component was originally created as a DTP Incubator project. Its latest status can be found in Bugzilla 132958.

A generic ODA driver has been added to EMF for Indigo M4. See bug 330988 for details.

Tutorial

Tim has written a tutorial for the Ecore ODA Driver at Overcoming Fear.

Below you'll find some of the same information but without the detail or pretty pictures.

Backport to Eclipse 3.2, EMF 2.2 and JDK 1.4

A backport of these plug-ins was checked-in to CVS for use with Eclipse 3.2, EMF 2.2 and JDK 1.4. The backport has no guarantee of future support. If you would like instructions for using these versions of the plug-ins, please look here.

Connection Properties and Profiles

In order to support requests for Connection Profiles and Connection Properties, we made some changes as of August 22, 2008 that will affect existing reports, i.e., the Model file location is now stored directly as a URI, the property for this URI has been renamed, Column Selections are contained in a single property (instead of in properties with increasing numbers), and the name of the Column Selection property has been changed. Hopefully these fixes will not be too disruptive to existing reports and the benefit of dynamic property binding will outweigh the inconvenience of either manually editing existing reports or re-creating those reports.

Installation

The Ecore ODA Driver build package is available on the DTP download page. The source is available from CVS. After obtaining the code, you may notice the driver has a number of dependencies that might be un-met in your workspace:

Dependency Download Site
BIRT Report Designer http://download.eclipse.org/birt/downloads/
Datatools Connectivity http://www.eclipse.org/datatools/downloads.php
EMF Query http://www.eclipse.org/modeling/emf/downloads/?project=query
Object Constraint Language (OCL) Integration http://www.eclipse.org/modeling/mdt/downloads/?project=ocl

Using the Driver

Those less familiar with EMF or without a handy EMF model should install the EMF Examples from http://www.eclipse.org/modeling/emf/updates and create an instance of an .extlibrary file with some data. It's outside the scope of this document to describe this process, but typical readers will already have familiarity with EMF editors.

Of course, any serialized EMF model will do, as long as the package has been registered so that the Java classes representing the model are available at runtime.

Create a Report

The primary consumer of ODA data sources is BIRT. Typically, creating a BIRT report is the first step to using the Ecore ODA Driver.

Create an Ecore ODA Data Source

Any ODA drivers registered with the platform show up within BIRT as data source types, each with a wizard to allow for the entry of connection information. In the case of the Ecore ODA Driver, the only information required by the connection is the path to a serialized Ecore model of a registered model type. (If you aren't familiar with registering EMF models, see this question in the EMF/FAQ.) Attempting to load a serialized model for an unregistered package will result in an error.

Create an Ecore ODA Data Set

Once a data source has been created for your Ecore model, use the New Data Set wizard to launch the Ecore ODA Data Set Wizard.

...to be continued... Feature changes in process--screen shots forthcoming...

CVS

The Ecore ODA Driver and UI can be checked out of CVS from the Datatools_Project Repository of dev.eclipse.org with a path of org.eclipse.datatools.incubator/plugins.

Browse: ViewCVS