The goal of SimpleTransformationsChain plugin aims at gathering the [http://wiki.eclipse.org/MoDisco#Infrastructure infrastructure] and [http://wiki.eclipse.org/MoDisco#Technologies technologies] plugins and at providing orchestration of these plugins. These additional facilities reuse the features offered by the other plugins in order to allow performing more elaborate operations such as directly generating a UML model from a Java project.

+

The goal of the SimpleTransformationsChain plug-in is gathering the [[MoDisco#Infrastructure|infrastructure]] and [[MoDisco#Technologies|technologies]] plug-ins and providing orchestration of these plug-ins. These additional facilities reuse the features offered by the other plug-ins in order to allow performing more elaborate operations and complex tasks, such as directly generating a UML model from a Java project. It also provides an additional feature trying to detect bidirectional associations in target UML model.

−

=Description=

+

=Quick Start Guide=

−

After discovery of your application, you will obtain a UML model. This model could be imported in some usual modelers like Papyrus or UML2 Tools from Modeling project.

+

After discovery of your application, you will obtain a UML model. This model could be imported in some usual modelers like [http://www.eclipse.org/modeling/mdt/papyrus/ Papyrus] from the Modeling project.

−

[[Image:MoDisco_SimpleCaptchaExample_UmlModelView.jpg|center|An example of UML model discovered from famous PetStore application]]

+

[[Image:MoDisco_simpletransformationschain_tutorial_PetStore_UML_inModelBrowser.png|frame|center|An example of UML model discovered from the famous '''Pet Store''' application]]

You can launch the “Discover UML model from Java project” action from a Java project by right-clicking on the corresponding Java project (into your workspace) and then selecting the appropriate action in the provided contextual menu.

+

You can launch the "Discover UML model from Java project" action from a Java project by right-clicking on the corresponding Java project (in your workspace) and then selecting the appropriate action under '''Discovery > Discoverers''' in the provided contextual menu:

A complete bundle of Modeling components could be found at this url : http://www.eclipse.org/downloads/download.php?file=/technology/epp/downloads/release/galileo/R/eclipse-modeling-galileo-incubation-win32.zip

+

== Discoverer API ==

+

+

First, add the following plug-in dependencies to your project ('''Require-Bundle''' in your Manifest.MF):

+

* org.eclipse.uml2.uml

+

* org.eclipse.modisco.usecase.simpletransformationschain

+

* org.eclipse.modisco.infra.discovery.core

+

+

Then, you can use the following discoverer classes:

+

* DiscoverUmlModelFromJavaProject: from an IJavaProject (defined in jdt.core)

+

* DiscoverUmlModelFromProject: from an IProject

+

* DiscoverUmlModelWithBidirectionalAssociationsFromJavaProject: from an IJavaProject, with bidirectional associations

+

* DiscoverUmlModelWithBidirectionalAssociationsFromProject: from an IProject, with bidirectional associations

You could also use the the contextual menu (right click) when the project containing the Pet Store application is selected. Select '''Discovery > Discoverers > Discover Java Project''':

+

+

[[Image:MoDisco_DiscoverJavaProject_Menu.png|frame|center|Menu to discover a Java project]]

+

+

[[Image:MoDisco_simpletransformationschain_PetStore_JavaXMI_inModelBrowser.png|frame|center|The Java model, with a focus on the '''SimpleCaptcha''' class.]]

+

+

==== Get the KDM model ====

+

+

Using the ATL transformation [https://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.modisco/plugins/trunk/org.eclipse.modisco.java.discoverer/src/org/eclipse/modisco/java/discoverer/internal/resources/transformations/javaToKdm.atl javaToKdm], we will transform the Java model into a KDM model. We have to define another configuration to perform this transformation:

+

+

* Open the '''Run configurations...''' dialog

+

* Press the "New" button to create a configuration of type '''ATL Transformation'''

+

* Enter a name for this configuration, "Java to Kdm transformation" for example

[[Image:MoDisco_simpletransformationschain_tutorial_Run_Configurations-JavaToKDM.png|frame|center|configuration of the ''Java to Kdm'' ATL Transformation]]

+

+

Finally, press the '''Run''' button to get the KDM model.

+

+

You could also use the the contextual menu (right click) when the Java model of the Pet Store application is selected: '''Discovery > Discoverers > Discover KDM model from Java model'''.

+

+

[[Image:MoDisco_PetStore_kdm_xmi_inModelBrowser.png|frame|center|The KDM model, with a focus on the '''SimpleCaptcha''' class.]]

+

+

==== Get the UML model====

+

+

Using the ATL transformation [https://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.modisco/plugins/trunk/org.eclipse.modisco.kdm.uml2converter/src/org/eclipse/modisco/kdm/uml2converter/internal/resources/transformations/KDMtoUML.atl KDMtoUML], we will transform the KDM model into a UML model.

+

+

We have to define another launch configuration to perform this transformation:

+

+

* Open the '''Run configurations...''' dialog

+

* Press the "New" button to create a configuration of type '''ATL Transformation'''

+

* Enter a name for this configuration, '''Kdm to Uml transformation''' for example.

[[Image:MoDisco_Run_Configurations_DiscoveryOfPetStoreApplication.png|frame|center|The workflow configuration to execute all steps to get a UML model from a java project]]

+

+

* Finally, press the '''Run''' button to get the UML model.

+

+

This is a first way to get a UML model from a java application. However when parameters change (the selected java application, target UML model, ...), you will have to change the different configurations in order to restore the coherence of all steps, by making sure the input of each step is produced by the previous step.

+

+

===The SimpleTransformationsChain way===

+

+

* Open the '''Run configurations...''' dialog

+

* Press the '''New''' button to create a configuration of type '''MoDisco Discoverers'''.

+

* Enter a name for this configuration, "PetStore reverse to UML model" for example.

You could also use the the contextual menu (right click) when the Pet Store application project is selected: '''Discovery > Discoverers > Discover UML model from Java project'''

+

+

[[Image:MoDisco_simpletransformationschain_tutorial_PetStore_UML_inModelBrowser.png|frame|center|The UML model, with a focus on the '''SimpleCaptcha''' class.]]

+

+

==Visualize the UML model==

+

+

There are different possibilities for visualizing and exploring the target model.

+

+

===Using MoDisco model browser===

+

+

The MoDisco model browser displays the model as a tree. It proposes a view of all instances sorted by metaclass, and offers the possibility to visualize all links in the model (whether empty or not, with cardinality, etc.)

See [http://www.eclipse.org/modeling/mdt/papyrus/ the Papyrus project page]

=Current limitations=

=Current limitations=

+

+

As this component is an aggregation of existing components, its limitations reflect this architecture: the main limitations come from the [[MoDisco/Components/KDM/Documentation/0.9#Current_Limitations|KDM to UML converter]].

+

+

{{MoDisco}}

+

[[Category:MoDisco]]

Latest revision as of 03:12, 19 August 2011

The goal of the SimpleTransformationsChain plug-in is gathering the infrastructure and technologies plug-ins and providing orchestration of these plug-ins. These additional facilities reuse the features offered by the other plug-ins in order to allow performing more elaborate operations and complex tasks, such as directly generating a UML model from a Java project. It also provides an additional feature trying to detect bidirectional associations in target UML model.

Contextual menu

You can launch the "Discover UML model from Java project" action from a Java project by right-clicking on the corresponding Java project (in your workspace) and then selecting the appropriate action under Discovery > Discoverers in the provided contextual menu:

Contextual menu populated with MoDisco entries

Launch configuration

The SimpleTransformationsChain plugin is registered with the "discoverer" extension point, so in launch configurations, you are able to create a discoverer launcher dedicated to a project:

Open the launch configurations:

Launch Configurations...

Create a new MoDisco Discovery launch configuration, and select the discoverer "discoverUMLModelWithBidirectionalAssociationsFromProject" from the drop-down list:

Select the discoverer

Then, select your project in the "Source element" field:

Selecting a source project

And finally, click Run to start the discovery.

Discoverer API

First, add the following plug-in dependencies to your project (Require-Bundle in your Manifest.MF):

org.eclipse.uml2.uml

org.eclipse.modisco.usecase.simpletransformationschain

org.eclipse.modisco.infra.discovery.core

Then, you can use the following discoverer classes:

DiscoverUmlModelFromJavaProject: from an IJavaProject (defined in jdt.core)

DiscoverUmlModelFromProject: from an IProject

DiscoverUmlModelWithBidirectionalAssociationsFromJavaProject: from an IJavaProject, with bidirectional associations

DiscoverUmlModelWithBidirectionalAssociationsFromProject: from an IProject, with bidirectional associations

Setup

You may have to download several libraries to obtain an eclipse project without errors (JPA, JTA, JSF-apis and Servlets-jsp-apis).
A complete bundle is also available from Mia-Software...
To view this application in your Eclipse workspace, you will have to extract the content of this archive, and use the "import" wizard (import project in workspace).

Get UML model of Pet Store application

We will explain different ways to obtain the UML model; it will demonstrate how several simple steps have been combined to build a complex task : discover a UML model from a java project.

Basic way

There are several tools that are each able to perform a specific task; we will see how each task works.

Get the java model

Open the Run configurations... dialog.

Then, press the "New" button to create a configuration of type "MoDisco Discovery".

Enter a name for this configuration, "PetStore reverse to Java model" for example.

Select the discoverer named "org.eclipse.modisco.java.discoverer.project".

Enter the path to the project containing the PetStore application in the "Source element" field.

Set SERIALIZE_TARGET to true

Java Discoverer configuration

Finally, press the Run button to get the Java model.

You could also use the the contextual menu (right click) when the project containing the Pet Store application is selected. Select Discovery > Discoverers > Discover Java Project:

Menu to discover a Java project

The Java model, with a focus on the SimpleCaptcha class.

Get the KDM model

Using the ATL transformation javaToKdm, we will transform the Java model into a KDM model. We have to define another configuration to perform this transformation:

Open the Run configurations... dialog

Press the "New" button to create a configuration of type ATL Transformation

Enter a name for this configuration, "Java to Kdm transformation" for example

Select the ATL module in your workspace, "/Transformations/JavaToKdm.atl" for example

Select metamodel URIs from the EMF Registry (http://www.eclipse.org/MoDisco/Java/0.2.incubation/java and http://www.eclipse.org/MoDisco/kdm/action)

Note: the source metamodel parameter must be named "java" and the source model parameter must be named "IN", otherwise the transformation won't work

The workflow configuration to execute all steps to get a UML model from a java project

Finally, press the Run button to get the UML model.

This is a first way to get a UML model from a java application. However when parameters change (the selected java application, target UML model, ...), you will have to change the different configurations in order to restore the coherence of all steps, by making sure the input of each step is produced by the previous step.

The SimpleTransformationsChain way

Open the Run configurations... dialog

Press the New button to create a configuration of type MoDisco Discoverers.

Enter a name for this configuration, "PetStore reverse to UML model" for example.

You could also use the the contextual menu (right click) when the Pet Store application project is selected: Discovery > Discoverers > Discover UML model from Java project

The UML model, with a focus on the SimpleCaptcha class.

Visualize the UML model

There are different possibilities for visualizing and exploring the target model.

Using MoDisco model browser

The MoDisco model browser displays the model as a tree. It proposes a view of all instances sorted by metaclass, and offers the possibility to visualize all links in the model (whether empty or not, with cardinality, etc.)