- 1 Papyrus Oxygen API Migration Guide
- 2 API Evolution Report
- 3 Infra Layer
- 4 Toolsmiths Layer
- 5 PaletteConfiguration model
Papyrus Oxygen API Migration Guide
This document provides a guide to migrating applications that extend Papyrus to the new Oxygen version APIs.
API Evolution Report
An API Evolution Report is generated for "Neon to Oxygen" and it is available here: API Evolution Report
Following deprecated types have been removed:
|Deprectated Types||New Types|
ElementTypesConfiguration Metamodel Changes
The metamodel for the ElementTypesConfigurations has been changed to use model-based defintion of specialization relationships among elementtypes and advice ordering specification.
Although these changes don't change the underlying concepts of the elementtypesconfigurations and their extensions, they impact the
*.elementtypesconfigurations models created with this metamodel.
You'll find all the details of the changes below. A little developer tool has been developed to assist the migration in the
org.eclipse.papyrus.types.dev plugin (namely:
org.eclipse.papyrus.dev.types.handlers.MigrateSpecializations). Note that if there are specializations of elementtypes coming from multiple files, you must select all the files to migrate.
Migration of the NsURI
|Old Namespace URI||New Namespace URI|
Migration of the SpecializationTypeConfiguration
specializedTypesID attribute of
org.eclipse.papyrus.infra.types.SpecializationTypeConfiguration is now
specializedTypes. Instead of being a list of String-based identifiers of elementtypes, developers can now reference to the
org.eclipse.papyrus.infra.types.ElementTypeConfiguration to specialize at a model level directly.
Should the elementtype to reference be already defined using the extension point mechanism, developers may use an
org.eclipse.papyrus.infra.types.ExternallyRegisteredType to have a model element that is a "proxy" to the extension point definition.
Migration of the AdviceConfiguration
after attributes of
org.eclipse.papyrus.infra.types.AdviceConfiguration are now lists of
org.eclipse.papyrus.infra.types.AdviceConfiguration instead of being lists of String-based qualified names of Java classes implementing
org.eclipse.gmf.runtime.emf.type.core.edithelper.IEditHelperAdvice. Developers can now reference to the
org.eclipse.papyrus.infra.types.AdviceConfiguration to force advice execution order at a model level directly.
Should the advice to reference be already defined using the extension point mechanism, developers may use an
org.eclipse.papyrus.infra.types.ExternallyRegisteredAdvice to have a model element that is a "proxy" to the extension point definition.
A feature for expert user that creates upon Papyrus
A new feature has been created to gather all plugins utilities dedicated to create utility programs upon Papyrus. At present time, it contains the following plugins:
Focus on the DSML Configurator Plugin
In order to help expert user to create upon Papyrus, a plugin initially designed by C. Letavernier helps to generate plugin from a list of model customization. Improvement have been made:
- ModelTemplate now takes into account di and notation files in addition of uml file
- Palette has been migrated to latest version
- TableConfiguration plugin has been integrated
Nevertheless at present time, an important effort should be made to switch to View point with the generation of Architrecture file.
Switching from Ecore models to Papyrus UML models
An effort has been made to switch from pure ecore model to Papyrus UML model in all relevant plugins used in Papyrus Toolsmiths. The genmodel is now based on the UML model, it generates the Ecore model used to produce model, edit and editor plugins.
Switching from Elementtype String based references to Elementtype EReference
Papyrus is becomming more and more model based, an effort has been made to migrate all models that use Elementtype with String references to Elementtype with EReferences.
To improve user experience a set of menu and popups links has been create to gathger all sub menus and commands
Currently there is no automatic way to migrate the palette configuration from old to the new version. Later a tool should be available.
Here is a manual method to pass from old to new model.
In a papyrus instance:
- Create a copy of your palette configuration model.
- open it with a text editor
- Remove all elementTypeId attributes. (keep it in the original file)
- Save it and open it with palette configuration editor.
- For each tool, add elementType which corresponds to the elementTypeIds in the original file. Past its id in the search field is a easy way to find the corresponding element type.
- In the plugin.xml file at the palette configuration declaration. Replace org.eclipse.papyrus.uml.diagram.common.paletteDefinition by org.eclipse.papyrus.infra.gmfdiag.common.paletteDefinition.