com.massa.mrules.accessor.arithmetic

Class MArithmeticAccessor

java.lang.Object

com.massa.mrules.base.AbstractMRulesObject

com.massa.mrules.addon.AbstractAddon

com.massa.mrules.accessor.AbstractReadAccessor

com.massa.mrules.accessor.arithmetic.MArithmeticAccessor

All Implemented Interfaces:

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

Direct Known Subclasses:

Divide, Mod, Multiply, Pow, Subtract, Sum

@PersistantProperty(property="source") @PersistantProperty(property="values",alias="value") @PersistantProperty(property="property") @PersistantProperty(property="condition") @PersistantProperty(property="decimals")
public abstract class MArithmeticAccessor
extends AbstractReadAccessor

Abstract class that allows to perform arithmetic operations.
An iteration will be performed on source and/or values and depending on implementation, calculation will be done.

• "source" and "values" may have different semantics :
  • If one is filled, it will be the source of all values. Convenient for sums, averages, etc ...
  • If both are filled, "source" will be the first number(or numbers if it's an iterable) and values will follow. Convenient for subtractions.
• "property" allows to search the desired property in a sub property of the iterated objects.
• "condition" allows to validate (or not and then ignore) the iterated objects.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	MArithmeticAccessor.InternalIterator Class allowing to internally iterate on property.

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

IReadAccessor.Standalone

Constructor Summary

Constructors

Constructor and Description
MArithmeticAccessor()
MArithmeticAccessor(IReadAccessor... sources)
MArithmeticAccessor(IReadAccessor source)
MArithmeticAccessor(List<IReadAccessor> sources)
MArithmeticAccessor(Rounder decimals)
MArithmeticAccessor(Rounder decimals, IReadAccessor... sources)
MArithmeticAccessor(Rounder decimals, IReadAccessor source)
MArithmeticAccessor(Rounder decimals, List<IReadAccessor> sources)

Method Summary

Modifier and Type	Method and Description
MArithmeticAccessor	clone() Clones the Addon.
<G,C extends Collection<G>> void	compileCollection(ICompilationContext ctxt, Class<C> expectedType, Class<G> expectedGenericType) Unsupported.
void	compileValue(ICompilationContext ctxt, Class<?> expectedType) Implementation to handle case when expected result is a single value.
boolean	equals(Object o)
protected abstract BigDecimal	evaluate(IExecutionContext ctxt, MArithmeticAccessor.InternalIterator valuesToEvaluate) Performs the arithmetic operation.
protected BigDecimal	format(BigDecimal ret) Method used to format returned property (desired number of decimals, trailing zeros removed, etc ...)
ICondition	getCondition()
Rounder	getDecimals()
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.
Class<?>	getInternalExpectedType() Returns expected types to provide for sub-accessors compilation.
int	getMaxDecimals()
IReadAccessor	getProperty()
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()
int	hashCode()
protected Object	internalGet(IExecutionContext ctxt) Performs operations like rounding, casting and delegates the pure arithmetic operation to evaluate(IExecutionContext, InternalIterator)
boolean	isCacheUsed() Returns false by default.
boolean	isShouldIterate() If this iterator is dedicated to iterate over values, then it should be precised.
void	setCondition(ICondition condition)
void	setDecimals(Rounder decimals)
void	setProperty(IReadAccessor value)
void	setSource(IReadAccessor source)
void	setValues(List<IReadAccessor> sources)
protected boolean	shouldFormatResult() If the implementation of evaluate(IExecutionContext, InternalIterator) performs the rounding and formating operations, then this method should be overridden to return false.
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.addon.IAddon

getImplementationId, getInternalCacheIdentifier, isInternalCacheIdentifierNeeded, optimize, resetCachedData, setInternalCacheIdentifier, wasRegistered

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

getDebugInfo, getDescription, getName, setDebugInfo, setDescription, setName

Constructor Detail

MArithmeticAccessor

public MArithmeticAccessor()

MArithmeticAccessor

public MArithmeticAccessor(IReadAccessor source)

MArithmeticAccessor

public MArithmeticAccessor(List<IReadAccessor> sources)

MArithmeticAccessor

public MArithmeticAccessor(IReadAccessor... sources)

MArithmeticAccessor

public MArithmeticAccessor(Rounder decimals)

MArithmeticAccessor

public MArithmeticAccessor(Rounder decimals,
                           IReadAccessor source)

MArithmeticAccessor

public MArithmeticAccessor(Rounder decimals,
                           List<IReadAccessor> sources)

MArithmeticAccessor

public MArithmeticAccessor(Rounder decimals,
                           IReadAccessor... sources)

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

Unsupported.

Specified by:

compileCollection in class AbstractReadAccessor

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.

Parameters:

ctxt - Compilation context.

Throws:

MRuleValidationException - if validation problem detected.

internalGet

protected Object internalGet(IExecutionContext ctxt)
                      throws MAccessorException

Performs operations like rounding, casting and delegates the pure arithmetic operation to evaluate(IExecutionContext, InternalIterator)

Specified by:

internalGet in class AbstractReadAccessor

Throws:

MAccessorException

evaluate

protected abstract BigDecimal evaluate(IExecutionContext ctxt,
                                       MArithmeticAccessor.InternalIterator valuesToEvaluate)
                                throws MAccessorException

Performs the arithmetic operation.

Throws:

MAccessorException

shouldFormatResult

protected boolean shouldFormatResult()

If the implementation of evaluate(IExecutionContext, InternalIterator) performs the rounding and formating operations, then this method should be overridden to return false.

format

protected final BigDecimal format(BigDecimal ret)

Method used to format returned property (desired number of decimals, trailing zeros removed, etc ...)

getInternalExpectedType

public Class<?> getInternalExpectedType()

Returns expected types to provide for sub-accessors compilation.

Returns:

BigDecimal for basic implementation if "property" is null, null otherwise.

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.

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.

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.

clone

public MArithmeticAccessor 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.

Throws:

IOException

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)

getValues

public List<IReadAccessor> getValues()

setValues

public void setValues(List<IReadAccessor> sources)

getProperty

public IReadAccessor getProperty()

setProperty

public void setProperty(IReadAccessor value)

getCondition

public ICondition getCondition()

setCondition

public void setCondition(ICondition condition)

getDecimals

public Rounder getDecimals()

getMaxDecimals

public int getMaxDecimals()

Returns:

specified max number of decimals or -1 if unspecified

setDecimals

public void setDecimals(Rounder decimals)