com.massa.mrules.condition

Interface ICondition

All Superinterfaces:

Cloneable, IAddon, IMRulesObject, Outable, Serializable

All Known Subinterfaces:

IEvaluationCondition

All Known Implementing Classes:

AbstractAccessorWrapperCondition, AbstractCondition, MAccessorWrapperCondition, MConditionNot, MConditionSet, MEvaluationCondition, MEvaluationCondition.LiveCastCondition, MHardCodedCondition

@PersistantProperties(properties=@PersistantProperty(property="not",defaultValue="false"))
public interface ICondition
extends IAddon

An object which can be evaluated, telling if one or more condition(s) is(are) respected. All implementations should be done in a thread safe way for execution.

Method Summary

Modifier and Type	Method and Description
ICondition	clone() Clones the Condition.
ICondition	combine(ILogicalOperator operator, ICondition condition) Creates a new ICondition combining the result of the current one with the other provided one, using the provided operator.
void	compile(ICompilationContext ctxt) Compiles condition and validates data.
boolean	evaluate(IExecutionContext ctxt) Evaluates the result of the rule.
CostInfo	getEstimatedCost(ICompilationContext ctxt) Estimates the condition complexity, to allow callers to optimize calls.
boolean	isConstantValue() Tells if this condition returns a constant result for all executions.
ConditionEquivalence	isEquivalent(ICondition o) Tells if this condition is strictly equivalent or a strict negation of the other provided condition.
boolean	isNot() Allows to invert condition's behavior.
boolean	isShouldBeWrappedToConstantValue() Tells if this condition should be wrapped into a constant value for optimization.
void	setNot(boolean not) Allows to invert condition's behavior.

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)
      throws MRuleValidationException

Compiles condition and validates data.

Throws:

MRuleValidationException - if validation problem detected.

getEstimatedCost

CostInfo getEstimatedCost(ICompilationContext ctxt)
                   throws MRuleValidationException

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.

Throws:

MRuleValidationException - if validation problem detected.

evaluate

boolean evaluate(IExecutionContext ctxt)
          throws MConditionEvaluationException

Evaluates the result of the rule.

Throws:

MConditionEvaluationException

combine

ICondition combine(ILogicalOperator operator,
                   ICondition condition)

Creates a new ICondition combining the result of the current one with the other provided one, using the provided operator.
The result might be the same instance as the current or the provided one.

Parameters:

operator - Operator to use to combine the results.

condition - Condition to combine with

Returns:

The combining condition.

clone

ICondition clone()

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

Specified by:

clone in interface IAddon

Specified by:

clone in interface IMRulesObject

isEquivalent

ConditionEquivalence isEquivalent(ICondition o)

Tells if this condition is strictly equivalent or a strict negation of the other provided condition.
Implementations should take into account the fact that a condition might be negated by its own "not" boolean property OR by the MConditionNot implementation or that the order of conditions in Condition Sets may or may not have influence on equivalence depending on the operator.
As this method is internally used in optimization processes, false positives for equivalence may have serious consequences, when false negatives are acceptable and will just lead to less efficient optimization.

Since:

1.5.0

isConstantValue

boolean isConstantValue()

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

Since:

1.5.0

isShouldBeWrappedToConstantValue

boolean isShouldBeWrappedToConstantValue()

Tells if this condition should be wrapped into a constant value for optimization.

Since:

1.5.0

isNot

boolean isNot()

Allows to invert condition's behavior.

Since:

1.5.0 - became common to all conditions in order to allow more efficient optimization process.

setNot

void setNot(boolean not)

Allows to invert condition's behavior.

Since:

1.5.0 - became common to all conditions in order to allow more efficient optimization process.