Jump to: navigation, search

Difference between revisions of "Ecore ODA Driver"

(Using the Driver)
Line 46: Line 46:
 
== Using the Driver ==
 
== Using the Driver ==
  
The primary consumer of ODA data sources is [[BIRT Project|BIRT]]. 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]].)
+
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.
  
Toolwise, the primary beneficiary of the Ecore ODA driver is [http://www.eclipse.org/birt/phoenix/ BIRT], which you've presumably installed. To use the Ecore ODA Driver, un the BIRT Report Designer and create a new report. You might want to 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 if you don't already have a serialized EMF model to use as your report data source. When adding a Data Source, a new type will display <tt>Ecore ODA Data Source</tt> and the wizard will allow you to choose a file.  Selecting and naming this Data Source and giving the name of a file will allow you to enter a new Data Set.
+
=== Create a Report ===
 +
 
 +
The primary consumer of ODA data sources is [[BIRT Project|BIRT]]. Typically creating a [[BIRT Project|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 [[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 ===
 +
 
 +
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 ==
 
== CVS ==

Revision as of 02:04, 11 April 2008

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 has been proposed to the new DTP Incubator. It is hoped (perhaps optimistically) that it can join in the Ganymede release in June of 2008.

Installation

The Ecore ODA Driver is currently only available from CVS. After obtaining the code, you may notice the driver has a number of dependencies that are un-met in your workspace:

Dependency Update Site Path
BIRT Report Designer http://download.eclipse.org/releases/ganymede/ Charting and Reporting/Eclipse BIRT Report Designer Framework
Datatools Connectivity http://download.eclipse.org/releases/ganymede/ Enabling Features/Data Tools Platform Connectivity
Data Tools Platform Enablement for JDBC http://download.eclipse.org/releases/ganymede/ Enabling Features/Data Tools Platform Enablement for JDBC
EMF Query http://download.eclipse.org/releases/ganymede/ Enabling Features/EMF Model Query
EMF Model Query OCL Integration http://download.eclipse.org/releases/ganymede/ Enabling Features/EMF Model Query OCL Integration
EMF Transaction http://download.eclipse.org/releases/ganymede/ Enabling Features/EMF Model Transaction
EMF Search http://download.eclipse.org/releases/ganymede/ Models and Model Development/EMF Search SDK

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.

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