Difference between revisions of "Ecore ODA Driver"

From Eclipsepedia

Jump to: navigation, search
(CVS)
Line 7: Line 7:
 
# A second  ''official'' and more functional ODA driver has been added to [[EMF ECore]] for [[Indigo]] M4. See [https://bugs.eclipse.org/bugs/show_bug.cgi?id=330988 bug 330988] for details. This official [[EMF]] implementation effectively obsoletes the interim [[DTP Incubator]] implementation.
 
# A second  ''official'' and more functional ODA driver has been added to [[EMF ECore]] for [[Indigo]] M4. See [https://bugs.eclipse.org/bugs/show_bug.cgi?id=330988 bug 330988] for details. This official [[EMF]] implementation effectively obsoletes the interim [[DTP Incubator]] implementation.
  
== Tutorials ==
+
== Interim Driver ==
 +
 
 +
=== Tutorial ===
  
=== Interim Driver ===
 
 
Tim has written a tutorial for the Ecore ODA Driver at [http://timezra.blogspot.com/2008/04/oda-ecore-getting-started-guide.html Overcoming Fear].
 
Tim has written a tutorial for the Ecore ODA Driver at [http://timezra.blogspot.com/2008/04/oda-ecore-getting-started-guide.html Overcoming Fear].
  
=== EMF Driver ===
+
=== Backport to Eclipse 3.2, EMF 2.2 and JDK 1.4 ===
For the EMF based driver see the 2011 [[EclipseCon]] Session: [http://eclipsecon.org/2011/sessions/?page=sessions&id=2028 Reports and Charts right from your EMF models]
+
 
+
Below you'll find some of the information common to both drivers (Unless noted) but without the detail or pretty pictures.
+
 
+
== Interim Driver - Backport to Eclipse 3.2, EMF 2.2 and JDK 1.4 ==
+
  
 
For the original driver 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 [http://timezra.blogspot.com/2008/05/oda-ecore-driver-backport.html here].
 
For the original driver 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 [http://timezra.blogspot.com/2008/05/oda-ecore-driver-backport.html here].
  
== Interim Driver - Connection Properties and Profiles ==
+
=== Connection Properties and Profiles ===
  
 
In order to support requests for [https://bugs.eclipse.org/bugs/show_bug.cgi?id=243099 Connection Profiles] and [https://bugs.eclipse.org/bugs/show_bug.cgi?id=243499 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.
 
In order to support requests for [https://bugs.eclipse.org/bugs/show_bug.cgi?id=243099 Connection Profiles] and [https://bugs.eclipse.org/bugs/show_bug.cgi?id=243499 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 ==
+
=== Installation ===
  
 
* The Interim Driver build package is available on the [http://www.eclipse.org/datatools/downloads.php DTP download] page.
 
* The Interim Driver build package is available on the [http://www.eclipse.org/datatools/downloads.php DTP download] page.
 
* The EMF Driver builds are not yet available for download as a zips, but they can be obtained through the [[p2]] Eclipse Modeling Project Update Site - http://www.eclipse.org/modeling/updates/
 
* The EMF Driver builds are not yet available for download as a zips, but they can be obtained through the [[p2]] Eclipse Modeling Project Update Site - http://www.eclipse.org/modeling/updates/
  
The sources for both drivers are available from [[#CVS|CVS]].  
+
=== CVS ===
 +
 
 +
The Interim Ecore ODA Driver and UI can be checked out of CVS from the <tt>Datatools_Project</tt> Repository of <tt>dev.eclipse.org</tt> with a path of <tt>org.eclipse.datatools.incubator/plugins</tt>.
 +
 
 +
Browse: [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.datatools.incubator/plugins/?root=Datatools_Project ViewCVS]
 +
 
 +
== EMF Driver ==
 +
 
 +
=== Tutorial ===
 +
For the EMF based driver see the 2011 [[EclipseCon]] Session: [http://eclipsecon.org/2011/sessions/?page=sessions&id=2028 Reports and Charts right from your EMF models]
 +
 
 +
Below you'll find some of the information common to both drivers (Unless noted) but without the detail or pretty pictures.
 +
 
 +
=== Installation ===
 +
 
 +
The EMF Driver builds are not yet available for download as a zips, but they can be obtained through the [[p2]] Eclipse Modeling Project Update Site - http://www.eclipse.org/modeling/updates/
 +
 
 +
=== CVS ===
 +
 
 +
The EMF Ecore ODA Driver and UI can be checked out of CVS from the <tt>Modeling</tt> Repository of <tt>dev.eclipse.org</tt> with a path of <tt>/cvsroot/modeling</tt>.
 +
 
 +
You will find the EMF Driver implemented as features under org.eclipse.emf/features:
 +
* org.eclipse.emf.oda-feature
 +
* org.eclipse.emf.oda.ecore-feature
 +
* org.eclipse.emf.oda.ecore.ui-feature
 +
 
  
 
== Dependencies ==
 
== Dependencies ==
Line 54: Line 75:
 
|}
 
|}
  
== Using the Driver ==
+
== Using the Driver to Create BIRT Reports ==
  
 
Those less familiar with EMF or without a handy EMF model should install the EMF Examples from [http://www.eclipse.org/modeling/emf/updates 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.
 
Those less familiar with EMF or without a handy EMF model should install the EMF Examples from [http://www.eclipse.org/modeling/emf/updates 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.
Line 66: Line 87:
 
=== Create an Ecore ODA Data Source ===
 
=== 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 [[EMF/FAQ#I get a PackageNotFoundException: e.g., "Package with uri 'http://com.example.company.ecore' not found." What do I need to do?|this question]] in the [[EMF/FAQ]].) Attempting to load a serialized model for an unregistered package will result in an error.
+
Any ODA driver 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 [[EMF/FAQ#I get a PackageNotFoundException: e.g., "Package with uri 'http://com.example.company.ecore' not found." What do I need to do?|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 ===
 
=== Create an Ecore ODA Data Set ===
Line 73: Line 94:
  
 
''...to be continued... Feature changes in process--screen shots forthcoming...''
 
''...to be continued... Feature changes in process--screen shots forthcoming...''
 
== CVS ==
 
 
=== Interim Driver ===
 
The Interim Ecore ODA Driver and UI can be checked out of CVS from the <tt>Datatools_Project</tt> Repository of <tt>dev.eclipse.org</tt> with a path of <tt>org.eclipse.datatools.incubator/plugins</tt>.
 
 
Browse: [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.datatools.incubator/plugins/?root=Datatools_Project ViewCVS]
 
 
=== EMF Driver ===
 
The EMF Ecore ODA Driver and UI can be checked out of CVS from the <tt>Modeling</tt> Repository of <tt>dev.eclipse.org</tt> with a path of <tt>/cvsroot/modeling</tt>.
 
 
You will find the EMF Driver implemented as features under org.eclipse.emf/features:
 
* org.eclipse.emf.oda-feature
 
* org.eclipse.emf.oda.ecore-feature
 
* org.eclipse.emf.oda.ecore.ui-feature
 

Revision as of 17:38, 5 January 2012

Contents

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.

The Ecore ODA Driver has been implemented in two projects:

  1. An interim driver was created as a DTP Incubator project. Its latest status can be found in Bugzilla 132958.
  2. A second official and more functional ODA driver has been added to EMF ECore for Indigo M4. See bug 330988 for details. This official EMF implementation effectively obsoletes the interim DTP Incubator implementation.

Interim Driver

Tutorial

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

Backport to Eclipse 3.2, EMF 2.2 and JDK 1.4

For the original driver 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

CVS

The Interim 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

EMF Driver

Tutorial

For the EMF based driver see the 2011 EclipseCon Session: Reports and Charts right from your EMF models

Below you'll find some of the information common to both drivers (Unless noted) but without the detail or pretty pictures.

Installation

The EMF Driver builds are not yet available for download as a zips, but they can be obtained through the p2 Eclipse Modeling Project Update Site - http://www.eclipse.org/modeling/updates/

CVS

The EMF Ecore ODA Driver and UI can be checked out of CVS from the Modeling Repository of dev.eclipse.org with a path of /cvsroot/modeling.

You will find the EMF Driver implemented as features under org.eclipse.emf/features:

  • org.eclipse.emf.oda-feature
  • org.eclipse.emf.oda.ecore-feature
  • org.eclipse.emf.oda.ecore.ui-feature


Dependencies

After obtaining the code, you may notice the drivers have 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 to Create BIRT Reports

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 driver 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...