org.bonitasoft.engine.expression

Class ExpressionBuilder

java.lang.Object

org.bonitasoft.engine.expression.ExpressionBuilder

public class ExpressionBuilder
extends Object

Builds a new Expression. This class provides utilitary methods for building of different Expression types. Attributes Name and ReturnType must be set.

Author:

Feng Hui, Matthieu Chaffotte, Emmanuel Duchastenier

Field Summary

Fields

Modifier and Type	Field and Description
static String	EQUALS_COMPARATOR
static String	GREATER_THAN_COMPARATOR
static String	GREATER_THAN_OR_EQUALS_COMPARATOR
static String	LESS_THAN_COMPARATOR
static String	LESS_THAN_OR_EQUALS_COMPARATOR
static String	NOT_COMPARATOR
static String	NOT_EQUALS_COMPARATOR

Constructor Summary

Constructors

Constructor and Description
ExpressionBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
Expression	createAPIAccessorExpression()
Expression	createComparisonExpression(String name, Expression leftOperand, ComparisonOperator operator, Expression rightOperand)
Expression	createComparisonExpression(String name, Expression leftOperand, String operator, Expression rightOperand)
Expression	createConstantBooleanExpression(boolean value)
Expression	createConstantDoubleExpression(double d)
Expression	createConstantFloatExpression(float f)
Expression	createConstantIntegerExpression(int value)
Expression	createConstantLongExpression(long value)
Expression	createConstantStringExpression(String value) The name of the built expression is set to the value of the constant.
Expression	createDataExpression(String dataName, String dataType)
Expression	createDocumentReferenceExpression(String documentName)
Expression	createEngineConstant(ExpressionConstants value)
Expression	createExpression(String name, String expressionContent, String returnType, ExpressionType expressionType)
Expression	createExpression(String name, String content, String type, String returnType, String interpreter, List<Expression> dependencies)
Expression	createGroovyScriptExpression(String name, String script, String returnType)
Expression	createGroovyScriptExpression(String name, String script, String returnType, Expression... dependencies)
Expression	createGroovyScriptExpression(String name, String script, String returnType, List<Expression> dependencies)
Expression	createInputExpression(String value, String returnType)
Expression	createJavaMethodCallExpression(String name, String methodName, String returnType, Expression entityExpression) Create an expression to call a simple Java method (without parameters)
Expression	createListExpression(String name, List<Expression> expressions)
Expression	createListOfListExpression(String name, List<List<Expression>> expressions)
Expression	createLogicalComplementExpression(String name, Expression expression)
ExpressionBuilder	createNewInstance(String name)
Expression	createParameterExpression(String expressionName, String parameterName, String returnType)
Expression	createPatternExpression(String dataContent)
Expression	createPatternExpression(String name, String messagePattern, Expression... dependencies)
Expression	createXPathExpression(String name, String xPathExpression, XPathReturnType returnType, String xmlContent)
Expression	createXPathExpressionWithDataAsContent(String name, String xPathExpression, XPathReturnType returnType, String xmlContentAsDataRef)
Expression	done() Builds a new expression with the specified attributes
protected void	getXPathReturnType(XPathReturnType returnType, ExpressionBuilder expBuilder)
ExpressionBuilder	setContent(String content)
ExpressionBuilder	setDependencies(List<Expression> dependencies)
ExpressionBuilder	setExpressionType(ExpressionType expressionType)
ExpressionBuilder	setExpressionType(String expressionType)
ExpressionBuilder	setInterpreter(String interpreter)
ExpressionBuilder	setName(String name)
ExpressionBuilder	setReturnType(String returnType)

Methods inherited from class java.lang.Object

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

Field Detail

NOT_EQUALS_COMPARATOR

public static final String NOT_EQUALS_COMPARATOR

See Also:

Constant Field Values

NOT_COMPARATOR

public static final String NOT_COMPARATOR

See Also:

Constant Field Values

LESS_THAN_OR_EQUALS_COMPARATOR

public static final String LESS_THAN_OR_EQUALS_COMPARATOR

See Also:

Constant Field Values

LESS_THAN_COMPARATOR

public static final String LESS_THAN_COMPARATOR

See Also:

Constant Field Values

GREATER_THAN_OR_EQUALS_COMPARATOR

public static final String GREATER_THAN_OR_EQUALS_COMPARATOR

See Also:

Constant Field Values

GREATER_THAN_COMPARATOR

public static final String GREATER_THAN_COMPARATOR

See Also:

Constant Field Values

EQUALS_COMPARATOR

public static final String EQUALS_COMPARATOR

See Also:

Constant Field Values

Constructor Detail

ExpressionBuilder

public ExpressionBuilder()

Method Detail

createNewInstance

public ExpressionBuilder createNewInstance(String name)

createConstantStringExpression

public Expression createConstantStringExpression(String value)
                                          throws InvalidExpressionException

The name of the built expression is set to the value of the constant.

Parameters:

value - the value of this CONSTANT expression

Throws:

InvalidExpressionException

Since:

6.0

createConstantBooleanExpression

public Expression createConstantBooleanExpression(boolean value)
                                           throws InvalidExpressionException

Throws:

InvalidExpressionException

createConstantLongExpression

public Expression createConstantLongExpression(long value)
                                        throws InvalidExpressionException

Throws:

InvalidExpressionException

createConstantIntegerExpression

public Expression createConstantIntegerExpression(int value)
                                           throws InvalidExpressionException

Throws:

InvalidExpressionException

createDataExpression

public Expression createDataExpression(String dataName,
                              String dataType)
                                throws InvalidExpressionException

Throws:

InvalidExpressionException

createDocumentReferenceExpression

public Expression createDocumentReferenceExpression(String documentName)
                                             throws InvalidExpressionException

Throws:

InvalidExpressionException

createPatternExpression

public Expression createPatternExpression(String dataContent)
                                   throws InvalidExpressionException

Throws:

InvalidExpressionException

createInputExpression

public Expression createInputExpression(String value,
                               String returnType)
                                 throws InvalidExpressionException

Throws:

InvalidExpressionException

createAPIAccessorExpression

public Expression createAPIAccessorExpression()
                                       throws InvalidExpressionException

Throws:

InvalidExpressionException

createEngineConstant

public Expression createEngineConstant(ExpressionConstants value)
                                throws InvalidExpressionException

Throws:

InvalidExpressionException

done

public Expression done()
                throws InvalidExpressionException

Builds a new expression with the specified attributes

Returns:

the newly built Expression

Throws:

InvalidExpressionException - is name or returnType is not set or set to an empty String.

Since:

6.0

setContent

public ExpressionBuilder setContent(String content)

setExpressionType

public ExpressionBuilder setExpressionType(String expressionType)

setExpressionType

public ExpressionBuilder setExpressionType(ExpressionType expressionType)

setReturnType

public ExpressionBuilder setReturnType(String returnType)

setInterpreter

public ExpressionBuilder setInterpreter(String interpreter)

setDependencies

public ExpressionBuilder setDependencies(List<Expression> dependencies)

setName

public ExpressionBuilder setName(String name)

createExpression

public Expression createExpression(String name,
                          String expressionContent,
                          String returnType,
                          ExpressionType expressionType)
                            throws InvalidExpressionException

Throws:

InvalidExpressionException

createConstantDoubleExpression

public Expression createConstantDoubleExpression(double d)
                                          throws InvalidExpressionException

Throws:

InvalidExpressionException

createConstantFloatExpression

public Expression createConstantFloatExpression(float f)
                                         throws InvalidExpressionException

Throws:

InvalidExpressionException

createListExpression

public Expression createListExpression(String name,
                              List<Expression> expressions)
                                throws InvalidExpressionException

Throws:

InvalidExpressionException

createListOfListExpression

public Expression createListOfListExpression(String name,
                                    List<List<Expression>> expressions)
                                      throws InvalidExpressionException

Throws:

InvalidExpressionException

createExpression

public Expression createExpression(String name,
                          String content,
                          String type,
                          String returnType,
                          String interpreter,
                          List<Expression> dependencies)
                            throws InvalidExpressionException

Throws:

InvalidExpressionException

createGroovyScriptExpression

public Expression createGroovyScriptExpression(String name,
                                      String script,
                                      String returnType)
                                        throws InvalidExpressionException

Throws:

InvalidExpressionException

createGroovyScriptExpression

public Expression createGroovyScriptExpression(String name,
                                      String script,
                                      String returnType,
                                      List<Expression> dependencies)
                                        throws InvalidExpressionException

Throws:

InvalidExpressionException

createGroovyScriptExpression

public Expression createGroovyScriptExpression(String name,
                                      String script,
                                      String returnType,
                                      Expression... dependencies)
                                        throws InvalidExpressionException

Throws:

InvalidExpressionException

createPatternExpression

public Expression createPatternExpression(String name,
                                 String messagePattern,
                                 Expression... dependencies)
                                   throws InvalidExpressionException

Throws:

InvalidExpressionException

createParameterExpression

public Expression createParameterExpression(String expressionName,
                                   String parameterName,
                                   String returnType)
                                     throws InvalidExpressionException

Throws:

InvalidExpressionException

createComparisonExpression

public Expression createComparisonExpression(String name,
                                    Expression leftOperand,
                                    ComparisonOperator operator,
                                    Expression rightOperand)
                                      throws InvalidExpressionException

Throws:

InvalidExpressionException

createComparisonExpression

public Expression createComparisonExpression(String name,
                                    Expression leftOperand,
                                    String operator,
                                    Expression rightOperand)
                                      throws InvalidExpressionException

Throws:

InvalidExpressionException

createLogicalComplementExpression

public Expression createLogicalComplementExpression(String name,
                                           Expression expression)
                                             throws InvalidExpressionException

Throws:

InvalidExpressionException

createXPathExpressionWithDataAsContent

public Expression createXPathExpressionWithDataAsContent(String name,
                                                String xPathExpression,
                                                XPathReturnType returnType,
                                                String xmlContentAsDataRef)
                                                  throws InvalidExpressionException

Throws:

InvalidExpressionException

createXPathExpression

public Expression createXPathExpression(String name,
                               String xPathExpression,
                               XPathReturnType returnType,
                               String xmlContent)
                                 throws InvalidExpressionException

Throws:

InvalidExpressionException

getXPathReturnType

protected void getXPathReturnType(XPathReturnType returnType,
                      ExpressionBuilder expBuilder)

Parameters:

returnType -

expBuilder -

createJavaMethodCallExpression

public Expression createJavaMethodCallExpression(String name,
                                        String methodName,
                                        String returnType,
                                        Expression entityExpression)
                                          throws InvalidExpressionException

Create an expression to call a simple Java method (without parameters)

Parameters:

name - the expression name

methodName - the name of method to call

returnType - the method return type

entityExpression - the expression representing the entity (Java Object) where the method will be called

Returns:

the created expression

Throws:

InvalidExpressionException - if the created expression is invalid

Since:

6.0