org.modelio.api.module.command

Class DefaultModuleCommandHandler

java.lang.Object

org.modelio.api.module.command.DefaultModuleCommandHandler

All Implemented Interfaces:

IModuleCommandHandler

Direct Known Subclasses:

AbstractCreateMatrixCommandHandler, ApplyPatternStandardHandler, ElementCreationStandardHandler, GenDocCommandStandardHandler, RunJythonScriptBasicHandler

public abstract class DefaultModuleCommandHandler
extends java.lang.Object
implements IModuleCommandHandler

Default implementation of the IModuleCommandHandler interface.

This default implementation may be inherited by the module developers in order to simplify the code writing of a contextual command.

Constructor Summary

Constructors

Constructor and Description
DefaultModuleCommandHandler()

Method Summary

Modifier and Type	Method and Description
boolean	accept(java.util.List<MObject> selectedElements, IModule module) The handler accepts elements matching at least one scope
Stereotype	findStereotypeFromSpec(IModule module, MClass metaclass, java.lang.String stereotypeSpec) Find the stereotype from a stereotype specification.
java.lang.String	getParameter(java.lang.String key) get a parameter value.
java.util.Map<java.lang.String,java.lang.String>	getParameters()
java.util.List<ElementScope>	getScopes()
void	initialize(java.util.List<ElementScope> scopes, java.util.Map<java.lang.String,java.lang.String> hParameters) This method is called right after the constructor to initialize scopes and parameters for the handler.
boolean	isActiveFor(java.util.List<MObject> selectedElements, IModule module) The handler is active by default.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.modelio.api.module.command.IModuleCommandHandler

actionPerformed

Constructor Detail

DefaultModuleCommandHandler

public DefaultModuleCommandHandler()

Method Detail

accept

public boolean accept(java.util.List<MObject> selectedElements,
                      IModule module)

The handler accepts elements matching at least one scope

Specified by:

accept in interface IModuleCommandHandler

Parameters:

selectedElements - Current selection

module - Owner of the command

Returns:

true if the command is valid for all the elements, false otherwise.

isActiveFor

public boolean isActiveFor(java.util.List<MObject> selectedElements,
                           IModule module)

The handler is active by default.

Specified by:

isActiveFor in interface IModuleCommandHandler

Parameters:

selectedElements - Current selection

module - Owner of the command

Returns:

false if the command has to be grayed, false otherwise.

initialize

public void initialize(java.util.List<ElementScope> scopes,
                       java.util.Map<java.lang.String,java.lang.String> hParameters)

Description copied from interface: IModuleCommandHandler

This method is called right after the constructor to initialize scopes and parameters for the handler.

Specified by:

initialize in interface IModuleCommandHandler

getParameter

public java.lang.String getParameter(java.lang.String key)

get a parameter value.

Parameters:

key - a parameter key

Returns:

the parameter value

findStereotypeFromSpec

public final Stereotype findStereotypeFromSpec(IModule module,
                                               MClass metaclass,
                                               java.lang.String stereotypeSpec)

Find the stereotype from a stereotype specification.

The stereotype specification may have one of the following formats:

• stereotype name
• module name#stereotype name
• module regex#stereotype name
• module regex#stereotype regex

Returns null if the specification is null or the stereotype is not found.

Parameters:

module - the module

metaclass - the metaclass to look from

stereotypeSpec - the stereotype specification

Returns:

the found stereotype or null.

getParameters

public java.util.Map<java.lang.String,java.lang.String> getParameters()

Specified by:

getParameters in interface IModuleCommandHandler

getScopes

public java.util.List<ElementScope> getScopes()

Specified by:

getScopes in interface IModuleCommandHandler