com.massa.mrules.context.execute

Class AbstractExecutionContext

java.lang.Object

com.massa.mrules.context.AbstractContext

com.massa.mrules.context.execute.AbstractExecutionContext

All Implemented Interfaces:

IExecutionContext, IContext

Direct Known Subclasses:

MCompilationContextConverter, MExecutionContext, MStandaloneExecutionContext

public abstract class AbstractExecutionContext
extends AbstractContext
implements IExecutionContext

Class allowing to execute 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.execute.IExecutionContext

DEFAULT_LOGGER_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractExecutionContext()
AbstractExecutionContext(IMRuleExecutionSet executionSet)
AbstractExecutionContext(IMRuleExecutionSet executionSet, String loggerName)
AbstractExecutionContext(String loggerName)

Method Summary

Modifier and Type	Method and Description
protected void	completeWrapping(AbstractExecutionContext wrapper, boolean copyVariables) Completes execution context wrapping after calling super implementation.
void	debug(String msg) Writes a debug message.
void	debugEntering() Forces to enter a log sub-phase without logging any message.
void	debugEntering(String msg) Increments Debug Level : When entering into a sub-phase.
void	debugExiting() Forces to exit a log sub-phase without logging any message.
void	debugExiting(String msg) Decreases Debug Level : When exiting from a sub-phase.
void	debugParent(String msg) Writes a debug message indented once less (if possible).
void	debugSub(String msg) Writes a debug message indented once more.
IExecutionResult	execute() Convenience method to execute the MRuleExecutionSet of this context with this context.
Object	getCachedData(IAddon a) Retrieves data cached by IExecutionContext.setCachedData(IAddon, Object).
ExtPropertySource	getCachedPropertySource(Object src) Internal use only: Drastically disminuish memory footprint by caching Property Source Object.
ExtPropertySource	getCachedPropertySource(Object src, Class<?> defaultSrcType) Internal use only: Drastically disminuish memory footprint by caching Property Source Object.
String	getDefaultLoggerName()
Appendable	getErr() Gets error stream.
String	getLogSpaces() Get spaces corresponding to stack level.
Integer	getMaxDebugLevel()
Appendable	getOut() Gets standard stream.
String	getParentLogSpaces() Get spaces corresponding to stack level indented once less (if possible).
Phase	getPhase() Returns: Phase.COMPILE or Phase.OPTIMIZE for ICompilationContext Phase.EXECUTE for IExecutionContext
Class<?>	getReadBaseType() Returns IExecutionContext.getReadBase() class or null.
IExecutionContext	getRootContext() In case of sub context usage, this allows to access the root context.
MExecutionContext<Object>	getSubContextForNewBases(Object newBases) Gets a new Execution Context instance, modifying the following behaviours : Read and write bases are the provided newBases Cache is disabled
MInOutExecutionContext<Object,Object>	getSubContextForNewBases(Object newReadBase, Object newWriteBase) Gets a new Execution Context instance, modifying the following behaviours : Read and write bases are the provided newReadBase and newWriteBase Cache is disabled
MInOutExecutionContext<Object,Object>	getSubContextForNewVariables() Gets a new Execution Context instance, modifying the following behaviours : Variables repository is different
String	getSubLogSpaces() Get spaces corresponding to stack level indented once more.
Class<?>	getWriteBaseType() Returns IExecutionContext.getWriteBase() class or null.
boolean	hasCachedData(IAddon a) Tells if data are cached by IExecutionContext.setCachedData(IAddon, Object), included null value.
void	init() INTERNAL USE ONLY: Called by rule engine to initialize and check before execution.
boolean	isDebugEnabled() Debug is enabled if LOGGER has debug enabled.
void	resetCachedData() Resets all cached data for all addons.
Object	resetCachedData(IAddon a) Resets cached data for one addons, returning previously cached data.
Object	setCachedData(IAddon a, Object o) Allows to cache data for a given addon.
void	setErr(Appendable err) Changes error stream, which is System.err by default.
void	setMaxDebugLevel(Integer maxDebugLevel)
void	setOut(Appendable out) Changes standard stream, which is System.out by default.

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

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

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.execute.IExecutionContext

getReadBase, getWriteBase

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

getExecutionSet, getImports, getLog, getSecurityManager, getVariables, setExecutionSet, setLoggerName

Constructor Detail

AbstractExecutionContext

public AbstractExecutionContext()

AbstractExecutionContext

public AbstractExecutionContext(String loggerName)

AbstractExecutionContext

public AbstractExecutionContext(IMRuleExecutionSet executionSet)

AbstractExecutionContext

public AbstractExecutionContext(IMRuleExecutionSet executionSet,
                                String loggerName)

Method Detail

getLogSpaces

public String getLogSpaces()

Description copied from interface: IExecutionContext

Get spaces corresponding to stack level.

Specified by:

getLogSpaces in interface IExecutionContext

getSubLogSpaces

public String getSubLogSpaces()

Description copied from interface: IExecutionContext

Get spaces corresponding to stack level indented once more.

Specified by:

getSubLogSpaces in interface IExecutionContext

getParentLogSpaces

public String getParentLogSpaces()

Description copied from interface: IExecutionContext

Get spaces corresponding to stack level indented once less (if possible).

Specified by:

getParentLogSpaces in interface IExecutionContext

debugEntering

public void debugEntering()

Description copied from interface: IExecutionContext

Forces to enter a log sub-phase without logging any message.

Specified by:

debugEntering in interface IExecutionContext

See Also:

IExecutionContext.debugEntering()

debugEntering

public void debugEntering(String msg)

Description copied from interface: IExecutionContext

Increments Debug Level : When entering into a sub-phase.

Specified by:

debugEntering in interface IExecutionContext

See Also:

IExecutionContext.debugEntering(java.lang.String)

debug

public void debug(String msg)

Description copied from interface: IExecutionContext

Writes a debug message.

Specified by:

debug in interface IExecutionContext

See Also:

IExecutionContext.debug(java.lang.String)

debugSub

public void debugSub(String msg)

Description copied from interface: IExecutionContext

Writes a debug message indented once more.

Specified by:

debugSub in interface IExecutionContext

See Also:

IExecutionContext.debugSub(java.lang.String)

debugParent

public void debugParent(String msg)

Description copied from interface: IExecutionContext

Writes a debug message indented once less (if possible).

Specified by:

debugParent in interface IExecutionContext

See Also:

IExecutionContext.debugParent(java.lang.String)

debugExiting

public void debugExiting()

Description copied from interface: IExecutionContext

Forces to exit a log sub-phase without logging any message.

Specified by:

debugExiting in interface IExecutionContext

See Also:

IExecutionContext.debugExiting()

debugExiting

public void debugExiting(String msg)

Description copied from interface: IExecutionContext

Decreases Debug Level : When exiting from a sub-phase.

Specified by:

debugExiting in interface IExecutionContext

See Also:

IExecutionContext.debugExiting(java.lang.String)

isDebugEnabled

public boolean isDebugEnabled()

Description copied from interface: IExecutionContext

Debug is enabled if LOGGER has debug enabled.

Specified by:

isDebugEnabled in interface IExecutionContext

See Also:

IExecutionContext.isDebugEnabled()

execute

public IExecutionResult execute()
                         throws MExecutionException

Description copied from interface: IExecutionContext

Convenience method to execute the MRuleExecutionSet of this context with this context.

Specified by:

execute in interface IExecutionContext

Returns:

ExecutionResultState of the execution.

Throws:

MExecutionException

See Also:

IExecutionContext.execute()

init

public void init()
          throws MExecutionException

Description copied from interface: IExecutionContext

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

Specified by:

init in interface IExecutionContext

Throws:

MExecutionException

See Also:

IExecutionContext.init()

getDefaultLoggerName

public String getDefaultLoggerName()

Specified by:

getDefaultLoggerName in class AbstractContext

Returns:

IExecutionContext.DEFAULT_LOGGER_NAME

getCachedData

public Object getCachedData(IAddon a)

Description copied from interface: IExecutionContext

Retrieves data cached by IExecutionContext.setCachedData(IAddon, Object).

Specified by:

getCachedData in interface IExecutionContext

See Also:

IExecutionContext.getCachedData(IAddon)

setCachedData

public Object setCachedData(IAddon a,
                            Object o)

Description copied from interface: IExecutionContext

Allows to cache data for a given addon. Two identical instances have the same cache space. The cached data lives during the current execution only.

Specified by:

setCachedData in interface IExecutionContext

Returns:

previously cached data.

See Also:

IExecutionContext.setCachedData(IAddon, Object)

hasCachedData

public boolean hasCachedData(IAddon a)

Description copied from interface: IExecutionContext

Tells if data are cached by IExecutionContext.setCachedData(IAddon, Object), included null value.

Specified by:

hasCachedData in interface IExecutionContext

See Also:

IExecutionContext.hasCachedData(IAddon)

resetCachedData

public Object resetCachedData(IAddon a)

Description copied from interface: IExecutionContext

Resets cached data for one addons, returning previously cached data.
To force an addon instance to reset its cached data, please call the IAddon.resetCachedData(IExecutionContext).

Specified by:

resetCachedData in interface IExecutionContext

Returns:

previously cached data.

See Also:

IExecutionContext.resetCachedData(IAddon)

resetCachedData

public void resetCachedData()

Description copied from interface: IExecutionContext

Resets all cached data for all addons.

Specified by:

resetCachedData in interface IExecutionContext

See Also:

IExecutionContext.resetCachedData()

getCachedPropertySource

public ExtPropertySource getCachedPropertySource(Object src)

Description copied from interface: IExecutionContext

Internal use only: Drastically disminuish memory footprint by caching Property Source Object.

Specified by:

getCachedPropertySource in interface IExecutionContext

getCachedPropertySource

public ExtPropertySource getCachedPropertySource(Object src,
                                                 Class<?> defaultSrcType)

Description copied from interface: IExecutionContext

Internal use only: Drastically disminuish memory footprint by caching Property Source Object.

Specified by:

getCachedPropertySource in interface IExecutionContext

getPhase

public Phase getPhase()

Description copied from interface: IContext

Returns:

• Phase.COMPILE or Phase.OPTIMIZE for ICompilationContext
• Phase.EXECUTE for IExecutionContext

Specified by:

getPhase in interface IContext

getOut

public Appendable getOut()

Gets standard stream.

Specified by:

getOut in interface IExecutionContext

Returns:

Standard output stream for this context, dedicated to executables which print outputs. No log should be printed here. Defaults to System.out.

See Also:

IExecutionContext.getOut()

setOut

public void setOut(Appendable out)

Changes standard stream, which is System.out by default.

See Also:

IExecutionContext.getOut()

getErr

public Appendable getErr()

Gets error stream.

Specified by:

getErr in interface IExecutionContext

Returns:

Error output stream for this context, dedicated to executables which print outputs. No log should be printed here. Defaults to System.err.

See Also:

IExecutionContext.getErr()

setErr

public void setErr(Appendable err)

Changes error stream, which is System.err by default.

See Also:

IExecutionContext.getErr()

getReadBaseType

public Class<?> getReadBaseType()

Returns IExecutionContext.getReadBase() class or null.

Specified by:

getReadBaseType in interface IContext

getWriteBaseType

public Class<?> getWriteBaseType()

Returns IExecutionContext.getWriteBase() class or null.

Specified by:

getWriteBaseType in interface IContext

getMaxDebugLevel

public Integer getMaxDebugLevel()

setMaxDebugLevel

public void setMaxDebugLevel(Integer maxDebugLevel)

getRootContext

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

Specified by:

getRootContext in interface IContext

Overrides:

getRootContext in class AbstractContext

Returns:

The root context

getSubContextForNewVariables

public MInOutExecutionContext<Object,Object> getSubContextForNewVariables()

Description copied from interface: IExecutionContext

Gets a new Execution Context instance, modifying the following behaviours :

• Variables repository is different

Specified by:

getSubContextForNewVariables in interface IExecutionContext

getSubContextForNewBases

public MExecutionContext<Object> getSubContextForNewBases(Object newBases)

Description copied from interface: IExecutionContext

Gets a new Execution Context instance, modifying the following behaviours :

• Read and write bases are the provided newBases
• Cache is disabled

Specified by:

getSubContextForNewBases in interface IExecutionContext

getSubContextForNewBases

public MInOutExecutionContext<Object,Object> getSubContextForNewBases(Object newReadBase,
                                                                      Object newWriteBase)

Description copied from interface: IExecutionContext

Gets a new Execution Context instance, modifying the following behaviours :

• Read and write bases are the provided newReadBase and newWriteBase
• Cache is disabled

Specified by:

getSubContextForNewBases in interface IExecutionContext

completeWrapping

protected void completeWrapping(AbstractExecutionContext wrapper,
                                boolean copyVariables)

Completes execution context wrapping after calling super implementation. Internal use only.