Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
ATL/Model Handlers
In ATL engine terminology, a model handler is a library providing primitives for handling models:
- Creating new models,
- Loading and saving models,
- Adding and deleting elements,
- Reading and writing element properties.
A model handler driver is a piece of Java code making it possible to use the corresponding model handler with the ATL Virtual Machine.
The current version of ATL Virtual Machine provides three model handler drivers:
- emf4atl to use Eclipse/EMF,
- mdr4atl to use Netbeans/MDR.
- uml24atl to use UML2.
Creating New Model Handler Drivers
Here is a brief description of the work to be done (see CVS Links table below for links to source code):
- Extend ASMModel to implement specific model-level behavior. There are already two examples: ASMEMFModel, and ASMMDRModel.
- Extend ASMModelElement to implement specific model-element-level behavior. There are already two examples: ASMEMFModelElement, and ASMMDRModelElement.
- Extend AtlModelHandler to implement model loading and saving. There are already two examples: AtlEMFModelHandler, and AtlMDRModelHandler.
- Use the
org.atl.eclipse.engine.modelhandler
extension in your plugin.xml to register your model handler driver. There is already one example: mdr4atl plugin.xml.
ATL Development Tools strongly depend on emf4atl, which is consequently built into it. mdr4atl should rather be used as an example for properly placing Java classes and plugin.xml elements.
Entity | M2M/ATL/deprecated (moved from GMT/ATL CVS) | M2M/ATL/plugins CVS (current location) | |||
---|---|---|---|---|---|
Eclipse/EMF | Netbeans/MDR | Eclipse/EMF | Netbeans/MDR | UML2 | |
plugin | emf4atl | mdr4atl | emf4atl | mdr4atl | uml24atl |
ASMModel | ASMModel | ASMModel | |||
ASM<ModelHandler>Model | ASMEMFModel | ASMMDRModel | ASMEMFModel | ASMMDRModel | ASMUMLModel |
ASMModelElement | ASMModelElement | ASMModelElement | |||
ASM<ModelHandler>ModelElement | ASMEMFModelElement | ASMMDRModelElement | ASMEMFModelElement | ASMMDRModelElement | ASMUMLModelElement |
AtlModelHandler | AtlModelHandler | AtlModelHandler | |||
Atl<ModelHandler>ModelHandler | AtlEMFModelHandler | AtlMDRModelHandler | AtlEMFModelHandler | AtlMDRModelHandler | AtlUML2ModelHandler |
When to Create a New Model Handler Driver
In theory, there should be a distinct model handler driver for each model handler, independently of the metamodel that is used. For instance, there is one for Eclipse/EMF and one for Netbeans/MDR.
In practice, there are exceptions. For instance, the Eclipse/UML2 plugin implements the UML 2.0 metamodel by using EMF. However, it seems that UML2 models created with this plugin cannot be handled by EMF without the additional Java code available in the Eclipse/UML2 plugin (see ATL_Language_Troubleshooter#UML2_Profiles and this thread). This means that the UML2 metamodel that is implemented does not strictly follow EMF rules but adds its own rules. One example is profile and stereotype application: the profile must be applied before the stereotype. Such an ordering constraint is beyond EMF semantics. For this reason, full support for the Eclipse/UML2 plugin can only be properly achieved by adding code specific to this plugin in the model handler driver. Instead of doing this in emf4atl, which is metamodel-independant, the uml24atl model handler driver has been developed.