Module Developer Guide Index

About this guide

This guide explains how to develop modules for Modelio.Concretely, this guide presents a simplified real case study and a tutorial. It goes into detail down to code level when required and when there is a real added value in these details, and remains more general in well known and explored domains.

After reading this document, the reader should be able to create, package and deploy its own modules or modify existing modules, with a clear view of mechanisms and their implementation in Modelio.

Beside the big picture this guide provides, the detailed information about the Modelio API can be found here :

• Module Reference Guide: detailed description of directory structure and the files required to build a module as well as the documentation of XML files

What is a Module ?

Module or Macro ? * What is a macro ? * Comparison between macro and module

Modelio project concepts

Module concepts

• Identifier

• Module

• Profiles

• UML extensions

• Module commands

• GUI features

• Model management

  • Model navigation

  • Transactions

  • Model events

• Runtime Phases

• Peers services

Module project development structure

• Maven development structure

Sample module design (Example of Junit module)

Module development tutorial

• Setting up the Development Environment

• Creating the module – basics

  • Module declaration

  • Module Java classes

  • Creating a module profile

  • Creating module stereotypes

    • Stereotypes declaration

    • Adding icons to a stereotype

  • Creating module commands

    • Command declaration

    • Command Java class

    • Writing command method

  • Processing commands: model transformation

    • Step 1: Checking for an already existing test case

    • Step 2: Creating/updating the test model hierarchy

    • Step 3: Creating the test model class

    • Step 4: Adding the [JUnit] stereotype to the test model class

    • Step 5: Establishing the [JUnit] dependency link

    • Step 6: Adding the test class features

  • Catching modeling events

    • A bit of theory: module model events

    • Event handling or listening

    • Implementation example

  • Creating a module property page

    • Property page declaration

    • Commands associated with the property page

    • Coding the property page behavior

  • Creating a customized diagram

• Packaging the module

• Updating the version

Debugging the module with Eclipse

• Creating the JRE configuration

• Creating the target configuration

• Creating the debug configuration

• Launching Modelio under Eclipse debugger