org.modelio.api.module.command.standard

Class ElementCreationStandardHandler

java.lang.Object

org.modelio.api.module.command.DefaultModuleCommandHandler

org.modelio.api.module.command.standard.ElementCreationStandardHandler

All Implemented Interfaces:

IModuleCommandHandler

Direct Known Subclasses:

DiagramCreationStandardHandler

public class ElementCreationStandardHandler
extends DefaultModuleCommandHandler

Generic model element creation command handler.

This handler supports the following parameters;

• name : the handler identifier
• metaclass : the metaclass name
• stereotype : the stereotype name. May be a regular expression. May be "module#stereotype" where module and stereotype are plain text or regular expression. "#" must not be used in the module or stereotype name.
• relation : the meta relation name from the owner to the new element.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CREATION_NAME Command parameter containing the name of the element to create.
static java.lang.String	METACLASS_NAME Command parameter containing the metaclass of the element to create.
static java.lang.String	RELATION_NAME Command parameter containing the created element's relation towards its parent.
static java.lang.String	STEREOTYPE_NAME Command parameter created element's stereotype.

Constructor Summary

Constructors

Constructor and Description
ElementCreationStandardHandler() Default constructor.

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.lang.String	getMetaclass()
protected java.lang.String	getName()
protected java.lang.String	getRelation()
protected java.lang.String	getStereotype()
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.
protected void	postConfigureElement(MObject newElement, IModule module) Hook called once the element is created and configured and before the transaction is committed.

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

findStereotypeFromSpec, getParameter, getParameters, getScopes, isActiveFor

Methods inherited from class java.lang.Object

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

Field Detail

CREATION_NAME

public static final java.lang.String CREATION_NAME

Command parameter containing the name of the element to create.

See Also:

Constant Field Values

METACLASS_NAME

public static final java.lang.String METACLASS_NAME

Command parameter containing the metaclass of the element to create.

See Also:

Constant Field Values

STEREOTYPE_NAME

public static final java.lang.String STEREOTYPE_NAME

Command parameter created element's stereotype. Might be null.

See Also:

Constant Field Values

RELATION_NAME

public static final java.lang.String RELATION_NAME

Command parameter containing the created element's relation towards its parent. null means the default composition relation is used.

See Also:

Constant Field Values

Constructor Detail

ElementCreationStandardHandler

public ElementCreationStandardHandler()

Default constructor.

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

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.

postConfigureElement

protected void postConfigureElement(MObject newElement,
                                    IModule module)

Hook called once the element is created and configured and before the transaction is committed.

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

Deleting "newElement" in this method triggers an automatic rollback for the current transaction.

Parameters:

newElement - the new created element

module - the module

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

Overrides:

initialize in class DefaultModuleCommandHandler

getName

protected java.lang.String getName()

Returns:

the created element's name.

getMetaclass

protected java.lang.String getMetaclass()

Returns:

the created element's metaclass.

getRelation

protected java.lang.String getRelation()

Returns:

the created element's relation towards its parent. null means the default composition relation is used.

getStereotype

protected java.lang.String getStereotype()

Returns:

the created element's stereotype. Might be null.