NumericEvaluator (T-Plan Robot Enterprise 7.0 Code Documentation)

java.lang.Object
- com.tplan.robot.scripting.NumericEvaluator

All Implemented Interfaces:

ExpressionEvaluator

Direct Known Subclasses:

JavaTestScriptMethodMapper
```
public class NumericEvaluator
extends Object
implements ExpressionEvaluator
```
Parser and evaluator of numeric and boolean expressions as is defined in the Numeric Expressions and Boolean Expressions chapters of the T-Plan Robot Enterprise language specification.

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Field Summary

Fields
Modifier and Type	Field and Description
`static String[]`	`BOOLEAN_OPERATORS`
`static String[]`	`NUMERIC_OPERATORS`
`static String`	`OPERATOR_AND`
`static String`	`OPERATOR_CONTAINS`
`static String`	`OPERATOR_DIVIDE`
`static String`	`OPERATOR_ENDSWITH`
`static String`	`OPERATOR_EQUALS`
`static String`	`OPERATOR_EQUALS_NOT`
`static String`	`OPERATOR_EXISTS`
`static String`	`OPERATOR_GREATER_THAN`
`static String`	`OPERATOR_LEFT_PARENTHESIS`
`static String`	`OPERATOR_LOWER_THAN`
`static String`	`OPERATOR_MATCHES`
`static String`	`OPERATOR_MINUS`
`static String`	`OPERATOR_MODULO`
`static String`	`OPERATOR_MULTIPLY`
`static String`	`OPERATOR_OR`
`static String`	`OPERATOR_PLUS`
`static String`	`OPERATOR_RIGHT_PARENTHESIS`
`static String`	`OPERATOR_STARTSWITH`
`static String[]`	`UNARY_OPERATORS`

Constructor Summary

Constructors
Constructor and Description

NumericEvaluator()

Constructors
Constructor and Description
`NumericEvaluator()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`evaluateNumericExpression(String expression, Class resultType)` Evaluate an expression and return the result of the requested result type.
`Object`	`evaluateNumericExpression(String expression, Class resultType, ScriptingContext context)` Evaluate an expression and return the result of the requested result type.
`String`	`fixForCondition(String expression, String forVariableName, ScriptingContext context)` Fix improper variable calls in a condition which is to be processed using the 'for' statement.
`String`	`fixIfCondition(String expression, ScriptingContext context)` Fix improper variable calls in a condition which is to be processed using the 'if' statement.
`String[]`	`getBinaryOperators()`
`boolean`	`isLegacy()` Indicate whether the back end parser is the legacy one.
`boolean`	`isOperator(String s)`
`static void`	`main(String[] args)`
`List`	`parseExpression(String expression)`
`void`	`test()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - OPERATOR_LEFT_PARENTHESIS
```
public static final String OPERATOR_LEFT_PARENTHESIS
```
    See Also:
    
    Constant Field Values
  - OPERATOR_RIGHT_PARENTHESIS
```
public static final String OPERATOR_RIGHT_PARENTHESIS
```
    See Also:
    
    Constant Field Values
  - OPERATOR_PLUS
```
public static final String OPERATOR_PLUS
```
    See Also:
    
    Constant Field Values
  - OPERATOR_MINUS
```
public static final String OPERATOR_MINUS
```
    See Also:
    
    Constant Field Values
  - OPERATOR_MULTIPLY
```
public static final String OPERATOR_MULTIPLY
```
    See Also:
    
    Constant Field Values
  - OPERATOR_MODULO
```
public static final String OPERATOR_MODULO
```
    See Also:
    
    Constant Field Values
  - OPERATOR_DIVIDE
```
public static final String OPERATOR_DIVIDE
```
    See Also:
    
    Constant Field Values
  - OPERATOR_EQUALS
```
public static final String OPERATOR_EQUALS
```
    See Also:
    
    Constant Field Values
  - OPERATOR_EQUALS_NOT
```
public static final String OPERATOR_EQUALS_NOT
```
    See Also:
    
    Constant Field Values
  - OPERATOR_AND
```
public static final String OPERATOR_AND
```
    See Also:
    
    Constant Field Values
  - OPERATOR_OR
```
public static final String OPERATOR_OR
```
    See Also:
    
    Constant Field Values
  - OPERATOR_GREATER_THAN
```
public static final String OPERATOR_GREATER_THAN
```
    See Also:
    
    Constant Field Values
  - OPERATOR_LOWER_THAN
```
public static final String OPERATOR_LOWER_THAN
```
    See Also:
    
    Constant Field Values
  - OPERATOR_EXISTS
```
public static final String OPERATOR_EXISTS
```
    See Also:
    
    Constant Field Values
  - OPERATOR_CONTAINS
```
public static final String OPERATOR_CONTAINS
```
    See Also:
    
    Constant Field Values
  - OPERATOR_STARTSWITH
```
public static final String OPERATOR_STARTSWITH
```
    See Also:
    
    Constant Field Values
  - OPERATOR_ENDSWITH
```
public static final String OPERATOR_ENDSWITH
```
    See Also:
    
    Constant Field Values
  - OPERATOR_MATCHES
```
public static final String OPERATOR_MATCHES
```
    See Also:
    
    Constant Field Values
  - NUMERIC_OPERATORS
```
public static final String[] NUMERIC_OPERATORS
```
  - BOOLEAN_OPERATORS
```
public static final String[] BOOLEAN_OPERATORS
```
  - UNARY_OPERATORS
```
public static final String[] UNARY_OPERATORS
```
- Constructor Detail
  - NumericEvaluator
```
public NumericEvaluator()
```
- Method Detail
  - evaluateNumericExpression
```
public Object evaluateNumericExpression(String expression,
                                        Class resultType)
```
    Description copied from interface: ExpressionEvaluator
    
    Evaluate an expression and return the result of the requested result type. If the expression is invalid the method throws an IllegalArgumentException.
    
    Specified by:
    
    evaluateNumericExpression in interface ExpressionEvaluator
    
    Parameters:
    
    expression - an expression such as "1+1" or "5==3 || 3>2".
    
    resultType - the target result type. If Boolean.class is passed the expression will be evaluated as a boolean expression. Otherwise the method must return the numeric return type, for example Double.class or Integer.class.
    
    Returns:
    
    the result (Boolean or Number) subject to the argument type.
  - evaluateNumericExpression
```
public Object evaluateNumericExpression(String expression,
                                        Class resultType,
                                        ScriptingContext context)
```
    Description copied from interface: ExpressionEvaluator
    
    Evaluate an expression and return the result of the requested result type. If the expression is invalid the method throws an IllegalArgumentException.
    
    Specified by:
    
    evaluateNumericExpression in interface ExpressionEvaluator
    
    Parameters:
    
    expression - an expression such as "1+1" or "5==3 || 3>2".
    
    resultType - the target result type. If Boolean.class is passed the expression will be evaluated as a boolean expression. Otherwise the method must return the numeric return type, for example Double.class or Integer.class.
    
    context - the script context. It is used for certain operators such as 'exists [variable]'.
    
    Returns:
    
    the result (Boolean or Number) subject to the argument type.
  - getBinaryOperators
```
public String[] getBinaryOperators()
```
  - isOperator
```
public boolean isOperator(String s)
```
  - parseExpression
```
public List parseExpression(String expression)
```
  - main
```
public static void main(String[] args)
```
  - test
```
public void test()
```
  - fixIfCondition
```
public String fixIfCondition(String expression,
                             ScriptingContext context)
```
    Description copied from interface: ExpressionEvaluator
    
    Fix improper variable calls in a condition which is to be processed using the 'if' statement.
    
    Specified by:
    
    fixIfCondition in interface ExpressionEvaluator
    
    Parameters:
    
    expression - an expression.
    
    context - the script context.
    
    Returns:
    
    the fixed expression.
  - fixForCondition
```
public String fixForCondition(String expression,
                              String forVariableName,
                              ScriptingContext context)
```
    Description copied from interface: ExpressionEvaluator
    
    Fix improper variable calls in a condition which is to be processed using the 'for' statement.
    
    Specified by:
    
    fixForCondition in interface ExpressionEvaluator
    
    Parameters:
    
    expression - an expression.
    
    forVariableName - optional name of the variable the 'for' loop iterates on.
    
    context - the script context.
    
    Returns:
    
    the fixed expression.
  - isLegacy
```
public boolean isLegacy()
```
    Description copied from interface: ExpressionEvaluator
    
    Indicate whether the back end parser is the legacy one.
    
    Specified by:
    
    isLegacy in interface ExpressionEvaluator
    
    Returns:
    
    true for legacy parser used by version 4.4.6 and earlier.

Class NumericEvaluator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OPERATOR_LEFT_PARENTHESIS

OPERATOR_RIGHT_PARENTHESIS

OPERATOR_PLUS

OPERATOR_MINUS

OPERATOR_MULTIPLY

OPERATOR_MODULO

OPERATOR_DIVIDE

OPERATOR_EQUALS

OPERATOR_EQUALS_NOT

OPERATOR_AND

OPERATOR_OR

OPERATOR_GREATER_THAN

OPERATOR_LOWER_THAN

OPERATOR_EXISTS

OPERATOR_CONTAINS

OPERATOR_STARTSWITH

OPERATOR_ENDSWITH

OPERATOR_MATCHES

NUMERIC_OPERATORS

BOOLEAN_OPERATORS

UNARY_OPERATORS

Constructor Detail

NumericEvaluator

Method Detail

evaluateNumericExpression

evaluateNumericExpression

getBinaryOperators

isOperator

parseExpression

main

test

fixIfCondition

fixForCondition

isLegacy