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

Class GenDocCommandStandardHandler

java.lang.Object

org.modelio.api.module.command.DefaultModuleCommandHandler

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

All Implemented Interfaces:

IModuleCommandHandler

public class GenDocCommandStandardHandler
extends DefaultModuleCommandHandler

Command handler to generate a documentation artifact.

Needs the DocumentPublisher module to be deployed in the project.

This handler uses the following command parameters:

• PARAM_STYLESHEET : the base style sheet file path
• PARAM_TARGETFILE : the target file name
• PARAM_TARGETFORMAT : the target file format
• PARAM_TEMPLATE : the document template identifier

Since:

3.4

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PARAM_OPEN_AFTER_GENERATE Command parameter for "open after generation".
static java.lang.String	PARAM_STYLESHEET Command parameter for base stylesheet file path.
static java.lang.String	PARAM_TARGETFILE Command parameter for target file path.
static java.lang.String	PARAM_TARGETFORMAT Command parameter for target format.
static java.lang.String	PARAM_TEMPLATE Command parameter for template name.

Constructor Summary

Constructors

Constructor and Description
GenDocCommandStandardHandler()

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.util.List<MObject> selectedElements, IModule module) Execute the action.
protected boolean	askForParameters(java.util.List<MObject> selectedElements, IModule module, java.util.Map<java.lang.String,java.lang.String> execParameters) Ask the user for the document generation path and other parameters.
protected java.nio.file.Path	getDocTemplatePath(IModule module, java.util.Map<java.lang.String,java.lang.String> execParameters) Retrieve from the given parameters the document template jar file path.
protected java.util.List<ModelElement>	getElementsToGenerate(IModule module, java.util.List<MObject> selectedElements, java.util.Map<java.lang.String,java.lang.String> execParameters) Get the elements on which the documentation must be generated.
protected java.lang.String	getStyleSheetFile(IModule module, java.util.Map<java.lang.String,java.lang.String> execParameters) Retrieve from the given parameters the style sheet file absolute path.
protected java.lang.String	getTargetFile(IModule module, java.util.Map<java.lang.String,java.lang.String> execParameters) Retrieve from the given parameters the target file name.
protected java.lang.String	getTargetFormat(IModule module, java.util.Map<java.lang.String,java.lang.String> execParameters) Retrieve from the given parameters the target file format.
protected java.util.Map<java.lang.String,java.lang.String>	getTemplateParameterValues(java.util.Map<java.lang.String,java.lang.String> execParameters) Get the document template parameter values from the current execution parameters.
boolean	isActiveFor(java.util.List<MObject> selectedElements, IModule module) The handler is active by default.
protected boolean	isOpenAfterGenerate(java.util.Map<java.lang.String,java.lang.String> execParameters) Tells whether to open the generated document after generation.
protected void	postConfigure(java.util.List<MObject> selectedElements, IModule module, java.util.Map<java.lang.String,java.lang.String> execParameters) Hook called after generation.
protected void	preConfigure(java.util.List<MObject> selectedElements, IModule module, java.util.Map<java.lang.String,java.lang.String> execParameters) Hook called before asking the user for parameters.
protected void	reportFailure(java.lang.Throwable error, IModule module) Report failure to the user.

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_TARGETFILE

public static final java.lang.String PARAM_TARGETFILE

Command parameter for target file path.

See Also:

Constant Field Values

PARAM_STYLESHEET

public static final java.lang.String PARAM_STYLESHEET

Command parameter for base stylesheet file path.

See Also:

Constant Field Values

PARAM_TEMPLATE

public static final java.lang.String PARAM_TEMPLATE

Command parameter for template name.

See Also:

Constant Field Values

PARAM_TARGETFORMAT

public static final java.lang.String PARAM_TARGETFORMAT

Command parameter for target format.

See Also:

Constant Field Values

PARAM_OPEN_AFTER_GENERATE

public static final java.lang.String PARAM_OPEN_AFTER_GENERATE

Command parameter for "open after generation".

See Also:

Constant Field Values

Constructor Detail

GenDocCommandStandardHandler

public GenDocCommandStandardHandler()

Method Detail

actionPerformed

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

Execute the action.

The execution order is by follow:

1. copy the command parameters in a new current execution parameters.
2. call preConfigure(List, IModule, Map) with the current execution parameters.
3. call askForParameters(List, IModule, Map) with the current execution parameters.
4. use the getters to get the template generation information from the current execution parameters.
5. run the generation with the found parameters
6. call postConfigure(List, IModule, Map) with the current execution parameters.

Parameters:

selectedElements - the elements on which the command was launched

module - the current module

reportFailure

protected void reportFailure(java.lang.Throwable error,
                             IModule module)

Report failure to the user.

By default log the error and display a message dialog.

Parameters:

error - the failure cause

module - the module

askForParameters

protected boolean askForParameters(java.util.List<MObject> selectedElements,
                                   IModule module,
                                   java.util.Map<java.lang.String,java.lang.String> execParameters)

Ask the user for the document generation path and other parameters.

By default opens a simple dialog asking the user for the file path where the document should be generated. If the user selects a file it puts the file name into the execParameters map with "TARGET" as key.

The user may also choose to cancel the operation in which case the method returns false.

Sub classes may redefine this method and do anything else. In this case they may modify the execParameters map.

Parameters:

selectedElements - the elements on which the command is run.

module - the module owning this command.

execParameters - the document generation parameters.

Returns:

true to continue command execution, false to cancel it.

postConfigure

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

Hook called after generation.

Does nothing by default.

Parameters:

selectedElements - the elements on which the command is run

module - the module

execParameters - the current execution parameters.

preConfigure

protected void preConfigure(java.util.List<MObject> selectedElements,
                            IModule module,
                            java.util.Map<java.lang.String,java.lang.String> execParameters)

Hook called before asking the user for parameters.

Does nothing by default. Sub classes may redefine this method to modify the execParameters execution parameters that will be used to configure the documentation generation. The execution parameters contain initially all the command parameters.

Parameters:

selectedElements - the elements on which the command is run

module - the module

execParameters - the current execution parameters.

getTemplateParameterValues

protected java.util.Map<java.lang.String,java.lang.String> getTemplateParameterValues(java.util.Map<java.lang.String,java.lang.String> execParameters)

Get the document template parameter values from the current execution parameters.

By default return the command handler parameters. Subclasses may redefine.

Parameters:

execParameters - the action execution parameters.

Returns:

the document template parameter values.

getTargetFormat

protected java.lang.String getTargetFormat(IModule module,
                                           java.util.Map<java.lang.String,java.lang.String> execParameters)

Retrieve from the given parameters the target file format.

The returned string must be compatible with the DocumentPublisher 'Target' enumeration.

This method won't call askForParameters(List, IModule, Map) if the target file name is not yet specified.

By default reads the PARAM_TARGETFORMAT parameter from execParameters.

Parameters:

module - the module.

execParameters - the current execution parameters

Returns:

the target file format or null.

getElementsToGenerate

protected java.util.List<ModelElement> getElementsToGenerate(IModule module,
                                                             java.util.List<MObject> selectedElements,
                                                             java.util.Map<java.lang.String,java.lang.String> execParameters)

Get the elements on which the documentation must be generated.

By default returns the selectedElements list filtered by elements deriving from ModelElement.

Parameters:

module - the module

selectedElements - the Modelio selection

execParameters - the current execution parameters.

Returns:

the elements on which the documentation must be generated.

getTargetFile

protected java.lang.String getTargetFile(IModule module,
                                         java.util.Map<java.lang.String,java.lang.String> execParameters)

Retrieve from the given parameters the target file name.

This method won't call askForParameters(List, IModule, Map) if the target file name is not yet specified.

By default reads the PARAM_TARGETFILE parameter from execParameters.

Parameters:

module - the module

execParameters - the current execution parameters

Returns:

the target file name or null.

getStyleSheetFile

protected java.lang.String getStyleSheetFile(IModule module,
                                             java.util.Map<java.lang.String,java.lang.String> execParameters)

Retrieve from the given parameters the style sheet file absolute path.

This method won't call askForParameters(List, IModule, Map) if the information is not yet specified.

By default reads the PARAM_STYLESHEET parameter from execParameters.

Parameters:

module - the module

execParameters - the current execution parameters

Returns:

the style sheet file path or null.

getDocTemplatePath

protected java.nio.file.Path getDocTemplatePath(IModule module,
                                                java.util.Map<java.lang.String,java.lang.String> execParameters)

Retrieve from the given parameters the document template jar file path.

This method won't call askForParameters(List, IModule, Map) if the information is not yet specified.

By default reads the PARAM_TEMPLATE parameter from execParameters.

Parameters:

module - the module

execParameters - the current execution parameters

Returns:

the document template jar path or null.

isOpenAfterGenerate

protected boolean isOpenAfterGenerate(java.util.Map<java.lang.String,java.lang.String> execParameters)

Tells whether to open the generated document after generation.

By default returns true unless "open_generated" execution parameter is set to "false".

Parameters:

execParameters - the action execution parameters.

Returns:

whether to open the generated document after generation.

isActiveFor

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

Description copied from class: DefaultModuleCommandHandler

The handler is active by default.

Specified by:

isActiveFor in interface IModuleCommandHandler

Overrides:

isActiveFor in class DefaultModuleCommandHandler

Parameters:

selectedElements - Current selection

module - Owner of the command

Returns:

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