Package com.inductiveautomation.ignition.common.expressions

Class ContextDelegateFunctionFactory

java.lang.Object
com.inductiveautomation.ignition.common.expressions.ContextDelegateFunctionFactory
All Implemented Interfaces:
FunctionFactory
public class ContextDelegateFunctionFactory extends Object implements FunctionFactory
Many custom function factories get cached, but when delegating to the factory provided by the context, that shouldn't happen. This class can be used as the parent of those other factories, and will look up the context factory fresh each time.

  • Constructor Details

    • ContextDelegateFunctionFactory

      public ContextDelegateFunctionFactory(CommonContext context)

  • Method Details

    • f

      protected FunctionFactory f()

    • 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