Package org.apache.poi.ss.formula.atp

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 Summary

Fields

Modifier and Type	Field	Description
static final UDFFinder	instance

Method Summary

Modifier and Type	Method	Description
FreeRefFunction	findFunction(String name)	Returns executor by specified name.
static Collection<String>	getNotSupportedFunctionNames()	Returns a collection of ATP function names NOT implemented by POI.
static Collection<String>	getSupportedFunctionNames()	Returns a collection of ATP function names implemented by POI.
static boolean	isATPFunction(String name)
static void	registerFunction(String name, FreeRefFunction func)	Register an ATP function in runtime.
static void	registerFunction(String name, FreeRefFunction func, boolean force)	Register an ATP function in runtime.

Methods inherited from class java.lang.Object

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

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 an ATP function in runtime.

Parameters:

name - the function name

func - the function to register

Throws:

IllegalArgumentException - if the function is unknown or already registered.

Since:

3.8 beta6

registerFunction

public static void registerFunction(String name,
 FreeRefFunction func,
 boolean force)

Register an ATP function in runtime.

Parameters:

name - the function name

func - the function to register

force - force registration even if the function is already registered or unknown to POI

Throws:

IllegalArgumentException - if the function is unknown or already registered (and `force` is not true).

Since:

5.5.0