com.massa.mrules.addon

Class AbstractAddon

java.lang.Object

com.massa.mrules.base.AbstractMRulesObject

com.massa.mrules.addon.AbstractAddon

All Implemented Interfaces:

IAddon, IMRulesObject, Outable, Serializable, Cloneable

Direct Known Subclasses:

AbstractCondition, AbstractContextFactory, AbstractEvaluationOperator, AbstractExecutable, AbstractLogicalOperator, AbstractMathOperator, AbstractReadAccessor, Function

public abstract class AbstractAddon
extends AbstractMRulesObject
implements IAddon

Common mother class for addons implementation.

Since:

1.3.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractAddon()

Method Summary

Modifier and Type	Method and Description
AbstractAddon	clone() Clones the Addon.
Integer	getInternalCacheIdentifier() Returns null by default.
boolean	isCacheUsed() Returns false by default.
boolean	isInternalCacheIdentifierNeeded() This method allows to tell the engine if a cache identifier is needed.
void	optimize(ICompilationContext ctxt) Convenience method, which does nothing.
void	resetCachedData(IExecutionContext ctxt) Does nothing.
void	setInternalCacheIdentifier(Integer internalIdentifier) Stores nothing.
String	toString()
boolean	wasRegistered(ICompilationContext ctxt, IAddon parent, AddonInfo info) Convenience method, which does nothing.

Methods inherited from class com.massa.mrules.base.AbstractMRulesObject

getDebugInfo, getDescription, getName, setDebugInfo, setDescription, setName

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getImplementationId

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

Constructor Detail

AbstractAddon

public AbstractAddon()

Method Detail

optimize

public void optimize(ICompilationContext ctxt)
              throws MRuleValidationException

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:

optimize in interface IAddon

Throws:

MRuleValidationException

wasRegistered

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

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

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

info - Addon info for the currently registered addon

Returns:

false

Throws:

MRuleValidationException

setInternalCacheIdentifier

public void setInternalCacheIdentifier(Integer internalIdentifier)

Stores nothing.

Specified by:

setInternalCacheIdentifier in interface IAddon

Parameters:

internalIdentifier - Internal identifier

See Also:

IAddon.getInternalCacheIdentifier()

getInternalCacheIdentifier

public Integer getInternalCacheIdentifier()

Returns null by default.

Specified by:

getInternalCacheIdentifier in interface IAddon

Returns:

Internal identifier

See Also:

IAddon.setInternalCacheIdentifier(Integer)

isCacheUsed

public boolean isCacheUsed()

Returns false by default.

Specified by:

isCacheUsed in interface IAddon

resetCachedData

public void resetCachedData(IExecutionContext ctxt)

Does nothing.

Specified by:

resetCachedData in interface IAddon

isInternalCacheIdentifierNeeded

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

Specified by:

isInternalCacheIdentifierNeeded in interface IAddon

Returns:

Internal identifier

See Also:

setInternalCacheIdentifier(Integer)

toString

public String toString()

Overrides:

toString in class Object

clone

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

Overrides:

clone in class AbstractMRulesObject