In this tutorial we will illustrate the compartment feature of GMF.

This tutorial is based on the model built in the first tutorial.

The model files can be downloaded from this location.

Full code is availabale through :

• SVN : https://gmfsamples.svn.sourceforge.net/svnroot/gmfsamples/Filesystem/tags/tuto2-final-diagram/
• direct download : https://sourceforge.net/projects/gmfsamples/files/20091121/tuto2-final-diagram.zip/download

This tutorial has been built with :

• Eclipse 3.5.1
• Graphical Modeling Framework SDK 2.2.1
• Eclipse Modeling Framework 2.5.0

Known bugs and fixes :

• This tutorial doesn't show how to avoid compartment deletion : see this page to see how to fix it

In order to use the compartment feature, the ecore model has to evolve ; the Folder associations must be turned into agregations :

• Open the filesystem.ecore file
• In the Folder EClass, select the folders attribute.
• In the property view, set the Containment property to true.
• Repeat this operation with the files attribute of the Folder EClass.

• Regenerate the model and the EMF editor with these steps :
  • Open the filesystem.genmodel file
  • On the root item, right click and select Generate Model Code
  • Right click again on the root and select Generate Edit Code.
  • Right click again on the root and select Generate Editor Code.

The new model diagram becomes like this :

The two links creation tools become unusefull. We have to delete it.

• Open the filesystem.gmftool file
• Delete the nodes Create new FolderFolders and Create new FolderFiles
• Save the file

The two Connection become unusefull. We have to delete it.

• Open the filesystem.gmfgraph file
• Delete the nodes :
  • Connection FolderFolders
  • Connection FolderFiles
  • Polyline decoration FolderFoldersTargetDecoration
  • Polyline decoration FolderFilesTargetDecoration
  • Figure Descriptor FolderFoldersFigure
  • Figure Descriptor FolderFilesFigure
• Under the Rectangle Folder Figure node add a Rectangle child node ; this will be the graphical representation our compartment.
• In the property view, set this rectangle's name to FolderCompartmentFigure
• Under the Figure Descriptor FolderFigure, add a Child Access child node.
• Select this child access node and in the property view, select the Rectangle FolderCompartmentFigure for the figure property
• Under the Canvas filesystem node, add a Compartment child node.
• Select this node and fix its properties :
  • Accessor = Child Access getFigureFolderCompartmentFigure
  • Collapsible = true
  • Figure = Figure Descriptor FolderFigure
  • Name = FolderCompartment
  • Needs title = false
• Under the Rectangle Folder Figure node :
  • Delete the Flow Layout false node
  • Delete the Background lightGray node
  • Add a new Border Layout child node
• Under the Label FolderNameFigure node :
  • Add a Boder Layout Data
  • Select this node and set its properties in tehe property view :
    • Alignment = BEGINNING
    • Vertical = true
• Under the Rectangle FolderCompartmentFigure node :
  • Add a Boder Layout Data
  • Select this node and set its properties in tehe property view :
    • Alignment = CENTER
    • Vertical = true
• Save the file

The two Linksbecome unusefull. We will delete it.

• Open the filesystem.gmfmap file
• Delete the two Link Mapping nodes
• Under the Node Mapping <Folder/Folder> node, add two Child Reference child nodes.
• For the first Child Reference, set the properties like this :
  • Containment Feature = Folder.folders:Folder
  • Referenced Child = Node Mapping <Folder/Folder>
• For the second Child Reference, set the properties like this :
  • Containment Feature = Folder.files:File
  • Referenced Child = Node Mapping <File/File>
• Under the Node Mapping <Folder/Folder> node, add aCompartment Mapping child node.
• Select this node and set its properties like this :
  • For the property Children, select both Child reference <folders:Folder/Folder> and Child reference <files:File/File>
  • Compartment = Compartment FolderCompartment (FolderFigure)

• Delete the filesystem.gmfgen file
• Click on the label Transform of the dashboard ; this will recreate the filesystem.gmfgen file
• Open the filesystem.gmfgen file
• Select the Gen Compartment FolderFolderCompartmentEditPart node.
• Check that the List Layout property is set to false (set it to false if not).
• Do the same with the Gen Compartment FolderFolderCompartment2EditPart node
• Delete the project Filesystem.diagram (delete also project contents on disk) or at least delete the sources of this project (src folder content)
• Generate the diagram by clicking on the Generate diagram editor in the dashboard.

• Run the eclipse configuration that had been created in the first tutorial.
• Create a new diagram as in the first tutorial.
• And this is the result…

You can get the filesystem model files described in this tutorial following this link : gmf-tutorial2-filesystem-model.zip

I hope that this material will be helpful for you. If you want to support it, your help is welcome :