Modelio API

Module developer’s API guide Modelio v4.0

Modelio is a UML and BPMN Modeler whose features can be extended by additional modules.

A module is a set of so-called contributions that can be of different nature:

• additional metamodel material used to enrich the Modelio metamodel

• additional functions (commands)

• additional GUI (views, dialogs, diagrams)

Additional commands, views and diagrams are developed in Java code using the Modelio API which is a documented set of interfaces and classes providing basic and advanced services required for the development of a module. The Modelio API is organised into several services, each of which is specific to a particular aspect of Module development. In practical terms, these services are combined in order to implement most the functionalities of a module.

The Modelio API is currently delivered as a unique jar file (modelio.jar) that is to be used in module development projects.

The development of a Modelio module, like any software development project, has a development lifecycle made of several activities like development, debugging, building, testing and so on. The Modelio API is used in development and debugging phases when Java code is relevant.

This guide is mainly addressing developers facing the question “how to use the Modelio API practically?”

Although this guide shows many code snippets and describes some methods of the Modelio API classes, it should not be considered as an exhaustive reference of the Modelio API simply because many methods and services are not detailed here.
Should he require full and fine grained details about a particular service, the reader is advised to consult the Modelio API Java Documentation.

This guide tries to illustrate and explain the principles which are the base of the Modelio API and an important part of the learning process.

Model API

• Runtime environment of a module

  • The module context

  • The modeling session

• Model services

  • access and explore model

    • basic navigation

    • advanced navigation

    • commented examples

  • transactions

  • create/modify/delete model elements

  • react to model changes (model listener)

• Metamodel services

  • Metamodel API

  • meta-navigation

Application API

• Modelio context service – Get information about Modelio

• Project context service – Get information about the project

• Module service – Access to the ‘peer’ services of the modules in the project

  • List the modules of the project

  • Call the services provided by a module

  • Manage a module’s configuration (parameters)

• Model components service – Manage the model components in the project

  • List the model components of the project

  • Deploy a model component in the project

  • Remove a model component from the project

  • Package a model component defined in the project

• Audit services – Use the Modelio Audit services

  • Audit of a model element

  • Check a model element

• Log services – Write messages in the Modelio log

  • log a message

• Script services – Evaluate Jython scripts or expressions in Modelio

  • get a Python interpreter to execute a Python script

GUI API

• Diagram services – manipulating diagrams

  • Concepts

  • API Model

  • Masking unmasking

  • Changing the diagram symbols appearance

  • Layouting the diagram

  • Jython code example

• Navigation services – manage the current selection in Modelio

  • Fire navigation events

  • React to changes

• Image services – get an icon for a model element

  • get a model element’s image

• Picking services – graphic completion mecanism

  • be a picking client

  • be a picking provider

• Edition services – open a simple text editor

  • Open a text editor

  • React to the editor save and close events

Annexes

• Diagram style properties – All available style properties for diagram elements.