com.massa.mrules.optimizer

Class AbstractRecursiveOptimizer

java.lang.Object

com.massa.mrules.optimizer.AbstractOptimizer

com.massa.mrules.optimizer.AbstractRecursiveOptimizer

All Implemented Interfaces:

IMOptimizer

Direct Known Subclasses:

MConstantOptimizer, MDeduplicationOptimizer, MExpressionOptimizer, MReturnStatementOptimizer

public abstract class AbstractRecursiveOptimizer
extends AbstractOptimizer

Base implementation for all optimizers which need to browse recursively all addons hierarchy of a rule set.
It browses all addons hierarchy from top root addon, including those contained in Collections or Maps (only values are handled).

Since:

1.5.0

Constructor Summary

Constructors

Constructor and Description
AbstractRecursiveOptimizer()

Method Summary

Modifier and Type	Method and Description
protected abstract IAddon	doAfterChildren(ICompilationContext ctxt, IAddon parent, PersistantPropertyInfo parentProp, IAddon addon) Hook called by pOptimizeRecursively(ICompilationContext, IAddon, PersistantPropertyInfo, IAddon) after browsing all sub addons.
protected abstract IAddon	doBeforeChildren(ICompilationContext ctxt, IAddon parent, PersistantPropertyInfo parentProp, IAddon addon) Hook called by pOptimizeRecursively(ICompilationContext, IAddon, PersistantPropertyInfo, IAddon) before browsing all sub addons.
protected void	pOptimize(ICompilationContext ctxt, IAddon addon) Intermediate method between optimizer's entry point and recursive method, allowing for example to implement easily multi-pass optimizers.
protected void	pOptimizeInCollection(ICompilationContext ctxt, IAddon parent, PersistantPropertyInfo parentProp, Collection<Object> propValues) Allows to parse a collection and call pOptimizeRecursively(ICompilationContext, IAddon, PersistantPropertyInfo, IAddon) on all addons it contains.
protected void	pOptimizeInMap(ICompilationContext ctxt, IAddon parent, PersistantPropertyInfo parentProp, Map<Object,Object> propValues) Allows to parse a map and call pOptimizeRecursively(ICompilationContext, IAddon, PersistantPropertyInfo, IAddon) on all addons it contains in values.
protected IAddon	pOptimizeRecursively(ICompilationContext ctxt, IAddon parent, PersistantPropertyInfo parentProp, IAddon addon) Recursive method allowing to browse addon hierarchy.

Methods inherited from class com.massa.mrules.optimizer.AbstractOptimizer

getActivationPropertyName, isActivated, optimize, setActivated

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRecursiveOptimizer

public AbstractRecursiveOptimizer()

Method Detail

pOptimize

protected void pOptimize(ICompilationContext ctxt,
                         IAddon addon)
                  throws MRuleValidationException

Intermediate method between optimizer's entry point and recursive method, allowing for example to implement easily multi-pass optimizers. Default implementation simply redirects to recursive method.

Specified by:

pOptimize in class AbstractOptimizer

Throws:

MRuleValidationException

pOptimizeRecursively

protected IAddon pOptimizeRecursively(ICompilationContext ctxt,
                                      IAddon parent,
                                      PersistantPropertyInfo parentProp,
                                      IAddon addon)
                               throws MRuleValidationException

Recursive method allowing to browse addon hierarchy. If returned addon is different from the provided one, it will be replaced in parent.
First call with root addon must be done with a null parent.

Parameters:

ctxt -

parent - Parent addon (null for root optimization)

parentProp - Property in parent (null for root optimization)

addon - Addon to optimize

Returns:

Optimized addon

Throws:

MRuleValidationException

doBeforeChildren

protected abstract IAddon doBeforeChildren(ICompilationContext ctxt,
                                           IAddon parent,
                                           PersistantPropertyInfo parentProp,
                                           IAddon addon)
                                    throws MRuleValidationException

Hook called by pOptimizeRecursively(ICompilationContext, IAddon, PersistantPropertyInfo, IAddon) before browsing all sub addons.
If the addon is modified but should not be replaced, this method should return null, otherwise browsing of sub addons will not be made.
Implementation are responsible for compiling and optimizing new Addon if neccessary.

Returns:

A new addon instance if the addon should be replaced in the parent. Null if not.

Throws:

MRuleValidationException

doAfterChildren

protected abstract IAddon doAfterChildren(ICompilationContext ctxt,
                                          IAddon parent,
                                          PersistantPropertyInfo parentProp,
                                          IAddon addon)
                                   throws MRuleValidationException

Hook called by pOptimizeRecursively(ICompilationContext, IAddon, PersistantPropertyInfo, IAddon) after browsing all sub addons.
If the addon is modified but should not be replaced, this method should return null.
Implementation are responsible for compiling and optimizing new Addon if neccessary.

Returns:

A new addon instance if the addon should be replaced in the parent. Null if not.

Throws:

MRuleValidationException

pOptimizeInCollection

protected void pOptimizeInCollection(ICompilationContext ctxt,
                                     IAddon parent,
                                     PersistantPropertyInfo parentProp,
                                     Collection<Object> propValues)
                              throws MRuleValidationException

Allows to parse a collection and call pOptimizeRecursively(ICompilationContext, IAddon, PersistantPropertyInfo, IAddon) on all addons it contains.

Throws:

MRuleValidationException

pOptimizeInMap

protected void pOptimizeInMap(ICompilationContext ctxt,
                              IAddon parent,
                              PersistantPropertyInfo parentProp,
                              Map<Object,Object> propValues)
                       throws MRuleValidationException

Allows to parse a map and call pOptimizeRecursively(ICompilationContext, IAddon, PersistantPropertyInfo, IAddon) on all addons it contains in values.

Throws:

MRuleValidationException