org.modelio.api.module.command.standard

Class RunJythonScriptBasicHandler

java.lang.Object

org.modelio.api.module.command.DefaultModuleCommandHandler

org.modelio.api.module.command.standard.RunJythonScriptBasicHandler

All Implemented Interfaces:

IModuleCommandHandler

Direct Known Subclasses:

RunJythonScriptStandardHandler

public class RunJythonScriptBasicHandler
extends DefaultModuleCommandHandler

Command handler that runs a Jython script.

The jython script must be in the "JY_SCRIPT" command parameter.

The scripts are run with the bindings configured by configure(ScriptEngine, List, IModule).

Since:

3.4

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SCRIPT_PARAM Command parameter containing the Jython script to run.

Constructor Summary

Constructors

Constructor and Description
RunJythonScriptBasicHandler()

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 javax.script.Bindings	configure(javax.script.ScriptEngine engine, java.util.List<MObject> selectedElements, IModule module) Computes the bindings to use to run the scripts.
protected boolean	runBooleanScript(java.lang.String scriptParamName, java.util.List<MObject> selectedElements, IModule module) Run a Jython script stored in the given command parameter.

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

accept, 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

SCRIPT_PARAM

public static final java.lang.String SCRIPT_PARAM

Command parameter containing the Jython script to run.

See Also:

Constant Field Values

Constructor Detail

RunJythonScriptBasicHandler

public RunJythonScriptBasicHandler()

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 javax.script.Bindings configure(javax.script.ScriptEngine engine,
                                          java.util.List<MObject> selectedElements,
                                          IModule module)

Computes the bindings to use to run the scripts.

By defaults creates the following bindings:

• selectedElements : the elements selected in Modelio.
• module : the module owning the command.
• modelingSession : the modeling session.
• and all command parameters.

Parameters:

engine - the script engine that will be used.

selectedElements - the Modelio selection.

module - the module owning the command

Returns:

the bindings to use.

runBooleanScript

protected boolean runBooleanScript(java.lang.String scriptParamName,
                                   java.util.List<MObject> selectedElements,
                                   IModule module)

Run a Jython script stored in the given command parameter.

The Jython script should return a boolean value. Returns false if the script does not return a boolean or fails.

Does nothing and returns true if no script is present for the given command parameter.

Parameters:

scriptParamName - the command parameter where the script is stored.

selectedElements - the current Modelio selection

module - the module owing the command

Returns:

the boolean returned by the script.