Technology Tutorial. - Details and Advanced Concepts - Patrick Könemann Software Engineering 2 (02162)

Transcription

1 Technology Tutorial Software Engineering 2 (02162) - Details and Advanced Concepts - Patrick Könemann (pk@imm.dtu.dk) Oct 19 th 2009

2 Previous Tutorials. 1. A view and a selection listener for file types public void createpartcontrol(composite parent) { viewer = new TableViewer(parent, SWT.MULTI SWT.H_SCROLL SWT.V_SCROLL); viewer.setcontentprovider(new ArrayContentProvider()); viewer.setlabelprovider(new LabelProvider()); getsite().getpage().addselectionlistener(this); public void selectionchanged(iworkbenchpart part, ISelection selection) { List<String> list = new ArrayList<String>(); if (selection instanceof StructuredSelection) { StructuredSelection str = (StructuredSelection) selection; if (!str.isempty()) { for (Object obj : str.tolist()) { if (obj instanceof IResource) { IResource resource = (IResource) obj; list.add(resource.getname() + " (type: " + resource.getfileextension() + ", path: " + resource.getfullpath().tostring() + ")"); } } } } viewer.setinput(list); } 2

3 Previous Tutorials.. 1. A view and a selection listener for file types 2. Create an EMF model (for Petrinets), generate code, and install a command (for simulation) as a popup action for transitions 3

4 Previous Tutorials 1. A view and a selection listener for file types 2. Create an EMF model (for Petrinets), generate code, and install a command (for simulation) as a popup action for transitions 3. Create a compound command for creating an object and set its initial id 4

5 Previous Tutorials. 1. A view and a selection listener for file types 2. Create an EMF model (for Petrinets), generate code, and install a command (for simulation) as a popup action for transitions 3. Create a compound command for creating an object and set its initial id 4. Use GMF to generate a graphical editor for Petrinets and install a command (for simulation) as a popup action for transition figures 5

6 Previous Tutorials.. 1. A view and a selection listener for file types 2. Create an EMF model (for Petrinets), generate code, and install a command (for simulation) as a popup action for transitions 3. Create a compound command for creating an object and set its initial id 4. Use GMF to generate a graphical editor for Petrinets and install a command (for simulation) as a popup action for transition figures 5. A simple dashboard view for Petrinets with listeners/adapters showing the current number of tokens on selected places 6

7 Motivation This lecture covers advanced topics after the regular tutorials. But didn t we get enough tutorials yet?! These were just the basics. The following advanced concepts probably save a lot of time later. Then why listening now?! We can read things later in the slides! Good, do that! But following now will help you understand things much better. And not everything I say is in the slides ;-) 7

8 Overview Topic Concepts Examples Slides Resources in Eclipse Dialogs OCL in EMF / GMF GMF: Graphical properties in the model GMF: Architecture GMF: Decorator 8

9 Resources in Eclipse: Examples C:\se2\workspace\.metadata\ dk.dtu.imm.se2.petrinet\ model\ src\ bin\ petrinet.ecore petrinet.genmodel META-INF\.project MANIFEST.MF plugin.xml java.io.file java.io.file java.io.file java.io.file java.io.file java.io.file java.io.file java.io.file java.io.file java.io.file java.io.file java.io.file IWorkspace (metadata directory) IProject IFolder IFile IFile IFolder (source files) IFolder (compiled files) IFolder IFile (IProjectDescription) IFile How do you access these items in Java? Images are also stored as IFiles ;-) 9

10 Resources in Eclipse: Class hierarchy Open that dialog with Ctrl + t How to navigate? [brief excerpt from the JavaDoc] IResource.exists(): boolean Check whether the resource exists IResource.getFullPath(): IPath Returns the full, absolute path of this resource relative to the workspace. IResource.getLocationURI(): URI Get the URI of this ressource IContainer.members(): IResource[] Get handles to all resources contained here IContainer.getFile(String file): IFile Get a handle to a file contained here IFolder.create( ): void Create this folder (assuming it does not exist) IFile.create( ): void Create this file (assuming it does not exist) 10

11 Resources in Eclipse: Handles Access to a resource is managed by a handle : petrinetmodel: IFile fullpath = /dk.dtu.imm.se2.petrinet/model/petrinet.ecore There is no guarantee or requirement that the resource itself exists until you try to do something with the handle. [Eclipse help] IFile petrinetmodel = modelfolder.getfile("petinet.ecore"); MessageDialog.openInformation(shell, "petrinet model path", petrinetmodel.getfullpath().tostring() + "\n" + "File exists: " + petrinetmodel.exists()); What will be shown here? 11

12 Resources in Eclipse: URIs Syntax for Uniform Resource Identifiers Platform independent! <URI scheme>:<path>#<fragment> Examples: platform:/resource/dk.dtu.imm.se2.petrinet/plugin.xml platform:/plugin/org.eclipse.emf.ecore/model/ecore.ecore#//ereference Resource is located in a running plugin Resource is located in the workspace Reference to an EClass within the EMF meta model URIs also in your models (as XMI): wiper.componentdefinition wipersystem.deployment test.petrinet 12

13 Resources in Eclipse: Load a Resource A resource can be loaded with a given URI via the bundle of the local plugin activator: platform:/resource/dk.dtu.imm.se2.dashboard/icons/dashboard.gif final URL imageurl = PluginActivator.getDefault().getBundle().getEntry("icons/dashboard.gif"); final Image image = ImageDescriptor.createFromURL(imageURL).createImage(); EMF provides simple methods for loading models: 1. Create resource set 2. ask it for a resource using a URI final ResourceSet resourceset = new ResourceSetImpl(); final URI uri = URI.createURI( "platform:/resource/casetool-examples/wipersystem/controller.componentdefinition"); final Resource resource = resourceset.getresource(uri, true); final EObject compdef = resource.getcontents().get(0); Located in workspace Project Folder File 13

14 Resources in Eclipse: References Eclipse help (Help Help Contents): Platform Plug-in Developer Guide Programmer s Guide Resources overview Resources and the file system Uniform Resource Identifier (URI) Generic Syntax: 14

15 Progress Topic Concepts Examples Slides Resources in Eclipse Dialogs No direct access! Use wrapper for accessing resources IFile, IFolder, URI 9 14 OCL in EMF / GMF GMF: Graphical properties in the model GMF: Architecture GMF: Decorator 15

16 Dialog: Examples if (MessageDialog.openQuestion(shell, Disconnect?, Do you really want to disconnect from the running simulation?")) { new InputDialog(shell, "Name?", "Please enter a name.", "system1", null).open(); new ResourceDialog(shell, "Select deployment", SWT.OPEN SWT.SINGLE).open(); 16

17 Dialog: More Examples List<ViewerFilter> filters = new ArrayList<ViewerFilter>(); filters.add(new ViewerFilter() public boolean select(viewer viewer, Object parentelement, Object element) { if (element instanceof IFile) { return ((IFile)element). getfileextension().equals("deployment"); } else return true; } }); WorkspaceResourceDialog.openFileSelection(shell, "Select files", "Please select input file(s)", false, null, filters); Filters for the files Suggested path WorkspaceResourceDialog.openNewFile(shell, "Save file", "Please select output file", null, null); 17

18 Dialogs: Yet More Examples String[] buttons = new String[]{ "Overwrite", "Save as '" + filealternative.getname() + "'", "Cancel }; MessageDialog dialog = new MessageDialog(shell, "File already exists", image, "'" + file.getname() + "' already exists.\nwhat do you want to do?", MessageDialog.WARNING, buttons, 1); switch (dialog.open()) { case 0: return file; case 1: return filealternative; default: return null; } 18

19 Dialogs: Which one?! Does a dialog already exist for my purpose? Yes? Use it! No? Pick the closet one, inherit from it, and adjust it for your needs! How do I find existing dialogs? Type Hierarchy of existing dialogs Plug-in Spy on open dialogs Quick Type Hierarchy with Ctrl + t Open with Alt + Shift + F1 19

20 Dialogs: References Eclipse Help (Help Help Contents): Platform Plug-in Developer Guide > Programmer's Guide > Dialogs and wizards JavaDoc JFace Snippets: 20

21 Progress Topic Concepts Examples Slides Resources in Eclipse No direct access! Use wrapper for accessing resources IFile, IFolder, URI 9 14 Dialogs Use existing ones! (static & dynamic) MessageDialog, InputDialog, ResourceDialog, OCL in EMF / GMF GMF: Graphical properties in the model GMF: Architecture GMF: Decorator 21

22 OCL: in EMF and GMF What is wrong here? What is wrong with the deployment? free_software is not on a node wiper_on_a_chip is on a node Goal: validate that the models are correct! Hard-coding constraints but I am lazy Model constraints in OCL (Object Constraint Language) self.definition->size() > 0 and self.definition.hardware self.definition->size() > 0 and not self.definition.hardware 22

23 Constraint for connections: The messages at the out-port must be receivable at the in-port! OCL: Constraints for modeling 23

24 OCL: Constraints for modeling Constraint for connections: The messages at the out-port must be receivable at the in-port! Context (self) In OCL: self.source.definition.out->forall( m1 self.target.definition._in->exists(m2 m1=m2 ))) and self.target.definition.out->forall( m1 self.source.definition._in->exists(m2 m1=m2 )) 24

25 OCL: brief overview OCL expressions: start from the context object (in OCL called self) may access attributes and methods (by dot-notation and resp. names) may navigate along associations may call operations and built-in functions OCL is independent from a concrete programing language and is tuned to formulate typical constraints on MOF and UML models also allows us to formulate pre and post conditions of methods can be used to implement some methods and derived attributes can be used for validation of models 25

26 OCL: use in GMF Different kinds of OCL Constraints are supported by GMF editors: Live mode: During work on model (slide 23) Non-live mode: Explicit validation (slide 22) Severity: Information Warning Error Context (self) [ Examples in DeploymentEditor.gmfmap ] 26

27 OCL: Interactive Console The Interactive OCL Console allows to evaluate OCL expressions live Context (self) must be selected Evaluation results Select OCL Console here Code completion!!! 27

28 OCL: References OCL Definition: OCL in Eclipse: GMF Constraints in general: Validation in GMF: OCL in EMF (advanced!): EMF-Codegen-with-OCL/index.html OCL for GMF requires an additional feature installed (unfortunately): 28

29 Helpful plugins MDT OCL All-in-One Tool for checking the correct syntact of OCL constraints and for evaluating constraints at runtime ( Interactive OCL Console ): From Update site: Install OCL All-in-One SDK (latest version) 29

30 OCL Console M1 level (design time) 30

31 Console M2 level (runtime) 31

32 Progress Topic Concepts Examples Slides Resources in Eclipse No direct access! Use wrapper for accessing resources IFile, IFolder, URI 9 14 Dialogs Use existing ones! (static & dynamic) MessageDialog, InputDialog, ResourceDialog, OCL in EMF / GMF Constraints in the model: Deployment model; Object Constraint Language OCL Console GMF: Graphical properties in the model GMF: Architecture GMF: Decorator 32

33 Model vs. View: Reminder [ From Lecture 1: SE2-L01.pdf ] 33

34 What is a model? What is a view? Model vs. View Model: instance of a meta model A view on the Dashboard meta model Several views on a Dashboard model A view on a model is one representation of the entire model or of a part of the model. There might be several representations of the same model element in a view. In the model, each element exists only once! 34

35 Model vs. View: GMF contains the model is just one representation Contents of the _diagram file: Each graphical element is stored as a Node GMF stores graphical information for each Node: position, size, font style, colours, 35

36 Model vs. View: Dashboard Motivation Creating Dashboard model.dashboar d _diagram Dashboard editor Dashboard model(s) Dashboard view Visualizing Dashboard model during simulation What is the problem? All graphical information is missing in the model! 36

37 Model vs. View: Storing graphical details in the model 1. Make your model capable of storing the graphical details 2. Install a listener on graphical elements which updates the location attributes each time a figure is created/moved 3. Hook listener into your editor, e.g. in ResourceSetInfo in DiagramDocumentProvider protected class ResourceSetInfo extends ElementInfo { NOT */ private GraphicElementListener graphicelementlistener = new GraphicElementListener(); NOT */ public ResourceSetInfo(IDiagramDocument document, IEditorInput editorinput) { [...] getresourceset().getresources().get(0).eadapters().add(graphicelementlistener); } NOT */ public void dispose() { getresourceset().getresources().get(0).eadapters().remove(graphicelementlistener); [...] } 37

38 Model vs. View: Graphical Element Listener public class GraphicElementListener extends EContentAdapter { private NotificationFilter modifiedfilter; public GraphicElementListener() { modifiedfilter = NotificationFilter.createEventTypeFilter(Notification.SET).or( NotificationFilter.createEventTypeFilter(Notification.UNSET)).or( NotificationFilter.createEventTypeFilter(Notification.ADD)).or( NotificationFilter.createEventTypeFilter(Notification.REMOVE)); } public void notifychanged(notification notification) { if (notification.getnotifier() instanceof EObject) { super.notifychanged(notification); } if (modifiedfilter.matches(notification) && (notification instanceof ENotificationImpl) && (notification.getnotifier() instanceof EObject)) { ENotificationImpl enotification = (ENotificationImpl) notification; EObject enotifier = (EObject) enotification.getnotifier(); extends Adapter (Listener) filter for notification types handle the notification event call updatenodebounds } } if (NotationPackage.eINSTANCE.getBounds().isSuperTypeOf(eNotifier.eClass())) { updatenodebounds(enotification, enotifier); } private void updatenodebounds(enotificationimpl enotification, EObject enotifier) { int featureid = enotification.getfeatureid(eattribute.class); EObject modelelement = ((View) enotifier.econtainer()).getelement(); } } if (modelelement instanceof ILocation){ ILocation location = (ILocation) modelelement; } switch (featureid) { case NotationPackage.BOUNDS X: location.setx(enotification.getnewintvalue()); break; case NotationPackage.BOUNDS Y: location.sety(enotification.getnewintvalue()); break; } Update the location for all ILocation objects: call setx( ) and sety( ) 38

39 Progress Topic Concepts Examples Slides Resources in Eclipse No direct access! Use wrapper for accessing resources IFile, IFolder, URI 9 14 Dialogs Use existing ones! (static & dynamic) MessageDialog, InputDialog, ResourceDialog, OCL in EMF / GMF Constraints in the model: Deployment model; Object Constraint Language OCL Console GMF: Graphical properties in the model Model vs. View Saving the position of figures in the model GMF: Architecture GMF: Decorator 39

40 GMF Architecture [Introduction to GMF, EclipseCon 2006] The important relevant parts:.diagram.edit.commands Commands for creating elements.diagram.edit.parts Controller (and views!) for all model elements.diagram.edit.policies General editing rules and restrictions.diagram.part Main classes (Editor, Wizard, Palette, Toolbar, Model provider, ).diagram.providers Item providers for edit-parts 40

41 GMF Architecture: MVC pattern Model Root Model Controller (EditParts) Diagram EditPart View (Figures) Diagram Figure fig 42 Located in you EMF model plugin Located in.diagram.edit.parts Also located in.diagram.edit.parts Observer pattern (Listeners) Direct access 41

42 MVC excursion: GMF vs. Pattern idea Model Controller View fig Controller and View are tightly coupled in GMF! No queries from the view to the model [ From Lecture 2: SE2-L02.pdf ] 42

43 GMF Architecture: The EditParts EditParts are controllers Create Figures Define Figure Layout Set graphical properties (not stored in the model) Contain Figures!!! Let s have a look at the PlaceEditPart of the Petrinet editor Tipp: Create your own package for your customized figures and integrate your figures in the.gmfgraph file (unless you need to customize what is not possible to define in gmfgraph) Dashboard editor does probably not need customized figures! 43

44 Progress Topic Concepts Examples Slides Resources in Eclipse No direct access! Use wrapper for accessing resources IFile, IFolder, URI 9 14 Dialogs Use existing ones! (static & dynamic) MessageDialog, InputDialog, ResourceDialog, OCL in EMF / GMF Constraints in the model: Deployment model; Object Constraint Language OCL Console GMF: Graphical properties in the model Model vs. View Saving the position of figures in the model GMF: Architecture Model-View-Controller pattern EditParts, Figures, ModelElements GMF: Decorator 44

45 Decorator: Examples Where are the decodators? A decorator decorates an existing element by adding something Overlay images, examples above Adding behavior to a method by delegation, e.g. streams Adding components on a GUI, e.g. scrollbars Advantages: Existing element is not changed! Different decorators possible, either nested or alternative 45

46 Decorator: The Pattern Nested decorators: 1. the image 2. inner frame 3. outer frame [ Design Patterns Simply ] 46

47 Decorators: Realization in GMF 1. Implement a decorator by extending AbstractDecorator overwrite the refresh() method make sure changes to model elements are recognized: install an observer on the model element and handle updates 2. Implement a decorator provider by extending AbstractProvider and implementing IDecoratorProvider responsible for the creation of the decorator for the correct model elements 3. Register the decorator provider at the extension point: org.eclipse.gmf.runtime.diagram.ui.decorator.providers [details in 47

48 Decorator: References Gamma, E.; Helm, R.; Johnson, R. & Vlissides, J. Design Patterns: Elements of Reusable Object-Oriented Software Addison-Wesley, 1995 Design Patterns Simply: Decorating shapes in GMF (slides 44-51): GMF Tutorial: 48

49 Summary Topic Concepts Examples Slides Resources in Eclipse No direct access! Use wrapper for accessing resources IFile, IFolder, URI 9 14 Dialogs Use existing ones! (static & dynamic) MessageDialog, InputDialog, ResourceDialog, OCL in EMF / GMF Constraints in the model: Deployment model; Object Constraint Language OCL Console GMF: Graphical properties in the model Model vs. View Saving the position of figures in the model GMF: Architecture Model-View-Controller pattern EditParts, Figures, ModelElements GMF: Decorator Decorator design pattern Decorating figures; Initial state in component definition

50 Questions? 1. Questions about this tutorial? 2. Questions about the tutorials in general? 3. Questions about the project? Think about where to use these technologies in your project! 50