Package org.pipservices3.expressions.calculator

Class ExpressionCalculator

java.lang.Object

org.pipservices3.expressions.calculator.ExpressionCalculator

public class ExpressionCalculator
extends Object

Constructor Summary

Constructors

Constructor	Description
ExpressionCalculator()
ExpressionCalculator(String expression)	Constructs this class and assigns expression string.

Method Summary

Modifier and Type	Method	Description
void	clear()	Cleans up this calculator from all data.
void	createVariables(IVariableCollection variables)	Populates the specified variables list with variables from parsed expression.
Variant	evaluate()	Evaluates this expression using default variables and functions.
Variant	evaluateWithVariables(IVariableCollection variables)	Evaluates this expression using specified variables.
Variant	evaluateWithVariablesAndFunctions(IVariableCollection variables, IFunctionCollection functions)	Evaluates this expression using specified variables and functions.
boolean	getAutoVariables()	Gets the flag to turn on auto creation of variables for specified expression.
IFunctionCollection	getDefaultFunctions()	The list with default functions.
IVariableCollection	getDefaultVariables()	The list with default variables.
String	getExpression()	The expression string.
List<ExpressionToken>	getInitialTokens()	The list of original expression tokens.
List<Token>	getOriginalTokens()
List<ExpressionToken>	getResultTokens()	The list of processed expression tokens.
IVariantOperations	getVariantOperations()	Gets the manager for operations on variant values.
void	setAutoVariables(boolean value)	Sets the flag to turn on auto creation of variables for specified expression.
void	setExpression(String value)	The expression string.
void	setOriginalTokens(List<Token> value)
void	setVariantOperations(IVariantOperations value)	Sets the manager for operations on variant values.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExpressionCalculator

public ExpressionCalculator()
                     throws Exception

Throws:

Exception

ExpressionCalculator

public ExpressionCalculator(String expression)
                     throws Exception

Constructs this class and assigns expression string.

Parameters:

expression - The expression string.

Throws:

Exception

Method Detail

getExpression

public String getExpression()

The expression string.

setExpression

public void setExpression(String value)
                   throws Exception

The expression string.

Throws:

Exception

getOriginalTokens

public List<Token> getOriginalTokens()

setOriginalTokens

public void setOriginalTokens(List<Token> value)
                       throws SyntaxException

Throws:

SyntaxException

getAutoVariables

public boolean getAutoVariables()

Gets the flag to turn on auto creation of variables for specified expression.

setAutoVariables

public void setAutoVariables(boolean value)

Sets the flag to turn on auto creation of variables for specified expression.

getVariantOperations

public IVariantOperations getVariantOperations()

Gets the manager for operations on variant values.

setVariantOperations

public void setVariantOperations(IVariantOperations value)

Sets the manager for operations on variant values.

getDefaultVariables

public IVariableCollection getDefaultVariables()

The list with default variables.

getDefaultFunctions

public IFunctionCollection getDefaultFunctions()

The list with default functions.

getInitialTokens

public List<ExpressionToken> getInitialTokens()

The list of original expression tokens.

getResultTokens

public List<ExpressionToken> getResultTokens()

The list of processed expression tokens.

createVariables

public void createVariables(IVariableCollection variables)

Populates the specified variables list with variables from parsed expression.

Parameters:

variables - The list of variables to be populated.

clear

public void clear()

Cleans up this calculator from all data.

evaluate

public Variant evaluate()
                 throws Exception

Evaluates this expression using default variables and functions.

Returns:

the evaluation result.

Throws:

Exception

evaluateWithVariables

public Variant evaluateWithVariables(IVariableCollection variables)
                              throws Exception

Evaluates this expression using specified variables.

Parameters:

variables - The list of variables

Returns:

the evaluation result

Throws:

Exception

evaluateWithVariablesAndFunctions

public Variant evaluateWithVariablesAndFunctions(IVariableCollection variables,
                                                 IFunctionCollection functions)
                                          throws Exception

Evaluates this expression using specified variables and functions.

Parameters:

variables - The list of variables

functions - The list of functions

Returns:

the evaluation result

Throws:

Exception