com.massa.mrules.accessor

Class MVariablePropertyAccessor

java.lang.Object

com.massa.mrules.base.AbstractMRulesObject

com.massa.mrules.addon.AbstractAddon

com.massa.mrules.accessor.AbstractReadAccessor

com.massa.mrules.accessor.MVariablePropertyAccessor

All Implemented Interfaces:

IAccessor, IAccessorValueHandler, IReadAccessor, IReadAccessor.Standalone, IReadWriteAccessor, IWriteAccessor, IAddon, IMRulesObject, Outable, Serializable, Cloneable

@PersistantProperties(properties=@PersistantProperty(property="property"))
public class MVariablePropertyAccessor
extends AbstractReadAccessor
implements IReadAccessor.Standalone, IReadWriteAccessor, IAccessorValueHandler

Allows to access properties for which name is not known (or not fully known) at compilation time.

Since:

1.9.0

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	VARIABLE_PROPERTY_ID

Constructor Summary

Constructors

Constructor and Description
MVariablePropertyAccessor()
MVariablePropertyAccessor(IReadAccessor property)

Method Summary

Modifier and Type	Method and Description
MVariablePropertyAccessor	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	compileReadWrite(ICompilationContext ctxt, boolean forReadTarget) Compiles this accessor to get or set a value.
void	compileValue(ICompilationContext ctxt, Class<?> expectedType) Implementation to handle case when expected result is a single value.
void	compileWrite(ICompilationContext ctxt) Compiles this accessor to set a value.
boolean	equals(Object o)
Object	get(IExecutionContext ctxt, boolean instantiateAll) Gets the value of the target.
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	getPrefix()
IReadAccessor	getProperty()
String	getSuffix()
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.
Object	handleValue(IExecutionContext ctxt, Object propertyName) Called for each value of the iterated element.
Object	handleValue(IExecutionContext ctxt, Object propertyName, boolean instantiateAll)
int	hashCode()
protected Object	internalGet(IExecutionContext ctxt) Specific addon implementation must be here.
boolean	isCacheUsed() Returns false by default.
boolean	isShouldIterate() If this iterator is dedicated to iterate over values, then it should be precised.
Object	set(IExecutionContext ctxt, IReadAccessor accessor) Sets the value.
Object	set(IExecutionContext ctxt, Object obj) Sets the value.
void	setPrefix(String prefix)
void	setProperty(IReadAccessor property)
void	setSuffix(String suffix)
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, isConstantValue, isShouldBeWrappedToConstantValue, isShouldNotCache

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

getInternalCacheIdentifier, 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.accessor.IReadAccessor

compileRead, compileRead, compileRead, compileRead, get, isConstantValue, isShouldBeWrappedToConstantValue

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

getGenericTypes

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

getInternalCacheIdentifier, isInternalCacheIdentifierNeeded, optimize, resetCachedData, setInternalCacheIdentifier, wasRegistered

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

getDebugInfo, getDescription, getName, setDebugInfo, setDescription, setName

Field Detail

VARIABLE_PROPERTY_ID

public static final String VARIABLE_PROPERTY_ID

See Also:

Constant Field Values

Constructor Detail

MVariablePropertyAccessor

public MVariablePropertyAccessor()

MVariablePropertyAccessor

public MVariablePropertyAccessor(IReadAccessor property)

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

compileWrite

public void compileWrite(ICompilationContext ctxt)
                  throws MRuleValidationException

Description copied from interface: IWriteAccessor

Compiles this accessor to set a value.

Specified by:

compileWrite in interface IWriteAccessor

Throws:

MRuleValidationException - if validation problem detected.

compileReadWrite

public void compileReadWrite(ICompilationContext ctxt,
                             boolean forReadTarget)
                      throws MRuleValidationException

Description copied from interface: IReadWriteAccessor

Compiles this accessor to get or set a value. The default target is the context read or write base depending on the "forReadTarget" parameter value.
The contract of the "compileRead(*)" and "compileWrite(*)" methods is globally updated :

• compileRead will always target the read base.
• compileWrite will always target the write base.

Specified by:

compileReadWrite in interface IReadWriteAccessor

forReadTarget - To choose between read or write base for compilation and execution.

Throws:

MRuleValidationException - if validation problem detected.

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

get

public Object get(IExecutionContext ctxt,
                  boolean instantiateAll)
           throws MAccessorException

Description copied from interface: IReadWriteAccessor

Gets the value of the target. Automatic cast might be done according to specified expected types. If requested, all nested null properties and the final one will be instantiated, if possible. If impossible, an exception is raised.

Specified by:

get in interface IReadWriteAccessor

Throws:

MAccessorException

handleValue

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

Description copied from interface: IAccessorValueHandler

Called for each value of the iterated element.

Specified by:

handleValue in interface IAccessorValueHandler

Throws:

MAccessorException

handleValue

public Object handleValue(IExecutionContext ctxt,
                          Object propertyName,
                          boolean instantiateAll)
                   throws MAccessorException

Throws:

MAccessorException

set

public Object set(IExecutionContext ctxt,
                  IReadAccessor accessor)
           throws MAccessorException

Description copied from interface: IWriteAccessor

Sets the value. Automatic cast might be done according to the target type.

Specified by:

set in interface IWriteAccessor

Returns:

Value set.

Throws:

MAccessorException

set

public Object set(IExecutionContext ctxt,
                  Object obj)
           throws MAccessorException

Description copied from interface: IWriteAccessor

Sets the value. Automatic cast might be done according to the target type.

Specified by:

set in interface IWriteAccessor

Returns:

Value set.

Throws:

MAccessorException

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

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

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

clone

public MVariablePropertyAccessor 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 IReadWriteAccessor

Specified by:

clone in interface IWriteAccessor

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

getProperty

public IReadAccessor getProperty()

setProperty

public final void setProperty(IReadAccessor property)

isCacheUsed

public boolean isCacheUsed()

Description copied from class: AbstractAddon

Returns false by default.

Specified by:

isCacheUsed in interface IAddon

Overrides:

isCacheUsed in class AbstractAddon

getPrefix

public String getPrefix()

setPrefix

public void setPrefix(String prefix)

getSuffix

public String getSuffix()

setSuffix

public void setSuffix(String suffix)