Eclipse Modeling Framework (EMF) und das Graphical Editing Framework (GEF)

Transkript

1 Eclipse Modeling Framework (EMF) und das Graphical Editing Framework (GEF) Markus Bauer, Florian Lautenbacher, Stephan Roser Programmierung verteilter Systeme Lab Institut für Informatik Universität Augsburg Universitätsstraße 14, Augsburg Tel.: (+49) 821/ , Fax: URL:

2 Agenda Motivation und Überblick Eclipse Modeling Framework (EMF) EMF-Modellimport EMOF und ECore EMF Edit & Codegen Graphical Editing Framework (GEF) Model-View-Controller (MVC)-Pattern MVC in GEF Weitere Konstrukte: EditPolicies und Commands Nutzung von EMF in GEF Einführung eines Beispiels Beispiel in EMF und GEF Zusammenfassung und Ausblick Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

5 Standards im Überblick OMG Standards Model-Driven Architecture (MDA) zur modellgetriebenen Software-Entwicklung. BPMN (Business Process Modeling Notation) zur Modellierung der Business-Sicht. SBVR (Semantics of Business Vocabulary and Business Rules) für Business- Regeln, etc. Spezifikation eines allgemeinen Ansatzes. Eclipse Modeling Framework (EMF) Spezifische Realisierung der OMG MOF-Konzepte mit Eclipse und Java. Integriert im Eclipse Tools Projekt. Graphical Editing Framework (GEF) Framework zur Darstellung von Modellen. kann auf Basis eines EMF-Metamodells geschehen, aber auch eigenständig. Graphical Modeling Framework (GMF) Versuch EMF und GEF zu integrieren. Projekt noch im frühen Entwicklungsstadium. sehr komplex. Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

7 EMF Allgemeines EMF ist ein Modellierungsframework und Tool zur Code-Generierung basierend auf einem strukturierten Datenmodell Ausgehend von einer Modellspezifikation in XMI bietet EMF: Tools und Laufzeitunterstützung um eine Menge von Javaklassen aus dem Modell zu erstellen Adapterklassen, die eine einfache Sicht und ein kommando-basiertes Editieren des Modells ermöglichen einen grundlegenden Editor Modelle können auf unterschiedlichem Wege erstellt werden: aus annotierten Java-Klassen aus XML-Dokumenten aus Modellierungstools wie Rational Rose direkt mithilfe des EMF Ecore Baum-Editors Durch EMF wird die Grundlage für Interoperabilität zwischen verschiedenen EMF-basierten Tools und Anwendungen gelegt. Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

9 EMF - Modellimport EMF (Meta-)Modelle können wie folgt erstellt werden: XMI-Datei direkt in einem Texteditor erstellen ( Ecore model) Verwendung eines Modellierungstools wie beispielsweise Rational Rose und export als XMI-Dokument ( Rose class model) Annotierte Java-Klassen und Interfaces einlesen ( Annotated Java) XML-Schema verwenden um die Serialisierung des Models zu beschreiben ( XML Schema) Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

10 EMF Überblick EMF.EMOF Teil der MOF 2.0-Spezifikation (Essential MOF) EMF.Ecore Das Core EMF-Framework beinhaltet ein Meta-Model um Modelle zu beschreiben Laufzeitunterstützung für die Modelle inkl. Benachrichtigung bei Änderungen, Persistenzunterstützung durch eine Standard XML-Serialisierung, Eine API um EMF-Modelle generisch zu verändern. EMF.Edit Generische und wiederverwendbare Klassen um Editoren für EMF-Modelle zu erstellen EMF.Codegen Generierung von allen notwendigen Klassen, um EMF-Modelle später in einem eigenen Editor zu erstellen und verändern Integriert eine GUI um Optionen einzugeben und Generatoren aufzurufen Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

12 (Essential) MOF EMOF ist Teil der MOF 2 Spezifikation. verwendet um einfache Metamodelle mit simplen Konzepten zu definieren nutzt dabei objekt-orientierte Konzepte MOF 2.0 verwendet UML 2.0 Klassen Diagramme Metamodell können mit UML-Tools erstellt werden MOF 2.0 definiert ausserdem die Complete MOF (CMOF) mit zusätzlichen Eigenschaften Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

15 EMF Genmodel Zusätzliche Informationen um die Java Klassen zu erstellen Allgemeine Informationen: Copyright Name des Modells ID des Plugins Einstellungen für EMF.Edit Unterstützung zur Erstellung von Kindelementen durch Commands Icons Plug-in Klassen Einstellungen für EMF Editor Template & Merge Automatische Formatierung des Codes Dynamische Templates: Java Klassen werden mithilfe von JET (Java Emitter Templates) erzeugt; diese können bei Bedarf angepasst werden Einstellungen zur Property View Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

16 Erzeugte Java Klassen - Modell Zu jeder Klasse im Ecore Metamodell: Java Interface. Implementierung im Unterpakage impl. Zu jedem Package: Eine Package Klasse. Informationen zu den Features und Metadaten des Modell. Factory Klasse: Bietet Methoden zum Erzeugen neuer Objekte. Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

17 Erzeugte Java Klassen - Edit Ein Edit Provider für jede Klasse im Ecore Metamodell Informationen zu Kindern und Eltern von einem Objekt Descriptoren zur Erzeugung von Kindern Commands zur Änderung des Objekts Informationen zur Erzeugung eines Baumes, der das Modell repräsentiert Text und Icon zu einem Objekt Informationen für Property Sheet Adapter Factory Liefert zu einem Objekt den richtigen Provider Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

19 EMF Überblick über Edit und Codegen M3 (Metametamodel) OMG MOF EMF Ecore (Java classes) EMF M2 (Metamodel) UML, CWM,... EMF model EMF.Edit instanceof EMF codegen EMF.Codegen EMF Java code for manipulation and default serialization of EMF models M1 (Model) instanceof EMF model EMF.Edit Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

21 EMF Zusammenfassung UML: EMF Ecore beschäftigt sich nur mit den Klassenmodellierungsaspekten der UML Das UML 2.0 Metamodell ist allerdings in EMF Ecore implementiert. MOF: Die Meta-Object Facility definiert eine konkrete Untermenge von UML um Modellierungskonzepte innerhalb eines Repositories zu beschreiben. MOF ist vergleichbar mit Ecore. Ecore vermeidet einige der komplexen Elemente von MOF, da es den Fokus eher auf Tool-Integration denn auf Management von Metadaten-Repositories legt. XMI: XMI wird verwendet um Modelle zu serialisieren sowohl für jegliches EMF-Modell als auch für Ecore selbst. MDA: EMF unterstützt das Hauptkonzept der MDA indem es Erstellung von Modellen für die Entwicklung und Generierung ermöglicht und nicht nur zur Dokumentation. Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

24 Was ist GEF? Framework um Modelle graphisch darstellen. Erlaubt dem Benutzer mit dem Modell zu interagieren. Verarbeitung von Benutzereingaben durch Maus und Tastatur. Interpretation der Eingaben. Bietet Möglichkeiten das Modell zu verändern. Änderungen können rückgängig gemacht werden (undo/redo). Bietet nützliche Workbench Funktionen Aktionen und Menüs Toolbars Keybindings Plugin von Eclipse Baut auf dem Model-View-Controller Pattern auf Ziel: Immer wieder verwendete Funktionalitäten nicht jedesmal neu entwickeln zu müssen Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

25 Model View Controller Pattern 3 Schichten Modell strikte Trennung der Schichten Daten in der Modellschicht Visualisierung der Daten in der Viewschicht Kommunikation zwischen den 2 Schichten in der Controllerschicht Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

26 MVC Pattern: Modellschicht Alle persistenten und wichtigen Daten ausschließlich hier gespeichert Container für Daten Kennt keine anderen Teile des Programms Teilt Änderungen an sich mit über Listener Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

27 MVC Pattern: Viewschicht Keine Daten in der Viewschicht. Keine Modelllogik. Kennt keine anderen Teile des Programms. Abbildung der Daten der Modellschicht. Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

28 MVC Pattern: Controllerschicht Verbindung von Modell- und Viewschicht Leitet Kommunikation vom Modell an die View weiter In GEF: Unterklasse von EditPart Zu jedem EditPart genau ein Modell und genau eine View Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

30 Die Viewschicht in GEF: Draw2D und Figures Darstellung der Modellobjekte in GEF mit Figures Figures in einer Baumstruktur Anzeige der Figures im lightweight system von Draw2D Figures zeichnen sich selbst und rekursiv ihre Kinder Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

31 Die Controllerschicht in GEF: EditParts und EditPartFactory EditParts wie Figures in einer Baumstruktur Drei wichtige Methoden in den EditParts: createfigure(): Erstellen der Figure zu dieser EditPart => Verbindung Controllerschicht Viewschicht refreshvisuals(): Aktualisieren der Daten der Viewschicht mit den Daten der Modellschicht. getmodelchildren(): Eine Liste von Modellklassen, die logisch Kinder von dem zum EditPart korrespondierenden Modellelement sind Verbindung Modellschicht Controller über EditPartFactory Neues Modellobjekt wird erzeugt In der Factory wird der dazu korrespondierende EditPart gesucht Verbindung wird geknüpft Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

33 Kommunikation zwischen den Schichten Ausgangspunkt: Änderung findet im Modell statt. In EMF sendet ein Objekt bei Änderung eine Notification an alle registrierten Adapter. Adapter sind die EditParts. EditParts müssen sich bei ihren Modellklassen registrieren. Dafür zwei Methoden activate(): Wenn das EditPart erzeugt wird, registriert es sich bei dem entsprechenden Modellelement. deactivate(): Wenn das EditPart aus dem EditPartBaum ausgehängt wird, entfernt es den Adapter aus dem Modellelement. Notifications werden an die Methode notifychanged(notification notification) gesendet. Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

35 Veränderungen im Modell während der Laufzeit: EditPolicies und Commands Festlegen der Aufgaben eines EditParts über EditPolicies. EditPolicies bekommen Requests. Requests sind Anfragen des Systems, um eine Aufgabe auszuführen. Mit den Informationen eines Requests wird ein Command erzeugt. Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

36 Von Requests zu Commands Tool EditPart EditPolicy SWT Events Requests Requests showfeedback() erasefeedback() getcommand() Commands Commands? Stack Commands Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

37 Ausführung von Commands Im Command werden Änderungen im Modell vorgenommen execute(): Bei 1. Ausführung des Commands. undo(): Rückgängigmachen der Aktionen von execute redo(): Wiederholen der Aktionen nach undo. Commands werden intern in einem CommandStack gehalten. Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

38 EditParts und EditPolicies EditPolicies werden in der Methode createeditpolicies() von EditPart erzeugt. Die EditPart ist dafür verantwortlich die View aktuell zu halten. EditPolicies behandelt Aufgaben die durch das Editieren entstehen Verhindern Einschränkung durch Einfachvererbung Übernehmen Aufgaben, die nicht zu den EditParts gehören. Erlauben es die Bearbeitung dynamisch zu halten. Werden mithilfe von Roles verwaltet. Behandeln Feedback, Commands, Targeting, etc. Tipp: UnexecutableCommand vs. null Verwendetes Pattern: Pool of Responsibility Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

39 The Big Picture EditDomain EditPartViewer EditPartViewer EditPartViewer 1. acts on Model 2. events 3. request 4. command Palette CommandStack Active Tool Tool1 Tool2 Tool3 5. execute Command Command Command Command 6. modifies Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

40 GEF Fazit Durchdachte und robuste Struktur Viele Funktionalitäten wie ein CommandStack bereits implementiert View kann durch andere ausgetauscht werden Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

43 Beispiel - Features Erstellen eines neuen Diagramms mittels Wizard. Öffnen eines existierenden Diagramms. Speichern von Änderungen. auch als neues Dokument ( speichern als ). Palette mit Selektionstools und Elementen. Erstellen von Knoten (node). Erstellen von Verbindungen (connection) zwischen den Knoten. Löschen von Knoten und Verbindungen. Verschieben von Knoten. Ändern der Größe von Knoten. Alle Veränderungen können rückgängig gemacht werden (undo) und wiederhergestellt werden (redo). Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

45 Beispiel Metamodell UML Erstellt mit ArgoUML ( Diagram ist Wurzelelement. Ein Diagramm enthält Knoten (node). Knoten besitzen Quell- und Zielverbindungen (source Connection / target Connection). Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

47 Erstellen des Modells Erstellen des GenModels aus dem Ecore Modell. Erstellen des Modells aus dem GenModel. Wenn man den Editor generiert, dann hat man an dieser Stelle bereits einen Baumeditor mit dem man ein Modell bearbeiten kann. Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

48 Modell: Commands Jedes Objekt, das erstellt werden kann, benötigt ein CreateCommand public void execute() diagram.getelements().add(newnode); public void undo() diagram.getelements().remove(newnode); Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

49 Modell: Commands Jedes Objekt, das gelöscht werden kann, benötigt ein DeleteCommand public void execute() source = connection.getsource(); target = connection.gettarget(); connection.setsource(null); connection.settarget(null); public void undo() connection.setsource(source); connection.settarget(target); Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

50 Modell: Commands Jedes Objekt, das geändert werden kann, benötigt ein Command public void execute() oldbounds = new Rectangle(node.getX(), node.gety(), node.getwidth(), node.getheight()); redo(); public void redo() node.setx(newbounds.x); node.sety(newbounds.y); node.setwidth(newbounds.width); node.setheight(newbounds.height); public void undo() node.setx(oldbounds.x); node.sety(oldbounds.y); node.setwidth(oldbounds.width); node.setheight(oldbounds.height); Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

51 View: Figures Figures werden in den EditParts erzeugt. Komplexere Figures werden als eigene Unterklassen implementiert. Node: protected IFigure createfigure() IFigure f = new RectangleFigure(); f.setopaque(true); f.setbackgroundcolor(colorconstants.green); return f; Connection: protected IFigure createfigure() PolylineConnection connection = (PolylineConnection) super.createfigure(); connection.settargetdecoration( new PolygonDecoration()); return connection; Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

52 Controller: EditPartFactory EditParts werden in einer EditPartFactory erzeugt und mit dem Modellobjekt verbunden. public EditPart createeditpart(editpart context, Object model) EditPart editpart = null; if (model instanceof Diagram) editpart = new DiagramEditPart(); else if (model instanceof Node) editpart = new NodeEditPart(); else if (model instanceof Connection) editpart = new ConnectionEditPart(); editpart.setmodel(model); return editpart; Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

53 Controller: Adapter Um auf Änderungen aus dem EMF Modell reagieren zu können, müssen die EditParts org.eclipse.emf.common.notify.adapter implementieren. Registrierung als Adapter zum entsprechenden Modellobjekt: public void activate() super.activate(); gettarget().eadapters().add(this); public void deactivate() super.deactivate(); gettarget().eadapters().remove(this); Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

54 Controller: Reaktion auf Notifications public void notifychanged(notification notification) int featureid = notification.getfeatureid(node.class); switch (notification.geteventtype()) case Notification.SET: case Notification.UNSET: switch (featureid) case EmfGefExamplePackage.NODE X: case EmfGefExamplePackage.NODE Y: case EmfGefExamplePackage.NODE WIDTH: case EmfGefExamplePackage.NODE HEIGHT: refreshvisuals(); break; break; Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

55 Controller: Reaktion auf Notifications case Notification.ADD: case Notification.ADD_MANY: case Notification.REMOVE: case Notification.REMOVE_MANY: switch (featureid) case EmfGefExamplePackage.NODE IN: refreshtargetconnections(); break; case EmfGefExamplePackage.NODE OUT: refreshsourceconnections(); break; break; Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

56 Controller: Hierarchie Nodes als Kindelemente von Diagram: protected List getmodelchildren() return ((Diagram) getmodel()).getelements(); Connections zwischen Nodes: protected List getmodelsourceconnections() return ((Node) getmodel()).getout(); protected List getmodeltargetconnections() return ((Node) getmodel()).getin(); Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

57 Controller: EditPolicies - DiagramEditPart protected void createeditpolicies() // disallows the removal of this edit part // from its parent installeditpolicy(editpolicy.component_role, new RootComponentEditPolicy()); // handles constraint changes //(e.g. moving and/or resizing) of model // elements and creation of new model elements installeditpolicy(editpolicy.layout_role, new DiagramXYLayoutEditPolicy()); Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

58 Controller: EditPolicies - DiagramXYLayoutEditPolicy protected Command getcreatecommand(createrequest request) Object childclass = request.getnewobjecttype(); if (childclass == Node.class) Node newnode = (Node) request.getnewobject(); Command command = new NodeCreateCommand(newNode, (Diagram) gethost().getmodel()); return command.chain(new NodeSetConstraintCommand( newnode, (Rectangle) getconstraintfor(request))); return null; protected Command createchangeconstraintcommand( ChangeBoundsRequest request, EditPart child, Object constraint) if (child.getmodel() instanceof Node && constraint instanceof Rectangle) return new NodeSetConstraintCommand((Node) child.getmodel(), (Rectangle) constraint); return super.createchangeconstraintcommand(request, child, constraint); Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

59 Controller: EditPolicies - NodeEditPart protected void createeditpolicies() // allow removal of the associated model element installeditpolicy(editpolicy.component_role, new ComponentEditPolicy() protected Command getdeletecommand(grouprequest request) return new NodeDeleteCommand( (Node) gethost().getmodel()); ); // allow the creation of connections installeditpolicy(editpolicy.graphical_node_role, new NodeGraphicalNodeEditPolicy()); Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

60 Controller: EditPolicies - NodeGraphicalNodeEditPolicy protected Command getconnectioncreatecommand( CreateConnectionRequest request) Node node = (Node) gethost().getmodel(); ConnectionCreateCommand command = new ConnectionCreateCommand(request, node); request.setstartcommand(command); return command; protected Command getconnectioncompletecommand( CreateConnectionRequest request) ConnectionCreateCommand command = (ConnectionCreateCommand) request.getstartcommand(); command.settarget((node) gethost().getmodel()); return command; Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

61 Editor: Laden eines Modells String filename = ((IFileEditorInput) geteditorinput()). getfile().getfullpath().tostring(); URI resourceuri = URI.createPlatformResourceURI(fileName); // Create a resource set ResourceSet resourceset = new ResourceSetImpl(); // register plugin extension to XMI serialization resourceset.getresourcefactoryregistry(). getextensiontofactorymap().put( EmfGefExampleCreationWizard.DEFAULT_EXTENSION, new XMIResourceFactoryImpl()); // Create a resource for this file. modelresource = resourceset.createresource(resourceuri); // load model modelresource.load(collections.empty_map); Diagram diagram = modelresource.getcontents().get(0); Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

62 Editor: Speichern des Modells try modelresource.save(collections.empty_map); getcommandstack().marksavelocation(); catch (IOException e) //... Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

63 Editor: Erstellen eines neuen Modells im Wizard IFile newfile = createnewfile(); ResourceSet resourceset = new ResourceSetImpl(); resourceset.getresourcefactoryregistry(). getextensiontofactorymap().put(default_extension, new XMIResourceFactoryImpl()); URI fileuri = URI.createPlatformResourceURI( newfile.getfullpath().tostring()); Resource resource = resourceset.createresource(fileuri); Diagram rootobject = EmfGefExampleFactory.eINSTANCE.createDiagram(); resource.getcontents().add(rootobject); try resource.save(collections.empty_map); catch (IOException e) Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

64 Editor: Weitere Komponenten AbstractUIPlugin Instanz des Plugins ActionBarContributor Actions für ToolBar Actions für Menüs Im Beispiel: Undo, Redo, Delete ContextMenuProvider Kontextmenü im Editor Im Beispiel: Undo, Redo, Delete Plugin.xml Name, Version, ID des Plugins Durch Abhängigkeiten benötigte Plugins Registrierung des Wizards Registrierung des Editors Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

66 Vor- und Nachteile für die Verwendung von EMF für GEF Vorteile: Kostengünstige Möglichkeit für modellbasierte Softwareentwicklung Effektivität durch automatische Konsistenzerhaltung der Modellrepräsentanten Mächtige Codegenerierung erspart viel stupiden Programmieraufwand Nachteile: Modellierungssprachschatz nicht so mächtig wie UML (von Hand nachprogrammieren) weiterhin manuelle Implementierung/Anpassung des graphischen Editors für das EMF-Modell notwendig Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

67 Wie geht s weiter? GEF Beispiele (im Plug-in enthalten) Shapes: Einfachstes Beispiel Logic: Sehr umfangreiches Beispiel GEF Dokumentation: GefDescription: EMF Dokumentation: EMF Übersicht: EMF.Edit Übersicht: EMF Book: Eclipse Modeling Framework (Overview and Developer's Guide): samplechapter/budinskych02.pdf Create an Eclipse-based application using the GEF: ibm.com/developerworks/opensource/library/os-gef Using GEF with EMF IBM Redbook: Eclipse Development using the Graphical Editing Framework and the Eclipse Modeling Framework Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved

68 Quellen entnommen aus Seminarvorträge aus dem Sommersemester 2005: Model Driven Software Development & Software Generation Hudson, Randy; Shah, Pratik: Tutorial #23 / GEF In Depth; EclipseCon 2005 und 2006: Vorträge zu EMF und GEF Beispiele und Tutorials von Eclipse EMF und GEF Markus Bauer, Florian Lautenbacher, Stephan Roser; all rights reserved 2006