org.bonitasoft.engine.operation

Class OperationBuilder

java.lang.Object

org.bonitasoft.engine.operation.OperationBuilder

public class OperationBuilder
extends Object

Utilitary builder to creation Operation objects. Operations are a way to 'assign', 'operate', 'set a new value', ... on something. See OperatorType for the different types of operation.

Author:

Zhang Bole, Baptiste Mesta, Emmanuel Duchastenier, Matthieu Chaffotte

See Also:

OperatorType, Operation

Constructor Summary

Constructors

Constructor and Description
OperationBuilder()

Method Summary

Modifier and Type	Method and Description
Operation	attachBusinessDataSetAttributeOperation(String businessDataName, Expression expressionReturningBusinessData) Creates a new operation of type OperatorType.ASSIGNMENT that associates an existing Business Data to the current process.
Operation	createBusinessDataSetAttributeOperation(String businessDataName, String methodName, String methodParamType, Expression expression) Creates a new operation of type LeftOperand.TYPE_BUSINESS_DATA that allows to update a Business Data by calling a Java setter on one of its attributes.
Operation	createJavaMethodOperation(String objectName, String methodName, String methodParamType, Expression methodParams) create an operation that update a data that contains a java object
OperationBuilder	createNewInstance() Initiate the building of a new Operation.
Operation	createSetDataOperation(String dataName, Expression expression)
Operation	createSetDocument(String docName, Expression expression) create an operation that update a document
Operation	createSetDocumentList(String docName, Expression expression) create an operation that update a document list
Operation	createSetStringIndexOperation(int index, Expression setValue) Creates a new operation that sets a new value to a String search index.
Operation	createXPathOperation(String xmlName, String xPath, Expression setValue) create an operation that update an xml data using a xpath expression
Operation	deleteBusinessDataOperation(String businessDataName) Creates a new operation of type OperatorType.ASSIGNMENT that remove the named Business Data of the current process.
Operation	done()
static Operation	getNonNullCopy(Operation operation) Get a copy of this operation, so that this operation can be added at several places without conflicting because of unique ID constraint.
OperationBuilder	setLeftOperand(LeftOperand leftOperand) Sets the LeftOperand of this operation.
OperationBuilder	setLeftOperand(String name, boolean external) Deprecated. use setLeftOperand(String,String) Sets the LeftOperand of this operation. It is built for you with its name and external properties.
OperationBuilder	setLeftOperand(String name, LeftOperandType type, boolean external) Deprecated. use setLeftOperand(String,String) Sets the LeftOperand of this operation. It is built for you with its name and external properties.
OperationBuilder	setLeftOperand(String name, String type) Sets the LeftOperand of this operation.
OperationBuilder	setOperator(String operator)
OperationBuilder	setOperatorInputType(String operatorInputType)
OperationBuilder	setRightOperand(Expression rightOperand)
OperationBuilder	setType(OperatorType operatorType)

Methods inherited from class java.lang.Object

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

Constructor Detail

OperationBuilder

public OperationBuilder()

Method Detail

createNewInstance

public OperationBuilder createNewInstance()

Initiate the building of a new Operation. The Operation building will be complete when calling the done() method.

Returns:

this builder itself, so that calls the various exposed methods can be chained.

setLeftOperand

public OperationBuilder setLeftOperand(LeftOperand leftOperand)

Sets the LeftOperand of this operation. A LeftOperand can be obtained by using LeftOperandBuilder.

Parameters:

leftOperand - the LeftOperand to set.

Returns:

this builder itself, so that calls the various exposed methods can be chained.

See Also:

LeftOperandBuilder

setLeftOperand

@Deprecated
public OperationBuilder setLeftOperand(String name,
                                                   boolean external)

Deprecated. use setLeftOperand(String,String) Sets the LeftOperand of this operation. It is built for you with its name and external properties.

Parameters:

name - the name of the left operand

external - is the data managed externally and thus should not be tried to be updated?

Returns:

this builder itself, so that calls the various exposed methods can be chained.

setLeftOperand

@Deprecated
public OperationBuilder setLeftOperand(String name,
                                                   LeftOperandType type,
                                                   boolean external)

Deprecated. use setLeftOperand(String,String) Sets the LeftOperand of this operation. It is built for you with its name and external properties.

Parameters:

name - the name of the left operand

type -

external -

Returns:

this builder itself, so that calls the various exposed methods can be chained.

setLeftOperand

public OperationBuilder setLeftOperand(String name,
                                       String type)

Sets the LeftOperand of this operation. It is built for you with its name and external properties.

Parameters:

name - the name of the left operand

type -

Returns:

this builder itself, so that calls the various exposed methods can be chained.

setType

public OperationBuilder setType(OperatorType operatorType)

Parameters:

operatorType -

Returns:

this builder itself, so that calls the various exposed methods can be chained.

setOperator

public OperationBuilder setOperator(String operator)

Parameters:

operator -

Returns:

this builder itself, so that calls the various exposed methods can be chained.

setOperatorInputType

public OperationBuilder setOperatorInputType(String operatorInputType)

Parameters:

operatorInputType -

Returns:

this builder itself, so that calls the various exposed methods can be chained.

setRightOperand

public OperationBuilder setRightOperand(Expression rightOperand)

Parameters:

rightOperand -

Returns:

this builder itself, so that calls the various exposed methods can be chained.

createSetDataOperation

public Operation createSetDataOperation(String dataName,
                                        Expression expression)

Parameters:

dataName -

expression -

Returns:

the newly created Operation.

createBusinessDataSetAttributeOperation

public Operation createBusinessDataSetAttributeOperation(String businessDataName,
                                                         String methodName,
                                                         String methodParamType,
                                                         Expression expression)

Creates a new operation of type LeftOperand.TYPE_BUSINESS_DATA that allows to update a Business Data by calling a Java setter on one of its attributes.

Parameters:

businessDataName - the name of the business data to update.

methodName - the Java setter method to call.

methodParamType - the type of the Java setter method parameter (to be able to differentiate 2 methods with the same name but with different parameter types)

expression - the Expression to evaluate that represents the new value to set.

Returns:

the newly created Operation.

attachBusinessDataSetAttributeOperation

public Operation attachBusinessDataSetAttributeOperation(String businessDataName,
                                                         Expression expressionReturningBusinessData)

Creates a new operation of type OperatorType.ASSIGNMENT that associates an existing Business Data to the current process.

Parameters:

businessDataName - the name of the reference in the process.

expressionReturningBusinessData - the expression returning an existing business data.

Returns:

the newly created Operation.

See Also:

LeftOperand.TYPE_BUSINESS_DATA

deleteBusinessDataOperation

public Operation deleteBusinessDataOperation(String businessDataName)

Creates a new operation of type OperatorType.ASSIGNMENT that remove the named Business Data of the current process.

Parameters:

businessDataName - the name of the reference in the process.

Returns:

the newly created Operation.

See Also:

OperatorType.DELETION

createSetDocument

public Operation createSetDocument(String docName,
                                   Expression expression)

create an operation that update a document

Parameters:

docName - the name of the document

expression - the expression that returns a DocumentValue

Returns:

the newly created Operation.

createSetDocumentList

public Operation createSetDocumentList(String docName,
                                       Expression expression)

create an operation that update a document list

Parameters:

docName - the name of the document list

expression - the expression that returns a list of DocumentValue

Returns:

the newly created Operation.

createXPathOperation

public Operation createXPathOperation(String xmlName,
                                      String xPath,
                                      Expression setValue)

create an operation that update an xml data using a xpath expression

Parameters:

xmlName - name of the data

xPath - the xpath expression

setValue - the value to set the node in the data with

Returns:

the newly created Operation.

createJavaMethodOperation

public Operation createJavaMethodOperation(String objectName,
                                           String methodName,
                                           String methodParamType,
                                           Expression methodParams)

create an operation that update a data that contains a java object

Parameters:

objectName - the name of the data

methodName - the method to call on this data to update it

methodParamType - the type of the parameter of the method

methodParams - the value to call the method with

Returns:

the newly created Operation.

createSetStringIndexOperation

public Operation createSetStringIndexOperation(int index,
                                               Expression setValue)

Creates a new operation that sets a new value to a String search index.

Parameters:

index - the search index to set

setValue - the Expression to set the search index to.

Returns:

the newly created Operation.

done

public Operation done()

Returns:

the newly built Operation.

getNonNullCopy

public static Operation getNonNullCopy(Operation operation)

Get a copy of this operation, so that this operation can be added at several places without conflicting because of unique ID constraint. If operation is null, simply returns null. In particular, the right operand expression needs to be unique, because of its ID.

Parameters:

operation - the operation to copy

Returns:

a deep copy of this operation, or null.