com.massa.mrules.optimizer

Class AbstractOptimizer

java.lang.Object

com.massa.mrules.optimizer.AbstractOptimizer

All Implemented Interfaces:

IMOptimizer

Direct Known Subclasses:

AbstractRecursiveOptimizer, MSpecificAddonOptimizeOptimizer

public abstract class AbstractOptimizer
extends Object
implements IMOptimizer

Base implementation for all optimizers.
It allows the optimizer to be declared, but deactivated by default (with the "activated" flag to "false" in global configuration). And it also allows to force it's activation / deactivation via a rule set specific property. This property is boolean and the property name is provided by the abstract method "getActivationPropertyName". To force deactivation of this optimizer for a specific rule set, the following property must be added to the rule set: [key: my.optimizer.package.MyOptimizerClass.activated / value: false]. To force activation of this optimizer for a specific rule set, the following property must be added to the rule set: [key: my.optimizer.package.MyOptimizerClass.activated / value: true].

Since:

1.5.0

Constructor Summary

Constructors

Constructor and Description
AbstractOptimizer()

Method Summary

Modifier and Type	Method and Description
String	getActivationPropertyName() Name of the property allowing to force activation or deactivation of the optimizer on a specific rule set.
boolean	isActivated()
void	optimize(ICompilationContext ctxt, IAddon rootAddon) Checks activation and delegated optimization to pOptimize(ICompilationContext, IAddon).
protected abstract void	pOptimize(ICompilationContext ctxt, IAddon addon) Performs optimization.
void	setActivated(boolean activated)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractOptimizer

public AbstractOptimizer()

Method Detail

optimize

public final void optimize(ICompilationContext ctxt,
                           IAddon rootAddon)
                    throws MRuleValidationException

Checks activation and delegated optimization to pOptimize(ICompilationContext, IAddon).

Specified by:

optimize in interface IMOptimizer

Parameters:

ctxt - Compilation context

rootAddon - Addon to optimize

Throws:

MRuleValidationException

getActivationPropertyName

public String getActivationPropertyName()

Name of the property allowing to force activation or deactivation of the optimizer on a specific rule set.
Default returns [fully qualified class name] + "activated".

pOptimize

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

Performs optimization.

Throws:

MRuleValidationException

isActivated

public boolean isActivated()

setActivated

public void setActivated(boolean activated)