Model-to-Model Transformations in MEMOCenterNG

Size: px

Start display at page:

Download "Model-to-Model Transformations in MEMOCenterNG"

Emil Holland
6 years ago
Views:

1 Model-to-Model Transformations in MEMOCenterNG Jens Gulden Chair of Information Systems and Enterprise Modelling Institute for Computer Science und Business Information Systems (ICB) University of Duisburg-Essen, Universitätsstr Essen Germany jens.gulden@uni-duisburg-essen.de

Information Systems and Enterprisee Modelling, University Duisburg Essen, Prof.

Enterprise models carry a high degree of semanticss through their domain specific language elements, which makes it easy to formulate specific queries for analysess and to describe desiredd

Technically speaking, this resembles a general code generation process, since any type of textual document, including source code in a programming language, can be generated in a comparable way.

plugins (http://www.openarchitectureware.org/) installed into the Eclipse platform, which extend the EMF/GM modelling plugins by additional capabilities for running model transformations.

org/staticpages/index.php/download?menu=download) and extract the content into your Eclipse folder.

2 Information Systems and Enterprisee Modelling, University Duisburg Essen, Prof. Frank 1 Introduction One core feature of enterprise models is the ability to exploit the knowledge they capture for specific analysess or transformation purposes. Enterprise models carry a high degree of semanticss through their domain specific language elements, which makes it easy to formulate specific queries for analysess and to describe desiredd transformations. In the following, a general approach for running model to model transformations from models in MEMOCenterNG to a textual target notation is described. Technically speaking, this resembles a general code generation process, since any type of textual document, including source code in a programming language, can be generated in a comparable way. The process described here requires the openarchitectureware plugins ( installed into the Eclipse platform, which extend the EMF/GM modelling plugins by additional capabilities for running model transformations. The current the MEMOCente case, erng distribu download ution should the d already con oaw ntain these r SDK required ext as a ensions. If t ZIP his is not from ( and extract the content into your Eclipse folder. 2 The Manual Way As a starting point, a model to model transformation can initially be developedd independently from the overall MEMOCenterNG tool, in a first step without integration into the model editor s user from a simple Entity Relationship like modelling language created with the MML. Figure 1 shows the MML model describing the language. In Fig. 2, the automatically derived Ecore interface. The following examples will assume that a basic SQL database schema is to be generated model, which internally is generated from the MML model, is displayed. Fig. 1 MML example model for a language from which transformations are to be developed Jens Gulden,

Information Systems and Enterprisee Modelling, University Duisburg Essen, Prof. Frank Fig.

with the corresponding generated model editor is given in Fig.

3 Example model created with a model editor generated from the MML model Transformation

The first step is to create an openarchitectureware project via File New Project.

transformation in the workspace where the generated editor packages reside (packages

3 Information Systems and Enterprisee Modelling, University Duisburg Essen, Prof. Frank Fig. 2 Ecore model automatically generated from the above MML model An example model created with the corresponding generated model editor is given in Fig. 3. Fig. 3 Example model created with a model editor generated from the MML model Transformation templates in the XPand language are now developed based on the Ecore representation. The first step is to create an openarchitectureware project via File New Project... openarchitectureware openarchitectureware Project, named e.g. mylanguage.transformation in the workspace where the generated editor packages reside (packages mylanguage, mylanguage.editor, mylanguage.diagram etc.). Switch to the openarchitectureware perspective or the Java perspective after the project has been created to get a Package Explorer view in the left column. Jens Gulden,

4 Inside the new project, create a source folder named generator, by Right click on the project node New Source Folder. Inside the generator folder, create both an openarchitectureware (oaw) workflow file, e.g., generate.oaw (New Other... openarchitectureware Workflow File), and an Xpand template, e.g., generate.xpt (New Other... openarchitectureware Xpand Template). Also, copy the generated.ecore file into this folder. Copying a file can be done inside the workspace via the usual copy&paste functionality, or outside with a file browser. If files are changed outside the workspace, please remember to refresh the project in the workspace with F5. Also, add the projects containing the modelling language definition and the diagram editor to the build path of the transformation project by Right click on project Properties Java Build Path tab: Projects select: mylanguage and mylanguage.diagram. The following XML code shows an example oaw workflow file which can be adopted to run any transformation script manually. <workflow>  <property name="model" value="../../runtime-eclipseapplication/erm-example/default.erm"/> <component class="oaw.emf.xmireader"> <modelfile value="${model"/> <outputslot value="model"/> </component> <component class="oaw.xpand2.generator"> <fileencoding value="iso "/> <metamodel class="oaw.type.emf.emfmetamodel"> <metamodelpackage value="erm.erm.ermpackage"/>  </metamodel> <outlet path="."/> <expand value="generator::generate::model FOR model"/>  </component> </workflow> Example 1 oaw workflow file The workflow file is only used for the manual invocation of the transformation process, and otherwise independent from the rest of the transformation description. As example content of the Xpand file, the following code is given. The basic idea behind the Xpand language should become clear by the example. Detailed reference information on the Xpand language can be found in the openarchitectureware documentation at file documentation/4.3.1/openarchitectureware Reference.pdf. «IMPORT erm» «DEFINE model FOR ErmModel» «FILE "dbschema.sql"» -- This is a generated database schema. DROP DATABASE test; CREATE DATABASE test; «EXPAND dbtable FOREACH entitytypes» «ENDFILE» Jens Gulden,

5 «ENDDEFINE» «DEFINE dbtable FOR EntityType» CREATE TABLE «this.name» ( ID INT NOT NULL «FOREACH attributelink AS attr», «attr.name» «attr.type» «ENDFOREACH» ) «ENDDEFINE» Example 2 Xpand source code The import declaration at the beginning of the template file refers to the Ecore model, which specifies the language. This is why the.ecore file has to be copied into the same folder, to make the language definition available to the transformation script. For more complex transformations, the Xtend language can be incorporated in the transformation description. It allows for integrating helper functions or even calling arbitrary Java code. See also the openarchitectureware reference documentation for details on the Xtend language. To run the transformation manually, invoke the Workflow file with Right click Run As... oaw Workflow. The result of the example transformation is shown below. -- This is a generated database schema. DROP DATABASE test; CREATE DATABASE test; CREATE TABLE Organisation ( ID INT NOT NULL ), address VARCHAR(255), orgid VARCHAR(255) CREATE TABLE Resource ( ID INT NOT NULL ), resid VARCHAR(255), codenum int CREATE TABLE Person ( ID INT NOT NULL, fullname VARCHAR(255), nickname VARCHAR(255), address VARCHAR(255) ) Example 3 Result of applying the example Xpand template Jens Gulden,

6 3 The One-Click way In order to invoke the previously developed transformation from the graphical user interface, i.e., without Right click Run As... oaw Workflow, two additional pieces are required: first, some Java code which replaces the workflow file and invokes the Xpand template interpreter, and second, the declaration of a button in the graphical user interface, which will cause the Java code to be executed on a click event. 3.1 Java code The Java code can be encapsulated inside one class file that declares an IEditorActionDelegate class for the MEMOCenterNG/Eclipse platform. Such an action declaration can be bound directly to the click event of a button. Create a Java class file by Right click on the src folder Class..., choose a package name, e.g., mylanguage.transform.sql, and a class name, e.g., SQLTransformationAction. Paste the following code into the class file and adopt the names to the desired language. package erm.transform.sql; import java.io.file; import java.io.ioexception; import java.net.url; import java.text.simpledateformat; import java.util.date; import java.util.map; import org.eclipse.core.runtime.ipath; import org.eclipse.core.runtime.iprogressmonitor; import org.eclipse.emf.common.command.basiccommandstack; import org.eclipse.emf.common.util.uri; import org.eclipse.emf.common.util.wrappedexception; import org.eclipse.emf.ecore.eobject; import org.eclipse.emf.ecore.epackage; import org.eclipse.emf.ecore.impl.eobjectimpl; import org.eclipse.emf.ecore.resource.resource; import org.eclipse.emf.ecore.resource.resourceset; import org.eclipse.emf.ecore.resource.impl.resourcesetimpl; import org.eclipse.emf.ecore.xmi.impl.xmiresourcefactoryimpl; import org.eclipse.emf.ecore.xmi.impl.xmiresourceimpl; import org.eclipse.emf.edit.domain.editingdomain; import org.eclipse.emf.edit.ui.provider.adapterfactorycontentprovider; import org.eclipse.emf.transaction.impl.resourcesetmanager; import org.eclipse.gef.editpart; import org.eclipse.gmf.runtime.diagram.ui.parts.diagrameditdomain; import org.eclipse.gmf.runtime.diagram.ui.resources.editor.document.diagramdocument; import org.eclipse.gmf.runtime.diagram.ui.resources.editor.document.idiagramdocument; import org.eclipse.gmf.runtime.diagram.ui.resources.editor.document.idocument; import org.eclipse.gmf.runtime.diagram.ui.resources.editor.document.idocumentprovider; import org.eclipse.gmf.runtime.notation.diagram; import org.eclipse.gmf.runtime.notation.impl.diagramimpl; import org.eclipse.jface.action.iaction; import org.eclipse.jface.viewers.iselection; import org.eclipse.jface.viewers.istructuredselection; import org.eclipse.jface.viewers.treeviewer; import org.eclipse.m2t.type.emf.emfregistrymetamodel; import org.eclipse.mwe.emf.reader; import org.eclipse.mwe.emf.standalonesetup; import org.eclipse.ui.ieditoractiondelegate; import org.eclipse.ui.ieditorpart; import org.eclipse.ui.iobjectactiondelegate; import org.eclipse.ui.iworkbenchpart; import org.eclipse.ui.part.editorpart; import org.eclipse.ui.part.fileeditorinput; import org.openarchitectureware.expression.exceptionhandler; import org.openarchitectureware.expression.executioncontext; import org.openarchitectureware.expression.ast.syntaxelement; Jens Gulden,

7 import org.openarchitectureware.type.metamodel; import org.openarchitectureware.type.emf.emfmetamodel; import org.openarchitectureware.util.stdlib.globalvarextensions; import org.openarchitectureware.workflow.workflowcontext; import org.openarchitectureware.workflow.workflowcontextdefaultimpl; import org.openarchitectureware.workflow.issues.issues; import org.openarchitectureware.workflow.issues.issuesimpl; import org.openarchitectureware.workflow.monitor.nullprogressmonitor; import org.openarchitectureware.workflow.monitor.progressmonitor; import org.openarchitectureware.xpand2.generator; import ERM.erm.ErmModel; import ERM.erm.ermPackage; import ERM.erm.diagram.part.ErmDiagramEditor; public class SQLTransformationAction implements IEditorActionDelegate { protected ErmModel model; protected IEditorPart editorpart; protected String modelfilename; protected String outputfolder; public SQLTransformationAction() { super(); init(); protected void init() { this.editorpart = null; this.model = null; this.modelfilename = null; this.outputfolder = "."; //@Override public void setactivepart(iaction action, IWorkbenchPart targetpart) { updateconfiguration(targetpart); //@Override public void selectionchanged(iaction action, ISelection selection) { // nop, we care for the whole model only //@Override public void setactiveeditor(iaction action, IEditorPart targeteditor) { if (targeteditor!= null) { updateconfiguration(targeteditor); protected void updateconfiguration(iworkbenchpart targetpart) { ErmDiagramEditor editor = (ErmDiagramEditor)targetPart; this.editorpart = editor; DiagramImpl doc = (DiagramImpl)editor.getDiagramDocument().getContent(); this.model = (ErmModel)doc.getElement(); FileEditorInput input = ((FileEditorInput) editorpart.geteditorinput() ); IPath path = input.getpath(); this.modelfilename = path.tostring(); this.modelfilename = this.modelfilename.substring(0, this.modelfilename.length()-8); //@Override public void run(iaction action) { rungenerator(); protected void rungenerator() { System.out.println("Code generation starting."); WorkflowContextDefaultImpl context = new WorkflowContextDefaultImpl(); URI modeluri = URI.createFileURI(modelFilename); generatecode(context, (this.model == null)? modeluri : null); System.out.println("Code generation done."); Jens Gulden,

8 protected void generatecode(workflowcontext context, URI modeluri) { EmfMetaModel metamodel = new EmfMetaModel(); metamodel.setusesingleglobalresourceset(true); metamodel.setmetamodelpackage(ermpackage.class.getname()); Issues issues = new IssuesImpl(); ExceptionHandler exceptionhandler = new ExceptionHandler() { public void handleruntimeexception(runtimeexception ex, SyntaxElement element, ExecutionContext ctx, Map<String, Object> additionalcontextinfo) { System.err.println(ex.getMessage()); ex.printstacktrace(); ; context.set("model", this.model); // output-folder File folder = null; if (outputfolder!= null) { folder = new File(outputFolder); if (! folder.isabsolute() ) { // relative to model-file's parent folder folder = new File(modelFilename); folder = new File(folder, "../"+outputfolder); String outputpath = null; try { if ( folder == null ) { throw new IOException(); outputpath = folder.getcanonicalpath(); folder = new File(outputPath); if ( (! folder.exists() ) (! folder.isdirectory() ) ) { throw new IOException(); catch (IOException ioe) { System.err.println("error: invalid source folder " + outputfolder); return; // IRREGULAR EXIT GlobalVarExtensions.storeGlobalVar("outputPath", outputpath); Generator g = new Generator(); g.addmetamodel(metamodel); g.setgenpath( outputpath ); g.setexpand("generator::generate::model FOR model"); g.setexceptionhandler(exceptionhandler); g.invoke(context, new NullProgressMonitor(), issues); Example 4 Java code for invoking an Xpand transformation At this point, several compilation errors are still likely to arise because required dependencies are still missing. To fix this, open the file META INF/MANIFEST.MF, click on the MANIFEST.MF bottom tab to see the textual MANIFEST file, and make sure the following plugins are listed under Require Bundle : Require Bundle: org.openarchitectureware.dependencies, org.eclipse.ui.ide, org.eclipse.gmf.runtime.diagram.ui.properties, org.eclipse.gmf.runtime.diagram.ui.resources.editor.ide, org.openarchitectureware.util.stdlib, mylanguage, mylanguage.edit, mylanguage.editor, mylanguage.diagram Example 5 Fragment of the META INF/MANIFEST.MF file Jens Gulden,

9 The settings of the Require Bundle parameter can alternatively be edited via a form based userinterface on the Dependencies tab in the plugin.xml editor. 3.2 Button declaration A button is declared without additional programming. To add the button, only a plugin declaration is required which lists the button in its plugin.xml specification. The current project usually is already considered an empty plugin, since it has been created as an openarchitectureware project. If it is not yet a plugin, it can be declared as such using Right click on project name PDE Tools Convert to plugin project. Now make sure a file plugin.xml exists in the root folder of the project, if it does not yet, create an empty one using New File. Open plugin.xml and switch to the plugin.xml bottom tab, to see the textual XML source code of the file. (Alternatively, open the file in text mode with Right click Open with Text Editor.) Add an XML fragment like the following to plugin.xml, and adopt the names of IDs, classes and files as required: <plugin> <extension point="org.eclipse.ui.editoractions"> <editorcontribution id="erm.transform.sqltransformationaction" targetid="erm.erm.diagram.part.ermdiagrameditorid">  <action class="erm.transform.sql.sqltransformationaction" icon="icons/icb.png" id="erm.transform.sql.sqltransformationactionid" label="generate SQL" menubarpath="erm/generator" toolbarpath="/sql" tooltip="generate SQL"> </action> <menu id="erm.transform.sqltransformationaction.menu" label="generate SQL"> <groupmarker name="generator"> </groupmarker> </menu> </editorcontribution> </extension> </plugin> Example 5 File plugin.xml The class attribute of the action element holds the name of the Java class that was previously created. IDs and the entries menubarpath, toolbarpath and icon can be freely chosen. The path to the icon file refers to the project file structure. In the example, an additional source folder icons was created, which contains an image file for the button s icon. Jens Gulden,

10 4 Further Information MML o "The MEMO Meta Modelling Language (MML) and Language Architecture", ICB Research Report, Institut für Informatik und Wirtschaftsinformatik (ICB), Universität Duisburg Essen, Nr. 24, MEMO: o "Multi Perspective Enterprise Modeling (MEMO): Conceptual Framework and Modeling Languages" in Proceedings of the Hawaii International Conference on System Sciences (HICSS 35): Honolulu, o "Multiperspektivische Unternehmensmodellierung: Theoretischer Hintergrund und Entwurf einer objektorientierten Entwicklungsumgebung", Oldenbourg Verlag, MemoCenterNG Tool Development o Eclipse Platform: o EMF: o GMF: o OpenArchitectureWare: Jens Gulden,

MEMOCenterNG A full-featured modeling environment for organization modeling and model-driven software development

MEMOCenterNG A full-featured modeling environment for organization modeling and model-driven software development Jens Gulden and Prof. Dr. Ulrich Frank University Duisburg-Essen, Universitaetsstr. 9,