com.massa.mrules.executable

Class MIndex

java.lang.Object

com.massa.mrules.base.AbstractMRulesObject

com.massa.mrules.addon.AbstractAddon

com.massa.mrules.executable.AbstractExecutable

com.massa.mrules.executable.MIndex

All Implemented Interfaces:

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

@PersistantProperty(property="source") @PersistantProperty(property="index") @PersistantProperty(property="defaultRedirect") @PersistantProperty(property="defaultActions",alias="defaultAction") @PersistantProperty(property="stopAtFirstValidatedCondition",defaultValue="true") @PersistantProperty(property="stopAtFirstValidatedDefaultCondition",defaultValue="false")
public class MIndex
extends AbstractExecutable

A complete set of conditions to evaluate and actions to perform according to evaluation result.
The iteration on index sub-executables might stop on first validated condition (default is true, as it will be in many cases non final actions).
The iteration on default sub-executables might stop on first validated condition (default is false, as it will be in many cases 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	MIndex.IndexAction This class contains description of what to do when an index value corresponds to the entity value.

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

IExecutable.ValueReturning

Field Summary

Fields

Modifier and Type	Field and Description
static String	INDEX_ID

Constructor Summary

Constructors

Constructor and Description
MIndex() Empty Constructor.
MIndex(IReadAccessor source, Map<Object,MIndex.IndexAction> index)
MIndex(IReadAccessor source, Map<Object,MIndex.IndexAction> index, List<? extends IExecutable> defaultActions) Complete constructor

Method Summary

Modifier and Type	Method and Description
MIndex	clone() Clones the Addon.
protected void	compileExecutable(ICompilationContext ctxt) Called by AbstractExecutable.compile(ICompilationContext) to perform compilation operations.
protected void	debugAfterIndex(IExecutionContext ctxt, boolean valueFound) Called in AbstractExecutable.execute(IExecutionContext), between conditions evaluation and actions execution.
void	debugEntering(IExecutionContext ctxt, IAddon addon) Called at beginning of AbstractExecutable.execute(IExecutionContext).
boolean	equals(Object o)
List<? extends IExecutable>	getDefaultActions()
Object	getDefaultRedirect()
String	getImplementationId() Unique addon implementation ID.
Map<Object,MIndex.IndexAction>	getIndex()
IReadAccessor	getSource()
int	hashCode()
protected IExecutionResult	internalExecute(IExecutionContext ctxt)
boolean	isStopAtFirstValidatedCondition()
boolean	isStopAtFirstValidatedDefaultCondition()
void	setDefaultActions(List<? extends IExecutable> defaultActions)
void	setDefaultRedirect(Object defaultRedirect)
void	setIndex(Map<Object,MIndex.IndexAction> index)
void	setSource(IReadAccessor source)
void	setStopAtFirstValidatedCondition(boolean stopAtFirstValidatedCondition)
void	setStopAtFirstValidatedDefaultCondition(boolean stopAtFirstDefaultValidatedCondition)
void	toString(OuterWithLevel outer) Method used to send String representation of the current object to the OuterWithLevel.
boolean	wasRegistered(ICompilationContext ctxt, IAddon parent, AddonInfo info) Convenience method, which does nothing.

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

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

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

INDEX_ID

public static final String INDEX_ID

See Also:

Constant Field Values

Constructor Detail

MIndex

public MIndex()

Empty Constructor.

MIndex

public MIndex(IReadAccessor source,
              Map<Object,MIndex.IndexAction> index)

MIndex

public MIndex(IReadAccessor source,
              Map<Object,MIndex.IndexAction> index,
              List<? extends IExecutable> defaultActions)

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

wasRegistered

public boolean wasRegistered(ICompilationContext ctxt,
                             IAddon parent,
                             AddonInfo info)
                      throws MRuleValidationException

Description copied from class: AbstractAddon

Convenience method, which does nothing. All implementing classes may override to perform internal operations, starting with a "super" call to keep compatibility with future versions.

Specified by:

wasRegistered in interface IAddon

Overrides:

wasRegistered in class AbstractAddon

parent - Parent from which this instance of addon was registered.

info - Addon info for the currently registered addon

Returns:

false

Throws:

MRuleValidationException

internalExecute

protected IExecutionResult internalExecute(IExecutionContext ctxt)
                                    throws MExecutionException

Specified by:

internalExecute in class AbstractExecutable

Returns:

Execution results :

• Condition :
  • OK if indexed value had a match.
  • KO if indexed value had no match (default actions have been executed if any).
• 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

• KO if indexed value had no match (default actions have been executed if any).
• OK otherwise

Throws:

MExecutionException

debugEntering

public void debugEntering(IExecutionContext ctxt,
                          IAddon addon)

Called at beginning of AbstractExecutable.execute(IExecutionContext).

debugAfterIndex

protected void debugAfterIndex(IExecutionContext ctxt,
                               boolean valueFound)

Called in AbstractExecutable.execute(IExecutionContext), between conditions evaluation and actions execution.

getImplementationId

public String getImplementationId()

Description copied from interface: IAddon

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

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

clone

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

getSource

public IReadAccessor getSource()

setSource

public void setSource(IReadAccessor source)

getIndex

public Map<Object,MIndex.IndexAction> getIndex()

setIndex

public void setIndex(Map<Object,MIndex.IndexAction> index)

getDefaultRedirect

public Object getDefaultRedirect()

setDefaultRedirect

public void setDefaultRedirect(Object defaultRedirect)

getDefaultActions

public List<? extends IExecutable> getDefaultActions()

setDefaultActions

public void setDefaultActions(List<? extends IExecutable> defaultActions)

isStopAtFirstValidatedCondition

public boolean isStopAtFirstValidatedCondition()

setStopAtFirstValidatedCondition

public void setStopAtFirstValidatedCondition(boolean stopAtFirstValidatedCondition)

isStopAtFirstValidatedDefaultCondition

public boolean isStopAtFirstValidatedDefaultCondition()

setStopAtFirstValidatedDefaultCondition

public void setStopAtFirstValidatedDefaultCondition(boolean stopAtFirstDefaultValidatedCondition)