com.massa.mrules.set

Class MRuleExecutionSet

java.lang.Object

com.massa.mrules.set.AbstractMRuleExecutionSet

com.massa.mrules.set.MRuleExecutionSet

All Implemented Interfaces:

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

@PersistantProperty(property="stopAtFirstValidatedCondition",defaultValue="true") @PersistantProperty(property="importedClasses",alias="importedClass") @PersistantProperty(property="importedPackages",alias="importedPackage") @PersistantProperty(property="callables",alias="callable") @PersistantProperty(property="executables",alias="executable")
public class MRuleExecutionSet
extends AbstractMRuleExecutionSet
implements ICallableRepository, IExecutable.ValueReturning

Master Class and Entry point of the Engine. The iteration on sub-executables might stop on first validated condition (default is true, as it will be in many cases non final actions).
This implementation supports declaration of local imports (specific classes or packages) and of callables (i.e. functions for instance)
A full MRuleExecutionSet is thread safe at execution, but NOT at compilation.
Every modification made on rules after compilation process is not taken into account until another compilation is launched.

See Also:

Serialized Form

Nested Class Summary

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

IExecutable.ValueReturning

Field Summary

Fields

Modifier and Type	Field and Description
static String	RULEEXECUTIONSET_ID

Constructor Summary

Constructors

Constructor and Description
MRuleExecutionSet() Default constructor.
MRuleExecutionSet(List<? extends IExecutable> executables) stopAtFirstValidatedCondition defaults to true
MRuleExecutionSet(List<? extends IExecutable> executables, boolean stopAtFirstValidatedCondition)

Method Summary

Modifier and Type	Method and Description
IExecutionResult	call(String name, IExecutionContext ctxt) Requests call to the ICallable identified by its name inside the repository.
MRuleExecutionSet	clone() Clones the IExecutable.
protected void	compileRuleSet(ICompilationContext ctxt) Performs specific compilation actions, including addon registering in context.
boolean	equals(Object o)
IExecutionResult	executeRuleSet(IExecutionContext ctxt) Performs implementation specific execution actions.
MBeanUtils.ImportHolder	generateImports() Generates "on the fly" the imports, ignoring data produced by the compilation phase.
List<? extends ICallable>	getCallables()
CostInfo	getEstimatedReadCost(ICompilationContext ctxt) This kind of executable should provide a cost estimation in order to be used as accessor and be optimized effectively.
CostInfo	getEstimatedReadCost(String name, ICompilationContext ctxt) Computes an estimated cost of the whole callable execution, in order to be able to optimize accurately.
List<? extends IExecutable>	getExecutables()
String	getImplementationId() Unique addon implementation ID.
List<LocalImportHolder>	getImportedClasses()
List<LocalImportHolder>	getImportedPackages()
MBeanUtils.ImportHolder	getImports() Returns local imports for this ruleset.
List<? extends IExecutable>	getRules() Synonym for getExecutables()
int	hashCode()
boolean	isCompiled() Tells whether the mandatory compilation step has been executed or not.
boolean	isStopAtFirstValidatedCondition()
protected void	optimizeRuleSet(ICompilationContext ctxt) Performs specific optimization actions, including launching the optimization chain.
void	setCallables(List<? extends ICallable> callables)
void	setExecutables(List<? extends IExecutable> executables)
void	setImportedClasses(List<LocalImportHolder> importedClasses)
void	setImportedPackages(List<LocalImportHolder> importedPackages)
void	setStopAtFirstValidatedCondition(boolean stopAtFirstValidatedCondition)
String	toString()
void	toString(OuterWithLevel outer) Method used to send String representation of the current object to the OuterWithLevel.
boolean	validate(String name) Validates that the named ICallable exists in this repository.

Methods inherited from class com.massa.mrules.set.AbstractMRuleExecutionSet

compile, debugEntering, debugExiting, execute, getContextFactory, getDebugInfo, getDefaultObjectFilter, getDefaultObjectFilterInstance, getDescription, getInternalCacheIdentifier, getInternalDistinctAddonCacheCount, getMetadata, getName, getProperties, getProperty, getUri, hasProperties, hasProperty, isCacheEnabled, isCacheUsed, isInternalCacheIdentifierNeeded, optimize, removeProperty, resetCachedData, setCacheEnabled, setContextFactory, setDebugInfo, setDefaultObjectFilter, setDescription, setInternalCacheIdentifier, setName, setProperty, setUri, wasRegistered

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.massa.mrules.executable.IExecutable

compile, execute, getProperties, hasProperties, hasProperty, removeProperty

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

getInternalCacheIdentifier, isCacheUsed, isInternalCacheIdentifierNeeded, optimize, resetCachedData, setInternalCacheIdentifier, wasRegistered

Methods inherited from interface com.massa.mrules.base.IMRulesObject

getDebugInfo, getDescription, getName, setDebugInfo, setDescription, setName

Methods inherited from interface javax.rules.admin.Rule

getDescription, getName, getProperty, setProperty

Field Detail

RULEEXECUTIONSET_ID

public static final String RULEEXECUTIONSET_ID

See Also:

Constant Field Values

Constructor Detail

MRuleExecutionSet

public MRuleExecutionSet()

Default constructor. No specific logger name. Null rule list. stopAtFirstValidatedCondition defaults to true.

MRuleExecutionSet

public MRuleExecutionSet(List<? extends IExecutable> executables)

stopAtFirstValidatedCondition defaults to true

MRuleExecutionSet

public MRuleExecutionSet(List<? extends IExecutable> executables,
                         boolean stopAtFirstValidatedCondition)

Method Detail

compileRuleSet

protected void compileRuleSet(ICompilationContext ctxt)
                       throws MRuleValidationException

Description copied from class: AbstractMRuleExecutionSet

Performs specific compilation actions, including addon registering in context.

Specified by:

compileRuleSet in class AbstractMRuleExecutionSet

Throws:

MRuleValidationException

getEstimatedReadCost

public CostInfo getEstimatedReadCost(ICompilationContext ctxt)
                              throws MRuleValidationException

Description copied from interface: IExecutable.ValueReturning

This kind of executable should provide a cost estimation in order to be used as accessor and be optimized effectively.

Specified by:

getEstimatedReadCost in interface IExecutable.ValueReturning

Returns:

cost information

Throws:

MRuleValidationException

optimizeRuleSet

protected void optimizeRuleSet(ICompilationContext ctxt)
                        throws MRuleValidationException

Description copied from class: AbstractMRuleExecutionSet

Performs specific optimization actions, including launching the optimization chain.

Specified by:

optimizeRuleSet in class AbstractMRuleExecutionSet

Throws:

MRuleValidationException

executeRuleSet

public IExecutionResult executeRuleSet(IExecutionContext ctxt)
                                throws MExecutionException

Description copied from class: AbstractMRuleExecutionSet

Performs implementation specific execution actions.

Specified by:

executeRuleSet in class AbstractMRuleExecutionSet

Returns:

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:

MExecutionException

validate

public boolean validate(String name)

Description copied from interface: ICallableRepository

Validates that the named ICallable exists in this repository.

Specified by:

validate in interface ICallableRepository

Parameters:

name - Name of the ICallable to validate

getEstimatedReadCost

public CostInfo getEstimatedReadCost(String name,
                                     ICompilationContext ctxt)
                              throws MRuleValidationException

Description copied from interface: ICallableRepository

Computes an estimated cost of the whole callable execution, in order to be able to optimize accurately.

Specified by:

getEstimatedReadCost in interface ICallableRepository

ctxt - Compilation context.

Returns:

Estimated cost

Throws:

MRuleValidationException

call

public IExecutionResult call(String name,
                             IExecutionContext ctxt)
                      throws MExecutionException

Description copied from interface: ICallableRepository

Requests call to the ICallable identified by its name inside the repository.

Specified by:

call in interface ICallableRepository

Parameters:

name - Name of the ICallable to call

ctxt - Execution context

Returns:

Execution results

Throws:

MExecutionException

isCompiled

public boolean isCompiled()

Description copied from interface: IMRuleExecutionSet

Tells whether the mandatory compilation step has been executed or not.

Specified by:

isCompiled in interface IMRuleExecutionSet

getRules

public List<? extends IExecutable> getRules()

Synonym for getExecutables()

Specified by:

getRules in interface javax.rules.admin.RuleExecutionSet

getImports

public MBeanUtils.ImportHolder getImports()

Description copied from interface: IMRuleExecutionSet

Returns local imports for this ruleset. Data returned by this method is available after compilation.

Specified by:

getImports in interface IMRuleExecutionSet

generateImports

public MBeanUtils.ImportHolder generateImports()

Description copied from interface: IMRuleExecutionSet

Generates "on the fly" the imports, ignoring data produced by the compilation phase.

Specified by:

generateImports in interface IMRuleExecutionSet

getCallables

public List<? extends ICallable> getCallables()

setCallables

public void setCallables(List<? extends ICallable> callables)

getExecutables

public List<? extends IExecutable> getExecutables()

setExecutables

public void setExecutables(List<? extends IExecutable> executables)

getImportedClasses

public List<LocalImportHolder> getImportedClasses()

setImportedClasses

public void setImportedClasses(List<LocalImportHolder> importedClasses)

getImportedPackages

public List<LocalImportHolder> getImportedPackages()

setImportedPackages

public void setImportedPackages(List<LocalImportHolder> importedPackages)

isStopAtFirstValidatedCondition

public boolean isStopAtFirstValidatedCondition()

setStopAtFirstValidatedCondition

public void setStopAtFirstValidatedCondition(boolean stopAtFirstValidatedCondition)

toString

public String toString()

Overrides:

toString in class Object

toString

public void toString(OuterWithLevel outer)
              throws IOException

Description copied from interface: Outable

Method used to send String representation of the current object to the OuterWithLevel.

Specified by:

toString in interface Outable

Throws:

IOException

clone

public MRuleExecutionSet 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 AbstractMRuleExecutionSet

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getImplementationId

public String getImplementationId()

Description copied from interface: IAddon

Unique addon implementation ID. In case of conflict, an Class Initialization error will be raised.

Specified by:

getImplementationId in interface IAddon