Class AnalysisToolPak

java.lang.Object
org.apache.poi.ss.formula.atp.AnalysisToolPak
All Implemented Interfaces:
UDFFinder

public final class AnalysisToolPak extends Object implements UDFFinder
Analysis Toolpack Function Definitions
  • Field Details

    • instance

      public static final UDFFinder instance
  • Method Details

    • findFunction

      public FreeRefFunction findFunction(String name)
      Description copied from interface: UDFFinder
      Returns executor by specified name. Returns null if the function name is unknown.
      Specified by:
      findFunction in interface UDFFinder
      Parameters:
      name - Name of function.
      Returns:
      Function executor.
    • isATPFunction

      public static boolean isATPFunction(String name)
    • getSupportedFunctionNames

      public static Collection<String> getSupportedFunctionNames()
      Returns a collection of ATP function names implemented by POI.
      Returns:
      an array of supported functions
      Since:
      3.8 beta6
    • getNotSupportedFunctionNames

      public static Collection<String> getNotSupportedFunctionNames()
      Returns a collection of ATP function names NOT implemented by POI.
      Returns:
      an array of not supported functions
      Since:
      3.8 beta6
    • registerFunction

      public static void registerFunction(String name, FreeRefFunction func)
      Register a ATP function in runtime.
      Parameters:
      name - the function name
      func - the functoin to register
      Throws:
      IllegalArgumentException - if the function is unknown or already registered.
      Since:
      3.8 beta6