org.modelio.api.module

Interface IModule

All Known Implementing Classes:

AbstractJavaModule

public interface IModule

All Modelio module classes must implement this interface.

In practice, the Modelio modules implement the IModule interface .

The IModule interface is implemented thanks to the AbstractJavaModule class.
The IModule can never be used by another module developer.
Only the peer module (IPeerModule) can be accessed, as described below:

IPeerModule module = Modelio.getInstance().getModelingSession().getModuleService().getPeerModule (ModelerModulePeerModule.class);

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IModule.ImageType

Method Summary

Modifier and Type	Method and Description
IModuleUserConfiguration	getConfiguration() Deprecated. use IModuleContext services instead
String	getDescription() Used to return the module description.
String	getDescription(PropertyDefinition pdef) Deprecated. use IModuleContext services instead
org.eclipse.swt.graphics.Image	getImage(Stereotype stereotype, IModule.ImageType type) Get the image provided by the module for a given stereotype.
ScriptEngine	getJythonEngine() Deprecated. use IModuleContext services instead
String	getLabel()
String	getLabel(ExternDocumentType docType) Deprecated. use IModuleContext services instead
String	getLabel(NoteType noteType) Deprecated. use IModuleContext services instead
String	getLabel(PropertyDefinition pdef) Deprecated. use IModuleContext services instead
String	getLabel(Stereotype stereotype) Deprecated. use IModuleContext services instead
String	getLabel(String key) Deprecated. use IModuleContext services instead
String	getLabel(TagType tagType) Deprecated. use IModuleContext services instead
default ILicenseInfos	getLicenseInfos()
IModuleLifeCycleHandler	getLifeCycleHandler() Return the life cycle handler of a module.
default IMdaExpert	getMdaExpert(Stereotype st) Get an expert for a stereotype belonging to this module.
ModuleComponent	getModel() Deprecated. use IModuleContext services instead
default IModelComponentContributor	getModelComponentContributor(IModelComponent mc) Get the ModelComponent contributor associated to this module.
IModelingSession	getModelingSession() Deprecated. use IModuleContext services instead
IModuleContext	getModuleContext() Return the context of a module, to access Modelio services.
org.eclipse.swt.graphics.Image	getModuleImage() Returns an Image for this module.
String	getModuleImagePath() Get the path to the image representing the module.
String	getName() Used to return the module name.
default IParameterEditionModel	getParametersEditionModel() Get the parameters model as it must be shown in the module parameters edition dialog.
default IPanelProvider	getParametersEditionPanel() Define a custom panel for module parameter edition.
IPeerModule	getPeerModule() Returns the peer module, connected to this module.
Version	getRequiredModelioVersion() Returns the minimum Modelio version that authorize the Module to be activated.
Version	getVersion() Used to return the module version.
default void	init() Method automatically called just after the creation of the module.
void	initModulecontext(IModuleContext moduleContext) Reserved for compatibility M3.4 M3.5.
default void	initParametersEditionModel(IParameterEditionModel model) Initialize the parameters model from the module.xml file at module install.
default void	uninit() Method automatically called just before the disposal of the module.

Method Detail

getConfiguration

@Deprecated
IModuleUserConfiguration getConfiguration()

Deprecated. use IModuleContext services instead

Get the configuration associated to this module. Module configuration provide access to module parameter and resource paths

Returns:

the module configuration.

See Also:

IModuleUserConfiguration

getDescription

String getDescription()

Used to return the module description.

Returns:

The module description

getImage

org.eclipse.swt.graphics.Image getImage(Stereotype stereotype,
                                        IModule.ImageType type)

Get the image provided by the module for a given stereotype. The module should return an image if the stereotype is provided by itself, null in the other case. The image life cycle must be handled by the module.

Parameters:

stereotype - a stereotype

type - the image type

Returns:

the stereotype image, or null if the module provides none.

getJythonEngine

@Deprecated
ScriptEngine getJythonEngine()

Deprecated. use IModuleContext services instead

Get the Jython scripting engine configured for having access to all the module classes and the public classes of all required modules. The following variables are already bound:

• SESSION : the MDA modeling session
• IModule MODULE : this module
• ClassLoader CLASSLOADER : the class loader of the module

Returns:

The Jython scripting engine.

See Also:

The Jython project homepage

getLabel

@Deprecated
String getLabel(Stereotype stereotype)

Deprecated. use IModuleContext services instead

getLabel

@Deprecated
String getLabel(TagType tagType)

Deprecated. use IModuleContext services instead

getLabel

@Deprecated
String getLabel(NoteType noteType)

Deprecated. use IModuleContext services instead

getLabel

@Deprecated
String getLabel(ExternDocumentType docType)

Deprecated. use IModuleContext services instead

getLabel

String getLabel()

getLabel

@Deprecated
String getLabel(String key)

Deprecated. use IModuleContext services instead

getLabel

@Deprecated
String getLabel(PropertyDefinition pdef)

Deprecated. use IModuleContext services instead

getDescription

@Deprecated
String getDescription(PropertyDefinition pdef)

Deprecated. use IModuleContext services instead

getLicenseInfos

default ILicenseInfos getLicenseInfos()

getModel

@Deprecated
ModuleComponent getModel()

Deprecated. use IModuleContext services instead

Returns the ModuleComponent model associated with this module.

Returns:

the ModuleComponent model associated with this module.

getModelComponentContributor

default IModelComponentContributor getModelComponentContributor(IModelComponent mc)

Get the ModelComponent contributor associated to this module.

Parameters:

mc - the Model component being built.

Returns:

the module configuration.

See Also:

IModelComponentContributor

getModelingSession

@Deprecated
IModelingSession getModelingSession()

Deprecated. use IModuleContext services instead

Returns the modeling session this module is loaded into.

Returns:

the modeling session this module is loaded into.

getModuleImage

org.eclipse.swt.graphics.Image getModuleImage()

Returns an Image for this module.

Returns:

an Image for this module. Might be null.

getName

String getName()

Used to return the module name.

The module name corresponds to the name of the module, as defined in the MDA Designer tool.

Returns:

The module name

getParametersEditionModel

default IParameterEditionModel getParametersEditionModel()

Get the parameters model as it must be shown in the module parameters edition dialog.

Returns:

The parameters edition model.

getPeerModule

IPeerModule getPeerModule()

Returns the peer module, connected to this module.

The peer module represents the public services of this current module.

Returns:

The associated peer module

getRequiredModelioVersion

Version getRequiredModelioVersion()

Returns the minimum Modelio version that authorize the Module to be activated.

Returns:

The minimum Modelio version

getVersion

Version getVersion()

Used to return the module version.

Returns:

The module version

init

default void init()

Method automatically called just after the creation of the module.

The module is automatically instantiated at the beginning of the mda lifecycle and the constructor implementation is not accessible to the module developer.

The init method allows the developer to execute the desired initialization code at this step. For example, this is the perfect place to register any IViewpoint this module provides.

This method should never be called by the developer because it is already invoked by the tool.

uninit

default void uninit()

Method automatically called just before the disposal of the module.

The uninit method allows the developer to execute the desired un-initialization code at this step. For example, if IViewpoints have been registered in the init() method, this method is the perfect place to remove them.

This method should never be called by the developer because it is already invoked by the tool.

getModuleImagePath

String getModuleImagePath()

Get the path to the image representing the module.

Returns:

a path relative to the module's resource path.

getParametersEditionPanel

default IPanelProvider getParametersEditionPanel()

Define a custom panel for module parameter edition. Input will be an set as an IParameterEditionModel.

Returns:

a IPanelProvider. Might be null to use the standard Modelio implementation.

initParametersEditionModel

default void initParametersEditionModel(IParameterEditionModel model)

Initialize the parameters model from the module.xml file at module install.

It might be manually modified later.

Parameters:

model - The parameters edition model.

getMdaExpert

default IMdaExpert getMdaExpert(Stereotype st)

Get an expert for a stereotype belonging to this module.
Might return null.

Parameters:

st - a stereotype owned by the current module.

Since:

Modelio 3.4

getModuleContext

IModuleContext getModuleContext()

Return the context of a module, to access Modelio services.

Since:

Modelio 3.5

getLifeCycleHandler

IModuleLifeCycleHandler getLifeCycleHandler()

Return the life cycle handler of a module.

Since:

Modelio 3.5

initModulecontext

void initModulecontext(IModuleContext moduleContext)

Reserved for compatibility M3.4 M3.5. Not intended for use.

Parameters:

moduleContext -