org.cristalise.kernel.scripting

Class Script

java.lang.Object

org.cristalise.kernel.scripting.Script

All Implemented Interfaces:

DescriptionObject

public class Script
extends Object
implements DescriptionObject

$Revision: 1.25 $ $Date: 2005/10/05 07:39:37 $ Copyright (C) 2003 CERN - European Organization for Nuclear Research All rights reserved.

Field Summary

Fields

Modifier and Type	Field and Description
static String	INCLCOLL

Constructor Summary

Constructors

Constructor and Description
Script(String lang, AgentProxy agent, PrintStream out) For consoles
Script(String name, Integer version, ItemPath path, String xml) For testing.
Script(String lang, String expr)
Script(String lang, String expr, Class<?> returnType) Creates a script executor for the supplied expression, bypassing the xml parsing bit Output class is forced to an object.
Script(String lang, String name, String expr, AgentProxy agent) Creates a script executor requiring an agent to be set.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addIncludedInputParam(String name, Class<?> type)
protected void	addInputParam(String name, Class<?> type)
protected void	addInputParam(String name, String type)
protected void	addOutput(String name, Class<?> type)
protected void	addOutput(String name, String type)
Object	execute() Executes the script with the submitted parameters.
void	export(Writer imports, File dir)
HashMap<String,Parameter>	getAllInputParams() Gets all declared parameters, including those of imported scripts
ScriptContext	getContext()
HashMap<String,Parameter>	getInputParams() Gets all declared parameters
String	getItemID()
ItemPath	getItemPath()
String	getName()
String	getScriptData()
Integer	getVersion()
static void	main(String[] args)
CollectionArrayList	makeDescCollections()
void	setActExecEnvironment(ItemProxy object, AgentProxy subject, Job job)
void	setContext(ScriptContext context)
boolean	setInputParamValue(String name, Object value) Submits an input parameter to the script.
void	setItemPath(ItemPath path)
void	setName(String name)
void	setScriptData(String script)
void	setScriptEngine(String requestedLang)
void	setVersion(Integer version)

Methods inherited from class java.lang.Object

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

Field Detail

INCLCOLL

public static final String INCLCOLL

See Also:

Constant Field Values

Constructor Detail

Script

public Script(String name,
      Integer version,
      ItemPath path,
      String xml)
       throws ScriptParsingException,
              ParameterException

For testing. Parses a given script xml, instead of loading it from Items.

Parameters:

xml -

Throws:

ScriptParsingException

ParameterException

Script

public Script(String lang,
      String expr,
      Class<?> returnType)
       throws ScriptingEngineException

Creates a script executor for the supplied expression, bypassing the xml parsing bit Output class is forced to an object.

Throws:

ScriptingEngineException

Script

public Script(String lang,
      String name,
      String expr,
      AgentProxy agent)
       throws ScriptingEngineException

Creates a script executor requiring an agent to be set. Used by module event scripts.

Parameters:

lang - - script language

name - - script name for debugging

expr - - the script to run

agent - - the agentproxy to pass into the script as 'agent'

Throws:

ScriptingEngineException

Script

public Script(String lang,
      String expr)
       throws ScriptingEngineException

Throws:

ScriptingEngineException

Script

public Script(String lang,
      AgentProxy agent,
      PrintStream out)
       throws Exception

For consoles

Parameters:

lang - - script language

agent - - AgentProxy of the console user

out - - the output PrintStream for reporting results that don't go to the log

Throws:

Exception

Method Detail

setActExecEnvironment

public void setActExecEnvironment(ItemProxy object,
                         AgentProxy subject,
                         Job job)
                           throws ScriptingEngineException,
                                  InvalidDataException

Throws:

ScriptingEngineException

InvalidDataException

setScriptEngine

public void setScriptEngine(String requestedLang)
                     throws ScriptingEngineException

Throws:

ScriptingEngineException

setContext

public void setContext(ScriptContext context)

getContext

public ScriptContext getContext()

addInputParam

protected void addInputParam(String name,
                 String type)
                      throws ParameterException

Throws:

ParameterException

addInputParam

protected void addInputParam(String name,
                 Class<?> type)
                      throws ParameterException

Throws:

ParameterException

addIncludedInputParam

protected void addIncludedInputParam(String name,
                         Class<?> type)
                              throws ParameterException

Throws:

ParameterException

addOutput

protected void addOutput(String name,
             String type)
                  throws ParameterException

Throws:

ParameterException

addOutput

protected void addOutput(String name,
             Class<?> type)
                  throws ParameterException

Throws:

ParameterException

getInputParams

public HashMap<String,Parameter> getInputParams()

Gets all declared parameters

Returns:

HashMap of String (name), org.cristalise.kernel.scripting.Parameter (param)

See Also:

Parameter

getAllInputParams

public HashMap<String,Parameter> getAllInputParams()

Gets all declared parameters, including those of imported scripts

Returns:

HashMap of String (name), org.cristalise.kernel.scripting.Parameter (param)

See Also:

Parameter

setInputParamValue

public boolean setInputParamValue(String name,
                         Object value)
                           throws ParameterException

Submits an input parameter to the script. Must be declared by name and type in the script XML.

Parameters:

name - - input parameter name from the script xml

value - - object to use for this parameter

Throws:

ParameterException - - name not found or wrong type

execute

public Object execute()
               throws ScriptingEngineException

Executes the script with the submitted parameters. All declared input parametes should have been set first.

Returns:

The return value depends on the way the output type was declared in the script xml.

• If there was no output class declared then null is returned
• If a class was declared, but not named, then the object returned by the script is checked to be of that type, then returned.
• If the output value was named and typed, then an object of that class is created and passed to the script as an input parameter. The script should set this before it returns.

Throws:

ScriptingEngineException - - input parameters weren't set, there was an error executing the script, or the output was invalid

setScriptData

public void setScriptData(String script)
                   throws ScriptParsingException

Throws:

ScriptParsingException

getScriptData

public String getScriptData()

getName

public String getName()

Specified by:

getName in interface DescriptionObject

getVersion

public Integer getVersion()

Specified by:

getVersion in interface DescriptionObject

getItemPath

public ItemPath getItemPath()

Specified by:

getItemPath in interface DescriptionObject

getItemID

public String getItemID()

Specified by:

getItemID in interface DescriptionObject

setName

public void setName(String name)

Specified by:

setName in interface DescriptionObject

setVersion

public void setVersion(Integer version)

Specified by:

setVersion in interface DescriptionObject

setItemPath

public void setItemPath(ItemPath path)

Specified by:

setItemPath in interface DescriptionObject

makeDescCollections

public CollectionArrayList makeDescCollections()
                                        throws InvalidDataException,
                                               ObjectNotFoundException

Specified by:

makeDescCollections in interface DescriptionObject

Throws:

InvalidDataException

ObjectNotFoundException

export

public void export(Writer imports,
          File dir)
            throws IOException

Specified by:

export in interface DescriptionObject

Throws:

IOException

main

public static void main(String[] args)