org.modelio.api.module.command.standard

Class ApplyPatternStandardHandler

java.lang.Object

org.modelio.api.module.command.DefaultModuleCommandHandler

org.modelio.api.module.command.standard.ApplyPatternStandardHandler

All Implemented Interfaces:

IModuleCommandHandler

public class ApplyPatternStandardHandler
extends DefaultModuleCommandHandler

Command handler to apply a pattern.

Registered as default command handler for "PatternApply" module command verb.

The run pattern will have access to the following parameters:

• The pattern name : the selected element
• "selection" : the selected element
• "selectionName" : the selected element name
• "module" : the current module

Used handler parameters:

• "pattern_name" : the pattern name. Used to set a pattern parameter with the pattern name as key and the Modelio selected element as value
• "pattern_path" : the pattern file path relative to the module resources directory.

Since:

3.4

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMMANDPARAM_PATTERN_NAME Command parameter containing the name of the pattern to run.
static java.lang.String	COMMANDPARAM_PATTERN_PATH Command parameter containing the path of the pattern to run.
protected static java.lang.String	PATTERNPARAM_MODULE Pattern parameter name containing the current module.
protected static java.lang.String	PATTERNPARAM_SEL Pattern parameter name containing the selected element on which the pattern is run.
protected static java.lang.String	PATTERNPARAM_SEL_NAME Pattern parameter name containing the selected element name.

Constructor Summary

Constructors

Constructor and Description
ApplyPatternStandardHandler()

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
void	actionPerformed(java.util.List<MObject> selectedElements, IModule module) Method invoked when the command is launched.
protected java.util.Map<java.lang.String,java.lang.Object>	configure(java.util.List<MObject> selectedElements, IModule module) Configure the command before being executed.
protected void	postConfigure(java.util.List<MObject> selectedElements, IModule module) Hook called once the pattern is applied and before the transaction is committed.

Methods inherited from class org.modelio.api.module.command.DefaultModuleCommandHandler

findStereotypeFromSpec, getParameter, getParameters, getScopes, initialize, isActiveFor

Methods inherited from class java.lang.Object

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

Field Detail

COMMANDPARAM_PATTERN_PATH

public static final java.lang.String COMMANDPARAM_PATTERN_PATH

Command parameter containing the path of the pattern to run.

The path must be relative to the module resources path.

See Also:

Constant Field Values

COMMANDPARAM_PATTERN_NAME

public static final java.lang.String COMMANDPARAM_PATTERN_NAME

Command parameter containing the name of the pattern to run.

See Also:

Constant Field Values

PATTERNPARAM_MODULE

protected static final java.lang.String PATTERNPARAM_MODULE

Pattern parameter name containing the current module.

See Also:

Constant Field Values

PATTERNPARAM_SEL_NAME

protected static final java.lang.String PATTERNPARAM_SEL_NAME

Pattern parameter name containing the selected element name.

See Also:

Constant Field Values

PATTERNPARAM_SEL

protected static final java.lang.String PATTERNPARAM_SEL

Pattern parameter name containing the selected element on which the pattern is run.

See Also:

Constant Field Values

Constructor Detail

ApplyPatternStandardHandler

public ApplyPatternStandardHandler()

Method Detail

actionPerformed

public void actionPerformed(java.util.List<MObject> selectedElements,
                            IModule module)

Description copied from interface: IModuleCommandHandler

Method invoked when the command is launched.

This command is launched by Modelio when the user clicks on the contextual menu command. The selected elements that corresponds to the current selection are given as parameter.

The module that is passed as parameter corresponds to the owner of the command.

Parameters:

selectedElements - Current selection

module - Owner of the command

configure

protected java.util.Map<java.lang.String,java.lang.Object> configure(java.util.List<MObject> selectedElements,
                                                                     IModule module)

Configure the command before being executed.

This method is a hook called by actionPerformed(List, IModule). It returns the parameters the pattern will use.

By default copy all the command handler parameters and add the following ones:

• selection : the selectedElements selection
• module : the IModule.

Parameters:

selectedElements - the current selection in Modelio

module - the module owning the command handler.

postConfigure

protected void postConfigure(java.util.List<MObject> selectedElements,
                             IModule module)

Hook called once the pattern is applied and before the transaction is committed.

Does nothing by default. Sub classes may redefine this method to make additional modifications.

Parameters:

selectedElements - the current selection in Modelio

module - the module owning the command handler.

accept

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

Description copied from class: DefaultModuleCommandHandler

The handler accepts elements matching at least one scope

Specified by:

accept in interface IModuleCommandHandler

Overrides:

accept in class DefaultModuleCommandHandler

Parameters:

selectedElements - Current selection

module - Owner of the command

Returns:

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