de.hybris.platform.btg.condition.impl

Class AbstractExpressionEvaluator

java.lang.Object

de.hybris.platform.btg.condition.impl.AbstractExpressionEvaluator

All Implemented Interfaces:

ExpressionEvaluator

Direct Known Subclasses:

AbstractCollectionExpressionEvaluator, AbstractComparableExpressionEvaluator, BooleanExpressionEvaluator, CompositeExpressionEvaluator, ReverseCollectionExpressionEvaluator, StringExpressionEvaluator, UserAddressPostalCodeExpressionEvaluator

public abstract class AbstractExpressionEvaluator
extends java.lang.Object
implements ExpressionEvaluator

Abstract implementation for ExpressionEvaluator.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allowLeftNull
protected static java.lang.String	LEFT_OP_MISSING
protected static java.lang.String	LEFT_OP_NOT_SUPPORTED
protected static java.lang.String	OPERATOR_MISSING
protected static java.lang.String	OPERATOR_NOT_SUPPORTED
protected static java.lang.String	RIGHT_OP_MISSING
protected static java.lang.String	RIGHT_OP_NOT_ALLOWED
protected static java.lang.String	RIGHT_OP_NOT_SUPPORTED

Constructor Summary

Constructors

Constructor and Description
AbstractExpressionEvaluator(java.lang.Class leftOperandType) Constructs a ExpressionEvaluator and takes passed type as type for left operand.

Method Summary

Modifier and Type	Method and Description
void	addSupportedOperator(java.lang.String operator) Adds a new operator to the list of supported ones.
void	addSupportedOperator(java.lang.String operator, java.lang.Class type) Adds a new operator to the list of supported ones and registers passed type as supported type for right operand whenever this operator is chosen
void	addSupportedOperator(java.lang.String operator, java.util.Collection<java.lang.Class> types) Adds a new operator to the list of supported ones and registers passed types as supported types for right operand whenever this operator is chosen
boolean	evaluate(java.lang.Object leftOperand, java.lang.String operator, java.lang.Object rightOperand) Evaluates this expression.
abstract boolean	evaluateTerm(java.lang.Object leftOperand, java.lang.String operator, java.lang.Object rightOperand) Evaluates this expression without any error or validation checking.
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.
boolean	isSupported(java.lang.Class leftType, java.lang.String operator, java.lang.Class rightType, boolean strict) Implements ExpressionEvaluator.isSupported(Class, String, Class) but additionally adds a flag which, when set to true, throws a ExpressionEvaluationException instead of returning just only false.

Methods inherited from class java.lang.Object

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

Field Detail

LEFT_OP_MISSING

protected static final java.lang.String LEFT_OP_MISSING

See Also:

Constant Field Values

LEFT_OP_NOT_SUPPORTED

protected static final java.lang.String LEFT_OP_NOT_SUPPORTED

See Also:

Constant Field Values

RIGHT_OP_MISSING

protected static final java.lang.String RIGHT_OP_MISSING

See Also:

Constant Field Values

RIGHT_OP_NOT_SUPPORTED

protected static final java.lang.String RIGHT_OP_NOT_SUPPORTED

See Also:

Constant Field Values

RIGHT_OP_NOT_ALLOWED

protected static final java.lang.String RIGHT_OP_NOT_ALLOWED

See Also:

Constant Field Values

OPERATOR_NOT_SUPPORTED

protected static final java.lang.String OPERATOR_NOT_SUPPORTED

See Also:

Constant Field Values

OPERATOR_MISSING

protected static final java.lang.String OPERATOR_MISSING

See Also:

Constant Field Values

allowLeftNull

protected boolean allowLeftNull

Constructor Detail

AbstractExpressionEvaluator

public AbstractExpressionEvaluator(java.lang.Class leftOperandType)

Constructs a ExpressionEvaluator and takes passed type as type for left operand.

Parameters:

leftOperandType - type of left operand

Method Detail

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

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

addSupportedOperator

public void addSupportedOperator(java.lang.String operator)

Adds a new operator to the list of supported ones.

Parameters:

operator - symbol of operator which shall be added

addSupportedOperator

public void addSupportedOperator(java.lang.String operator,
                                 java.lang.Class type)

Adds a new operator to the list of supported ones and registers passed type as supported type for right operand whenever this operator is chosen

Parameters:

operator - operator symbol

type - supported type for right operand

addSupportedOperator

public void addSupportedOperator(java.lang.String operator,
                                 java.util.Collection<java.lang.Class> types)

Adds a new operator to the list of supported ones and registers passed types as supported types for right operand whenever this operator is chosen

Parameters:

operator - operator symbol

types - supported types for right 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

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

isSupported

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

Implements ExpressionEvaluator.isSupported(Class, String, Class) but additionally adds a flag which, when set to true, throws a ExpressionEvaluationException instead of returning just only false.

Parameters:

leftType - type of left operand

operator - operator symbol

rightType - type of right operand

strict - when true throws an exception in case passed arguments are not supported in that combination

Returns:

true when passed arguments are valid to evaluate an expression without errors

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

evaluateTerm

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

Evaluates this expression without any error or validation checking.

Parameters:

leftOperand - value for left operand

operator - operator symbol

rightOperand - value for right operand

Returns:

true when expression evaluates to true