com.massa.mrules.accessor

Class AbstractReadSourceAccessor

java.lang.Object

com.massa.mrules.base.AbstractMRulesObject

com.massa.mrules.addon.AbstractAddon

com.massa.mrules.accessor.AbstractReadAccessor

com.massa.mrules.accessor.AbstractReadSourceAccessor

All Implemented Interfaces:

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

Direct Known Subclasses:

Abs, AbstractMapAccessor, MCastAccessor, MDateManipulationAccessor, MNullIfEmptyAccessor, MSearchAccessor, MSizeAccessor, MSplitAccessor, Round

@PersistantProperties(properties=@PersistantProperty(property="source"))
public abstract class AbstractReadSourceAccessor
extends AbstractReadAccessor
implements IAccessorValueHandler

This class intends to provide a base for accessors dedicated to read a source sub-accessor and transform the value in any way. The source is validated but not compiled. The equals and clone methods are implemented but should be overriden if other parameters are added. The get and handle methods are implemented, so that the eventual casts are performed and the implementing class only has to worry about the transformation of the value.
The source might be iterable, in which case the result will be too.
This abstract accessor also handles modifying all members of a Collection, in which case it will return a new Collection instance. This behaviour is decided by the abstract method "parseCollection".

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
protected Class<?>	internalExpectedGenericType
protected Class<?>	internalExpectedType
protected IReadAccessor	source

Constructor Summary

Constructors

Constructor and Description
AbstractReadSourceAccessor()
AbstractReadSourceAccessor(IReadAccessor source)

Method Summary

Modifier and Type	Method and Description
AbstractReadSourceAccessor	clone() Clones the Addon.
boolean	equals(Object o)
CostInfo	getEstimatedReadCost(ICompilationContext ctxt) Returns source's cost + 1.
Class<?>	getGenericCollectionType(IContext ctxt) Returns requested generic type if any, otherwise the source's generic type if any.
Integer	getInternalCacheIdentifier() Returns null by default.
IReadAccessor	getSource()
Class<?>	getType(IContext ctxt) Returns requested type if any, otherwise the source's type if any.
Object	handleValue(IExecutionContext ctxt, Object value) If value is a collection an collections should be parsed, calls specificHandleValue(IExecutionContext, Object) for all elements in collection.
int	hashCode()
protected Object	internalGet(IExecutionContext ctxt) If source should iterate, calls handleValue for all elements.
boolean	isCacheUsed() Returns false by default.
boolean	isConstantValue() Default implementation returns "false".
boolean	isInternalCacheIdentifierNeeded() This method allows to tell the engine if a cache identifier is needed.
boolean	isShouldIterate() True if source should be iterated.
protected abstract boolean	parseCollections() If true, collection returned by source accessor will be parsed and specificHandleValue(IExecutionContext, Object) will be invoked for each values.
void	resetCachedData(IExecutionContext ctxt) Does nothing.
void	setInternalCacheIdentifier(Integer internalIdentifier) Stores nothing.
void	setSource(IReadAccessor source)
protected abstract Object	specificHandleValue(IExecutionContext ctxt, Object value) Override this to apply specific transformation on value read from source accessor.
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.accessor.AbstractReadAccessor

castToExpected, compileCollection, compileRead, compileRead, compileRead, compileRead, compileValue, get, getGenericTypes, isShouldBeWrappedToConstantValue, isShouldNotCache

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

optimize, 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

getImplementationId, optimize

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

getDebugInfo, getDescription, getName, setDebugInfo, setDescription, setName

Field Detail

source

protected IReadAccessor source

internalExpectedType

protected transient Class<?> internalExpectedType

internalExpectedGenericType

protected transient Class<?> internalExpectedGenericType

Constructor Detail

AbstractReadSourceAccessor

public AbstractReadSourceAccessor()

AbstractReadSourceAccessor

public AbstractReadSourceAccessor(IReadAccessor source)

Method Detail

getEstimatedReadCost

public CostInfo getEstimatedReadCost(ICompilationContext ctxt)
                              throws MRuleValidationException

Returns source's cost + 1.

Specified by:

getEstimatedReadCost in interface IReadAccessor

Parameters:

ctxt - Compilation context.

Throws:

MRuleValidationException - if validation problem detected.

wasRegistered

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

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

resetCachedData

public void resetCachedData(IExecutionContext ctxt)

Description copied from class: AbstractAddon

Does nothing.

Specified by:

resetCachedData in interface IAddon

Overrides:

resetCachedData in class AbstractAddon

internalGet

protected Object internalGet(IExecutionContext ctxt)
                      throws MAccessorException

If source should iterate, calls handleValue for all elements. If not, calls handleValue on source's result.

Specified by:

internalGet in class AbstractReadAccessor

Throws:

MAccessorException

handleValue

public Object handleValue(IExecutionContext ctxt,
                          Object value)
                   throws MAccessorException

If value is a collection an collections should be parsed, calls specificHandleValue(IExecutionContext, Object) for all elements in collection. Otherwise calls it only once for the value.
Casts to correspond to expected result are handled here if necessary.

Specified by:

handleValue in interface IAccessorValueHandler

Throws:

MAccessorException

parseCollections

protected abstract boolean parseCollections()

If true, collection returned by source accessor will be parsed and specificHandleValue(IExecutionContext, Object) will be invoked for each values. Otherwise, specificHandleValue(IExecutionContext, Object) will be invoked only once directly with the result of the source accessor.

specificHandleValue

protected abstract Object specificHandleValue(IExecutionContext ctxt,
                                              Object value)
                                       throws MAccessorException

Override this to apply specific transformation on value read from source accessor.

Throws:

MAccessorException

getType

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

Returns requested type if any, otherwise the source's type if any.

Specified by:

getType in interface IAccessor

Throws:

MAccessorException

getGenericCollectionType

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

Returns requested generic type if any, otherwise the source's generic type if any.

Specified by:

getGenericCollectionType in interface IAccessor

Throws:

MAccessorException

isShouldIterate

public boolean isShouldIterate()

True if source should be iterated.

Specified by:

isShouldIterate in interface IReadAccessor

setInternalCacheIdentifier

public final void setInternalCacheIdentifier(Integer internalIdentifier)

Description copied from class: AbstractAddon

Stores nothing.

Specified by:

setInternalCacheIdentifier in interface IAddon

Overrides:

setInternalCacheIdentifier in class AbstractAddon

Parameters:

internalIdentifier - Internal identifier

See Also:

IAddon.getInternalCacheIdentifier()

getInternalCacheIdentifier

public final Integer getInternalCacheIdentifier()

Description copied from class: AbstractAddon

Returns null by default.

Specified by:

getInternalCacheIdentifier in interface IAddon

Overrides:

getInternalCacheIdentifier in class AbstractAddon

Returns:

Internal identifier

See Also:

IAddon.setInternalCacheIdentifier(Integer)

isInternalCacheIdentifierNeeded

public boolean isInternalCacheIdentifierNeeded()

Description copied from class: AbstractAddon

This method allows to tell the engine if a cache identifier is needed. If not, the Addon will not be able to use internal execution cache.

Specified by:

isInternalCacheIdentifierNeeded in interface IAddon

Overrides:

isInternalCacheIdentifierNeeded in class AbstractAddon

Returns:

Internal identifier

See Also:

AbstractAddon.setInternalCacheIdentifier(Integer)

clone

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

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

isConstantValue

public boolean isConstantValue()

Description copied from class: AbstractReadAccessor

Default implementation returns "false".

Specified by:

isConstantValue in interface IReadAccessor

Overrides:

isConstantValue in class AbstractReadAccessor

isCacheUsed

public boolean isCacheUsed()

Description copied from class: AbstractAddon

Returns false by default.

Specified by:

isCacheUsed in interface IAddon

Overrides:

isCacheUsed in class AbstractAddon

getSource

public IReadAccessor getSource()

setSource

public void setSource(IReadAccessor source)