Skip to main content
Jump to: navigation, search

MoDisco/Components/Java/Composition/Documentation/0.9

< MoDisco‎ | Components‎ | Java‎ | Composition
Revision as of 09:54, 20 August 2010 by Fgiquel.mia-software.com (Talk | contribs) (User manual)

DEPRECATED use Template:MoDiscoTabs and Template:MoDiscoTab as explain here : Wiki Template for MoDisco

Java Composition Metamodel

Description

This metamodel JavaApplication aims at weaving a MoDisco Java Model with a MoDisco KDM Inventory Model. It relies on the core metamodel described in the kdm.source extension framework.

Such a metamodel allows to link java nodes to their physical position in the source files (JavaNodeSourceRegion metaclass owning startLine endLine properties).

As proposed in kdm.source extension framework, the reference JavaASTNodeSourceRegion.javaNode derived from ASTNodeSourceRegion.node. So as the Java2File.javaUnit from CodeUnit2File.unit.

JavaApplication Metamodel

Note : the references java2DirectoryChildren and java2FileChildren are expected to be containment references. For some technical reasons (memory usage tuning via lazy loading), they are not containment to make sure that the Java2Directory, Java2File and JavaNodeSourceRegion instances are managed in their own graph compared with JavaApplication instances (See benchmark).

Java Composition Discoverer

Description

MoDisco provides a discoverer associated to the metamodel definition described here.

The discovery takes as an entry one workspace Java project.

The first step of the discovery creates one Java model, using the associated discoverer.

The second step of the discovery creates one Kdm inventory model, using the associated discoverer.

The third step creates a model with JavaApplication metamodel instances with references to the two leaf models.

Java and kdm inventory discovery

User manual

The plug-in provides the user with a contextual menu to easily create models.

By right-clicking on a Java Project in the Eclipse Package Explorer view, you can quickly create the Java Application model of your application (see next Figure).

Discovering a JavaApplication model

The Java discovery parameters window appears for customizing the Java Model Discovery step.

Once launched, a progress bar will appear at the bottom of the window as soon as the operation begins. Depending on the size of your application, the reverse engineering process might take some time to complete (see next Figure).

Progress bar during model creation

At the end of the process, the newly created model files are added to the root of your project and the main file is automatically opened in the default editor. A xmi file suffixed by _javaapp.xmi contains the root element of the model, which refers to the .javaxmi Java model file and the _source.kdm Inventory model file. Some referenced xmi fragment files are serialized into a xmiFragmentsJavaApp' directory (see Resources distribution in benchmark).

File:TODO.png
JavaApplication xmi files in the package explorer

Once the main file _javaapp.xmi has been opened in MoDisco model Browser, you may navigate through the JavaApplication metamodel instances to the Java and kdm.source metamodels instances.

File:TODO.png
browsing the JavaApplication model

Some facets called TODO and TODO are available for allowing navigation shortcuts from some Java/Kdm.source model elements. (enabling the "Show Derived Links" option is necessary to view the shorcut links)

File:TODO.png
Apply TODO facet
File:TODO.png
Navigation shortcut from a java element to the associated source region

To take benefit of memory usage tuning (see benchmark), for huge Java legacy, the MoDisco global preferences should have the "resources loading depth" set to 1 (0 works but is less interesting for browsing). This setting allows the lazy loading of xmi fragment files, through the model navigation, for less memory usage than with a initial complete resources loading.

Setting MoDisco global loading depth preference

Using the Group by package setting will ease the selection in types panel considering the metamodels (EPackages instances) involved.

Group by package in MoDisco model browser

Discoverer API

Each MoDisco discoverer responds to a normalized interface and can be called programmatically (see org.eclipse.gmt.modisco.infra.discoverymanager.Discoverer).

As an example, you may checkout the code from org.eclipse.gmt.modisco.java.composition.discoverer.tests project.

Requirements

To use the plug-ins you need:

  • JDK 1.5 or above
  • a version of Eclipse 3.6 or above with the following set of plug-ins installed
  • EMF 2.5.0 or higher

Source Repository

All of the source code is stored in a public source repository, which you can access at:

https://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.modisco/plugins/trunk/org.eclipse.modisco.java.composition/

https://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.modisco/plugins/trunk/org.eclipse.modisco.java.composition.discoverer/

Back to the top