Package de.hybris.platform.ruleengineservices.compiler

Interface RuleCompilerContext

All Known Implementing Classes:

DefaultRuleCompilerContext

public interface RuleCompilerContext

This interface represents the context valid for the compilation of a rule. It is passed to, and potentially modified by, each phase of the compilation process.

Method Summary

Modifier and Type	Method	Description
void	addProblem(RuleCompilerProblem problem)	Adds a problem arose during compilation process to the list.
RuleIrLocalVariablesContainer	createLocalContainer()	A shortcut to RuleIrVariablesGenerator.createLocalContainer().
String	generateLocalVariable(RuleIrLocalVariablesContainer container, Class<?> type)	A shortcut to RuleIrVariablesGenerator.generateLocalVariable(RuleIrLocalVariablesContainer, Class).
String	generateVariable(Class<?> type)	A shortcut to RuleIrVariablesGenerator.generateVariable(Class).
Map<String,RuleActionDefinitionData>	getActionDefinitions()	Returns action definitions for rule
Map<String,Object>	getAttributes()	Returns a mutable Map that can be used to store attributes associated with this RuleCompilerContext.
Map<String,RuleConditionDefinitionData>	getConditionDefinitions()	Returns condition definitions for rule
List<Exception>	getFailureExceptions()	Returns all failure causing exceptions for this RuleCompilerContext.
String	getModuleName()	Returns the rules module name.
List<RuleCompilerProblem>	getProblems()	Returns all problems arose during compilation process.
AbstractRuleModel	getRule()	Returns the rule.
RuleCompilationContext	getRuleCompilationContext()	get Rules compilation context for a given compilation
List<RuleConditionData>	getRuleConditions()	Returns rule conditions for rule
List<RuleParameterData>	getRuleParameters()	Returns the rule parameters.
long	getRuleVersion()	Returns the rule version.
RuleIrVariablesGenerator	getVariablesGenerator()	Returns the variables generator valid for this compiler context.
void	setRuleVersion(long version)	Provides means of setting engine version of the rule.

Method Details

getRule

AbstractRuleModel getRule()

Returns the rule.

Returns:

rule

getRuleVersion

long getRuleVersion()

Returns the rule version.

Returns:

engine rule version

setRuleVersion

void setRuleVersion(long version)

Provides means of setting engine version of the rule.

Parameters:

version - - engine rule version

getModuleName

String getModuleName()

Returns the rules module name.

Returns:

rules module name

getRuleParameters

List<RuleParameterData> getRuleParameters()

Returns the rule parameters.

Returns:

The rule parameters

getVariablesGenerator

RuleIrVariablesGenerator getVariablesGenerator()

Returns the variables generator valid for this compiler context.

Returns:

the variables generator

generateVariable

String generateVariable(Class<?> type)

A shortcut to RuleIrVariablesGenerator.generateVariable(Class).

Parameters:

type - - the type

Returns:

the name of the variable

createLocalContainer

RuleIrLocalVariablesContainer createLocalContainer()

A shortcut to RuleIrVariablesGenerator.createLocalContainer().

Returns:

the current container

generateLocalVariable

String generateLocalVariable(RuleIrLocalVariablesContainer container,
 Class<?> type)

A shortcut to RuleIrVariablesGenerator.generateLocalVariable(RuleIrLocalVariablesContainer, Class).

Parameters:

type - - the type

Returns:

the name of the variable

getAttributes

Map<String,Object> getAttributes()

Returns a mutable Map that can be used to store attributes associated with this RuleCompilerContext.

Returns:

the map containing the attributes

getFailureExceptions

List<Exception> getFailureExceptions()

Returns all failure causing exceptions for this RuleCompilerContext.

getProblems

List<RuleCompilerProblem> getProblems()

Returns all problems arose during compilation process.

addProblem

void addProblem(RuleCompilerProblem problem)

Adds a problem arose during compilation process to the list.

Parameters:

problem -

getConditionDefinitions

Map<String,RuleConditionDefinitionData> getConditionDefinitions()

Returns condition definitions for rule

getActionDefinitions

Map<String,RuleActionDefinitionData> getActionDefinitions()

Returns action definitions for rule

getRuleConditions

List<RuleConditionData> getRuleConditions()

Returns rule conditions for rule

getRuleCompilationContext

RuleCompilationContext getRuleCompilationContext()

get Rules compilation context for a given compilation

Returns:

instance of RuleCompilationContext