com.massa.mrules.condition

Class MEvaluationCondition

java.lang.Object

com.massa.mrules.base.AbstractMRulesObject

com.massa.mrules.addon.AbstractAddon

com.massa.mrules.condition.AbstractCondition

com.massa.mrules.condition.MEvaluationCondition

All Implemented Interfaces:

IAddon, IMRulesObject, ICondition, IEvaluationCondition, Outable, Serializable, Cloneable

@PersistantProperty(property="source") @PersistantProperty(property="operator") @PersistantProperty(property="reference") @PersistantProperty(property="iterationOperator") @PersistantProperty(property="optimizeMultiEval",defaultValue="true")
public class MEvaluationCondition
extends AbstractCondition
implements IEvaluationCondition

IEvaluationCondition base implementation, allowing to retrieve 1 or 2 values from IReadAccessor and to apply test implemented in an operator on these values. An option allows to optimize multiple evaluation of a same condition by caching result.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MEvaluationCondition.LiveCastCondition Allows to dynamically cast values to be able to correctly evaluate the condition.

Field Summary

Fields

Modifier and Type	Field and Description
static String	EVAL_ID
static String	EVALUATION_FEATURE The value of this constant ("condition-evaluation") allows to disable caching of condition evaluations.

Constructor Summary

Constructors

Constructor and Description
MEvaluationCondition()
MEvaluationCondition(boolean not, IEvaluationOperator operator, IReadAccessor source, IReadAccessor reference)
MEvaluationCondition(IEvaluationOperator operator, IReadAccessor source, IReadAccessor reference) not defaults to false.

Method Summary

Modifier and Type	Method and Description
MEvaluationCondition	clone() Clones the Addon.
void	compile(ICompilationContext ctxt) Check presence of operator and validates it.
CostInfo	getEstimatedCost(ICompilationContext ctxt) Estimates the condition complexity, to allow callers to optimize calls.
String	getImplementationId() Unique addon implementation ID.
ILogicalOperator	getIterationOperator()
IEvaluationOperator	getOperator()
IReadAccessor	getReference()
Class<?>	getReferenceGenericType(IContext ctxt) The reference generic type if known and applicable.
Class<?>	getReferenceType(IContext ctxt) The reference type.
Object	getReferenceValue(IExecutionContext ctxt) The reference value to evaluate against source value.
IReadAccessor	getSource()
Class<?>	getSourceGenericType(IContext ctxt) The source generic type if known and applicable.
Class<?>	getSourceType(IContext ctxt) The source type.
Object	getSourceValue(IExecutionContext ctxt) The source value.
protected ConditionEquivalence	internalIsEquivalent(ICondition o) Called by AbstractCondition.internalIsEquivalent(ICondition) if the other condition is not an instance of MConditionNot.
boolean	isCacheUsed() Returns false by default.
boolean	isConstantValue() Tells if this condition returns a constant result for all executions.
boolean	isOptimizeMultiEval()
protected boolean	pEquals(AbstractCondition o) Tests equality on other parameters than "not".
protected boolean	pEvaluate(IExecutionContext ctxt)
protected int	pHashCode() Computes hashCode on other parameters than "not".
protected void	pToString(OuterWithLevel outer) Finishes toString output.
void	resetCachedData(IExecutionContext ctxt) Does nothing.
void	setIterationOperator(ILogicalOperator iterationOperator)
void	setNot(boolean not) Allows to invert condition's behavior.
void	setOperator(IEvaluationOperator operator)
void	setOptimizeMultiEval(boolean optimizeMultiEval)
void	setReference(IReadAccessor reference)
void	setSource(IReadAccessor source)
boolean	wasRegistered(ICompilationContext ctxt, IAddon parent, AddonInfo info) Convenience method, which does nothing.

Methods inherited from class com.massa.mrules.condition.AbstractCondition

combine, combineToNewSet, equals, evaluate, hashCode, isEquivalent, isNot, isShouldBeWrappedToConstantValue, toString

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

getInternalCacheIdentifier, isInternalCacheIdentifierNeeded, optimize, setInternalCacheIdentifier, 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.condition.ICondition

combine, evaluate, isEquivalent, isNot, isShouldBeWrappedToConstantValue

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

getInternalCacheIdentifier, isInternalCacheIdentifierNeeded, optimize, setInternalCacheIdentifier

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

getDebugInfo, getDescription, getName, setDebugInfo, setDescription, setName

Methods inherited from interface com.massa.mrules.util.out.Outable

toString

Field Detail

EVAL_ID

public static final String EVAL_ID

See Also:

Constant Field Values

EVALUATION_FEATURE

public static final String EVALUATION_FEATURE

The value of this constant ("condition-evaluation") allows to disable caching of condition evaluations.

See Also:

ICacheActivationResolver.isCacheEnabled(String), Constant Field Values

Constructor Detail

MEvaluationCondition

public MEvaluationCondition()

MEvaluationCondition

public MEvaluationCondition(IEvaluationOperator operator,
                            IReadAccessor source,
                            IReadAccessor reference)

not defaults to false.

MEvaluationCondition

public MEvaluationCondition(boolean not,
                            IEvaluationOperator operator,
                            IReadAccessor source,
                            IReadAccessor reference)

Method Detail

compile

public void compile(ICompilationContext ctxt)
             throws MRuleValidationException

Check presence of operator and validates it.

Specified by:

compile in interface ICondition

Throws:

MRuleValidationException - if validation problem detected.

See Also:

ICondition.compile(ICompilationContext)

wasRegistered

public boolean wasRegistered(ICompilationContext ctxt,
                             IAddon parent,
                             AddonInfo info)
                      throws MRuleValidationException

Description copied from class: AbstractAddon

Convenience method, which does nothing. All implementing classes may override to perform internal operations, starting with a "super" call to keep compatibility with future versions.

Specified by:

wasRegistered in interface IAddon

Overrides:

wasRegistered in class AbstractAddon

parent - Parent from which this instance of addon was registered.

info - Addon info for the currently registered addon

Returns:

false

Throws:

MRuleValidationException

resetCachedData

public void resetCachedData(IExecutionContext ctxt)

Description copied from class: AbstractAddon

Does nothing.

Specified by:

resetCachedData in interface IAddon

Overrides:

resetCachedData in class AbstractAddon

getEstimatedCost

public CostInfo getEstimatedCost(ICompilationContext ctxt)
                          throws MRuleValidationException

Description copied from interface: ICondition

Estimates the condition complexity, to allow callers to optimize calls. Calls to this method should be done on a compiled condition, so that all information is available to compute complexity.
Calls to non-compiled instance may return non-accurate results.

Specified by:

getEstimatedCost in interface ICondition

Throws:

MRuleValidationException - if validation problem detected.

isConstantValue

public boolean isConstantValue()

Description copied from interface: ICondition

Tells if this condition returns a constant result for all executions.

Specified by:

isConstantValue in interface ICondition

pEvaluate

protected boolean pEvaluate(IExecutionContext ctxt)
                     throws MConditionEvaluationException

Specified by:

pEvaluate in class AbstractCondition

Throws:

MConditionEvaluationException

See Also:

ICondition.evaluate(IExecutionContext)

getSourceValue

public Object getSourceValue(IExecutionContext ctxt)
                      throws MConditionEvaluationException

Description copied from interface: IEvaluationCondition

The source value.

Specified by:

getSourceValue in interface IEvaluationCondition

Throws:

MConditionEvaluationException

getReferenceValue

public Object getReferenceValue(IExecutionContext ctxt)
                         throws MConditionEvaluationException

Description copied from interface: IEvaluationCondition

The reference value to evaluate against source value.

Specified by:

getReferenceValue in interface IEvaluationCondition

Throws:

MConditionEvaluationException

getSourceType

public Class<?> getSourceType(IContext ctxt)
                       throws MConditionEvaluationException

Description copied from interface: IEvaluationCondition

The source type.

Specified by:

getSourceType in interface IEvaluationCondition

Throws:

MConditionEvaluationException

getReferenceType

public Class<?> getReferenceType(IContext ctxt)
                          throws MConditionEvaluationException

Description copied from interface: IEvaluationCondition

The reference type.

Specified by:

getReferenceType in interface IEvaluationCondition

Throws:

MConditionEvaluationException

getSourceGenericType

public Class<?> getSourceGenericType(IContext ctxt)
                              throws MConditionEvaluationException

Description copied from interface: IEvaluationCondition

The source generic type if known and applicable.

Specified by:

getSourceGenericType in interface IEvaluationCondition

Throws:

MConditionEvaluationException

getReferenceGenericType

public Class<?> getReferenceGenericType(IContext ctxt)
                                 throws MConditionEvaluationException

Description copied from interface: IEvaluationCondition

The reference generic type if known and applicable.

Specified by:

getReferenceGenericType in interface IEvaluationCondition

Throws:

MConditionEvaluationException

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

isCacheUsed

public boolean isCacheUsed()

Description copied from class: AbstractAddon

Returns false by default.

Specified by:

isCacheUsed in interface IAddon

Overrides:

isCacheUsed in class AbstractAddon

pToString

protected void pToString(OuterWithLevel outer)
                  throws IOException

Description copied from class: AbstractCondition

Finishes toString output.

Specified by:

pToString in class AbstractCondition

Throws:

IOException

internalIsEquivalent

protected ConditionEquivalence internalIsEquivalent(ICondition o)

Description copied from class: AbstractCondition

Called by AbstractCondition.internalIsEquivalent(ICondition) if the other condition is not an instance of MConditionNot.

Specified by:

internalIsEquivalent in class AbstractCondition

clone

public MEvaluationCondition 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 IAddon

Specified by:

clone in interface IMRulesObject

Specified by:

clone in interface ICondition

Specified by:

clone in interface IEvaluationCondition

Overrides:

clone in class AbstractCondition

pEquals

protected boolean pEquals(AbstractCondition o)

Description copied from class: AbstractCondition

Tests equality on other parameters than "not".

Specified by:

pEquals in class AbstractCondition

pHashCode

protected int pHashCode()

Description copied from class: AbstractCondition

Computes hashCode on other parameters than "not".

Specified by:

pHashCode in class AbstractCondition

setNot

public void setNot(boolean not)

Description copied from class: AbstractCondition

Allows to invert condition's behavior.

Specified by:

setNot in interface ICondition

Overrides:

setNot in class AbstractCondition

getOperator

public IEvaluationOperator getOperator()

setOperator

public void setOperator(IEvaluationOperator operator)

getIterationOperator

public ILogicalOperator getIterationOperator()

setIterationOperator

public void setIterationOperator(ILogicalOperator iterationOperator)

getSource

public IReadAccessor getSource()

setSource

public void setSource(IReadAccessor source)

getReference

public IReadAccessor getReference()

setReference

public void setReference(IReadAccessor reference)

isOptimizeMultiEval

public boolean isOptimizeMultiEval()

setOptimizeMultiEval

public void setOptimizeMultiEval(boolean optimizeMultiEval)