scriptinterface

Interface ScriptSystemInterface<ScopeType extends ExecutionScope,ReaderType extends ReaderInterface>

Type Parameters:

ScopeType - the type of the scope of the language.

ReaderType - the type of the input reader.

All Known Subinterfaces:

GraphanaScriptSystemInterface

All Known Implementing Classes:

GraphanaDefaultScriptSystem, GraphanaScriptSystem, TreeBuildingScriptSystem

public interface ScriptSystemInterface<ScopeType extends ExecutionScope,ReaderType extends ReaderInterface>

Enables parsing and executing of files and strings.

Field Summary

Fields

Modifier and Type	Field and Description
static ScriptType	ANY

Method Summary

Modifier and Type	Method and Description
java.lang.String	assignmentToString(java.lang.String identifier, java.lang.String value) Returns an assignment in valid script syntax.
java.lang.String	callToString(java.lang.String key, java.lang.String arguments) Returns a call in valid script syntax.
ExecutionResult<?>	cast(ExecutionResult<?> value, ScriptType toType) Tries to cast the given value to the given type.
ExecuterInterface	createExecuter(ReaderType source) Parses the given source and creates an executer from it.
ExecuterInterface	createExecuter(java.lang.String source) Parses the given string and creates an executer out of it.
SignatureInterface	createSignature() Creates a new uninitialized signature.
ExecuterInterface	executerFromFile(java.io.File file) Parses the given file and creates an executer from it.
ReaderType	fileToScriptReader(java.io.File file) Creates a script reader from file content.
ReaderType	fileToScriptReader(java.lang.String filename) Creates a script reader from file content.
ScriptType	getScriptType(java.lang.String typeName) Returns the script type associated with the given type key.
ScopeType	getTopScope() Returns the global scope of the script.
void	putTypeCast(ScriptType fromType, ScriptType toType, TypeCast<?,?> typeCast) Registers the given type cast with the two given types.
void	putTypeCast(java.lang.String[] fromTypes, java.lang.String toType, TypeCast<?,?> typeCast) Registers one type cast and associates it with the given types.
void	putTypeCast(java.lang.String fromType, java.lang.String[] toTypes, TypeCast<?,?> typeCast) Registers one type cast and associates it with the given types.
void	putTypeCast(java.lang.String fromType, java.lang.String toType, TypeCast<?,?> typeCast) Registers the given type cast with the two given types.
void	registerComplexType(ScriptComplexType complexType) Registers the given complex type.
ScriptComplexType	registerComplexType(java.lang.String name, java.lang.String parameters) Creates and registers a complex type.
java.lang.String	statementToString(java.lang.String statement) Returns the given statement embedded in valid script syntax.
ReaderType	stringToScriptReader(java.lang.String string) Creates a script reader from string.

Field Detail

ANY

static final ScriptType ANY

Method Detail

getScriptType

ScriptType getScriptType(java.lang.String typeName)

Returns the script type associated with the given type key.

Parameters:

typeName - the key of the type to return.

Returns:

the script type associated with the given type key.

putTypeCast

void putTypeCast(ScriptType fromType,
                 ScriptType toType,
                 TypeCast<?,?> typeCast)

Registers the given type cast with the two given types.

Parameters:

fromType - the input type of the cast.

toType - the output type of the cast.

typeCast - the type cast to register.

putTypeCast

void putTypeCast(java.lang.String fromType,
                 java.lang.String toType,
                 TypeCast<?,?> typeCast)

Registers the given type cast with the two given types.

Parameters:

fromType - the key of the input type of the cast.

toType - the key of the output type of the cast.

typeCast - the type cast to register.

putTypeCast

void putTypeCast(java.lang.String[] fromTypes,
                 java.lang.String toType,
                 TypeCast<?,?> typeCast)

Registers one type cast and associates it with the given types.

Parameters:

fromTypes - keys of the input types. The given type cast reference will be registered with every single key.

toType - key of the output type.

typeCast - the type cast to register.

putTypeCast

void putTypeCast(java.lang.String fromType,
                 java.lang.String[] toTypes,
                 TypeCast<?,?> typeCast)

Registers one type cast and associates it with the given types.

Parameters:

fromType - key of the input type.

toTypes - keys of the output types. The given type cast reference will be registered with every single key.

typeCast - the type cast to register.

cast

ExecutionResult<?> cast(ExecutionResult<?> value,
                        ScriptType toType)

Tries to cast the given value to the given type.

Parameters:

value - the value to cast.

toType - the type to which to cast the value.

Returns:

an equivalent value returned with the given type or null, if the value could not be cast.

registerComplexType

void registerComplexType(ScriptComplexType complexType)

Registers the given complex type.

Parameters:

complexType - the complex type to register.

registerComplexType

ScriptComplexType registerComplexType(java.lang.String name,
                                      java.lang.String parameters)
                               throws ParameterParseException

Creates and registers a complex type.

Parameters:

name - the name of the complex type to create.

parameters - the names and types of the complex type given as a string. See ParameterTuple for the syntax.

Returns:

the created complex type.

Throws:

ParameterParseException - if an error occurred while parsing the parameter string.

createSignature

SignatureInterface createSignature()

Creates a new uninitialized signature.

Returns:

a new signature instance.

getTopScope

ScopeType getTopScope()

Returns the global scope of the script.

Returns:

the global scope of the script.

fileToScriptReader

ReaderType fileToScriptReader(java.io.File file)

Creates a script reader from file content.

Parameters:

file - the file to parse.

Returns:

a script reader containing the file content.

fileToScriptReader

ReaderType fileToScriptReader(java.lang.String filename)

Creates a script reader from file content.

Parameters:

filename - the filename of the file to parse.

Returns:

a script reader containing the file content.

stringToScriptReader

ReaderType stringToScriptReader(java.lang.String string)

Creates a script reader from string.

Parameters:

string - the string containing the source code to parse.

Returns:

a script reader containing the string.

createExecuter

ExecuterInterface createExecuter(ReaderType source)

Parses the given source and creates an executer from it.

Parameters:

source - the source code to parse.

Returns:

an executer created from the source code.

createExecuter

ExecuterInterface createExecuter(java.lang.String source)

Parses the given string and creates an executer out of it.

Parameters:

source - the string containing the source code to parse.

Returns:

an executer created from the source code.

executerFromFile

ExecuterInterface executerFromFile(java.io.File file)

Parses the given file and creates an executer from it.

Parameters:

file - the file containing the source code to parse.

Returns:

an executer created from the source code.

statementToString

java.lang.String statementToString(java.lang.String statement)

Returns the given statement embedded in valid script syntax.

Parameters:

statement - the statement.

Returns:

the statement embedded in valud script syntax.

assignmentToString

java.lang.String assignmentToString(java.lang.String identifier,
                                    java.lang.String value)

Returns an assignment in valid script syntax.

Parameters:

identifier - the left hand side of the assignment.

value - the right hand side of the assignment.

Returns:

an assignment in valid script syntax.

callToString

java.lang.String callToString(java.lang.String key,
                              java.lang.String arguments)

Returns a call in valid script syntax.

Parameters:

key - the identifier of the call.

arguments - the arguments of the call.

Returns:

a call in valid script syntax.