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
java.lang.String	getDescription() Used to return the module description.
org.eclipse.swt.graphics.Image	getImage(Profile profile, IModule.ImageType imageType) Get the image provided by the module for a given profile.
org.eclipse.swt.graphics.Image	getImage(Stereotype stereotype, IModule.ImageType type) Get the image provided by the module for a given stereotype.
java.lang.String	getLabel() Get the module's i18n label.
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.
default IModelComponentContributor	getModelComponentContributor(IModelComponent mc) Get the ModelComponent contributor associated to this module.
IModuleContext	getModuleContext() Return the context of a module, to access Modelio services.
org.eclipse.swt.graphics.Image	getModuleImage() Returns an Image for this module.
java.lang.String	getModuleImagePath() Get the path to the image representing the module.
java.lang.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

getDescription

java.lang.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.

getImage

org.eclipse.swt.graphics.Image getImage(Profile profile,
                                        IModule.ImageType imageType)

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

Parameters:

type - the image type

profile - a profile

Returns:

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

Since:

Modelio Valkyrie 3.8

getLabel

java.lang.String getLabel()

Get the module's i18n label.

getLicenseInfos

default ILicenseInfos getLicenseInfos()

getLifeCycleHandler

IModuleLifeCycleHandler getLifeCycleHandler()

Return the life cycle handler of a module.

Since:

3.5

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:

3.4

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

getModuleContext

IModuleContext getModuleContext()

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

Since:

3.5

getModuleImage

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

Returns an Image for this module.

Returns:

an Image for this module. Might be null.

getModuleImagePath

java.lang.String getModuleImagePath()

Get the path to the image representing the module.

Returns:

a path relative to the module's resource path.

getName

java.lang.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.

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.

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 IExpertise this module provides.

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

initModulecontext

void initModulecontext(IModuleContext moduleContext)

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

Parameters:

moduleContext - the module's context.

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.

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 an IExpertise 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.