org.simbrain.workspace.updater

Class UpdateActionCustom

java.lang.Object

org.simbrain.workspace.updater.UpdateActionCustom

All Implemented Interfaces:

UpdateAction

public class UpdateActionCustom
extends java.lang.Object
implements UpdateAction

Update using a custom action saved as a beanshell script.

Author:

jyoshimi

Constructor Summary

Constructors

Constructor and Description
UpdateActionCustom(Workspace workspace, java.io.File file) Create a new custom update action from a file containing the custom script.
UpdateActionCustom(WorkspaceUpdater updater, java.lang.String script) Create a new custom update action from a file containing the custom script.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Provide a String description of this update method.
java.lang.String	getLongDescription() Provide a longer description for tooltips, etc.
java.lang.String	getScriptString()
void	init() Initialize the interpreter.
void	invoke() Invoke this action.
void	setScriptString(java.lang.String scriptString)

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateActionCustom

public UpdateActionCustom(WorkspaceUpdater updater,
                          java.lang.String script)

Create a new custom update action from a file containing the custom script.

Parameters:

updater - reference to workspace updater

script - the custom script as a string

UpdateActionCustom

public UpdateActionCustom(Workspace workspace,
                          java.io.File file)

Create a new custom update action from a file containing the custom script.

Parameters:

workspace - reference to parent workspace

file - file containing custom code

Method Detail

init

public void init()

Initialize the interpreter.

invoke

public void invoke()

Invoke this action.

Specified by:

invoke in interface UpdateAction

getDescription

public java.lang.String getDescription()

Description copied from interface: UpdateAction

Provide a String description of this update method.

Specified by:

getDescription in interface UpdateAction

Returns:

the update description

getLongDescription

public java.lang.String getLongDescription()

Description copied from interface: UpdateAction

Provide a longer description for tooltips, etc.

Specified by:

getLongDescription in interface UpdateAction

Returns:

the update description

getScriptString

public java.lang.String getScriptString()

Returns:

the scriptString

setScriptString

public void setScriptString(java.lang.String scriptString)

Parameters:

scriptString - the scriptString to set