com.massa.mrules.set

Class AbstractMRuleExecutionSet

java.lang.Object

com.massa.mrules.set.AbstractMRuleExecutionSet

All Implemented Interfaces:

IAddon, IMRulesObject, IExecutable, IMruleExecutionSet, IMRuleExecutionSet, Outable, Serializable, Cloneable, javax.rules.admin.Rule, javax.rules.admin.RuleExecutionSet

Direct Known Subclasses:

MRuleExecutionSet

public abstract class AbstractMRuleExecutionSet
extends Object
implements IMRulesObject, IMruleExecutionSet, IMRuleExecutionSet

This class provides common base for several ruleset implementations.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.massa.mrules.executable.IExecutable

IExecutable.ValueReturning

Constructor Summary

Constructors

Constructor and Description
AbstractMRuleExecutionSet() Default constructor.

Method Summary

Modifier and Type	Method and Description
AbstractMRuleExecutionSet	clone() Clones the IExecutable.
void	compile(ICompilationContext ctxt) Launches global compilation process.
protected abstract void	compileRuleSet(ICompilationContext ctxt) Performs specific compilation actions, including addon registering in context.
void	debugEntering(IExecutionContext ctxt, IAddon addon) Overridden to output provided entity.
void	debugExiting(IExecutionContext ctxt, IAddon addon, IExecutionResult result) Overridden to output result and provided output entity.
IExecutionResult	execute(IExecutionContext ctxt) General contract for all RuleExecutionSet implementations.
protected abstract IExecutionResult	executeRuleSet(IExecutionContext ctxt) Performs implementation specific execution actions.
IContextFactory	getContextFactory()
String	getDebugInfo() Retrieves some debug information of the current instance.
String	getDefaultObjectFilter()
javax.rules.ObjectFilter	getDefaultObjectFilterInstance()
String	getDescription() Retrieves the description of the current instance.
Integer	getInternalCacheIdentifier() Returns null by default.
int	getInternalDistinctAddonCacheCount()
MRuleExecutionSetMetadata	getMetadata()
String	getName() Retrieves the name of the current instance.
Map<Object,Object>	getProperties() Get all properties.
Object	getProperty(Object key)
String	getUri()
boolean	hasProperties() Has at least one property.
boolean	hasProperty(Object key) Contains the property identified by the provided key.
boolean	isCacheEnabled() Allows to globally disable cache usage for this ruleset.
boolean	isCacheUsed() Returns false by default.
boolean	isInternalCacheIdentifierNeeded() This method allows to tell the engine if a cache identifier is needed.
void	optimize(ICompilationContext ctxt) Launches global optimization process.
protected abstract void	optimizeRuleSet(ICompilationContext ctxt) Performs specific optimization actions, including launching the optimization chain.
void	removeProperty(Object key) Removing property.
void	resetCachedData(IExecutionContext ctxt) Does nothing.
void	setCacheEnabled(boolean cacheEnabled) Allows to globally disable cache usage for this ruleset.
void	setContextFactory(IContextFactory contextFactory)
void	setDebugInfo(String debugInfo) Sets some debug information of the current instance.
void	setDefaultObjectFilter(String defaultFilterClazz)
void	setDescription(String description) Sets the description of the current instance.
void	setInternalCacheIdentifier(Integer internalIdentifier) Stores nothing.
void	setName(String name) Sets the name of the current instance.
void	setProperty(Object key, Object value)
void	setUri(String uri) Set unique ruleset URI
boolean	wasRegistered(ICompilationContext ctxt, IAddon parent, AddonInfo info) Does nothing.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.massa.mrules.set.IMRuleExecutionSet

generateImports, getImports, isCompiled

Methods inherited from interface com.massa.mrules.addon.IAddon

getImplementationId

Methods inherited from interface com.massa.mrules.util.out.Outable

toString

Methods inherited from interface javax.rules.admin.RuleExecutionSet

getRules

Constructor Detail

AbstractMRuleExecutionSet

public AbstractMRuleExecutionSet()

Default constructor. No specific logger name.

Method Detail

compile

public final void compile(ICompilationContext ctxt)
                   throws MRuleValidationException

Launches global compilation process.
Implementations must implement compileRuleSet(ICompilationContext), as this method only initializes and finalizes the phase, core compilation has to be done by implementing classes.
The compileRuleSet method must integrate the addon registering in context.

Specified by:

compile in interface IExecutable

Throws:

MRuleValidationException - if validation problem detected.

compileRuleSet

protected abstract void compileRuleSet(ICompilationContext ctxt)
                                throws MRuleValidationException

Performs specific compilation actions, including addon registering in context.

Throws:

MRuleValidationException

optimize

public final void optimize(ICompilationContext ctxt)
                    throws MRuleValidationException

Launches global optimization process. Implementations must implement optimizeRuleSet(ICompilationContext), as this method only initializes and finalizes the phase, core optimization has to be done by implementing classes.
The optimizeRuleSet method must integrate the start of the optimization chain on the root addon.

Specified by:

optimize in interface IAddon

Throws:

MRuleValidationException

optimizeRuleSet

protected abstract void optimizeRuleSet(ICompilationContext ctxt)
                                 throws MRuleValidationException

Performs specific optimization actions, including launching the optimization chain.

Throws:

MRuleValidationException

execute

public final IExecutionResult execute(IExecutionContext ctxt)
                               throws MExecutionException

General contract for all RuleExecutionSet implementations. This generic implementations :

• checks if compilation is performed
• initializes context
• logs inputs / outputs
• handles generic exceptions

Specified by:

execute in interface IExecutable

Specified by:

execute in interface IMRuleExecutionSet

Returns:

All implementations must return Execution results :

• Condition (see ExecutionResultState.combineConditionState(ExecutionResultState)) :
  • NA if none evaluated
  • OK if at least one OK
  • KO if all KO
• Action (see ExecutionResultState.combineActionState(ExecutionResultState)) :
  • NA if not actions executed
  • OK if all actions OK
  • KO if all actions KO
  • PARTIAL if some actions OK and others KO

Throws:

MConditionEvaluationException

MActionExecutionException

MExecutionException

executeRuleSet

protected abstract IExecutionResult executeRuleSet(IExecutionContext ctxt)
                                            throws MExecutionException

Performs implementation specific execution actions.

Throws:

MExecutionException

wasRegistered

public boolean wasRegistered(ICompilationContext ctxt,
                             IAddon parent,
                             AddonInfo info)

Does nothing. Returns false.

Specified by:

wasRegistered in interface IAddon

parent - Parent from which this instance of addon was registered.

info - Addon info for the currently registered addon

Returns:

true if internal data of the addon, which have influence on hashcode and equality, has been modified.

debugEntering

public void debugEntering(IExecutionContext ctxt,
                          IAddon addon)

Overridden to output provided entity.

debugExiting

public void debugExiting(IExecutionContext ctxt,
                         IAddon addon,
                         IExecutionResult result)

Overridden to output result and provided output entity.

clone

public AbstractMRuleExecutionSet clone()

Description copied from interface: IExecutable

Clones the IExecutable.
The general contract is that the clone of a compiled executable is still compiled.

Specified by:

clone in interface IAddon

Specified by:

clone in interface IMRulesObject

Specified by:

clone in interface IExecutable

Specified by:

clone in interface IMRuleExecutionSet

Overrides:

clone in class Object

getInternalDistinctAddonCacheCount

public final int getInternalDistinctAddonCacheCount()

Specified by:

getInternalDistinctAddonCacheCount in interface IMRuleExecutionSet

Returns:

After compilation phase, the number of distinct addons using cache internally used.

getDefaultObjectFilter

public String getDefaultObjectFilter()

Specified by:

getDefaultObjectFilter in interface javax.rules.admin.RuleExecutionSet

setDefaultObjectFilter

public void setDefaultObjectFilter(String defaultFilterClazz)

Specified by:

setDefaultObjectFilter in interface javax.rules.admin.RuleExecutionSet

getDefaultObjectFilterInstance

public javax.rules.ObjectFilter getDefaultObjectFilterInstance()
                                                        throws MRuleInternalException

Specified by:

getDefaultObjectFilterInstance in interface IMRuleExecutionSet

Throws:

MRuleInternalException

getMetadata

public MRuleExecutionSetMetadata getMetadata()

Specified by:

getMetadata in interface IMRuleExecutionSet

Returns:

Global meta data on the current ruleset

getUri

public String getUri()

Specified by:

getUri in interface IMRuleExecutionSet

Returns:

Unique ruleset URI

setUri

public void setUri(String uri)

Description copied from interface: IMRuleExecutionSet

Set unique ruleset URI

Specified by:

setUri in interface IMRuleExecutionSet

getDebugInfo

public String getDebugInfo()

Description copied from interface: IMRulesObject

Retrieves some debug information of the current instance. This information is used in case of Exception.

Specified by:

getDebugInfo in interface IMRulesObject

setDebugInfo

public void setDebugInfo(String debugInfo)

Description copied from interface: IMRulesObject

Sets some debug information of the current instance. Factories should use this method to provide as much information as possible, such as line numbers, etc ...

Specified by:

setDebugInfo in interface IMRulesObject

getName

public String getName()

Description copied from interface: IMRulesObject

Retrieves the name of the current instance.

Specified by:

getName in interface IMRulesObject

Specified by:

getName in interface javax.rules.admin.Rule

Specified by:

getName in interface javax.rules.admin.RuleExecutionSet

setName

public void setName(String name)

Description copied from interface: IMRulesObject

Sets the name of the current instance. In general, it should not be mandatory to specify a name.

Specified by:

setName in interface IMRulesObject

getDescription

public String getDescription()

Description copied from interface: IMRulesObject

Retrieves the description of the current instance.

Specified by:

getDescription in interface IMRulesObject

Specified by:

getDescription in interface javax.rules.admin.Rule

Specified by:

getDescription in interface javax.rules.admin.RuleExecutionSet

setDescription

public void setDescription(String description)

Description copied from interface: IMRulesObject

Sets the description of the current instance. This information should not be mandatory.

Specified by:

setDescription in interface IMRulesObject

getProperty

public Object getProperty(Object key)

Specified by:

getProperty in interface javax.rules.admin.Rule

Specified by:

getProperty in interface javax.rules.admin.RuleExecutionSet

setProperty

public void setProperty(Object key,
                        Object value)

Specified by:

setProperty in interface javax.rules.admin.Rule

Specified by:

setProperty in interface javax.rules.admin.RuleExecutionSet

removeProperty

public void removeProperty(Object key)

Description copied from interface: IExecutable

Removing property.

Specified by:

removeProperty in interface IExecutable

getProperties

public Map<Object,Object> getProperties()

Description copied from interface: IExecutable

Get all properties.

Specified by:

getProperties in interface IExecutable

hasProperty

public boolean hasProperty(Object key)

Description copied from interface: IExecutable

Contains the property identified by the provided key.

Specified by:

hasProperty in interface IExecutable

hasProperties

public boolean hasProperties()

Description copied from interface: IExecutable

Has at least one property.

Specified by:

hasProperties in interface IExecutable

getContextFactory

public IContextFactory getContextFactory()

Specified by:

getContextFactory in interface IMRuleExecutionSet

setContextFactory

public void setContextFactory(IContextFactory contextFactory)

Specified by:

setContextFactory in interface IMRuleExecutionSet

isCacheEnabled

public boolean isCacheEnabled()

Description copied from interface: IMRuleExecutionSet

Allows to globally disable cache usage for this ruleset.
The compilation / optimization processes should NOT use this method, but the ICompilationContext.isCacheEnabled(String) instead.

Specified by:

isCacheEnabled in interface IMRuleExecutionSet

setCacheEnabled

public void setCacheEnabled(boolean cacheEnabled)

Description copied from interface: IMRuleExecutionSet

Allows to globally disable cache usage for this ruleset.
Changes are only taken into account after compilation.

Specified by:

setCacheEnabled in interface IMRuleExecutionSet

setInternalCacheIdentifier

public void setInternalCacheIdentifier(Integer internalIdentifier)

Stores nothing.

Specified by:

setInternalCacheIdentifier in interface IAddon

Parameters:

internalIdentifier - Internal identifier

See Also:

IAddon.getInternalCacheIdentifier()

getInternalCacheIdentifier

public Integer getInternalCacheIdentifier()

Returns null by default.

Specified by:

getInternalCacheIdentifier in interface IAddon

Returns:

Internal identifier

See Also:

IAddon.setInternalCacheIdentifier(Integer)

isCacheUsed

public boolean isCacheUsed()

Returns false by default.

Specified by:

isCacheUsed in interface IAddon

resetCachedData

public void resetCachedData(IExecutionContext ctxt)

Does nothing.

Specified by:

resetCachedData in interface IAddon

isInternalCacheIdentifierNeeded

public boolean isInternalCacheIdentifierNeeded()

This method allows to tell the engine if a cache identifier is needed. If not, the Addon will not be able to use internal execution cache.

Specified by:

isInternalCacheIdentifierNeeded in interface IAddon

Returns:

Internal identifier

See Also:

setInternalCacheIdentifier(Integer)