scriptinterface

Class ScriptCallSignature

java.lang.Object

scriptinterface.ScriptCallSignature

public class ScriptCallSignature
extends java.lang.Object

A signature for calling a script. An instance holds a normal signature (see SignatureInterface) and a filename for the script to execute. The inner signature is handled as usual.

Author:

Andreas Fender

Constructor Summary

Constructors

Constructor and Description
ScriptCallSignature(java.lang.String filename, ScriptSystemInterface<?,?> scriptSystem) Creates a new instance without initializing it.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	callToString(java.util.Vector<java.lang.String> args) Creates a statement in the syntax of the script system to call the script.
ExecutionError	create(java.lang.String signatureString) Initializes the signature.
java.lang.String	getFilename() Returns the filename of the script file.
SignatureInterface	getSignature() Returns the inner signature.
void	prepareScriptVariables(java.util.Vector<ExecutionReturn> args, VariableSystem<java.lang.String> variableSystem) Prepares a variable system for a call of the script.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptCallSignature

public ScriptCallSignature(java.lang.String filename,
                   ScriptSystemInterface<?,?> scriptSystem)

Creates a new instance without initializing it.

Parameters:

filename - the filename of the script.

scriptSystem - a script system to evaluate the default arguments.

Method Detail

create

public ExecutionError create(java.lang.String signatureString)

Initializes the signature.

Parameters:

signatureString - a string containing the signature. See the Graphana manual for syntax information.

Returns:

null, if the initialization was successful. Otherwise, the execution error.

getSignature

public SignatureInterface getSignature()

Returns the inner signature.

Returns:

the signature.

prepareScriptVariables

public void prepareScriptVariables(java.util.Vector<ExecutionReturn> args,
                          VariableSystem<java.lang.String> variableSystem)

Prepares a variable system for a call of the script. Every argument is used to assign a variable with the argument name as the identifier to the argument value.

Parameters:

args - the arguments for the script call.

variableSystem - the variable system in which to assign the respective variables.

callToString

public java.lang.String callToString(java.util.Vector<java.lang.String> args)

Creates a statement in the syntax of the script system to call the script.

Parameters:

args - the arguments as string representations.

Returns:

a statement its execution would invoke the script.

getFilename

public java.lang.String getFilename()

Returns the filename of the script file.

Returns:

the filename of the script file.