de.hybris.platform.btg.condition.impl

Class CollectionExpressionEvaluator

java.lang.Object

de.hybris.platform.btg.condition.impl.CollectionExpressionEvaluator

All Implemented Interfaces:

ExpressionEvaluator

public class CollectionExpressionEvaluator
extends java.lang.Object
implements ExpressionEvaluator

ExpressionEvaluator for Collection type as well as it's collection elements.

It must be configured in which mode to operate with setElementMode(boolean) or setCollectionMode(boolean). This is necessary to avoid operator clashes. (e.g. isEmpty operator can be applied on elements as well as on collection itself) Depending on current operation mode the result of getSupportedRightTypes(String) or getSupportedOperators() differs.

Constructor Summary

Constructors

Constructor and Description
CollectionExpressionEvaluator()

Method Summary

Modifier and Type	Method and Description
boolean	evaluate(java.lang.Object leftOperand, java.lang.String operator, java.lang.Object rightOperand) Evaluates this expression.
ExpressionEvaluator	getElementEvaluator() Returns the ExpressionEvaluator which is used for the elements of the collection.
java.lang.Class	getLeftType() Returns the type which is expected for left operand.
java.util.Collection<java.lang.String>	getSupportedOperators() Returns a Collection of supported Operators.
java.util.Collection<java.lang.Class>	getSupportedRightTypes(java.lang.String operator) Returns a Collection of types which are supported as right Operand.
boolean	isSupported(java.lang.Class leftType, java.lang.String operator, java.lang.Class rightType) Returns true when type of left and right operand and the passed operator is supported.
void	setCollectionExpEval(ExpressionEvaluator collectionExpEval)
void	setCollectionMode(boolean collectionMode) Convenience method.
void	setElementExpEval(ExpressionEvaluator elementExpEval)
void	setElementMode(boolean elementMode) When true collection elements are getting evaluated rather then the collection itself.

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionExpressionEvaluator

public CollectionExpressionEvaluator()

Method Detail

setCollectionMode

public void setCollectionMode(boolean collectionMode)

Convenience method. Opposite of setElementMode(boolean).

Parameters:

collectionMode -

setElementMode

public void setElementMode(boolean elementMode)

When true collection elements are getting evaluated rather then the collection itself.

Parameters:

elementMode - true for evaluating collection elements

getElementEvaluator

public ExpressionEvaluator getElementEvaluator()

Returns the ExpressionEvaluator which is used for the elements of the collection.

Returns:

ExpressionEvaluator

evaluate

public boolean evaluate(java.lang.Object leftOperand,
                        java.lang.String operator,
                        java.lang.Object rightOperand)

Description copied from interface: ExpressionEvaluator

Evaluates this expression. When operands or operator are not supported a ExpressionEvaluationException is thrown. Returns true when expression evaluates to true, returns false otherwise.

Specified by:

evaluate in interface ExpressionEvaluator

Parameters:

leftOperand - value for left operand

operator - operator

rightOperand - value for right operand

Returns:

true when expression evaluates to true

getLeftType

public java.lang.Class getLeftType()

Description copied from interface: ExpressionEvaluator

Returns the type which is expected for left operand.

Specified by:

getLeftType in interface ExpressionEvaluator

Returns:

type for left operand

getSupportedRightTypes

public java.util.Collection<java.lang.Class> getSupportedRightTypes(java.lang.String operator)

Description copied from interface: ExpressionEvaluator

Returns a Collection of types which are supported as right Operand.

Returns 'null' when requested operator is not supported. Returns an empty Collection when operator is supported but does not allow a right operand. In any other case returns a Collection of types which are supported for passed operator.

Specified by:

getSupportedRightTypes in interface ExpressionEvaluator

Parameters:

operator - the operator which shall be applied

Returns:

Collection of supported types

getSupportedOperators

public java.util.Collection<java.lang.String> getSupportedOperators()

Description copied from interface: ExpressionEvaluator

Returns a Collection of supported Operators. At least one Operator must be returned whenever a left Operand is available.

Specified by:

getSupportedOperators in interface ExpressionEvaluator

Returns:

Collection of supported operators

isSupported

public boolean isSupported(java.lang.Class leftType,
                           java.lang.String operator,
                           java.lang.Class rightType)

Description copied from interface: ExpressionEvaluator

Returns true when type of left and right operand and the passed operator is supported. In other words: when expression can be evaluated successfully to true or false without errors.

Specified by:

isSupported in interface ExpressionEvaluator

Parameters:

leftType - type of left operand

operator - the operator

rightType - type of right operand

Returns:

true when an evaluation is possible

setElementExpEval

public void setElementExpEval(ExpressionEvaluator elementExpEval)

Parameters:

elementExpEval - the elementExpEval to set

setCollectionExpEval

public void setCollectionExpEval(ExpressionEvaluator collectionExpEval)

Parameters:

collectionExpEval - the collectionExpEval to set