com.massa.mrules.accessor

Class AbstractReadAccessor

java.lang.Object

com.massa.mrules.base.AbstractMRulesObject

com.massa.mrules.addon.AbstractAddon

com.massa.mrules.accessor.AbstractReadAccessor

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractConditionWrapperAccessor, AbstractExecutableWrapperAccessor, AbstractPropertyCheckAccessor, AbstractReadSourceAccessor, DefaultVariablesManager.AbstractVariableAccessor, MArithmeticAccessor, MCoalesceAccessor, MConcatenateAccessor, MConditionsCountAccessor, MDateDiffAccessor, MFormatAccessor, MIterateAccessor, MNewInstanceAccessor, MPropertyAccessor, MSingleMathOperation, MSubPartAccessor, MValueAccessor, MValuesAccessor, MVariablePropertyAccessor

public abstract class AbstractReadAccessor
extends AbstractAddon
implements IReadAccessor

Implements base compilation chaining and provides 2 methods to implement instead of 4. For the moment, asking for an Array in not supported and WILL throw an exception. BUT, accessors MIGHT return arrays if original value is an Array and no cast is asked. Arrays from original values are fully supported.

See Also:

Serialized Form

Nested Class Summary

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

IReadAccessor.Standalone

Constructor Summary

Constructors

Constructor and Description
AbstractReadAccessor()

Method Summary

Modifier and Type	Method and Description
protected Object	castToExpected(Object ret, Class<?> expectedType, Class<?> expectedGenericType) Utility method allowing to cast result to what's expected.
AbstractReadAccessor	clone() Clones the Addon.
abstract <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	compileRead(ICompilationContext ctxt) Compiles this accessor to retrieve a value or a Collection, with no constraint.
void	compileRead(ICompilationContext ctxt, Class<?> expectedType) Compiles this accessor to retrieve a value or a Collection, for witch generic type should be automatically detected if possible.
<G,C extends Collection<G>> void	compileRead(ICompilationContext ctxt, Class<C> expectedType, Class<G> expectedGenericType) Compiles this accessor to retrieve a collection, for witch generic type should be automatically detected if not provided and possible.
void	compileRead(ICompilationContext ctxt, IAccessor accessor) Compiles this accessor to retrieve a value or a Collection, in order to conform to what the provided one awaits for.
abstract void	compileValue(ICompilationContext ctxt, Class<?> expectedType) Implementation to handle case when expected result is a single value.
Object	get(IExecutionContext ctxt) This method handles in / out logging and redirects to internalGet(IExecutionContext) for specific implementation.
Class<?>[]	getGenericTypes(IContext ctxt) By default, creates a 1 cell array with IAccessor.getGenericCollectionType(IContext) return value if any, or null if no value.
protected abstract Object	internalGet(IExecutionContext ctxt) Specific addon implementation must be here.
boolean	isConstantValue() Default implementation returns "false".
boolean	isShouldBeWrappedToConstantValue() Default implementation returns isConstantValue() && !
static boolean	isShouldNotCache(ICompilationContext ctxt, AddonInfo info) For optimization purpose, checks if results should be effectively cached.

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

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.massa.mrules.accessor.IReadAccessor

getEstimatedReadCost, isShouldIterate

Methods inherited from interface com.massa.mrules.accessor.IAccessor

getGenericCollectionType, getType

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

getImplementationId, 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 com.massa.mrules.util.out.Outable

toString

Constructor Detail

AbstractReadAccessor

public AbstractReadAccessor()

Method Detail

compileRead

public void compileRead(ICompilationContext ctxt)
                 throws MRuleValidationException

Description copied from interface: IReadAccessor

Compiles this accessor to retrieve a value or a Collection, with no constraint.

Specified by:

compileRead in interface IReadAccessor

Parameters:

ctxt - Compilation context.

Throws:

MRuleValidationException - if validation problem detected.

compileRead

public void compileRead(ICompilationContext ctxt,
                        IAccessor accessor)
                 throws MRuleValidationException

Description copied from interface: IReadAccessor

Compiles this accessor to retrieve a value or a Collection, in order to conform to what the provided one awaits for.

Specified by:

compileRead in interface IReadAccessor

Parameters:

ctxt - Compilation context.

accessor - Compilation base.

Throws:

MRuleValidationException - if validation problem detected.

compileRead

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

Description copied from interface: IReadAccessor

Compiles this accessor to retrieve a value or a Collection, for witch generic type should be automatically detected if possible.

Specified by:

compileRead in interface IReadAccessor

Parameters:

ctxt - Compilation context.

expectedType - If any type is expected. Null if none.

Throws:

MRuleValidationException - if validation problem detected.

compileRead

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

Description copied from interface: IReadAccessor

Compiles this accessor to retrieve a collection, for witch generic type should be automatically detected if not provided and possible.

Specified by:

compileRead in interface IReadAccessor

Parameters:

ctxt - Compilation context.

expectedType - If any specific implem is expected for the collection. Null (or "Collection.class") if none.

expectedGenericType - If any generic type is expected for the collection. Null if none.

Throws:

MRuleValidationException - if validation problem detected.

compileValue

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

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

Throws:

MRuleValidationException

compileCollection

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

Implementation to handle case when expected result is a Collection.

Throws:

MRuleValidationException

get

public Object get(IExecutionContext ctxt)
           throws MAccessorException

This method handles in / out logging and redirects to internalGet(IExecutionContext) for specific implementation.

Specified by:

get in interface IReadAccessor

Parameters:

ctxt - Compilation context.

Returns:

Result

Throws:

MAccessorException

internalGet

protected abstract Object internalGet(IExecutionContext ctxt)
                               throws MAccessorException

Specific addon implementation must be here.

Throws:

MAccessorException

castToExpected

protected Object castToExpected(Object ret,
                                Class<?> expectedType,
                                Class<?> expectedGenericType)
                         throws MAccessorException

Utility method allowing to cast result to what's expected.

Throws:

MAccessorException

isShouldNotCache

public static boolean isShouldNotCache(ICompilationContext ctxt,
                                       AddonInfo info)

For optimization purpose, checks if results should be effectively cached.
whatever it is, the result of this method should not have effect on the "isCacheUsed" methods.

isConstantValue

public boolean isConstantValue()

Default implementation returns "false".

Specified by:

isConstantValue in interface IReadAccessor

isShouldBeWrappedToConstantValue

public boolean isShouldBeWrappedToConstantValue()

Default implementation returns isConstantValue() && ! IReadAccessor.isShouldIterate().

Specified by:

isShouldBeWrappedToConstantValue in interface IReadAccessor

clone

public AbstractReadAccessor 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 AbstractAddon

getGenericTypes

public Class<?>[] getGenericTypes(IContext ctxt)
                           throws MAccessorException

By default, creates a 1 cell array with IAccessor.getGenericCollectionType(IContext) return value if any, or null if no value.

Specified by:

getGenericTypes in interface IAccessor

Throws:

MAccessorException