com.massa.mrules.callable

Class Function

java.lang.Object

com.massa.mrules.base.AbstractMRulesObject

com.massa.mrules.addon.AbstractAddon

com.massa.mrules.callable.Function

All Implemented Interfaces:

IAddon, IMRulesObject, ICallable, Outable, Serializable, Cloneable

@PersistantProperties(properties=@PersistantProperty(property="executables",alias="executable"))
public class Function
extends AbstractAddon
implements ICallable

Allows to declare functions.

Since:

1.9.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	FUNCTION_ID

Constructor Summary

Constructors

Constructor and Description
Function()

Method Summary

Modifier and Type	Method and Description
IExecutionResult	call(IExecutionContext ctxt) Executes the call.
Function	clone() Clones the Addon.
void	compile(ICompilationContext ctxt) Compiles this callable and all its sub components.
boolean	equals(Object o)
CostInfo	getEstimatedReadCost(ICompilationContext ctxt) Estimates the whole call complexity, to allow callers to optimize calls.
List<? extends IExecutable>	getExecutables()
String	getImplementationId() Unique addon implementation ID.
int	hashCode()
void	setExecutables(List<? extends IExecutable> executables)
void	toString(OuterWithLevel outer) Method used to send String representation of the current object to the OuterWithLevel.

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

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

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.addon.IAddon

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

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

getDebugInfo, getDescription, getName, setDebugInfo, setDescription, setName

Field Detail

FUNCTION_ID

public static final String FUNCTION_ID

See Also:

Constant Field Values

Constructor Detail

Function

public Function()

Method Detail

compile

public void compile(ICompilationContext ctxt)
             throws MRuleValidationException

Description copied from interface: ICallable

Compiles this callable and all its sub components.

Specified by:

compile in interface ICallable

Throws:

MRuleValidationException

getEstimatedReadCost

public CostInfo getEstimatedReadCost(ICompilationContext ctxt)
                              throws MRuleValidationException

Description copied from interface: ICallable

Estimates the whole call complexity, to allow callers to optimize calls.
Calls to non-compiled instance may return non-accurate results.

Specified by:

getEstimatedReadCost in interface ICallable

Parameters:

ctxt - Compilation context.

Returns:

cost info

Throws:

MRuleValidationException - if validation problem detected.

call

public IExecutionResult call(IExecutionContext ctxt)
                      throws MExecutionException

Description copied from interface: ICallable

Executes the call. Might return a value via the IExecutionResult.getReturnedValue() method.

Specified by:

call in interface ICallable

Returns:

Execution result.

Throws:

MExecutionException

toString

public void toString(OuterWithLevel outer)
              throws IOException

Description copied from interface: Outable

Method used to send String representation of the current object to the OuterWithLevel.

Specified by:

toString in interface Outable

Throws:

IOException

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

clone

public Function 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 ICallable

Overrides:

clone in class AbstractAddon

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getExecutables

public List<? extends IExecutable> getExecutables()

setExecutables

public void setExecutables(List<? extends IExecutable> executables)