com.toolsverse.util

Class Script

Object

com.toolsverse.util.Script

All Implemented Interfaces:

ObjectStorage, Serializable

public class Script
extends Object
implements ObjectStorage, Serializable

This is a wrapper for the Java scripting engine.

Since:

2.0

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Set<String>	JAVA_SCRIPT_KEYWORDS
static String	JAVA_SCRIPT_LANG
static Set<String>	LEFT_EXCEPTIONS
static String	PYTHON_SCRIPT_LANG
static Set<String>	RIGHT_EXCEPTIONS

Constructor Summary

Constructors

Constructor and Description
Script() Instantiates new Script object.

Method Summary

Modifier and Type	Method and Description
static String	any2Js(String code) Converts any script to javascript.
static String	any2Js(String code, String importStr) Converts any script to javascript.
void	clear() Clears the storage.
boolean	compile(ObjectStorage objectStorage, String name, String code, String lang, Boolean... compatible) Compiles script if it is possible.
Object	eval(ObjectStorage objectStorage, Bindings bindings, String name, String lang) Evaluates script.
static TypedKeyValue<String,TypedKeyValue<Integer,Integer>>	findBestOperand(String value, String[] ops) Find best operand.
Bindings	getBindings(ObjectStorage objectStorage, String lang) Returns an uninitialized Bindings for the script engine defined by lang.
Bindings	getBindings(ObjectStorage objectStorage, String lang, String key) Gets the bindings.
String	getString(String key) Gets the string representation of the value by the key.
Object	getValue(String key) Gets the value by the key.
LinkedHashMap<String,String>	getVariables(ObjectStorage objectStorage, String code) Gets the variables.
static LinkedHashMap<String,String>	getVariables(String code) Returns list of potential variables from the code.
boolean	hasCompiledCode(ObjectStorage objectStorage, String name) Checks if code has been compiled.
static boolean	hasVarsToBind(String code) Checks if script has for potential variables to bind.
static Script	insatnce()
static List<String>	parseExpression(String value, String[] connectors) Parse the expression.
static String[]	parseExpressionLine(String value, String[] ops, String[] connectors) Parses string and return parts of the expression.
static String	parseFunctions(String code, Map<String,String> patterns) Parses the functions.
void	setValue(String key, Object value) Associates value with the key.
static String	sql2Java(String code) Replaces SQL like boolean operations.

Methods inherited from class Object

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

Field Detail

JAVA_SCRIPT_LANG

public static String JAVA_SCRIPT_LANG

PYTHON_SCRIPT_LANG

public static String PYTHON_SCRIPT_LANG

JAVA_SCRIPT_KEYWORDS

public static Set<String> JAVA_SCRIPT_KEYWORDS

LEFT_EXCEPTIONS

public static final Set<String> LEFT_EXCEPTIONS

RIGHT_EXCEPTIONS

public static final Set<String> RIGHT_EXCEPTIONS

Constructor Detail

Script

public Script()

Instantiates new Script object.

Method Detail

any2Js

public static String any2Js(String code)

Converts any script to javascript.

Parameters:

code - the script

Returns:

the javascript

any2Js

public static String any2Js(String code,
                            String importStr)

Converts any script to javascript.

Parameters:

code - the script

importStr - the import string

Returns:

the javascript

findBestOperand

public static TypedKeyValue<String,TypedKeyValue<Integer,Integer>> findBestOperand(String value,
                                                                                   String[] ops)

Find best operand.

Parameters:

value - the string to parse

ops - the operands

Returns:

the operand

getVariables

public static LinkedHashMap<String,String> getVariables(String code)

Returns list of potential variables from the code.

Parameters:

code - the code

Returns:

the map of potential variables

hasVarsToBind

public static boolean hasVarsToBind(String code)

Checks if script has for potential variables to bind.

Parameters:

code - the code

Returns:

true, if script has for potential variables to bind

parseExpression

public static List<String> parseExpression(String value,
                                           String[] connectors)

Parse the expression. Return multiple expression lines with connectors such as AND, OR, etc in between.

Parameters:

value - the expression to parse

connectors - the connectors

Returns:

the expression lines

parseExpressionLine

public static String[] parseExpressionLine(String value,
                                           String[] ops,
                                           String[] connectors)

Parses string and return parts of the expression.

Parameters:

value - the string to parse

ops - the operands

connectors - the connectors

Returns:

the parts of the expression

parseFunctions

public static String parseFunctions(String code,
                                    Map<String,String> patterns)

Parses the functions.

 Example: sum(abc) + avg(xyz) -- com.toolsverse.function.Stat.sum(abc, context) + com.toolsverse.function.Stat.avg(xyz, context)
 

Parameters:

code - the code

patterns - the patterns

Returns:

the the code with function calls replaced on patterns from the function patterns map

sql2Java

public static String sql2Java(String code)

Replaces SQL like boolean operations.

 or  -> ||
 and -> &&
 not ->  !
 ==  ->  =
 

Parameters:

code - the code

Returns:

translated code

insatnce

public static Script insatnce()

clear

public void clear()

Clears the storage.

compile

public boolean compile(ObjectStorage objectStorage,
                       String name,
                       String code,
                       String lang,
                       Boolean... compatible)
                throws Exception

Compiles script if it is possible.

Parameters:

objectStorage - the storage for the compiled scripts

name - the name of the script

code - the script

lang - the script language name

compatible - if true script is compatible with all versions of JS

Returns:

true if script was compiled

Throws:

Exception - in case of any error

eval

public Object eval(ObjectStorage objectStorage,
                   Bindings bindings,
                   String name,
                   String lang)
            throws ScriptException

Evaluates script.

Parameters:

objectStorage - the storage for the compiled scripts

bindings - the bindings

name - the name of the script

lang - the script language name

Returns:

the object returned by evaluated script

Throws:

ScriptException - in case of any error

getBindings

public Bindings getBindings(ObjectStorage objectStorage,
                            String lang)

Returns an uninitialized Bindings for the script engine defined by lang.

Parameters:

objectStorage - the object storage

lang - the script language

Returns:

bindings

getBindings

public Bindings getBindings(ObjectStorage objectStorage,
                            String lang,
                            String key)

Gets the bindings.

Parameters:

objectStorage - the object storage

lang - the language

key - the cache key

Returns:

the bindings

getVariables

public LinkedHashMap<String,String> getVariables(ObjectStorage objectStorage,
                                                 String code)

Gets the variables.

Parameters:

objectStorage - the object storage

code - the code

Returns:

the variables

getString

public String getString(String key)

Description copied from interface: ObjectStorage

Gets the string representation of the value by the key.

Specified by:

getString in interface ObjectStorage

Parameters:

key - the key

Returns:

the string representation of the value or null if there is no mapping between key and value

getValue

public Object getValue(String key)

Description copied from interface: ObjectStorage

Gets the value by the key.

Specified by:

getValue in interface ObjectStorage

Parameters:

key - the key

Returns:

the value or null if there is no mapping between key and value

hasCompiledCode

public boolean hasCompiledCode(ObjectStorage objectStorage,
                               String name)

Checks if code has been compiled.

Parameters:

objectStorage - the object storage

name - the name

Returns:

true, if successful

setValue

public void setValue(String key,
                     Object value)

Description copied from interface: ObjectStorage

Associates value with the key. Key can not be null.

Specified by:

setValue in interface ObjectStorage

Parameters:

key - the key

value - the value