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

See Also:

OperatorType, Operation

Constructor Summary

Constructors

Constructor and Description
OperationBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
Operation	createJavaMethodOperation(String objectName, String methodName, String methodParamType, Expression methodParams)
OperationBuilder	createNewInstance() Initiate the building of a new Operation.
Operation	createSetDataOperation(String dataName, Expression expression)
Operation	createSetDocument(String docName, Expression expression)
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)
Operation	done()
OperationBuilder	setLeftOperand(LeftOperand leftOperand) Sets the LeftOperand of this operation.
OperationBuilder	setLeftOperand(String name, boolean external) 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

public OperationBuilder setLeftOperand(String name,
                              boolean external)

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 -

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.

createSetDocument

public Operation createSetDocument(String docName,
                          Expression expression)

Parameters:

docName -

expression -

Returns:

the newly created Operation.

createXPathOperation

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

Parameters:

xmlName -

xPath -

setValue -

Returns:

the newly created Operation.

createJavaMethodOperation

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

Parameters:

objectName -

methodName -

methodParamType -

methodParams -

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.