org.eclipse.emf.importer.java Read Me

diff -r 000000000000 -r 82d1d1de1a01 carbidecpp20devenv/plugins/org.eclipse.emf.source_2.4.1.v200808251517/src/org.eclipse.emf.importer.java_2.4.1.v200808251517/readme.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/carbidecpp20devenv/plugins/org.eclipse.emf.source_2.4.1.v200808251517/src/org.eclipse.emf.importer.java_2.4.1.v200808251517/readme.html Wed Mar 18 17:21:00 2009 -0500 @@ -0,0 +1,102 @@ + + + + +org.eclipse.emf.importer.java Read Me + + +

Introduction

This document describes how you can use scripts to generate code from Annotated Java. The +script can be either a regular shell script that invokes Eclipse headless +applications or an Ant script that invokes the task provided by this plugin.

+ +

Overall Comments

If you didn't extract this plugin from CVS, the "examples" directory mentioned +in this document is available in the EMF source plugin +(org.eclipse.emf.source_<version>/src/org.eclipse.emf.importer.java_<version>). +
Before running your build scripts or the examples provided here, make sure you have the 2 +jar files required by this plugin ("importer.java.jar" and +"importer.java.tasks.jar") and also the 2 jar files required by the org.eclipse.emf.ant +plugin ("emf.ant.jar" and "emf.ant.tasks.jar"). If necessary, Eclipse +can generate them for you. All you need to do is to run the Ant script created by PDE when you right click on the manifest file +and select "PDE Tools>Create Ant Build File". +
The Annotated Java interfaces must be placed in a directory that corresponds to the source folder of an Eclipse Java Project. In other words, +the project's directory must contain all Eclipse's required "metadata" files, such as ".project" and ".classpath". +If the project doesn't already exist in the workspace, the application or task will create it. +
In order to preserve the original state of this plugin's "examples" directory, you +should copy it to a different location and run the Ant scripts from there. +
Starting a new JVM process and invoking Eclipse are expensive operations. Your build will +perform better if you are able to group the steps that require Eclipse in a few scripts +(one script would be ideal). This is probably a reason to use Ant instead of invoking the +applications - you can generate code for multiple models using one single Ant script. +
The "examples/library" directory contains a set of Annotated Java interfaces, and shell and Ant scripts +to generate its code. +

+ +

Java and Generator Applications

The application provided by this plugin generates the ecore and genmodel files from models defined +using Java interfaces.

+ + + + +

Java application details
ID	`org.eclipse.emf.importer.ecore.Java2GenModel`
Class	`org.eclipse.emf.importer.ecore.JavaImporterApplication`

To generate the actual Java code you will need to use a second application, provided by +the "org.eclipse.emf.codegen.ecore" plugin.

+ + + + +

Generator application details
ID	`org.eclipse.emf.codegen.ecore.Generator`
Class	`org.eclipse.emf.codegen.ecore.Generator`

In order to run these or any other Eclipse application, you need to execute the following +command (without the line breaks):

+eclipse +
  -noSplash +
  -data <full path to a workspace - ideally an empty directory> +
  -application <application ID> +
  <application arguments> +

In Windows you should execute eclipsec instead of eclipse in order to have +access to the application's console output.

The directory "examples/library/build" has shell scripts that generate the code for +the Java interfaces provided. If you have any questions after reading and experimenting with it, look at the +applications's javadoc for more details. Also, check the application's class +"getUsage()" method for the list of possible arguments.

+ + +

Java Ant Task

The Java task details are:

+ + + +

Name	`emf.Java2Java`
Class	`org.eclipse.emf.importer.ecore.taskdefs.JavaGeneratorTask`

This is the usual command line to run an Ant script using a headless Eclipse instance (remove the line breaks):

+eclipse +
  -noSplash +
  -data <full path to a workspace - ideally an empty directory> +
  -application org.eclipse.ant.core.antRunner +
  -buildfile <full path to your script> +

In Windows you should execute eclipsec instead of eclipse in order to have +access to the Ant build script console output.

You can also use the Eclipse UI to execute an Ant script containing an EMF task. This can be +done by right-clicking the script and selecting +Run As > Ant Build... > JRE > "Run in the same JRE as the workspace".

The directory "examples/library/build" has an Ant script that generate the code for +the model provided. The task's javadoc has lots of information you may find useful.

+ + + \ No newline at end of file