com.massa.mrules.accessor

Class MIterateAccessor

java.lang.Object

com.massa.mrules.base.AbstractMRulesObject

com.massa.mrules.addon.AbstractAddon

com.massa.mrules.accessor.AbstractReadAccessor

com.massa.mrules.accessor.MIterateAccessor

All Implemented Interfaces:

IAccessor, IAccessorValueHandler, IReadAccessor, IAddon, IMRulesObject, Outable, Serializable, Cloneable

@PersistantProperty(property="source") @PersistantProperty(property="values",alias="value") @PersistantProperty(property="separator",defaultValue=";")
public class MIterateAccessor
extends AbstractReadAccessor
implements IAccessorValueHandler

Allows to iterate on:

• All items returned by a single source, which might be a String, an Iterable, an Iterator, an Enumeration or an Array.
• All items provided by multiple values.

Only one of source and values must be provided.
If source is a String, it's considered as delimited values, and the "separator" property is used for the split. The default separator is ";".

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.massa.mrules.accessor.IReadAccessor

IReadAccessor.Standalone

Field Summary

Fields

Modifier and Type	Field and Description
static String	ITERATE_ID

Constructor Summary

Constructors

Constructor and Description
MIterateAccessor()
MIterateAccessor(IReadAccessor source)
MIterateAccessor(IReadAccessor delimitedsource, String separator)
MIterateAccessor(List<IReadAccessor> sources)

Method Summary

Modifier and Type	Method and Description
MIterateAccessor	clone() Clones the Addon.
<G,C extends Collection<G>> void	compileCollection(ICompilationContext ctxt, Class<C> expectedType, Class<G> expectedGenericType) Implementation to handle case when expected result is a Collection.
void	compileValue(ICompilationContext ctxt, Class<?> expectedType) Implementation to handle case when expected result is a single value.
boolean	equals(Object o)
CostInfo	getEstimatedReadCost(ICompilationContext ctxt) Estimates the reading complexity, to allow callers to optimize calls.
Class<?>	getGenericCollectionType(IContext ctxt) Returns the Generic type, if value is a collection or an array, evaluated : at compilation time for standard compilation at runtime for light compilation and execution phase or null if the type can't be resolved or value is not a collection.
String	getImplementationId() Unique addon implementation ID.
String	getSeparator()
IReadAccessor	getSource()
Class<?>	getType(IContext ctxt) Returns the value's class, evaluated : at compilation time for standard compilation at runtime for light compilation or null if the type can't be resolved.
List<IReadAccessor>	getValues()
Iterator<?>	handleValue(IExecutionContext ctxt, Object value) Called for each value of the iterated element.
int	hashCode()
protected Object	internalGet(IExecutionContext ctxt) Specific addon implementation must be here.
boolean	isCacheUsed() Returns false by default.
boolean	isConstantValue() Detects if the result will always be the same.
boolean	isShouldIterate() If this iterator is dedicated to iterate over values, then it should be precised.
void	optimize(ICompilationContext ctxt) The automatic global constant value detection can not be applied to this implementation.
void	setSeparator(String separator)
void	setSource(IReadAccessor source)
void	setValues(List<IReadAccessor> sources)
void	toString(OuterWithLevel outer) Method used to send String representation of the current object to the OuterWithLevel.

Methods inherited from class com.massa.mrules.accessor.AbstractReadAccessor

castToExpected, compileRead, compileRead, compileRead, compileRead, get, getGenericTypes, isShouldBeWrappedToConstantValue, isShouldNotCache

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

getInternalCacheIdentifier, isInternalCacheIdentifierNeeded, 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, isInternalCacheIdentifierNeeded, resetCachedData, setInternalCacheIdentifier, wasRegistered

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

getDebugInfo, getDescription, getName, setDebugInfo, setDescription, setName

Field Detail

ITERATE_ID

public static final String ITERATE_ID

See Also:

Constant Field Values

Constructor Detail

MIterateAccessor

public MIterateAccessor()

MIterateAccessor

public MIterateAccessor(IReadAccessor source)

MIterateAccessor

public MIterateAccessor(List<IReadAccessor> sources)

MIterateAccessor

public MIterateAccessor(IReadAccessor delimitedsource,
                        String separator)

Method Detail

compileValue

public void compileValue(ICompilationContext ctxt,
                         Class<?> expectedType)
                  throws MRuleValidationException

Description copied from class: AbstractReadAccessor

Implementation to handle case when expected result is a single value.

Specified by:

compileValue in class AbstractReadAccessor

Throws:

MRuleValidationException

compileCollection

public <G,C extends Collection<G>> void compileCollection(ICompilationContext ctxt,
                                                          Class<C> expectedType,
                                                          Class<G> expectedGenericType)
                                                   throws MRuleValidationException

Description copied from class: AbstractReadAccessor

Implementation to handle case when expected result is a Collection.

Specified by:

compileCollection in class AbstractReadAccessor

Throws:

MRuleValidationException

optimize

public void optimize(ICompilationContext ctxt)
              throws MRuleValidationException

The automatic global constant value detection can not be applied to this implementation. So a specific optimization is implemented here.

Specified by:

optimize in interface IAddon

Overrides:

optimize in class AbstractAddon

Throws:

MRuleValidationException

getEstimatedReadCost

public CostInfo getEstimatedReadCost(ICompilationContext ctxt)
                              throws MRuleValidationException

Description copied from interface: IReadAccessor

Estimates the reading complexity, to allow callers to optimize calls. Calls to this method should be done on a compiled accessor, so that all information is available to compute complexity.
Calls to non-compiled instance may return non-accurate results.

Specified by:

getEstimatedReadCost in interface IReadAccessor

Parameters:

ctxt - Compilation context.

Throws:

MRuleValidationException - if validation problem detected.

internalGet

protected Object internalGet(IExecutionContext ctxt)
                      throws MAccessorException

Description copied from class: AbstractReadAccessor

Specific addon implementation must be here.

Specified by:

internalGet in class AbstractReadAccessor

Throws:

MAccessorException

handleValue

public Iterator<?> handleValue(IExecutionContext ctxt,
                               Object value)
                        throws MAccessorException

Description copied from interface: IAccessorValueHandler

Called for each value of the iterated element.

Specified by:

handleValue in interface IAccessorValueHandler

Throws:

MAccessorException

isConstantValue

public boolean isConstantValue()

Detects if the result will always be the same.

Specified by:

isConstantValue in interface IReadAccessor

Overrides:

isConstantValue in class AbstractReadAccessor

getType

public Class<?> getType(IContext ctxt)
                 throws MAccessorException

Description copied from interface: IAccessor

Returns the value's class, evaluated :

• at compilation time for standard compilation
• at runtime for light compilation

or null if the type can't be resolved.

Specified by:

getType in interface IAccessor

Throws:

MAccessorException

getGenericCollectionType

public Class<?> getGenericCollectionType(IContext ctxt)
                                  throws MAccessorException

Description copied from interface: IAccessor

Returns the Generic type, if value is a collection or an array, evaluated :

• at compilation time for standard compilation
• at runtime for light compilation and execution phase

or null if the type can't be resolved or value is not a collection.

Specified by:

getGenericCollectionType in interface IAccessor

Throws:

MAccessorException

getImplementationId

public String getImplementationId()

Description copied from interface: IAddon

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

Specified by:

getImplementationId in interface IAddon

isCacheUsed

public boolean isCacheUsed()

Description copied from class: AbstractAddon

Returns false by default.

Specified by:

isCacheUsed in interface IAddon

Overrides:

isCacheUsed in class AbstractAddon

clone

public MIterateAccessor 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 IAccessor

Specified by:

clone in interface IReadAccessor

Specified by:

clone in interface IAddon

Specified by:

clone in interface IMRulesObject

Overrides:

clone in class AbstractReadAccessor

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isShouldIterate

public boolean isShouldIterate()

Description copied from interface: IReadAccessor

If this iterator is dedicated to iterate over values, then it should be precised. In this case, the "get" method should return an Iterator, of instances of "getType".
Non-read only accessors should not be iterable. BUT it's not mandatory. In this particular case, the "set" method should be described precisely ...
Please not that returned Iterators should not support the "remove" method.
They also should use MRuleInternalRuntimeException if Exception must be thrown.
This method is not dependent on the compilation process. it can be called before and will return the correct result.

Specified by:

isShouldIterate in interface IReadAccessor

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.

Specified by:

toString in interface Outable

Throws:

IOException

getSource

public IReadAccessor getSource()

setSource

public void setSource(IReadAccessor source)

getValues

public List<IReadAccessor> getValues()

setValues

public void setValues(List<IReadAccessor> sources)

getSeparator

public String getSeparator()

setSeparator

public void setSeparator(String separator)