Package com.apama.dashboard.function
Interface IFunctionLibrary
-
public interface IFunctionLibrary
IFunctionLibrary is the interface a Dashboard Studio custom function library must implement. A function library provides the ability to extend Dashboard Studio through the addition of custom functions. A custom function library can implement multiple functions.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.Object
evaluateFunction​(java.lang.String function, IVariableData variables)
Invoke a function.java.util.List<IFunctionDescriptor>
getFunctionDescriptors()
Get the list of FunctionDescriptors defining the functions implemented by the library.
-
-
-
Method Detail
-
getFunctionDescriptors
java.util.List<IFunctionDescriptor> getFunctionDescriptors()
Get the list of FunctionDescriptors defining the functions implemented by the library.- Returns:
- List of FunctionDescriptors.
-
evaluateFunction
java.lang.Object evaluateFunction​(java.lang.String function, IVariableData variables)
Invoke a function. Called at runtime when a data attachment requires data from a function.- Parameters:
function
- Name of function to evaluate.variables
- Variable arguments to function.- Returns:
- Result of function. The data type returned must be of the type declared for the function.
-
-