com.modeliosoft.modelio.api.module.commands.standard

Class CreateMatrixStandardCommandHandler

java.lang.Object

org.modelio.api.module.command.DefaultModuleCommandHandler

com.modeliosoft.modelio.api.module.commands.AbstractCreateMatrixCommandHandler

com.modeliosoft.modelio.api.module.commands.standard.CreateMatrixStandardCommandHandler

All Implemented Interfaces:

IModuleCommandHandler

public class CreateMatrixStandardCommandHandler
extends AbstractCreateMatrixCommandHandler

Generic implementation of IMatrixWizardContributor that creates a matrix from the attached matrix descriptor.

Used parameters:

• "stereotype" the stereotype specification.
• "x" : the matrix descriptor identifier, registered by the module
• "matrix_name" : the matrix name. The parameter value may contain "$name" that will be replaced by the matrix owner name.
• "use_additions" : whether or not a query can receive manual additions. The parameter value must contain "true" or "false".

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PARAM_DESCRIPTOR Command parameter for the matrix descriptor identifier.
static java.lang.String	PARAM_MATRIX_NAME Command parameter for the matrix name.
static java.lang.String	PARAM_QUERY_USE_ADDITIONS Command parameter for a query.

Constructor Summary

Constructors

Constructor and Description
CreateMatrixStandardCommandHandler()

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.util.List<MObject> selectedElements, IModule module) Method invoked when the command is launched.
protected java.lang.String	computeMatrixDescription(ModelElement matrixContext, IModule module) Compute a description note content to put on the matrix.
protected java.lang.String	computeMatrixName(ModelElement matrixContext, IModule module) Compute the matrix name.
protected void	copyParameters(java.util.Map<java.lang.String,java.lang.String> source, PropertyTable target) Copy the source parameters to the given property table.
protected QueryDefinition	createQueryDefinition(IModule module, java.lang.String implementationClassName, java.util.Map<java.lang.String,java.lang.String> parameters) Creates a QueryDefinition to be used as line, column or depth query.
protected MatrixDescriptor	getDescriptor(ModelElement matrixContext, IModule module) Get the MatrixDescriptor that will be used to create the MatrixDefinition model from this command handler parameters.
protected void	postConfigure(MatrixDefinition matrix, ModelElement matrixContext, IModule module) Hook called after a matrix is created.

Methods inherited from class com.modeliosoft.modelio.api.module.commands.AbstractCreateMatrixCommandHandler

createExternProcessor, createMatrixValueDefinition, createQueryDefinition, isActiveFor

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

accept, findStereotypeFromSpec, getParameter, getParameters, getScopes, initialize

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_DESCRIPTOR

public static final java.lang.String PARAM_DESCRIPTOR

Command parameter for the matrix descriptor identifier.

See Also:

Constant Field Values

PARAM_MATRIX_NAME

public static final java.lang.String PARAM_MATRIX_NAME

Command parameter for the matrix name.

The parameter value may contain "$name" that will be replaced by the matrix owner name.

See Also:

Constant Field Values

PARAM_QUERY_USE_ADDITIONS

public static final java.lang.String PARAM_QUERY_USE_ADDITIONS

Command parameter for a query.

The parameter value must contain "true" or "false".

See Also:

Constant Field Values

Constructor Detail

CreateMatrixStandardCommandHandler

public CreateMatrixStandardCommandHandler()

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

copyParameters

protected void copyParameters(java.util.Map<java.lang.String,java.lang.String> source,
                              PropertyTable target)

Copy the source parameters to the given property table.

Parameters:

source - the source parameters.

target - the target property table.

getDescriptor

protected MatrixDescriptor getDescriptor(ModelElement matrixContext,
                                         IModule module)
                                  throws java.lang.IllegalStateException

Get the MatrixDescriptor that will be used to create the MatrixDefinition model from this command handler parameters.

By default reads the matrix descriptor identifier in the "x" command parameter and asks the IMatrixDescriptorService Modelio service for it.

Parameters:

matrixContext - the elements on which the matrix is to be created.

module - the current module

Returns:

the matrix descriptor

Throws:

java.lang.IllegalStateException - if the matrix descriptor is not found or not defined.

computeMatrixDescription

protected java.lang.String computeMatrixDescription(ModelElement matrixContext,
                                                    IModule module)

Compute a description note content to put on the matrix.

By default returns null meaning no description will be created.

Parameters:

matrixContext - the matrix owner

module - the current module

Returns:

the description note content.

computeMatrixName

protected java.lang.String computeMatrixName(ModelElement matrixContext,
                                             IModule module)

Compute the matrix name.

By default look for a "matrix_name" command parameter and replace "$name" by the matrix owner name.

Parameters:

matrixContext - the matrix owner

module - the current module

Returns:

the matrix name.

postConfigure

protected void postConfigure(MatrixDefinition matrix,
                             ModelElement matrixContext,
                             IModule module)

Hook called after a matrix is created.

Does nothing by default.

Parameters:

matrix - the create MatrixDefinition.

matrixContext - the matrix owner.

module - the current module

createQueryDefinition

protected final QueryDefinition createQueryDefinition(IModule module,
                                                      java.lang.String implementationClassName,
                                                      java.util.Map<java.lang.String,java.lang.String> parameters)

Creates a QueryDefinition to be used as line, column or depth query.

Parameters:

module - the module.

implementationClassName - the query java implementation class name.

parameters - the query parameters obtained from the matrix descriptor.

Returns:

the created query definition.