Tutorial: Using EMF to create the GCP domain model

This tutorial is about it: what is needed to do in order to use EMF to make changes in the GCP Domain Model

Table of Contents

Preliminary Reading

• Using EMF
• Model with the Eclipse Modeling Framework, Part 1: Create UML models and generate code
• Model with the Eclipse Modeling Framework, Part 2: Generate code with Eclipse's Java Emitter Templates
• Model with the Eclipse Modeling Framework, Part 2: Customize generated models and editors with Eclipse's JMerge
• We also suggest EMF articles in the Eclipse Resources

Set up (one needed to be done once)

1. Check out from CropForge in the Pantheon Project (https://svn.cropforge.org/svn/pantheon/) the following modules
   • /Demeter/projects/Demeter
   • /Demeter/projects/DemeterOntology
   • /Demeter/projects/Generator
   • /Ceres/projects/Ceres
   After checking the projects out, make sure the modules from the /projects folder compile cleanly. If there are errors due to maven dependencies, change pom files accordingly but do not commit. If there are still errors you may have to manually install jar files in your local maven repo.
2. For eclipse users only:
   Make you have Eclipse version 3.4. You will also need maven plugin for eclipse, see Tutorial: Using Maven from Ant for details
3. Install the Eclipse plugins for Eclipse Modelling Framework Tools (EMFT) using the Eclipse 3.4's Install manager
   Help > Software Updates... > Available Software > Add Site... Location: http://download.eclipse.org/modeling/emft/updates/ choose Ecore tools All-in-one Feature
   

Updating the model using Eclipse and Ant (Semi-automated)

Updating Demeter and Ceres

1. Update the following projects to ensure you have the latest versions
   • /Demeter/projects/Demeter
   • /Ceres/projects/Ceres
2. Make required changes to Java interfaces in Demeter making sure you update any @model and other EMF tags, and that you
   • Update the Java documentation.
   • Increase the version number of Demeter if necessary in the xmls/project.pom file. Please follow the version nomenclature defined in the best practices.
   • Update the version numbers in Ceres so that it matches Demeter
   • Update the Ceres version in the Ceres dependency of Demeter
3. Run the update-all ant task in the build.xml in the Demeter project. This will run the following subtaskes
   • update-demeter to update Demeter to remove unrequired EMF classes
   • update-ceres to update Ceres to move implementation from Demeter to Ceres
4. Refresh the following projects (right click on the project name in the package explorer view and select 'refresh')
   • /Demeter/projects/Demeter
   • /Ceres/projects/Ceres
5. Make sure these projects compile cleanly either using eclipse build or by runing the compile ant tas. You may need to compile and install the Demeter module in your local repo first.
6. Commit the Demeter, DemeterOntology, Ceres and CeresEMF code to SVN
7. Release the code to the GCP maven repository. See Tutorial: Using Maven from Ant for details on this
8. Update the corresponding eclipse Demeter and Ceres plugins. See Tutorial: Using Pantheon with Equinox for details on this
9. Release the Demeter and Ceres plugins to the GCP plugin update site
10. Update the Java docs for these projects on the Pantheon website
11. Update DemeterOntology (see next section)

Updating DemeterOntology

1. Update the following projects to ensure you have the latest versions
   • /Demeter/projects/Generator
   • /Demeter/projects/DemeterOntology
2. Make changes to DemeterOntology only in the src/etc/config/extended_ontology.xml file. For guidelines on how to edit tihs file see the section on Defining Extended Demeter Ontology terms . The version number of DemeterOntology does NOT need to match that of Demeter and Ceres, however if you update Demeter you need to advance the version number of DemeterOntology as well.
3. If Demeter has been changed you will need to change the dependency version of Generator on Demeter to the current version. Generator requires access (via maven) to the latest version of Demeter to generate its classes.
4. Run the following task from the build.xml in the Generator project.
   • update-demeter-ontology to update DemeterOntology
5. Refresh the following project (right click on the project name in the package explorer view and select 'refresh')
   • /Demeter/projects/DemeterOntology
6. Make sure the project compile cleanly either using eclipse build or by runing the compile ant task
7. Commit the DemeterOntology code to SVN
8. Release the code to the GCP maven repository. See Tutorial: Using Maven from Ant for details on this
9. Update the corresponding eclipse DemeterOntology plugin See Tutorial: Using Pantheon with Equinox for details on this
10. Release the DemeterOntology plugin to the GCP plugin update site
11. Update the Java docs for this project on the Pantheon website

Updating the model using Ant only (Fully-automated)

Defining Extended Demeter Ontology Terms

• Data type identifiers, suffixed with the text _DATATYPE_ID
• Data type names, suffixed with the text _DATATYPE_NAME
• Data type attribute identifiers, suffixed with the text _DATATYPE_ATTRIBUTE_ID
• Data type attribute names, suffixed with the text _DATATYPE_ATTRIBUTE_NAME
• General constants defined as a value, key pair