com.modeliosoft.modelio.api.mdac

Class AbstractJavaMdac

java.lang.Object

com.modeliosoft.modelio.api.mdac.AbstractJavaMdac

All Implemented Interfaces:

IMdac

public abstract class AbstractJavaMdac
extends Object
implements IMdac

Default implementation of the IMdac interface.

All Modelio java modules should inherit from this class.

Structure Diagram

Nested Class Summary

Nested classes/interfaces inherited from interface com.modeliosoft.modelio.api.mdac.IMdac

IMdac.ImageType, IMdac.MdacState

Field Summary

Fields

Modifier and Type	Field and Description
protected IParameterEditionModel	parameterEditionModel
protected List<IMdacPropertyPage>	propertyPages

Constructor Summary

Constructors

Constructor and Description
AbstractJavaMdac(IModelingSession modelingSession, IModule mdacHandle, IMdacConfiguration mdacConfiguration) Main constructor, to instantiate a new module.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<IMdacAction>	getActions(ActionLocation location) Returns the collection of IMdacAction associated with passed location.
IMdacConfiguration	getConfiguration() Get the configuration associated to this module.
String	getDescription() Used to return the module description.
long	getHid() Returns the high internal identifier of the module
org.eclipse.swt.graphics.Image	getImage(IStereotype stereotype, IMdac.ImageType type) Get the image provided by the module for a given stereotype.
org.eclipse.jface.resource.ImageDescriptor	getImageDescriptor(IStereotype stereotype, IMdac.ImageType imageType) Get the image descriptor provided by the module for a given stereotype.
ScriptEngine	getJythonEngine() Get the Jython scripting engine configured for having access to all the module classes and the public classes of all required modules.
String	getLabel() Get the module label that is displayed in dialog boxes and other GUIU parts.
long	getLid() Returns the low internal identifier of the module
Collection<IMdacAction>	getMdacActions(ActionLocation location) Deprecated.
String	getMdacImage() Get the path to the image representing the mdac.
org.eclipse.jface.resource.ImageDescriptor	getMdacImageDescriptor() Returns an ImageDescriptor for this module.
IModule	getModel() Returns the IModule model associated with this module.
IModelComponentContributor	getModelComponentContributor() Get the configuration associated to this module.
IModelingSession	getModelingSession() Returns the modeling session this module is loaded into.
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.
Collection<IMdacPropertyPage>	getPropertyPages() Return the defined property pages
Version	getRequiredModelioVersion() Returns the minimum Modelio version that authorize the MDAC to be activated.
IMdac.MdacState	getState() Returns current runtime state of this module.
Version	getVersion() Used to return the module version.
Collection<IWorkbenchAction>	getWorkbenchActions(WorkbenchActionLocation location) Deprecated. not used anymore, kept for compatibility reasons only.
int	hashCode()
void	init() Method automatically called just after the creation of the mdac.
void	registerAction(ActionLocation location, IMdacAction action) Register a module action for the contextual popupmenu(s) of the application.
void	setState(IMdac.MdacState runtimeState) Sets the runtime state of this module.
String	toString()
void	uninit() Method automatically called just before the disposal of the mdac.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.modeliosoft.modelio.api.mdac.IMdac

getPeerMdac, getSession

Field Detail

parameterEditionModel

protected IParameterEditionModel parameterEditionModel

propertyPages

protected List<IMdacPropertyPage> propertyPages

Constructor Detail

AbstractJavaMdac

public AbstractJavaMdac(IModelingSession modelingSession,
                IModule mdacHandle,
                IMdacConfiguration mdacConfiguration)

Main constructor, to instantiate a new module.

Parameters:

modelingSession - the current session.

mdacHandle - the IModule representing this module in the model.

mdacConfiguration - the configuration of this module.

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getActions

public List<IMdacAction> getActions(ActionLocation location)

Returns the collection of IMdacAction associated with passed location.

Specified by:

getActions in interface IMdac

Parameters:

location - the location for which actions are to be returned.

Returns:

the collection of IMdacAction associated with passed location.

getConfiguration

public IMdacConfiguration getConfiguration()

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

Specified by:

getConfiguration in interface IMdac

Returns:

the module configuration.

See Also:

IMdacConfiguration

getDescription

public String getDescription()

Used to return the module description.

Specified by:

getDescription in interface IMdac

Returns:

The module description

getHid

public long getHid()

Returns the high internal identifier of the module

Specified by:

getHid in interface IMdac

Returns:

The high internal identifier of the module

getImage

public org.eclipse.swt.graphics.Image getImage(IStereotype stereotype,
                                      IMdac.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 IMdac

Parameters:

stereotype - a stereotype

type - the image type

Returns:

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

getImageDescriptor

public org.eclipse.jface.resource.ImageDescriptor getImageDescriptor(IStereotype stereotype,
                                                            IMdac.ImageType imageType)

Get the image descriptor 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.

Specified by:

getImageDescriptor in interface IMdac

Parameters:

stereotype - a stereotype

imageType - the image type

Returns:

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

getJythonEngine

public ScriptEngine getJythonEngine()

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
• IMdac MODULE : this module
• ClassLoader CLASSLOADER : the class loader of the module

Specified by:

getJythonEngine in interface IMdac

Returns:

The Jython scripting engine.

See Also:

The Jython project homepage

getLabel

public String getLabel()

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

Specified by:

getLabel in interface IMdac

Returns:

The module label.

getLid

public long getLid()

Returns the low internal identifier of the module

Specified by:

getLid in interface IMdac

Returns:

The low internal identifier of the module

getMdacActions

@Deprecated
public Collection<IMdacAction> getMdacActions(ActionLocation location)

Deprecated.

Returns the collection of IMdacAction associated with passed location.

Specified by:

getMdacActions in interface IMdac

Parameters:

location - the location for which actions are to be returned.

Returns:

the collection of IMdacAction associated with passed location.

getMdacImage

public String getMdacImage()

Get the path to the image representing the mdac.

Returns:

a path relative to the module's resource path.

getMdacImageDescriptor

public org.eclipse.jface.resource.ImageDescriptor getMdacImageDescriptor()

Returns an ImageDescriptor for this module.

Specified by:

getMdacImageDescriptor in interface IMdac

Returns:

an ImageDescriptor for this module.

getModel

public IModule getModel()

Returns the IModule model associated with this module.

Specified by:

getModel in interface IMdac

Returns:

the IModule model associated with this module.

getModelingSession

public IModelingSession getModelingSession()

Returns the modeling session this module is loaded into.

Specified by:

getModelingSession in interface IMdac

Returns:

the modeling session this module is loaded into.

getName

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

Returns:

The module name

getParametersEditionModel

public IParameterEditionModel getParametersEditionModel()

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

Specified by:

getParametersEditionModel in interface IMdac

Returns:

The parameters edition model.

getPropertyPages

public Collection<IMdacPropertyPage> getPropertyPages()

Return the defined property pages

Specified by:

getPropertyPages in interface IMdac

Returns:

The collection of property pages

getModelComponentContributor

public IModelComponentContributor getModelComponentContributor()

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

Specified by:

getModelComponentContributor in interface IMdac

Returns:

the module configuration.

See Also:

IMdacConfiguration

getRequiredModelioVersion

public Version getRequiredModelioVersion()

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

Specified by:

getRequiredModelioVersion in interface IMdac

Returns:

The minimum Modelio version

getVersion

public Version getVersion()

Used to return the module version.

Specified by:

getVersion in interface IMdac

Returns:

The module version

getWorkbenchActions

@Deprecated
public Collection<IWorkbenchAction> getWorkbenchActions(WorkbenchActionLocation location)

Deprecated. not used anymore, kept for compatibility reasons only.

Returns the collection of IMdacAction associated with passed workbench location.

Specified by:

getWorkbenchActions in interface IMdac

Parameters:

location - the workbench location for which actions are to be returned.

Returns:

the collection of IMdacAction associated with passed workbench location.

init

public void init()

Method automatically called just after the creation of the mdac.

The mdac is automatically instantiated at the beginning of the mda lifecycle and the constructor implementation is not accessible to the mdac 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 mdac provides.

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

Specified by:

init in interface IMdac

registerAction

public void registerAction(ActionLocation location,
                  IMdacAction action)

Register a module action for the contextual popupmenu(s) of the application.

Specified by:

registerAction in interface IMdac

Parameters:

location - The action insertion point in the popupmenu (see ActionLocation)

action - Action to store

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getState

public IMdac.MdacState getState()

Returns current runtime state of this module.

Specified by:

getState in interface IMdac

Returns:

the current runtime state of this module.

setState

public void setState(IMdac.MdacState runtimeState)

Sets the runtime state of this module.

This method is not meant to be called by clients. Use of this method can result in unspecified behaviours.

Parameters:

runtimeState - the new runtime state of this module.

uninit

public void uninit()

Method automatically called just before the disposal of the mdac.

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.

Specified by:

uninit in interface IMdac