com.massa.mrules.addon

Interface IAddon

All Superinterfaces:

Cloneable, IMRulesObject, Outable, Serializable

All Known Subinterfaces:

IAccessor, IAction, ICallable, ICondition, IContextFactory, IEvaluationCondition, IEvaluationOperator, IExecutable, IExecutable.ValueReturning, ILogicalOperator, IMathOperator, IMruleExecutionSet, IMRuleExecutionSet, IReadAccessor, IReadAccessor.Standalone, IReadWriteAccessor, IWriteAccessor

All Known Implementing Classes:

Abs, AbstractAccessorWrapperCondition, AbstractActionPrint, AbstractAddon, AbstractAnonymousAddon, AbstractBasicAction, AbstractCollectionEvaluationOperator, AbstractCondition, AbstractConditionWrapperAccessor, AbstractContextFactory, AbstractEvaluationOperator, AbstractExecutable, AbstractExecutableWrapperAccessor, AbstractLogicalOperator, AbstractMapAccessor, AbstractMathOperator, AbstractMRuleExecutionSet, AbstractPropertyCheckAccessor, AbstractReadAccessor, AbstractReadSourceAccessor, AbstractSrcTgtAction, AbstractVariableCreator, AbstractVariableCreatorSource, AND, Average, BETWEEN, Call, COLDISJOINED, COLEQ, COLIN, COLINCLUDED, COLINCLUDES, COLINTERSECTS, COLNE, COLNOTIN, CONTAINS, DefaultVariablesManager.AbstractVariableAccessor, DefaultVariablesManager.Date, DefaultVariablesManager.DateTime, DefaultVariablesManager.Now, DefaultVariablesManager.NullValue, DefaultVariablesManager.Readbase, DefaultVariablesManager.RootReadbase, DefaultVariablesManager.RootWritebase, DefaultVariablesManager.RulesetName, DefaultVariablesManager.Time, DefaultVariablesManager.Writebase, Divide, DIVIDED, EMPTY, EQ, Function, GT, GTE, IN, Jdk8VariablesManager.Jdk8Date, Jdk8VariablesManager.Jdk8DateTime, Jdk8VariablesManager.Jdk8Now, Jdk8VariablesManager.Jdk8Time, LT, LTE, MAccessorWrapper, MAccessorWrapperCondition, MActionAdd, MActionAddAll, MActionClear, MActionDefine, MActionExec, MActionFlowControl, MActionPrint, MActionPrintF, MActionResetCache, MActionSet, MActionSort, MActionUndefine, MArithmeticAccessor, MATCH, MAvailableAccessor, MCastAccessor, MCoalesceAccessor, MConcatenateAccessor, MConditionNot, MConditionsCountAccessor, MConditionSet, MConditionWrapperAccessor, MContextFactory, MCountAccessor, MDateDiffAccessor, MDateManipulationAccessor, MDefinedAccessor, MEvaluationCondition, MEvaluationCondition.LiveCastCondition, MExecutableWrapperAccessor, MExecutionBlock, MFilterAccessor, MForEach, MForEachNumber, MFormatAccessor, MHardCodedCondition, MIndex, MIndex.IndexAction, MInOutContextFactory, MINUS, MIterateAccessor, MListContextFactory, MMapEntriesAccessor, MMapKeysAccessor, MMapValuesAccessor, MMinMaxAccessor, MMinMaxAccessor.Max, MMinMaxAccessor.Min, MNewInstanceAccessor, MNullIfEmptyAccessor, Mod, MODULO, MPropertyAccessor, MRule, MRuleExecutionSet, MRuleExecutionSetWrapper, MSearchAccessor, MSingleMathOperation, MSizeAccessor, MSplitAccessor, MStandaloneContextFactory, MSubPartAccessor, MTernaryAccessor, MULTIPLIED, Multiply, MValueAccessor, MValuesAccessor, MVariablePropertyAccessor, NE, NOTCONTAINS, NOTEMPTY, NOTIN, NOTMATCH, NOTNULL, NULL, OR, PLUS, Pow, POWER, Return, Round, Subtract, Sum, VALBETWEEN, XOR

public interface IAddon
extends IMRulesObject, Outable

Implementations can be loaded via ConfigDiscovery.

Method Summary

Modifier and Type	Method and Description
IAddon	clone() Clones the Addon.
String	getImplementationId() Unique addon implementation ID.
Integer	getInternalCacheIdentifier() This method allows to retrieve the internal cache identifier set during the compilation phase.
boolean	isCacheUsed() Tells if this addon will or not use cached data.
boolean	isInternalCacheIdentifierNeeded() This method allows to tell the engine if a cache identifier is needed.
void	optimize(ICompilationContext ctxt) Called automatically at the end of the compilation process on all addons, allows an addon to perform internal optimization depending on data computed by all other addons during compilation process.
void	resetCachedData(IExecutionContext ctxt) Tells this addon to reset its cached data, if any.
void	setInternalCacheIdentifier(Integer internalIdentifier) This method is called internally during the compilation phase, to set an internal cache identifier.
boolean	wasRegistered(ICompilationContext ctxt, IAddon parent, AddonInfo info) Hook called when addon is registered in context.

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

getImplementationId

String getImplementationId()

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

optimize

void optimize(ICompilationContext ctxt)
       throws MRuleValidationException

Called automatically at the end of the compilation process on all addons, allows an addon to perform internal optimization depending on data computed by all other addons during compilation process.

Throws:

MRuleValidationException

setInternalCacheIdentifier

void setInternalCacheIdentifier(Integer internalIdentifier)

This method is called internally during the compilation phase, to set an internal cache identifier. The global contract of all IAddon implementations is to store this identifier and to allow retrieving it, if they specify needing an identifier.

Parameters:

internalIdentifier - Internal identifier

See Also:

getInternalCacheIdentifier()

getInternalCacheIdentifier

Integer getInternalCacheIdentifier()

This method allows to retrieve the internal cache identifier set during the compilation phase.

Returns:

Internal identifier

See Also:

setInternalCacheIdentifier(Integer)

isInternalCacheIdentifierNeeded

boolean isInternalCacheIdentifierNeeded()

This method allows to tell the engine if a cache identifier is needed. If not, the Addon will not be able to use internal execution cache.
A particular addon might require data caching (see isCacheUsed()), but the optimization process can identify that the cache is not necessary in some cases. To deactivate it, at this point, the optimizer can't modify the value returned by isCacheUsed(), but only the value returned by isInternalCacheIdentifierNeeded().

Returns:

Internal identifier

See Also:

setInternalCacheIdentifier(Integer)

isCacheUsed

boolean isCacheUsed()

Tells if this addon will or not use cached data. If not, maybe callers should not use cache either.
Value returned by this method can be set by compilation process, but only at the beginning of the process (i.e. before compilation of children). The optimization process must not modify the value returned here, but it can modify the value returned by isInternalCacheIdentifierNeeded().

resetCachedData

void resetCachedData(IExecutionContext ctxt)

Tells this addon to reset its cached data, if any.
If this addon does not cache data (isInternalCacheIdentifierNeeded is false), this method does nothing.
This method may not be equivalent to IExecutionContext.resetCachedData(IAddon), so to tell an addon instance to reset its cached data, this method should be called, not the one in IExecutionContext.

wasRegistered

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

Hook called when addon is registered in context.
Parent is guaranteed to be valued. For the root addon, the parent is self.
Info is guaranteed to be valued.
This method is guaranteed to be called at least once during the compilation / optimization process.

Parameters:

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

info - Addon info for the currently registered addon

Returns:

true if internal data of the addon, which have influence on hashcode and equality, has been modified.

Throws:

MRuleValidationException

Since:

1.5.0

clone

IAddon clone()

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

Specified by:

clone in interface IMRulesObject