org.broadleafcommerce.common.rule

Class MvelHelper

java.lang.Object

org.broadleafcommerce.common.rule.MvelHelper

public class MvelHelper
extends Object

Helper class for some common rule functions that can be called from mvel as well as utility functions to make calling MVEL rules within Broadleaf easier. An instance of this class is available to the mvel runtime under the variable name MvelHelper with the following functions: convertField(type, fieldValue) toUpperCase(value)

Author:

Jeff Fischer

Field Summary

Fields

Modifier and Type	Field and Description
static String	BLC_RULE_MAP_PARAM
static String	REQUEST_DTO

Constructor Summary

Constructors

Constructor and Description
MvelHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static Map<String,Object>	buildMvelParameters() Builds parameters using time, request, customer, and cart.
static Object	convertField(String type, String fieldValue) Converts a field to the specified type.
static boolean	evaluateRule(String rule, Map<String,Object> ruleParameters) Returns true if the passed in rule passes based on the passed in ruleParameters.
static boolean	evaluateRule(String rule, Map<String,Object> ruleParameters, Map expressionCache) Evaluates the passed in rule given the passed in parameters.
static void	setTestMode(boolean testMode) When true, LOG.info statement will be suppressed.
static Object	toUpperCase(String value)

Methods inherited from class java.lang.Object

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

Field Detail

BLC_RULE_MAP_PARAM

public static final String BLC_RULE_MAP_PARAM

See Also:

Constant Field Values

REQUEST_DTO

public static final String REQUEST_DTO

See Also:

Constant Field Values

Constructor Detail

MvelHelper

public MvelHelper()

Method Detail

convertField

public static Object convertField(String type,
                  String fieldValue)

Converts a field to the specified type. Useful when

Parameters:

type -

fieldValue -

Returns:

toUpperCase

public static Object toUpperCase(String value)

evaluateRule

public static boolean evaluateRule(String rule,
                   Map<String,Object> ruleParameters)

Returns true if the passed in rule passes based on the passed in ruleParameters. Also returns true if the rule is blank or null. Calls the evaluateRule(String, Map, Map) method passing in the DEFAULT_EXPRESSION_CACHE. For systems that need to cache a large number of rule expressions, an alternate cache can be passed in. The default cache is able to cache up to 1,000 rule expressions which should suffice for most systems.

Parameters:

rule -

ruleParameters -

Returns:

evaluateRule

public static boolean evaluateRule(String rule,
                   Map<String,Object> ruleParameters,
                   Map expressionCache)

Evaluates the passed in rule given the passed in parameters.

Parameters:

rule -

ruleParameters -

Returns:

setTestMode

public static void setTestMode(boolean testMode)

When true, LOG.info statement will be suppressed. Should only be set from within MvelHelperTest. Prevents an error from displaying during unit test runs.

Parameters:

testMode -

buildMvelParameters

public static Map<String,Object> buildMvelParameters()

Builds parameters using time, request, customer, and cart. Should be called from within a valid web request.

Parameters:

request -

Returns: