de.hybris.platform.droolsruleengineservices.compiler.impl

Class DefaultDroolsRuleActionContext

java.lang.Object

de.hybris.platform.droolsruleengineservices.compiler.impl.DefaultDroolsRuleActionContext

All Implemented Interfaces:

RuleActionContext

public class DefaultDroolsRuleActionContext
extends java.lang.Object
implements RuleActionContext

Default implementation of RuleActionContext for the drools rule engine.

Constructor Summary

Constructors

Constructor and Description
DefaultDroolsRuleActionContext(java.util.Map<java.lang.String,java.lang.Object> variables, java.lang.Object helper)

Method Summary

Modifier and Type	Method and Description
protected KnowledgeHelper	checkAndGetRuleContext(java.lang.Object ruleContext)
protected <T> java.util.Set<T>	evaluateValues(java.lang.Class<T> type, java.util.List<T> values, java.lang.String... path)
protected <T> java.util.Set<T>	evaluateValues(java.lang.Class<T> type, java.util.Set<T> values, java.lang.String... path)
protected <T> java.util.Set<T>	findValues(java.lang.Class<T> type, java.lang.String... path)
CartRAO	getCartRao() Get cart RAO
java.lang.Object	getDelegate() Returns a rule engine specific context object.
java.lang.String	getMetaData(java.lang.String key) Returns the rule's meta-data for the given key (or null).
java.lang.Object	getParameter(java.lang.String parameterName) Returns parameter of the running rule by it name or null if not found.
<T> T	getParameter(java.lang.String parameterName, java.lang.Class<T> type) Returns parameter of the running rule by it name and type or throws IllegalArgumentException otherwise.
java.util.Map<java.lang.String,java.lang.Object>	getParameters() Returns parameters of the running rule.
RuleEngineResultRAO	getRuleEngineResultRao() Get rule engine result RAO
java.util.Map<java.lang.String,java.lang.Object>	getRuleMetadata() get rule metadata
java.lang.String	getRuleName() Get the name of the rule
java.util.Optional<java.lang.String>	getRulesModuleName() Get the name of the rules module.
<T> T	getValue(java.lang.Class<T> type) Returns the value for a specific type from the default variables container.
<T> T	getValue(java.lang.Class<T> type, java.lang.String... path) Returns the value for a specific type and variables container.
<T> java.util.Set<T>	getValues(java.lang.Class<T> type) Returns the values for a specific type from the default variables container.
<T> java.util.Set<T>	getValues(java.lang.Class<T> type, java.lang.String... path) Returns the values for a specific type and variables container.
java.util.Map<java.lang.String,java.lang.Object>	getVariables()
void	halt() Stops evaluation of following rules
void	insertFacts(java.util.Collection facts) Insert the facts in a collection to a context
void	insertFacts(java.lang.Object... facts) Insert the facts in an array to a context
boolean	isStackable() Deprecated. since 6.7
void	scheduleForUpdate(java.lang.Object... facts) schedules the given facts for an update.
void	setParameters(java.util.Map<java.lang.String,java.lang.Object> parameters) Sets parameters to the running rule
void	updateFacts(java.lang.Object... facts) Update the facts in a context
void	updateScheduledFacts() updates any previously scheduled facts (see RuleActionContext.scheduleForUpdate(Object...)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultDroolsRuleActionContext

public DefaultDroolsRuleActionContext(java.util.Map<java.lang.String,java.lang.Object> variables,
                                      java.lang.Object helper)

Method Detail

getVariables

public java.util.Map<java.lang.String,java.lang.Object> getVariables()

getDelegate

public java.lang.Object getDelegate()

Description copied from interface: RuleActionContext

Returns a rule engine specific context object.

Specified by:

getDelegate in interface RuleActionContext

getMetaData

public java.lang.String getMetaData(java.lang.String key)

Description copied from interface: RuleActionContext

Returns the rule's meta-data for the given key (or null). Calls toString() on the meta-data object.

Specified by:

getMetaData in interface RuleActionContext

Returns:

the string representation of the meta-data (or null)

getValue

public <T> T getValue(java.lang.Class<T> type)

Description copied from interface: RuleActionContext

Returns the value for a specific type from the default variables container. If more than one value is found, the first one is returned.

Specified by:

getValue in interface RuleActionContext

Parameters:

type - - the type

Returns:

the value or null if no value is found for the given type

scheduleForUpdate

public void scheduleForUpdate(java.lang.Object... facts)

Description copied from interface: RuleActionContext

schedules the given facts for an update. Note: The actual fact update is invoked via RuleActionContext.updateScheduledFacts()

Specified by:

scheduleForUpdate in interface RuleActionContext

Parameters:

facts - the facts to schedule for update

getValues

public <T> java.util.Set<T> getValues(java.lang.Class<T> type)

Description copied from interface: RuleActionContext

Returns the values for a specific type from the default variables container.

Specified by:

getValues in interface RuleActionContext

Parameters:

type - - the type

Returns:

the values or an empty set if no value is found for the given type

getValue

public <T> T getValue(java.lang.Class<T> type,
                      java.lang.String... path)

Description copied from interface: RuleActionContext

Returns the value for a specific type and variables container. If more than one value is found, the first one is returned.

Specified by:

getValue in interface RuleActionContext

Parameters:

type - - the type

path - - the path for the variables container

Returns:

the value or null if no value is found for the given type

getValues

public <T> java.util.Set<T> getValues(java.lang.Class<T> type,
                                      java.lang.String... path)

Description copied from interface: RuleActionContext

Returns the values for a specific type and variables container.

Specified by:

getValues in interface RuleActionContext

Parameters:

type - - the type

path - - the path for the variables container

Returns:

the values or an empty set if no value is found for the given type

insertFacts

public void insertFacts(java.lang.Object... facts)

Description copied from interface: RuleActionContext

Insert the facts in an array to a context

Specified by:

insertFacts in interface RuleActionContext

Parameters:

facts - - the array of facts

updateScheduledFacts

public void updateScheduledFacts()

Description copied from interface: RuleActionContext

updates any previously scheduled facts (see RuleActionContext.scheduleForUpdate(Object...)

Specified by:

updateScheduledFacts in interface RuleActionContext

updateFacts

public void updateFacts(java.lang.Object... facts)

Description copied from interface: RuleActionContext

Update the facts in a context

Specified by:

updateFacts in interface RuleActionContext

Parameters:

facts - - the array of facts

insertFacts

public void insertFacts(java.util.Collection facts)

Description copied from interface: RuleActionContext

Insert the facts in a collection to a context

Specified by:

insertFacts in interface RuleActionContext

Parameters:

facts - - the collection of facts

findValues

protected <T> java.util.Set<T> findValues(java.lang.Class<T> type,
                                          java.lang.String... path)

evaluateValues

protected <T> java.util.Set<T> evaluateValues(java.lang.Class<T> type,
                                              java.util.List<T> values,
                                              java.lang.String... path)

evaluateValues

protected <T> java.util.Set<T> evaluateValues(java.lang.Class<T> type,
                                              java.util.Set<T> values,
                                              java.lang.String... path)

getCartRao

public CartRAO getCartRao()

Description copied from interface: RuleActionContext

Get cart RAO

Specified by:

getCartRao in interface RuleActionContext

getRuleEngineResultRao

public RuleEngineResultRAO getRuleEngineResultRao()

Description copied from interface: RuleActionContext

Get rule engine result RAO

Specified by:

getRuleEngineResultRao in interface RuleActionContext

getRuleName

public java.lang.String getRuleName()

Description copied from interface: RuleActionContext

Get the name of the rule

Specified by:

getRuleName in interface RuleActionContext

getRulesModuleName

public java.util.Optional<java.lang.String> getRulesModuleName()

Description copied from interface: RuleActionContext

Get the name of the rules module.

Specified by:

getRulesModuleName in interface RuleActionContext

getRuleMetadata

public java.util.Map<java.lang.String,java.lang.Object> getRuleMetadata()

Description copied from interface: RuleActionContext

get rule metadata

Specified by:

getRuleMetadata in interface RuleActionContext

checkAndGetRuleContext

protected KnowledgeHelper checkAndGetRuleContext(java.lang.Object ruleContext)

getParameters

public java.util.Map<java.lang.String,java.lang.Object> getParameters()

Description copied from interface: RuleActionContext

Returns parameters of the running rule.

Specified by:

getParameters in interface RuleActionContext

getParameter

public java.lang.Object getParameter(java.lang.String parameterName)

Description copied from interface: RuleActionContext

Returns parameter of the running rule by it name or null if not found.

Specified by:

getParameter in interface RuleActionContext

getParameter

public <T> T getParameter(java.lang.String parameterName,
                          java.lang.Class<T> type)

Description copied from interface: RuleActionContext

Returns parameter of the running rule by it name and type or throws IllegalArgumentException otherwise.

Specified by:

getParameter in interface RuleActionContext

setParameters

public void setParameters(java.util.Map<java.lang.String,java.lang.Object> parameters)

Description copied from interface: RuleActionContext

Sets parameters to the running rule

Specified by:

setParameters in interface RuleActionContext

Parameters:

parameters - - map of named objects, creating the execution context for an action

isStackable

@Deprecated
public boolean isStackable()

Deprecated. since 6.7

Description copied from interface: RuleActionContext

Is the rule stackable?

Specified by:

isStackable in interface RuleActionContext

halt

public void halt()

Description copied from interface: RuleActionContext

Stops evaluation of following rules

Specified by:

halt in interface RuleActionContext