com.massa.mrules.accessor

Class MDateDiffAccessor

java.lang.Object

com.massa.mrules.base.AbstractMRulesObject

com.massa.mrules.addon.AbstractAddon

com.massa.mrules.accessor.AbstractReadAccessor

com.massa.mrules.accessor.MDateDiffAccessor

All Implemented Interfaces:

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

@PersistantProperty(property="date1") @PersistantProperty(property="date2") @PersistantProperty(property="field")
public class MDateDiffAccessor
extends AbstractReadAccessor

This accessor allows to compute difference between two dates (or time), in year(s), month(s), day(s), hour(s), minute(s), second(s) or milli(s).
Accepted date formats are all the ones available in the JDK (java.util.Date, Calendar, SQL types, ...).
For the Java time package to be handled, the JDK8 extension must be included in the classpath.
The result is negative if date2 is higher than date1.
The field's possible values are :

• "Y": Year
• "M": Month
• "D": Day
• "h": Hour
• "m": Minute
• "s": Second
• "z": Milli

The computed difference is the number of complete periods between the two dates. For example, difference between 2016-01-01 and 2016-12-21 is 11 month or 0 year and difference between 2016-01-01 and 2017-01-02 is 12 month or 1 year.

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	DATEDIFF_ID
protected Class<?>	internalExpectedGenericType
protected Class<?>	internalExpectedType

Constructor Summary

Constructors

Constructor and Description
MDateDiffAccessor() Default constructor.
MDateDiffAccessor(IReadAccessor date1, IReadAccessor date2, IReadAccessor field) Full constructor.

Method Summary

Modifier and Type	Method and Description
MDateDiffAccessor	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	compileValue(ICompilationContext ctxt, Class<?> expectedType) Implementation to handle case when expected result is a single value.
boolean	equals(Object o)
IReadAccessor	getDate1()
IReadAccessor	getDate2()
CostInfo	getEstimatedReadCost(ICompilationContext ctxt) Estimates the reading complexity, to allow callers to optimize calls.
IReadAccessor	getField()
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.
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.
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.
void	setDate1(IReadAccessor date1)
void	setDate2(IReadAccessor date2)
void	setField(IReadAccessor field)
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

getInternalCacheIdentifier, isInternalCacheIdentifierNeeded, optimize, resetCachedData, setInternalCacheIdentifier, wasRegistered

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

getDebugInfo, getDescription, getName, setDebugInfo, setDescription, setName

Field Detail

DATEDIFF_ID

public static final String DATEDIFF_ID

See Also:

Constant Field Values

internalExpectedType

protected transient Class<?> internalExpectedType

internalExpectedGenericType

protected transient Class<?> internalExpectedGenericType

Constructor Detail

MDateDiffAccessor

public MDateDiffAccessor()

Default constructor.

MDateDiffAccessor

public MDateDiffAccessor(IReadAccessor date1,
                         IReadAccessor date2,
                         IReadAccessor field)

Full constructor.

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

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

Description copied from class: AbstractReadAccessor

Specific addon implementation must be here.

Specified by:

internalGet in class AbstractReadAccessor

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.

isCacheUsed

public boolean isCacheUsed()

Description copied from class: AbstractAddon

Returns false by default.

Specified by:

isCacheUsed in interface IAddon

Overrides:

isCacheUsed in class AbstractAddon

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

getImplementationId

public String getImplementationId()

Description copied from interface: IAddon

Unique addon implementation ID. In case of conflict, an Class Initialization error will be raised.

clone

public MDateDiffAccessor 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

getDate1

public IReadAccessor getDate1()

setDate1

public void setDate1(IReadAccessor date1)

getDate2

public IReadAccessor getDate2()

setDate2

public void setDate2(IReadAccessor date2)

getField

public IReadAccessor getField()

setField

public void setField(IReadAccessor field)