com.massa.mrules.executable

Class AbstractExecutable

java.lang.Object

com.massa.mrules.base.AbstractMRulesObject

com.massa.mrules.addon.AbstractAddon

com.massa.mrules.executable.AbstractExecutable

All Implemented Interfaces:

IAddon, IMRulesObject, IExecutable, Outable, Serializable, Cloneable, javax.rules.admin.Rule

Direct Known Subclasses:

AbstractBasicAction, AbstractVariableCreator, Call, MActionUndefine, MExecutionBlock, MIndex, MRule

public abstract class AbstractExecutable
extends AbstractAddon
implements IExecutable

Provides base utilities for Executable Rules.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.massa.mrules.executable.IExecutable

IExecutable.ValueReturning

Constructor Summary

Constructors

Constructor and Description
AbstractExecutable() Empty Constructor.

Method Summary

Modifier and Type	Method and Description
AbstractExecutable	clone() Clones the Addon.
static IExecutionResult	combineResults(IExecutionResult result, IExecutionResult subresult) Combine results' states to produce a new result.
void	compile(ICompilationContext ctxt) Logs compilation beginning, delegates real operations to compileExecutable(ICompilationContext) and the logs ending.
protected abstract void	compileExecutable(ICompilationContext ctxt) Called by compile(ICompilationContext) to perform compilation operations.
static void	compileExecutables(ICompilationContext ctxt, List<? extends IExecutable> executables) Launched compilation process on a List of IExecutable, if not empty or null.
IExecutionResult	execute(IExecutionContext ctxt) This method handles in / out logging and redirects to internalExecute(IExecutionContext) for specific implementation.
static IExecutionResult	execute(IExecutionContext ctxt, IAddon owner, List<? extends IExecutable> executables, boolean stopAtFirstValidatedCondition) Executes a list of IExecutable.
IExecutionResult	execute(IExecutionContext ctxt, List<? extends IExecutable> executables, boolean stopAtFirstValidatedCondition) An easy way to launch execute(IExecutionContext, IAddon, List, boolean) with owner = this.
Map<Object,Object>	getProperties() Get all properties.
Object	getProperty(Object key)
boolean	hasProperties() Has at least one property.
boolean	hasProperty(Object key) Contains the property identified by the provided key.
protected abstract IExecutionResult	internalExecute(IExecutionContext ctxt)
void	removeProperty(Object key) Removing property.
void	setProperty(Object key, Object value)

Methods inherited from class com.massa.mrules.addon.AbstractAddon

getInternalCacheIdentifier, isCacheUsed, isInternalCacheIdentifierNeeded, optimize, resetCachedData, setInternalCacheIdentifier, toString, wasRegistered

Methods inherited from class com.massa.mrules.base.AbstractMRulesObject

getDebugInfo, getDescription, getName, setDebugInfo, setDescription, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.massa.mrules.addon.IAddon

getImplementationId, getInternalCacheIdentifier, isCacheUsed, isInternalCacheIdentifierNeeded, optimize, resetCachedData, setInternalCacheIdentifier, wasRegistered

Methods inherited from interface com.massa.mrules.base.IMRulesObject

getDebugInfo, getDescription, getName, setDebugInfo, setDescription, setName

Methods inherited from interface com.massa.mrules.util.out.Outable

toString

Methods inherited from interface javax.rules.admin.Rule

getDescription, getName

Constructor Detail

AbstractExecutable

public AbstractExecutable()

Empty Constructor.

Method Detail

compile

public final void compile(ICompilationContext ctxt)
                   throws MRuleValidationException

Logs compilation beginning, delegates real operations to compileExecutable(ICompilationContext) and the logs ending.

Specified by:

compile in interface IExecutable

Throws:

MRuleValidationException - if validation problem detected.

compileExecutable

protected abstract void compileExecutable(ICompilationContext ctxt)
                                   throws MRuleValidationException

Called by compile(ICompilationContext) to perform compilation operations.

Throws:

MRuleValidationException

execute

public IExecutionResult execute(IExecutionContext ctxt)
                         throws MExecutionException

This method handles in / out logging and redirects to internalExecute(IExecutionContext) for specific implementation.

Specified by:

execute in interface IExecutable

Returns:

ExecutionResultState of the execution. Implementations should precise the semantic of the result, which can not be null.

Throws:

MConditionEvaluationException

MActionExecutionException

MExecutionException

internalExecute

protected abstract IExecutionResult internalExecute(IExecutionContext ctxt)
                                             throws MExecutionException

Throws:

MExecutionException

execute

public IExecutionResult execute(IExecutionContext ctxt,
                                List<? extends IExecutable> executables,
                                boolean stopAtFirstValidatedCondition)
                         throws MExecutionException

An easy way to launch execute(IExecutionContext, IAddon, List, boolean) with owner = this.

Throws:

MExecutionException

execute

public static IExecutionResult execute(IExecutionContext ctxt,
                                       IAddon owner,
                                       List<? extends IExecutable> executables,
                                       boolean stopAtFirstValidatedCondition)
                                throws MExecutionException

Executes a list of IExecutable.
Flow commands DONTSTOP and STOP are handled here, others are redirected to caller.

Parameters:

owner - the IExecutable requesting execution of sub-executables.

executables - the ordered list of IExecutable to launch.

Returns:

Execution results :

• Condition (see ExecutionResultState.combineConditionState(ExecutionResultState)) :
  • NA if none evaluated
  • OK if at least one OK
  • KO if all KO
• Action (see ExecutionResultState.combineActionState(ExecutionResultState)) :
  • NA if not actions executed
  • OK if all actions OK
  • KO if all actions KO
  • PARTIAL if some actions OK and others KO
• Stops all and returns it if a directive is raised.

Throws:

MExecutionException

compileExecutables

public static void compileExecutables(ICompilationContext ctxt,
                                      List<? extends IExecutable> executables)
                               throws MRuleValidationException

Launched compilation process on a List of IExecutable, if not empty or null.

Parameters:

ctxt -

executables -

Throws:

MRuleValidationException

combineResults

public static IExecutionResult combineResults(IExecutionResult result,
                                              IExecutionResult subresult)

Combine results' states to produce a new result.

clone

public AbstractExecutable clone()

Description copied from interface: IAddon

Clones the Addon.
The general contract is that the clone of a compiled Addon is still compiled.

Specified by:

clone in interface IAddon

Specified by:

clone in interface IMRulesObject

Specified by:

clone in interface IExecutable

Overrides:

clone in class AbstractAddon

getProperty

public Object getProperty(Object key)

Specified by:

getProperty in interface javax.rules.admin.Rule

setProperty

public void setProperty(Object key,
                        Object value)

Specified by:

setProperty in interface javax.rules.admin.Rule

removeProperty

public void removeProperty(Object key)

Description copied from interface: IExecutable

Removing property.

Specified by:

removeProperty in interface IExecutable

getProperties

public Map<Object,Object> getProperties()

Description copied from interface: IExecutable

Get all properties.

Specified by:

getProperties in interface IExecutable

hasProperty

public boolean hasProperty(Object key)

Description copied from interface: IExecutable

Contains the property identified by the provided key.

Specified by:

hasProperty in interface IExecutable

hasProperties

public boolean hasProperties()

Description copied from interface: IExecutable

Has at least one property.

Specified by:

hasProperties in interface IExecutable