com.inductiveautomation.ignition.common.expressions

Class BasicFunctionFactory

java.lang.Object

com.inductiveautomation.ignition.common.expressions.AbstractFunctionFactory

com.inductiveautomation.ignition.common.expressions.BasicFunctionFactory

All Implemented Interfaces:

ExpressionFunctionManager, FunctionFactory

public class BasicFunctionFactory
extends AbstractFunctionFactory
implements ExpressionFunctionManager

This basic function factory extends AbstractFunctionFactory in order to implement the ExpressionFunctionManager interface, making it mutable.

Field Summary

Fields inherited from class com.inductiveautomation.ignition.common.expressions.AbstractFunctionFactory

categories, functions, parent

Constructor Summary

Constructors

Constructor and Description
BasicFunctionFactory()
BasicFunctionFactory(FunctionFactory parent)

Method Summary

Modifier and Type	Method and Description
void	addFunction(java.lang.String name, java.lang.String category, Function f) Adds the given function to the expression system.
void	addFunction(java.lang.String name, java.lang.String category, Function f, boolean visible) Adds the given function, optionally making it invisible to the various configuration helpers.
boolean	isDefined(java.lang.String functionName) Returns whether the specified function has already been defined.

Methods inherited from class com.inductiveautomation.ignition.common.expressions.AbstractFunctionFactory

getCategories, getFunction, getFunctionNames, getFunctionsInCategory

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.ignition.common.expressions.FunctionFactory

getCategories, getFunction, getFunctionNames, getFunctionsInCategory

Constructor Detail

BasicFunctionFactory

public BasicFunctionFactory()

BasicFunctionFactory

public BasicFunctionFactory(FunctionFactory parent)

Method Detail

isDefined

public boolean isDefined(java.lang.String functionName)

Description copied from interface: ExpressionFunctionManager

Returns whether the specified function has already been defined.

Specified by:

isDefined in interface ExpressionFunctionManager

addFunction

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

Description copied from interface: ExpressionFunctionManager

Adds the given function to the expression system.

Specified by:

addFunction in interface ExpressionFunctionManager

Overrides:

addFunction in class AbstractFunctionFactory

Throws:

java.lang.IllegalArgumentException - if the provided function name already exists.

addFunction

public void addFunction(java.lang.String name,
                        java.lang.String category,
                        Function f,
                        boolean visible)
                 throws java.lang.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

Overrides:

addFunction in class AbstractFunctionFactory

Throws:

java.lang.IllegalArgumentException