org.modelio.api.module

Class AbstractJavaModule

java.lang.Object

org.modelio.api.module.AbstractJavaModule

All Implemented Interfaces:

IModule

public abstract class AbstractJavaModule
extends java.lang.Object
implements IModule

Default implementation of the IModule interface.

All Modelio java modules should inherit from this class.

Nested Class Summary

Nested classes/interfaces inherited from interface org.modelio.api.module.IModule

IModule.ImageType

Field Summary

Fields

Modifier and Type	Field and Description
protected org.eclipse.jface.resource.ImageRegistry	imageRegistry The module image registry.
protected IParameterEditionModel	parameterEditionModel

Constructor Summary

Constructors

Constructor and Description
AbstractJavaModule(IModuleContext moduleContext) Main constructor, to instantiate a new module.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
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 label that is displayed in dialog boxes and other GUI parts.
ILicenseInfos	getLicenseInfos()
IModuleContext	getModuleContext() Return the context of a module, to access Modelio services.
org.eclipse.swt.graphics.Image	getModuleImage() Returns an Image for this module.
abstract java.lang.String	getModuleImagePath() Get the path to the image representing the module.
java.lang.String	getName() Used to return the module name.
IParameterEditionModel	getParametersEditionModel() Get the parameters model as it must be shown in the module parameters edition dialog.
Version	getRequiredModelioVersion() Returns the minimum Modelio version that authorize the Module to be activated.
Version	getVersion() Used to return the module version.
int	hashCode()
void	initModulecontext(IModuleContext context) Reserved for M3.4/M3.5 compatibility.
void	initParametersEditionModel(IParameterEditionModel model) Register the given parameter model as the fall back parameter edition model if the module implementation does not define a custom one.
java.lang.String	toString()
void	uninit() Method automatically called just before the disposal of the module.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.modelio.api.module.IModule

getLifeCycleHandler, getMdaExpert, getModelComponentContributor, getParametersEditionPanel, getPeerModule, init

Field Detail

imageRegistry

protected org.eclipse.jface.resource.ImageRegistry imageRegistry

The module image registry.

This registry contains the module stereotypes images and icons. This registry is disposed when the module is unloaded.

Sub classes may use it to store other images as well.
Sub classes should not set this property to another registry.

parameterEditionModel

protected IParameterEditionModel parameterEditionModel

Constructor Detail

AbstractJavaModule

public AbstractJavaModule(IModuleContext moduleContext)

Main constructor, to instantiate a new module.

Parameters:

moduleContext - access point to Modelio services.

Since:

3.5

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getDescription

public java.lang.String getDescription()

Used to return the module description.

Specified by:

getDescription in interface IModule

Returns:

The module description

getImage

public 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.

Specified by:

getImage in interface IModule

Parameters:

stereotype - a stereotype

type - the image type

Returns:

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

getImage

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

Description copied from interface: IModule

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.

Specified by:

getImage in interface IModule

Parameters:

profile - a profile

Returns:

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

getLabel

public java.lang.String getLabel()

Get the module label that is displayed in dialog boxes and other GUI parts.

Specified by:

getLabel in interface IModule

Returns:

The module label.

getLicenseInfos

public ILicenseInfos getLicenseInfos()

Specified by:

getLicenseInfos in interface IModule

getModuleContext

public final IModuleContext getModuleContext()

Description copied from interface: IModule

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

Specified by:

getModuleContext in interface IModule

getModuleImage

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

Description copied from interface: IModule

Returns an Image for this module.

Specified by:

getModuleImage in interface IModule

Returns:

an Image for this module. Might be null.

getModuleImagePath

public abstract java.lang.String getModuleImagePath()

Get the path to the image representing the module.

Specified by:

getModuleImagePath in interface IModule

Returns:

a path relative to the module's resource path.

getName

public 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.

Specified by:

getName in interface IModule

Returns:

The module name

getParametersEditionModel

public IParameterEditionModel getParametersEditionModel()

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

This default implementation returns a parameter model computed from the 'module.xml' file unless the module implementation filled the parameterEditionModel member.

Specified by:

getParametersEditionModel in interface IModule

Returns:

The parameters edition model.

getRequiredModelioVersion

public Version getRequiredModelioVersion()

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

Specified by:

getRequiredModelioVersion in interface IModule

Returns:

The minimum Modelio version

getVersion

public Version getVersion()

Used to return the module version.

Specified by:

getVersion in interface IModule

Returns:

The module version

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

initModulecontext

public final void initModulecontext(IModuleContext context)

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

Specified by:

initModulecontext in interface IModule

Parameters:

context - the module's context.

initParametersEditionModel

public final void initParametersEditionModel(IParameterEditionModel model)

Register the given parameter model as the fall back parameter edition model if the module implementation does not define a custom one.

Specified by:

initParametersEditionModel in interface IModule

Parameters:

model - The parameters edition model.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

uninit

public void uninit()

Description copied from interface: IModule

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 IModule.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.

Specified by:

uninit in interface IModule