Package com.inductiveautomation.ignition.client.expressions

Class ClientFunctionFactory.DynamicDispatchCreatorManager

java.lang.Object

com.inductiveautomation.ignition.client.expressions.ClientFunctionFactory.DynamicDispatchCreatorManager

All Implemented Interfaces:

ExpressionFunctionManager, FunctionFactory

Enclosing class:

ClientFunctionFactory

protected class ClientFunctionFactory.DynamicDispatchCreatorManager
extends Object
implements ExpressionFunctionManager

We only want to wrap up functions provided by modules, so we create this separate manager that will be used by them. It will wrap the functions up and then pass them to the client factory.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DynamicDispatchCreatorManager()

Method Summary

Modifier and Type	Method	Description
void	addFunction(String name, String category, Function f)	Adds the given function to the expression system.
void	addFunction(String name, String category, Function f, boolean visible)	Adds the given function, optionally making it invisible to the various configuration helpers.
Set<String>	getCategories()	Return a sequence of categories to organize functions.
Function	getFunction(String name)	Look up the function with the given name.
Set<String>	getFunctionNames()	Returns a set of all the registered function names.
Set<String>	getFunctionsInCategory(String name)	Returns a set of function names that belong to the given category.
boolean	isDefined(String functionName)	Returns whether the specified function has already been defined.

Methods inherited from class java.lang.Object

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

Constructor Details

DynamicDispatchCreatorManager

protected DynamicDispatchCreatorManager()

Method Details

getFunction

public Function getFunction(String name)

Description copied from interface: FunctionFactory

Look up the function with the given name. This function will be in a state that is ready to use in an expression, meaning that it may be a cloned copy for functions that keep state.

Specified by:

getFunction in interface FunctionFactory

Parameters:

name - the name of the function to look up

Returns:

the Function, or null if no function with the given name exists

getFunctionNames

public Set<String> getFunctionNames()

Description copied from interface: FunctionFactory

Returns a set of all the registered function names. Used for syntax highlighting in the designer.

Specified by:

getFunctionNames in interface FunctionFactory

Returns:

a Set of all registered function names

getCategories

public Set<String> getCategories()

Description copied from interface: FunctionFactory

Return a sequence of categories to organize functions. Used to generate the popup menu in the designer. Will automatically organize into submenus based on forward-slash in path.

Specified by:

getCategories in interface FunctionFactory

Returns:

a Set of function categories

getFunctionsInCategory

public Set<String> getFunctionsInCategory(String name)

Description copied from interface: FunctionFactory

Returns a set of function names that belong to the given category.

Specified by:

getFunctionsInCategory in interface FunctionFactory

Parameters:

name - the category name

Returns:

a Set of function names in the given category

addFunction

public void addFunction(String name,
 String category,
 Function f)
                 throws IllegalArgumentException

Description copied from interface: ExpressionFunctionManager

Adds the given function to the expression system.

Specified by:

addFunction in interface ExpressionFunctionManager

Throws:

IllegalArgumentException - if the provided function name already exists.

addFunction

public void addFunction(String name,
 String category,
 Function f,
 boolean visible)
                 throws IllegalArgumentException

Description copied from interface: ExpressionFunctionManager

Adds the given function, optionally making it invisible to the various configuration helpers. This is useful for supporting backwards compatibility of "legacy" expression functions.

Specified by:

addFunction in interface ExpressionFunctionManager

Throws:

IllegalArgumentException

isDefined

public boolean isDefined(String functionName)

Description copied from interface: ExpressionFunctionManager

Returns whether the specified function has already been defined.

Specified by:

isDefined in interface ExpressionFunctionManager