com.massa.mrules.accessor.arithmetic

Class Average

java.lang.Object

com.massa.mrules.base.AbstractMRulesObject

com.massa.mrules.addon.AbstractAddon

com.massa.mrules.accessor.AbstractReadAccessor

com.massa.mrules.accessor.arithmetic.MArithmeticAccessor

com.massa.mrules.accessor.arithmetic.Divide

com.massa.mrules.accessor.arithmetic.Average

All Implemented Interfaces:

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

@PersistantProperty(property="coefficientsSource") @PersistantProperty(property="coefficientsValues") @PersistantProperty(property="coefficientsProperty")
public class Average
extends Divide

Computes average value on some numbers.
Allows to provide coefficients, by using 3 properties. "coefficientsSource", "coefficientsValues" and "coefficientsProperty" which have exactly the same semantics as "source", "values" and "property".

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.massa.mrules.accessor.arithmetic.MArithmeticAccessor

MArithmeticAccessor.InternalIterator

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

IReadAccessor.Standalone

Field Summary

Fields

Modifier and Type	Field and Description
static String	AVERAGE_ID

Fields inherited from class com.massa.mrules.accessor.arithmetic.Divide

DIVIDE_ID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Average	clone() Clones the Addon.
void	compileValue(ICompilationContext ctxt, Class<?> expectedType) Compiles coefficient(s) accessor(s).
boolean	equals(Object obj)
BigDecimal	evaluate(IExecutionContext ctxt, MArithmeticAccessor.InternalIterator values) Performs the arithmetic operation.
IReadAccessor	getCoefficientsProperty()
IReadAccessor	getCoefficientsSource()
List<IReadAccessor>	getCoefficientsValues()
CostInfo	getEstimatedReadCost(ICompilationContext ctxt) Estimates the reading complexity, to allow callers to optimize calls.
String	getImplementationId() Unique addon implementation ID.
int	hashCode()
void	setCoefficientsProperty(IReadAccessor coefficient)
void	setCoefficientsSource(IReadAccessor coefficients)
void	setCoefficientsValues(List<IReadAccessor> coefficientsValues)
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.arithmetic.Divide

lastDivision, shouldFormatResult

Methods inherited from class com.massa.mrules.accessor.arithmetic.MArithmeticAccessor

compileCollection, format, getCondition, getDecimals, getGenericCollectionType, getInternalExpectedType, getMaxDecimals, getProperty, getSource, getType, getValues, internalGet, isCacheUsed, isShouldIterate, setCondition, setDecimals, setProperty, setSource, setValues

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

getInternalCacheIdentifier, isInternalCacheIdentifierNeeded, optimize, resetCachedData, setInternalCacheIdentifier, wasRegistered

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

getDebugInfo, getDescription, getName, setDebugInfo, setDescription, setName

Field Detail

AVERAGE_ID

public static final String AVERAGE_ID

See Also:

Constant Field Values

Constructor Detail

Average

public Average()

Average

public Average(IReadAccessor source)

Average

public Average(List<IReadAccessor> sources)

Average

public Average(IReadAccessor... sources)

Average

public Average(Rounder decimals)

Average

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

Average

public Average(Rounder decimals,
               IReadAccessor source)

Average

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

Method Detail

compileValue

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

Compiles coefficient(s) accessor(s).

Overrides:

compileValue in class Divide

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

Overrides:

getEstimatedReadCost in class MArithmeticAccessor

Parameters:

ctxt - Compilation context.

Throws:

MRuleValidationException - if validation problem detected.

evaluate

public BigDecimal evaluate(IExecutionContext ctxt,
                           MArithmeticAccessor.InternalIterator values)
                    throws MAccessorException

Description copied from class: MArithmeticAccessor

Performs the arithmetic operation.

Overrides:

evaluate in class Divide

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

Overrides:

getImplementationId in class Divide

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

Overrides:

toString in class MArithmeticAccessor

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class MArithmeticAccessor

equals

public boolean equals(Object obj)

Overrides:

equals in class MArithmeticAccessor

clone

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

getCoefficientsProperty

public IReadAccessor getCoefficientsProperty()

setCoefficientsProperty

public void setCoefficientsProperty(IReadAccessor coefficient)

getCoefficientsSource

public IReadAccessor getCoefficientsSource()

setCoefficientsSource

public void setCoefficientsSource(IReadAccessor coefficients)

getCoefficientsValues

public List<IReadAccessor> getCoefficientsValues()

setCoefficientsValues

public void setCoefficientsValues(List<IReadAccessor> coefficientsValues)