com.massa.mrules.operator.evaluation

Interface IEvaluationOperator

All Superinterfaces:

Cloneable, IAddon, IMRulesObject, Outable, Serializable

All Known Implementing Classes:

AbstractCollectionEvaluationOperator, AbstractEvaluationOperator, BETWEEN, COLDISJOINED, COLEQ, COLIN, COLINCLUDED, COLINCLUDES, COLINTERSECTS, COLNE, COLNOTIN, CONTAINS, EMPTY, EQ, GT, GTE, IN, LT, LTE, MATCH, NE, NOTCONTAINS, NOTEMPTY, NOTIN, NOTMATCH, NOTNULL, NULL

public interface IEvaluationOperator
extends IAddon

Interface specifying methods of evaluation operator implementations. This kind of operator evaluate value(s) and compute a result.
Note that ALL implementations have to be thread safe for execution.

Method Summary

Modifier and Type	Method and Description
IEvaluationOperator	clone() Clones the Operator.
void	compile(ICompilationContext ctxt, IEvaluationCondition condition) For additional validations, specific to this operator.
boolean	evaluate(IExecutionContext ctxt, IEvaluationCondition condition) Evaluate result for this operator.
IEvaluationOperator	getInverted() Returns a new instance instance of Evaluation operator, allowing to invert the operands.
IEvaluationOperator	getNegated() Returns a new instance instance of Evaluation operator, allowing to negate the operands.
Class<?>	getReferenceExpectedType(Class<?> srcType, Class<?> srcGenericType) If any, tells reference expected type, i.e. if reference is not assignable to this type, the operator will not work.
Class<?>	getReferencePreferredType(Class<?> srcType, Class<?> srcGenericType) If any, tells reference preferred type, i.e. if reference is assignable to this type, the operator will work better than if not.
String	getRepresentation() String representation for human read
Class<?>	getSourceExpectedType() If any, tells source expected type.

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

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

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

Method Detail

compile

void compile(ICompilationContext ctxt,
             IEvaluationCondition condition)
      throws MRuleValidationException

For additional validations, specific to this operator.

Throws:

MRuleValidationException

evaluate

boolean evaluate(IExecutionContext ctxt,
                 IEvaluationCondition condition)
          throws MConditionEvaluationException

Evaluate result for this operator.

Throws:

MConditionEvaluationException

getRepresentation

String getRepresentation()

String representation for human read

getSourceExpectedType

Class<?> getSourceExpectedType()

If any, tells source expected type. Null if no particular constraint.

getReferenceExpectedType

Class<?> getReferenceExpectedType(Class<?> srcType,
                                  Class<?> srcGenericType)

If any, tells reference expected type, i.e. if reference is not assignable to this type, the operator will not work. Null if "same type as source" is expected. Void if a reference is unexpected. If no particular constraint, return "Object.class".

Parameters:

srcType - If known, the source accessor type should be provided to make better prevision.

srcGenericType - If known, the source accessor generic type should be provided to make better prevision.

getReferencePreferredType

Class<?> getReferencePreferredType(Class<?> srcType,
                                   Class<?> srcGenericType)

If any, tells reference preferred type, i.e. if reference is assignable to this type, the operator will work better than if not. Must be the expected type or a sub type. Null means "same type as expected type" . Void (or null) if a reference is unexpected.

Parameters:

srcType - If known, the source accessor type should be provided to make better prevision.

srcGenericType - If known, the source accessor generic type should be provided to make better prevision.

Since:

1.8.0

getInverted

IEvaluationOperator getInverted()

Returns a new instance instance of Evaluation operator, allowing to invert the operands.
For example, "a < b" inverted gives "b > a", and is strictly equivalent.
This feature is used by optimization process, so a null result by default while the operator could be inverted might lead to less efficient performance.

Returns:

new operator instance or null if inversion is not possible.

Since:

1.8.0

getNegated

IEvaluationOperator getNegated()

Returns a new instance instance of Evaluation operator, allowing to negate the operands.
For example, "a < b" negated gives "a >= b", and is strictly equivalent to "! (a < b)". This feature is used by optimization process, so a null result by default while the operator could be negated might lead to less efficient performance.

Returns:

new operator instance or null if negation is not possible.

Since:

1.8.0

clone

IEvaluationOperator clone()

Clones the Operator.
The general contract is that the clone of a compiled Operator is still compiled.

Specified by:

clone in interface IAddon

Specified by:

clone in interface IMRulesObject