com.massa.mrules.executable

Class MForEachNumber

java.lang.Object

com.massa.mrules.base.AbstractMRulesObject

com.massa.mrules.addon.AbstractAddon

com.massa.mrules.executable.AbstractExecutable

com.massa.mrules.executable.AbstractVariableCreator

com.massa.mrules.executable.MForEachNumber

All Implemented Interfaces:

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

@PersistantProperty(property="executables",alias="executable") @PersistantProperty(property="stopAtFirstValidatedCondition",defaultValue="true") @PersistantProperty(property="resetCache",defaultValue="false") @PersistantProperty(property="indexVar") @PersistantProperty(property="start") @PersistantProperty(property="end") @PersistantProperty(property="iterations") @PersistantProperty(property="increment")
public class MForEachNumber
extends AbstractVariableCreator

An action which iterates on a range of numbers, creates a variable with the current value and invokes executables for each value.
Number range can be created by several ways :

• Specifying start (default is 0), end and increment (default is 1)
• Specifying start (default is 0), increment and number of iterations
• Mixed, in which case it will stop at first reached ending condition

The iteration on sub-executables might stop on first validated condition (default is true, as it will be in many cases non final actions).
A parameter allows to clear context cached data at each execution (default is true).
Allows to create a local variable containing current index (starting at 1). Note: This class is thread safe at execution.

See Also:

Serialized Form

Nested Class Summary

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

IExecutable.ValueReturning

Field Summary

Fields

Modifier and Type	Field and Description
static String	FOREACHNUMBER_ID

Fields inherited from class com.massa.mrules.executable.AbstractVariableCreator

VAR_PREFIX

Constructor Summary

Constructors

Constructor and Description
MForEachNumber() Empty Constructor.

Method Summary

Modifier and Type	Method and Description
MForEachNumber	clone() Clones the Addon.
protected void	compileExecutable(ICompilationContext ctxt) Called by AbstractExecutable.compile(ICompilationContext) to perform compilation operations.
boolean	equals(Object o)
IReadAccessor	getEnd()
List<? extends IExecutable>	getExecutables()
String	getImplementationId() Unique addon implementation ID.
IReadAccessor	getIncrement()
String	getIndexVar()
String	getIndexVarName() Returns the index var name to use in context variable cache.
IReadAccessor	getIterations()
IReadAccessor	getStart()
int	hashCode()
protected IExecutionResult	internalExecute(IExecutionContext ctxt)
boolean	isResetCache()
boolean	isStopAtFirstValidatedCondition()
void	setEnd(IReadAccessor end)
void	setExecutables(List<? extends IExecutable> executables)
void	setIncrement(IReadAccessor increment)
void	setIndexVar(String indexVar)
void	setIterations(IReadAccessor iterations)
void	setResetCache(boolean resetCache)
void	setStart(IReadAccessor start)
void	setStopAtFirstValidatedCondition(boolean stopAtFirstValidatedCondition)
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.AbstractVariableCreator

debugVariableCreation, getType, getVar, getVarName, setType, setVar

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

FOREACHNUMBER_ID

public static final String FOREACHNUMBER_ID

See Also:

Constant Field Values

Constructor Detail

MForEachNumber

public MForEachNumber()

Empty 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.

Overrides:

compileExecutable in class AbstractVariableCreator

Throws:

MRuleValidationException

internalExecute

protected IExecutionResult internalExecute(IExecutionContext ctxt)
                                    throws MExecutionException

Specified by:

internalExecute in class AbstractExecutable

Returns:

Execution results :

• Condition :
  • always NA, as no conditions are evaluated here.
• 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 condition was not validated.
• OK if condition was validated

Throws:

MExecutionException

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 MForEachNumber 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 AbstractVariableCreator

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractVariableCreator

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractVariableCreator

getExecutables

public List<? extends IExecutable> getExecutables()

setExecutables

public void setExecutables(List<? extends IExecutable> executables)

isStopAtFirstValidatedCondition

public boolean isStopAtFirstValidatedCondition()

setStopAtFirstValidatedCondition

public void setStopAtFirstValidatedCondition(boolean stopAtFirstValidatedCondition)

isResetCache

public boolean isResetCache()

setResetCache

public void setResetCache(boolean resetCache)

getIndexVarName

public String getIndexVarName()

Returns the index var name to use in context variable cache.

getIndexVar

public String getIndexVar()

setIndexVar

public final void setIndexVar(String indexVar)

getStart

public IReadAccessor getStart()

setStart

public void setStart(IReadAccessor start)

getEnd

public IReadAccessor getEnd()

setEnd

public void setEnd(IReadAccessor end)

getIterations

public IReadAccessor getIterations()

setIterations

public void setIterations(IReadAccessor iterations)

getIncrement

public IReadAccessor getIncrement()

setIncrement

public void setIncrement(IReadAccessor increment)