com.massa.mrules.executable

Class MRule

java.lang.Object

com.massa.mrules.base.AbstractMRulesObject

com.massa.mrules.addon.AbstractAddon

com.massa.mrules.executable.AbstractExecutable

com.massa.mrules.executable.MRule

All Implemented Interfaces:

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

@PersistantProperty(property="condition") @PersistantProperty(property="thens",alias="then") @PersistantProperty(property="elseifs",alias="elseif") @PersistantProperty(property="elses",alias="else") @PersistantProperty(property="stopAtFirstValidatedCondition",defaultValue="false")
public class MRule
extends AbstractExecutable

A complete set of condition to evaluate and actions to perform according to evaluation result.
The iteration on sub-thens might stop on first validated condition (default is false, as it will be in many cases non final actions).
Note: This class is thread safe at execution.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MRule.ElseIf

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

IExecutable.ValueReturning

Field Summary

Fields

Modifier and Type	Field and Description
static String	RULE_ID

Constructor Summary

Constructors

Constructor and Description
MRule() Empty Constructor.
MRule(ICondition condition, List<IExecutable> thens) Constructor without thens
MRule(ICondition condition, List<IExecutable> thens, List<IExecutable> elses) Complete constructor
MRule(List<IExecutable> thens) Constructor typically used for default rule

Method Summary

Modifier and Type	Method and Description
MRule	clone() Clones the Addon.
protected void	compileExecutable(ICompilationContext ctxt) Called by AbstractExecutable.compile(ICompilationContext) to perform compilation operations.
void	debugEntering(IExecutionContext ctxt, IAddon addon) Called at beginning of AbstractExecutable.execute(IExecutionContext).
boolean	equals(Object o)
ICondition	getCondition()
List<MRule.ElseIf>	getElseifs()
List<? extends IExecutable>	getElses()
String	getImplementationId() Unique addon implementation ID.
List<? extends IExecutable>	getThens()
int	hashCode()
protected IExecutionResult	internalExecute(IExecutionContext ctxt)
boolean	isStopAtFirstValidatedCondition()
void	setCondition(ICondition conditions)
void	setElseifs(List<MRule.ElseIf> elseifs)
void	setElses(List<? extends IExecutable> elses)
void	setStopAtFirstValidatedCondition(boolean stopAtFirstValidatedCondition)
void	setThens(List<? extends IExecutable> thens)
void	toString(OuterWithLevel outer) Method used to send String representation of the current object to the OuterWithLevel.

Methods inherited from class com.massa.mrules.executable.AbstractExecutable

combineResults, compile, compileExecutables, execute, execute, execute, getProperties, getProperty, hasProperties, hasProperty, removeProperty, setProperty

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

finalize, getClass, notify, notifyAll, wait, wait, wait

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

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 javax.rules.admin.Rule

getDescription, getName

Field Detail

RULE_ID

public static final String RULE_ID

See Also:

Constant Field Values

Constructor Detail

MRule

public MRule()

Empty Constructor.

MRule

public MRule(List<IExecutable> thens)

Constructor typically used for default rule

MRule

public MRule(ICondition condition,
             List<IExecutable> thens)

Constructor without thens

MRule

public MRule(ICondition condition,
             List<IExecutable> thens,
             List<IExecutable> elses)

Complete constructor

Method Detail

compileExecutable

protected void compileExecutable(ICompilationContext ctxt)
                          throws MRuleValidationException

Description copied from class: AbstractExecutable

Called by AbstractExecutable.compile(ICompilationContext) to perform compilation operations.

Specified by:

compileExecutable in class AbstractExecutable

Throws:

MRuleValidationException

internalExecute

protected IExecutionResult internalExecute(IExecutionContext ctxt)
                                    throws MExecutionException

Specified by:

internalExecute in class AbstractExecutable

Returns:

Execution results :

• Condition :
  • NA if none evaluated
  • OK if evaluation is true ("thens" have been executed)
  • OK if evaluation is false ("elses" have been executed)
• 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

Throws:

MExecutionException

debugEntering

public void debugEntering(IExecutionContext ctxt,
                          IAddon addon)

Called at beginning of AbstractExecutable.execute(IExecutionContext).

getImplementationId

public String getImplementationId()

Description copied from interface: IAddon

Unique addon implementation ID. In case of conflict, an Class Initialization error will be raised.

clone

public MRule 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 AbstractExecutable

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public void toString(OuterWithLevel outer)
              throws IOException

Description copied from interface: Outable

Method used to send String representation of the current object to the OuterWithLevel.

Throws:

IOException

getCondition

public ICondition getCondition()

setCondition

public void setCondition(ICondition conditions)

getThens

public List<? extends IExecutable> getThens()

setThens

public void setThens(List<? extends IExecutable> thens)

getElseifs

public List<MRule.ElseIf> getElseifs()

setElseifs

public void setElseifs(List<MRule.ElseIf> elseifs)

getElses

public List<? extends IExecutable> getElses()

setElses

public void setElses(List<? extends IExecutable> elses)

isStopAtFirstValidatedCondition

public boolean isStopAtFirstValidatedCondition()

setStopAtFirstValidatedCondition

public void setStopAtFirstValidatedCondition(boolean stopAtFirstValidatedCondition)