com.massa.mrules.context.compile

Interface ICompilationContext

All Superinterfaces:

IContext

All Known Implementing Classes:

AbstractCompilationContext, CallableCompilationContext, CompilationContextWrapper, MCompilationContext, MExecutionContextConverter, MInOutCompilationContext, MListCompilationContext, MStandaloneCompilationContext

public interface ICompilationContext
extends IContext

Base methods for compilation contexts.
The compilations context will hold all useful data required by compilation, for example input / output beans if provided, optimization data, and different state informations.
It's accessible by all rule engine components during compilation and optimization phases.

As it holds data dedicated to a single execution, an instance should not be used by different Threads: it could lead to unpredictable behaviors. All Thread should own their own instance of the context to run executions.
But, a context instance should be reused multiple times for several executions. All specific data are reset at the beginning of the execution process.

Please also note that compilation phase will modify internal data of the rule set. As a consequence, the compilation should not be made several times in parallel on the same rule set, as it may lead to an unstable state.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_COMPILE_LOGGER_NAME Default logger used for compilation contexts.
static String	DEFAULT_OPTIMIZE_LOGGER_NAME Default logger used for compilation contexts.

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
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	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 interface com.massa.mrules.context.IContext

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

Field Detail

DEFAULT_COMPILE_LOGGER_NAME

static final String DEFAULT_COMPILE_LOGGER_NAME

Default logger used for compilation contexts.

See Also:

Constant Field Values

DEFAULT_OPTIMIZE_LOGGER_NAME

static final String DEFAULT_OPTIMIZE_LOGGER_NAME

Default logger used for compilation contexts.

See Also:

Constant Field Values

Method Detail

compile

void compile()
      throws MRuleValidationException

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

Throws:

MRuleValidationException

init

void init()
   throws MRuleValidationException

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

Throws:

MRuleValidationException

getCompilationLevel

CompilationLevel getCompilationLevel()

Returns requested CompilationLevel

setPhase

void setPhase(Phase phase)

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

setCompilationLevel

void setCompilationLevel(CompilationLevel compilationLevel)

CompilationLevel to use for compilation.

getAddonInfo

<A extends IAddon> AddonInfo getAddonInfo(A addon)

Returns:

Addon Info for provided Addon.

getRootContext

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 IContext

Returns:

The root context

registerAddon

boolean registerAddon(IAddon parent,
                      IAddon addon)
               throws MRuleValidationException

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.

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

void registerAddonRecursively(IAddon parent,
                              IAddon addon)
                       throws MRuleValidationException

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.

Parameters:

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

addon - The addon to registered recursively.

Throws:

MRuleValidationException

Since:

1.5.0

See Also:

registerAddon(IAddon, IAddon)

clearRegisteredAddons

void clearRegisteredAddons()

Clears all registered Addons.

Since:

1.8.0

getAllUniqueAddons

Set<IAddon> getAllUniqueAddons()

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

getAllAddons

List<IAddon> getAllAddons()

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

Since:

1.5.0

getProperty

Object getProperty(Object key)

Allows to retrieve properties shared between components during compilation process.

setProperty

void setProperty(Object key,
                 Object value)

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

removeProperty

void removeProperty(Object key)

Allows to remove shared properties.

getCacheActivationResolver

ICacheActivationResolver getCacheActivationResolver()

setCacheActivationResolver

void setCacheActivationResolver(ICacheActivationResolver cacheActivationResolver)

isCacheEnabled

boolean isCacheEnabled(String feature)

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.

Parameters:

feature - Feature for which to check cache activation

Since:

1.8.0

isOptimizationEnabled

boolean isOptimizationEnabled()

Allows to completely disable optimization process.

Since:

1.5.0

setOptimizationEnabled

void setOptimizationEnabled(boolean optimizationEnabled)

Is optimization process enabled?

Since:

1.5.0

convertToExecutionContext

IExecutionContext convertToExecutionContext()

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.