com.massa.mrules.set

Class MRuleExecutionSetWrapper

java.lang.Object

com.massa.mrules.set.MRuleExecutionSetWrapper

All Implemented Interfaces:

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

public class MRuleExecutionSetWrapper
extends Object
implements IMRuleExecutionSet, IMruleExecutionSet, ICallableRepository, IExecutable.ValueReturning

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
MRuleExecutionSetWrapper(IMRuleExecutionSet wrapped)

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.
IMRuleExecutionSet	clone() Clones the IExecutable.
void	compile(ICompilationContext ctxt) Compiles the IExecutable to precompute data, ensure that future executions will work, etc ...
boolean	equals(Object obj)
IExecutionResult	execute(IExecutionContext ctxt) General contract for all RuleExecutionSet implementations.
MBeanUtils.ImportHolder	generateImports() Generates "on the fly" the imports, ignoring data produced by the compilation phase.
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.
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.
String	getImplementationId() Unique addon implementation ID.
MBeanUtils.ImportHolder	getImports() Returns local imports for this ruleset.
Integer	getInternalCacheIdentifier() This method allows to retrieve the internal cache identifier set during the compilation phase.
int	getInternalDistinctAddonCacheCount()
MRuleExecutionSetMetadata	getMetadata()
String	getName() Retrieves the name of the current instance.
Map<Object,Object>	getProperties() Get all properties.
Object	getProperty(Object arg0)
List<? extends IExecutable>	getRules()
String	getUri()
IMRuleExecutionSet	getWrapped()
int	hashCode()
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() Tells if this addon will or not use cached data.
boolean	isCompiled() Tells whether the mandatory compilation step has been executed or not.
boolean	isInternalCacheIdentifierNeeded() This method allows to tell the engine if a cache identifier is needed.
void	optimize(ICompilationContext ctxt) Called automatically at the end of the compilation process on all addons, allows an addon to perform internal optimization depending on data computed by all other addons during compilation process.
void	removeProperty(Object key) Removing property.
void	resetCachedData(IExecutionContext ctxt) Tells this addon to reset its cached data, if any.
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 arg0)
void	setDescription(String description) Sets the description of the current instance.
void	setInternalCacheIdentifier(Integer internalIdentifier) This method is called internally during the compilation phase, to set an internal cache identifier.
void	setName(String name) Sets the name of the current instance.
void	setProperty(Object arg0, Object arg1)
void	setUri(String uri) Set unique ruleset URI
void	setWrapped(IMRuleExecutionSet wrapped)
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.
boolean	wasRegistered(ICompilationContext ctxt, IAddon parent, AddonInfo info) Hook called when addon is registered in context.

Methods inherited from class java.lang.Object

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

Constructor Detail

MRuleExecutionSetWrapper

public MRuleExecutionSetWrapper(IMRuleExecutionSet wrapped)

Method Detail

getWrapped

public IMRuleExecutionSet getWrapped()

setWrapped

public void setWrapped(IMRuleExecutionSet wrapped)

compile

public void compile(ICompilationContext ctxt)
             throws MRuleValidationException

Description copied from interface: IExecutable

Compiles the IExecutable to precompute data, ensure that future executions will work, etc ...

Specified by:

compile in interface IExecutable

Throws:

MRuleValidationException - if validation problem detected.

execute

public IExecutionResult execute(IExecutionContext ctxt)
                         throws MExecutionException

Description copied from interface: IMRuleExecutionSet

General contract for all RuleExecutionSet implementations.

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

removeProperty

public void removeProperty(Object key)

Description copied from interface: IExecutable

Removing property.

Specified by:

removeProperty 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

getProperties

public Map<Object,Object> getProperties()

Description copied from interface: IExecutable

Get all properties.

Specified by:

getProperties in interface IExecutable

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

optimize

public void optimize(ICompilationContext ctxt)
              throws MRuleValidationException

Description copied from interface: IAddon

Called automatically at the end of the compilation process on all addons, allows an addon to perform internal optimization depending on data computed by all other addons during compilation process.

Specified by:

optimize in interface IAddon

Throws:

MRuleValidationException

setInternalCacheIdentifier

public void setInternalCacheIdentifier(Integer internalIdentifier)

Description copied from interface: IAddon

This method is called internally during the compilation phase, to set an internal cache identifier. The global contract of all IAddon implementations is to store this identifier and to allow retrieving it, if they specify needing an identifier.

Specified by:

setInternalCacheIdentifier in interface IAddon

Parameters:

internalIdentifier - Internal identifier

See Also:

IAddon.getInternalCacheIdentifier()

getInternalCacheIdentifier

public Integer getInternalCacheIdentifier()

Description copied from interface: IAddon

This method allows to retrieve the internal cache identifier set during the compilation phase.

Specified by:

getInternalCacheIdentifier in interface IAddon

Returns:

Internal identifier

See Also:

IAddon.setInternalCacheIdentifier(Integer)

isInternalCacheIdentifierNeeded

public boolean isInternalCacheIdentifierNeeded()

Description copied from interface: IAddon

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.
A particular addon might require data caching (see IAddon.isCacheUsed()), but the optimization process can identify that the cache is not necessary in some cases. To deactivate it, at this point, the optimizer can't modify the value returned by IAddon.isCacheUsed(), but only the value returned by IAddon.isInternalCacheIdentifierNeeded().

Specified by:

isInternalCacheIdentifierNeeded in interface IAddon

Returns:

Internal identifier

See Also:

IAddon.setInternalCacheIdentifier(Integer)

isCacheUsed

public boolean isCacheUsed()

Description copied from interface: IAddon

Tells if this addon will or not use cached data. If not, maybe callers should not use cache either.
Value returned by this method can be set by compilation process, but only at the beginning of the process (i.e. before compilation of children). The optimization process must not modify the value returned here, but it can modify the value returned by IAddon.isInternalCacheIdentifierNeeded().

Specified by:

isCacheUsed in interface IAddon

resetCachedData

public void resetCachedData(IExecutionContext ctxt)

Description copied from interface: IAddon

Tells this addon to reset its cached data, if any.
If this addon does not cache data (isInternalCacheIdentifierNeeded is false), this method does nothing.
This method may not be equivalent to IExecutionContext.resetCachedData(IAddon), so to tell an addon instance to reset its cached data, this method should be called, not the one in IExecutionContext.

Specified by:

resetCachedData in interface IAddon

wasRegistered

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

Description copied from interface: IAddon

Hook called when addon is registered in context.
Parent is guaranteed to be valued. For the root addon, the parent is self.
Info is guaranteed to be valued.
This method is guaranteed to be called at least once during the compilation / optimization process.

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.

Throws:

MRuleValidationException

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

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

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

getProperty

public Object getProperty(Object arg0)

Specified by:

getProperty in interface javax.rules.admin.Rule

Specified by:

getProperty in interface javax.rules.admin.RuleExecutionSet

setProperty

public void setProperty(Object arg0,
                        Object arg1)

Specified by:

setProperty in interface javax.rules.admin.Rule

Specified by:

setProperty in interface javax.rules.admin.RuleExecutionSet

getDefaultObjectFilter

public String getDefaultObjectFilter()

Specified by:

getDefaultObjectFilter in interface javax.rules.admin.RuleExecutionSet

getRules

public List<? extends IExecutable> getRules()

Specified by:

getRules in interface javax.rules.admin.RuleExecutionSet

setDefaultObjectFilter

public void setDefaultObjectFilter(String arg0)

Specified by:

setDefaultObjectFilter in interface javax.rules.admin.RuleExecutionSet

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

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

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

getContextFactory

public IContextFactory getContextFactory()

Specified by:

getContextFactory in interface IMRuleExecutionSet

setContextFactory

public void setContextFactory(IContextFactory contextFactory)

Specified by:

setContextFactory in interface IMRuleExecutionSet

getInternalDistinctAddonCacheCount

public int getInternalDistinctAddonCacheCount()

Specified by:

getInternalDistinctAddonCacheCount in interface IMRuleExecutionSet

Returns:

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

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

clone

public IMRuleExecutionSet 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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

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

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

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

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