com.massa.mrules.context.compile

Class AbstractCompilationContext

java.lang.Object

com.massa.mrules.context.AbstractContext

com.massa.mrules.context.compile.AbstractCompilationContext

All Implemented Interfaces:

ICompilationContext, IContext

Direct Known Subclasses:

MCompilationContext, MStandaloneCompilationContext

public abstract class AbstractCompilationContext
extends AbstractContext
implements ICompilationContext

Class allowing to compile the rule executionSet. A single instance might be reused multiple times, but is not thread safe.

See Also:

for further explanation on general usage of execution contexts.

Field Summary

Fields inherited from interface com.massa.mrules.context.compile.ICompilationContext

DEFAULT_COMPILE_LOGGER_NAME, DEFAULT_OPTIMIZE_LOGGER_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractCompilationContext()
AbstractCompilationContext(CompilationLevel compilationLevel)
AbstractCompilationContext(IMRuleExecutionSet executionSet)
AbstractCompilationContext(IMRuleExecutionSet executionSet, CompilationLevel compilationLevel)

Method Summary

Modifier and Type	Method and Description
void	clearRegisteredAddons() Clears all registered Addons.
void	compile() Convenience method to compile AND optimize the AbstractMRuleExecutionSet of this context with this context.
IExecutionContext	convertToExecutionContext() Allows to convert this compilation context to a "fake" execution context.
<A extends IAddon> AddonInfo	getAddonInfo(A addon)
List<IAddon>	getAllAddons() Gets all addons encountered during compilation process.
Set<IAddon>	getAllUniqueAddons() Gets all unique addons encountered during compilation process.
ICacheActivationResolver	getCacheActivationResolver()
CompilationLevel	getCompilationLevel() Returns requested CompilationLevel
String	getDefaultLoggerName()
Phase	getPhase() Returns current phase: COMPILE or OPTIMIZE.
Object	getProperty(Object key) Allows to retrieve properties shared between components during compilation process.
ICompilationContext	getRootContext() In case of sub context usage, this allows to access the root context.
void	init() INTERNAL USE ONLY: Called by rule engine to initialize and check before compilation.
boolean	isCacheEnabled(String feature) Tells if cache is enabled for a specific feature.
boolean	isOptimizationEnabled() Allows to completely disable optimization process.
boolean	registerAddon(IAddon parent, IAddon addon) Registers any encountered IAddon during compilation process.
void	registerAddonRecursively(IAddon parent, IAddon addon) Registers this Addon and all it's sub addons.
void	removeProperty(Object key) Allows to remove shared properties.
void	setCacheActivationResolver(ICacheActivationResolver cacheActivationResolver)
void	setCompilationLevel(CompilationLevel compilationLevel) CompilationLevel to use for compilation.
void	setLoggerName(String name) Allows to override logger name for an execution / a compilation.
void	setOptimizationEnabled(boolean optimizationEnabled) Is optimization process enabled?
void	setPhase(Phase phase) Sets current phase: COMPILE or OPTIMIZE.
void	setProperty(Object key, Object value) Allows to store properties to share between components during compilation process.

Methods inherited from class com.massa.mrules.context.AbstractContext

completeWrapping, getExecutionSet, getImports, getLog, getSecurityManager, getVariables, setExecutionSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.massa.mrules.context.IContext

getExecutionSet, getImports, getLog, getReadBaseType, getSecurityManager, getVariables, getWriteBaseType, setExecutionSet

Constructor Detail

AbstractCompilationContext

public AbstractCompilationContext()

AbstractCompilationContext

public AbstractCompilationContext(CompilationLevel compilationLevel)

AbstractCompilationContext

public AbstractCompilationContext(IMRuleExecutionSet executionSet)

AbstractCompilationContext

public AbstractCompilationContext(IMRuleExecutionSet executionSet,
                                  CompilationLevel compilationLevel)

Method Detail

compile

public void compile()
             throws MRuleValidationException

Description copied from interface: ICompilationContext

Convenience method to compile AND optimize the AbstractMRuleExecutionSet of this context with this context.

Specified by:

compile in interface ICompilationContext

Throws:

MRuleValidationException

See Also:

ICompilationContext.compile()

init

public void init()
          throws MRuleValidationException

Description copied from interface: ICompilationContext

INTERNAL USE ONLY: Called by rule engine to initialize and check before compilation.

Specified by:

init in interface ICompilationContext

Throws:

MRuleValidationException

See Also:

ICompilationContext.init()

setLoggerName

public void setLoggerName(String name)

Description copied from interface: IContext

Allows to override logger name for an execution / a compilation.
Set to null or empty String to reset to default. Default is ICompilationContext.DEFAULT_COMPILE_LOGGER_NAME or ICompilationContext.DEFAULT_OPTIMIZE_LOGGER_NAME or IExecutionContext.DEFAULT_LOGGER_NAME.
Use a suffix (i.e. ".suffix" starting with a dot) to add the suffix at the end of the default.
Otherwise, specify the full logger name.

Specified by:

setLoggerName in interface IContext

Overrides:

setLoggerName in class AbstractContext

getDefaultLoggerName

public String getDefaultLoggerName()

Specified by:

getDefaultLoggerName in class AbstractContext

Returns:

ICompilationContext.DEFAULT_COMPILE_LOGGER_NAME or ICompilationContext.DEFAULT_OPTIMIZE_LOGGER_NAME depending on the current phase.

getCompilationLevel

public CompilationLevel getCompilationLevel()

Description copied from interface: ICompilationContext

Returns requested CompilationLevel

Specified by:

getCompilationLevel in interface ICompilationContext

See Also:

ICompilationContext.getCompilationLevel()

setCompilationLevel

public void setCompilationLevel(CompilationLevel compilationLevel)

Description copied from interface: ICompilationContext

CompilationLevel to use for compilation.

Specified by:

setCompilationLevel in interface ICompilationContext

See Also:

ICompilationContext.setCompilationLevel(CompilationLevel)

getPhase

public Phase getPhase()

Returns current phase: COMPILE or OPTIMIZE.

Specified by:

getPhase in interface IContext

setPhase

public void setPhase(Phase phase)

Description copied from interface: ICompilationContext

Sets current phase: COMPILE or OPTIMIZE.
Internal use only.

Specified by:

setPhase in interface ICompilationContext

getProperty

public Object getProperty(Object key)

Description copied from interface: ICompilationContext

Allows to retrieve properties shared between components during compilation process.

Specified by:

getProperty in interface ICompilationContext

setProperty

public void setProperty(Object key,
                        Object value)

Description copied from interface: ICompilationContext

Allows to store properties to share between components during compilation process.

Specified by:

setProperty in interface ICompilationContext

removeProperty

public void removeProperty(Object key)

Description copied from interface: ICompilationContext

Allows to remove shared properties.

Specified by:

removeProperty in interface ICompilationContext

getAddonInfo

public <A extends IAddon> AddonInfo getAddonInfo(A addon)

Specified by:

getAddonInfo in interface ICompilationContext

Returns:

Addon Info for provided Addon.

registerAddon

public boolean registerAddon(IAddon parent,
                             IAddon addon)
                      throws MRuleValidationException

Description copied from interface: ICompilationContext

Registers any encountered IAddon during compilation process. If this specific instance has already been registered, this method does nothing.
If no similar IAddon has been registered, this method creates addon info for it.
If another similar IAddon has been registered, this method updates addon info and returns the same instance as provided.
Please note that only compiled addons should be provided to this method.
The hook IAddon.wasRegistered(ICompilationContext, IAddon, AddonInfo) is called at the end of the registration if registration is successful (i.e. if Addon was not already registered). Since 1.4.0, this method does not deduplicate anymore and so returns same instance as provided. This behaviour might change in future version so returned value should not be ignored. Since 1.5.0, An instance of IAddon is no more responsible for registering it's own sub-addons, as it's done automatically. The registration process is no more responsible for eventual deduplication, encapsulation, ... So the return type has been changed to boolean instead of formerly IAddon.

Specified by:

registerAddon in interface ICompilationContext

Parameters:

parent - Parent from which the addon was registered or [null | self] for root Addon.

addon - The addon to registered.

Returns:

true if registering successful, false if already registered.

Throws:

MRuleValidationException

registerAddonRecursively

public void registerAddonRecursively(IAddon parent,
                                     IAddon addon)
                              throws MRuleValidationException

Description copied from interface: ICompilationContext

Registers this Addon and all it's sub addons.
This methods handles addons or Collections of addons declared via PersistantProperties. If sub addons are declared differently (via Maps for instance) the IAddon.wasRegistered(ICompilationContext, IAddon, AddonInfo) hook has to be implemented.

Specified by:

registerAddonRecursively in interface ICompilationContext

Parameters:

parent - Parent from which the addon was registered or [null | self] for root Addon.

addon - The addon to registered recursively.

Throws:

MRuleValidationException

See Also:

ICompilationContext.registerAddon(IAddon, IAddon)

clearRegisteredAddons

public void clearRegisteredAddons()

Description copied from interface: ICompilationContext

Clears all registered Addons.

Specified by:

clearRegisteredAddons in interface ICompilationContext

getAllUniqueAddons

public Set<IAddon> getAllUniqueAddons()

Description copied from interface: ICompilationContext

Gets all unique addons encountered during compilation process. Two identical instances will not be contained twice.

Specified by:

getAllUniqueAddons in interface ICompilationContext

getAllAddons

public List<IAddon> getAllAddons()

Description copied from interface: ICompilationContext

Gets all addons encountered during compilation process. The same instance will not be contained twice, but two identical instances might be present.

Specified by:

getAllAddons in interface ICompilationContext

isCacheEnabled

public boolean isCacheEnabled(String feature)

Description copied from interface: ICompilationContext

Tells if cache is enabled for a specific feature.
If a ruleset is compiled with disabled cache for a feature, it must be recompiled to reactivate it.
Convenience method to interrogate cache activation resolver.

Specified by:

isCacheEnabled in interface ICompilationContext

Parameters:

feature - Feature for which to check cache activation

isOptimizationEnabled

public boolean isOptimizationEnabled()

Description copied from interface: ICompilationContext

Allows to completely disable optimization process.

Specified by:

isOptimizationEnabled in interface ICompilationContext

setOptimizationEnabled

public void setOptimizationEnabled(boolean optimizationEnabled)

Description copied from interface: ICompilationContext

Is optimization process enabled?

Specified by:

setOptimizationEnabled in interface ICompilationContext

getCacheActivationResolver

public ICacheActivationResolver getCacheActivationResolver()

Specified by:

getCacheActivationResolver in interface ICompilationContext

setCacheActivationResolver

public void setCacheActivationResolver(ICacheActivationResolver cacheActivationResolver)

Specified by:

setCacheActivationResolver in interface ICompilationContext

convertToExecutionContext

public IExecutionContext convertToExecutionContext()

Description copied from interface: ICompilationContext

Allows to convert this compilation context to a "fake" execution context.
The returned instance might have unsupported features. For example, read base and write base are null, as the compilation context only knows their types, but does not contain instances.

Specified by:

convertToExecutionContext in interface ICompilationContext

getRootContext

public ICompilationContext getRootContext()

Description copied from interface: IContext

In case of sub context usage, this allows to access the root context.
Calling this method on the root context returns the root context.

Specified by:

getRootContext in interface ICompilationContext

Specified by:

getRootContext in interface IContext

Overrides:

getRootContext in class AbstractContext

Returns:

The root context