com.massa.mrules.accessor

Class MMinMaxAccessor

java.lang.Object

com.massa.mrules.base.AbstractMRulesObject

com.massa.mrules.addon.AbstractAddon

com.massa.mrules.accessor.AbstractReadAccessor

com.massa.mrules.accessor.AbstractReadSourceAccessor

com.massa.mrules.accessor.MSearchAccessor

com.massa.mrules.accessor.MMinMaxAccessor

All Implemented Interfaces:

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

Direct Known Subclasses:

MMinMaxAccessor.Max, MMinMaxAccessor.Min

@PersistantProperty(property="on") @PersistantProperty(property="nbElementsToRetrieve")
public abstract class MMinMaxAccessor
extends MSearchAccessor

Allows to search a Collection to find the minimum / maximum value
This accessor allows to take into account only some elements of the Collection (via the condition) and also to consider a sub property for the comparison.
For example, given a list of Students, with the following structure :
[ gender: 'M' or 'F', age: integer, [other properties] } You will be able to find the student with the minimum / maximum age.

If the nbElementsToRetrieve field is configured, then the result must be a Collection or a compile error will be raised. In this case, the result will be ordered (if supported) from min to max / max to min.

Since:

2.4.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MMinMaxAccessor.Max
static class	MMinMaxAccessor.Min

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

IReadAccessor.Standalone

Field Summary

Fields

Modifier and Type	Field and Description
protected IReadAccessor	nbElementsToRetrieve
protected boolean	nullIsExtremumValue
protected List<IReadAccessor>	on

Fields inherited from class com.massa.mrules.accessor.MSearchAccessor

SEARCH_ID

Fields inherited from class com.massa.mrules.accessor.AbstractReadSourceAccessor

internalExpectedGenericType, internalExpectedType, source

Constructor Summary

Constructors

Constructor and Description
MMinMaxAccessor()
MMinMaxAccessor(IReadAccessor source)
MMinMaxAccessor(IReadAccessor source, ICondition condition)

Method Summary

Modifier and Type	Method and Description
protected void	check()
MMinMaxAccessor	clone() Clones the Addon.
protected void	commonCompile(ICompilationContext ctxt, Class<?> expectedType, Class<?> expectedGenericType)
boolean	equals(Object o)
protected abstract Comparator<Object>	getComparator(IExecutionContext ctxt)
CostInfo	getEstimatedReadCost(ICompilationContext ctxt) Returns source's cost + 1.
IReadAccessor	getNbElementsToRetrieve()
List<IReadAccessor>	getOn()
int	hashCode()
protected abstract boolean	interpreteComparisonResult(int comparisonResult)
boolean	isCacheUsed() Returns false by default.
void	setNbElementsToRetrieve(IReadAccessor nbElements)
void	setOn(List<IReadAccessor> on)
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.

Methods inherited from class com.massa.mrules.accessor.MSearchAccessor

check, compileCollection, compileValue, getCondition, getImplementationId, parseCollections, setCondition

Methods inherited from class com.massa.mrules.accessor.AbstractReadSourceAccessor

getGenericCollectionType, getInternalCacheIdentifier, getSource, getType, handleValue, internalGet, isConstantValue, isInternalCacheIdentifierNeeded, isShouldIterate, resetCachedData, setInternalCacheIdentifier, setSource, wasRegistered

Methods inherited from class com.massa.mrules.accessor.AbstractReadAccessor

castToExpected, compileRead, compileRead, compileRead, compileRead, 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

optimize

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

getDebugInfo, getDescription, getName, setDebugInfo, setDescription, setName

Field Detail

on

protected List<IReadAccessor> on

nbElementsToRetrieve

protected IReadAccessor nbElementsToRetrieve

nullIsExtremumValue

protected boolean nullIsExtremumValue

Constructor Detail

MMinMaxAccessor

public MMinMaxAccessor()

MMinMaxAccessor

public MMinMaxAccessor(IReadAccessor source)

MMinMaxAccessor

public MMinMaxAccessor(IReadAccessor source,
                       ICondition condition)

Method Detail

commonCompile

protected void commonCompile(ICompilationContext ctxt,
                             Class<?> expectedType,
                             Class<?> expectedGenericType)
                      throws MRuleValidationException

Overrides:

commonCompile in class MSearchAccessor

Throws:

MRuleValidationException

getEstimatedReadCost

public CostInfo getEstimatedReadCost(ICompilationContext ctxt)
                              throws MRuleValidationException

Description copied from class: AbstractReadSourceAccessor

Returns source's cost + 1.

Specified by:

getEstimatedReadCost in interface IReadAccessor

Overrides:

getEstimatedReadCost in class MSearchAccessor

Parameters:

ctxt - Compilation context.

Throws:

MRuleValidationException - if validation problem detected.

check

protected void check()
              throws MRuleValidationException

Overrides:

check in class MSearchAccessor

Throws:

MRuleValidationException

specificHandleValue

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

Description copied from class: AbstractReadSourceAccessor

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

Overrides:

specificHandleValue in class MSearchAccessor

Throws:

MAccessorException

interpreteComparisonResult

protected abstract boolean interpreteComparisonResult(int comparisonResult)

Returns:

"comparisonResult < 0" for MAX ; "comparisonResult > 0" for MIN

getComparator

protected abstract Comparator<Object> getComparator(IExecutionContext ctxt)

Returns:

Comparator to use for object comparison

isCacheUsed

public boolean isCacheUsed()

Description copied from class: AbstractAddon

Returns false by default.

Specified by:

isCacheUsed in interface IAddon

Overrides:

isCacheUsed in class MSearchAccessor

clone

public MMinMaxAccessor 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 MSearchAccessor

equals

public boolean equals(Object o)

Overrides:

equals in class MSearchAccessor

hashCode

public int hashCode()

Overrides:

hashCode in class MSearchAccessor

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 MSearchAccessor

Throws:

IOException

getOn

public List<IReadAccessor> getOn()

setOn

public void setOn(List<IReadAccessor> on)

getNbElementsToRetrieve

public IReadAccessor getNbElementsToRetrieve()

setNbElementsToRetrieve

public void setNbElementsToRetrieve(IReadAccessor nbElements)