Top Description Inners Fields Constructors Methods
org.apache.poi.ss.formula.atp

public final Class AnalysisToolPak

extends Object
implements UDFFinder
Class Inheritance
All Implemented Interfaces
org.apache.poi.ss.formula.udf.UDFFinder
Imports
java.util.Collection, .Collections, .HashMap, .Locale, .Map, .TreeSet, org.apache.poi.ss.formula.OperationEvaluationContext, org.apache.poi.ss.formula.eval.NotImplementedFunctionException, .ValueEval, org.apache.poi.ss.formula.function.FunctionMetadata, .FunctionMetadataRegistry, org.apache.poi.ss.formula.functions.*, org.apache.poi.ss.formula.udf.UDFFinder
Analysis Toolpack Function Definitions

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
AnalysisToolPak.NotImplemented

Field Summary

Modifier and TypeField and Description
private final Map<String, FreeRefFunction>
_functionsByName

public static final UDFFinder
instance

Constructor Summary

AccessConstructor and Description
private
AnalysisToolPak()

Method Summary

Modifier and TypeMethod and Description
private Map<String, FreeRefFunction>
createFunctionsMap()

public FreeRefFunction
findFunction(String
Name of function.
name)

Implements org.apache.poi.ss.formula.udf.UDFFinder.findFunction.

Returns executor by specified name.

public static Collection<String>

Returns:

an array of not supported functions
getNotSupportedFunctionNames()

Returns a collection of ATP function names NOT implemented by POI.

public static Collection<String>

Returns:

an array of supported functions
getSupportedFunctionNames()

Returns a collection of ATP function names implemented by POI.

public static boolean
isATPFunction(String name)

private static void
r(Map<String, FreeRefFunction> m, String functionName, FreeRefFunction pFunc)

public static void
registerFunction(String
the function name
name, FreeRefFunction
the function to register
func)

Register an ATP function in runtime.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

_functionsByNameback to summary
private final Map<String, FreeRefFunction> _functionsByName
instanceback to summary
public static final UDFFinder instance

Constructor Detail

AnalysisToolPakback to summary
private AnalysisToolPak()

Method Detail

createFunctionsMapback to summary
private Map<String, FreeRefFunction> createFunctionsMap()
findFunctionback to summary
public FreeRefFunction findFunction(String name)

Implements org.apache.poi.ss.formula.udf.UDFFinder.findFunction.

Doc from org.apache.poi.ss.formula.udf.UDFFinder.findFunction.

Returns executor by specified name. Returns null if the function name is unknown.

Parameters
name:String

Name of function.

Returns:FreeRefFunction

Function executor.

getNotSupportedFunctionNamesback to summary
public static Collection<String> getNotSupportedFunctionNames()

Returns a collection of ATP function names NOT implemented by POI.

Returns:Collection<String>

an array of not supported functions

Since
3.8 beta6
getSupportedFunctionNamesback to summary
public static Collection<String> getSupportedFunctionNames()

Returns a collection of ATP function names implemented by POI.

Returns:Collection<String>

an array of supported functions

Since
3.8 beta6
isATPFunctionback to summary
public static boolean isATPFunction(String name)
rback to summary
private static void r(Map<String, FreeRefFunction> m, String functionName, FreeRefFunction pFunc)
registerFunctionback to summary
public static void registerFunction(String name, FreeRefFunction func)

Register an ATP function in runtime.

Parameters
name:String

the function name

func:FreeRefFunction

the function to register

Exceptions
IllegalArgumentException:
if the function is unknown or already registered.
Since
3.8 beta6
org.apache.poi.ss.formula.atp back to summary

private final Class AnalysisToolPak.NotImplemented

extends Object
implements FreeRefFunction
Class Inheritance
All Implemented Interfaces
org.apache.poi.ss.formula.functions.FreeRefFunction

Field Summary

Modifier and TypeField and Description
private final String
_functionName

Constructor Summary

AccessConstructor and Description
public
NotImplemented(String functionName)

Method Summary

Modifier and TypeMethod and Description
public ValueEval
evaluate(ValueEval[]
the pre-evaluated arguments for this function. args is never null, nor are any of its elements.
args, OperationEvaluationContext
primarily used to identify the source cell containing the formula being evaluated. may also be used to dynamically create reference evals.
ec)

Implements org.apache.poi.ss.formula.functions.FreeRefFunction.evaluate.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

_functionNameback to summary
private final String _functionName

Constructor Detail

NotImplementedback to summary
public NotImplemented(String functionName)

Method Detail

evaluateback to summary
public ValueEval evaluate(ValueEval[] args, OperationEvaluationContext ec)

Implements org.apache.poi.ss.formula.functions.FreeRefFunction.evaluate.

Parameters
args:ValueEval[]

Doc from org.apache.poi.ss.formula.functions.FreeRefFunction.evaluate.

the pre-evaluated arguments for this function. args is never null, nor are any of its elements.

ec:OperationEvaluationContext

Doc from org.apache.poi.ss.formula.functions.FreeRefFunction.evaluate.

primarily used to identify the source cell containing the formula being evaluated. may also be used to dynamically create reference evals.

Returns:ValueEval

Doc from org.apache.poi.ss.formula.functions.FreeRefFunction.evaluate.

never null. Possibly an instance of ErrorEval in the case of a specified Excel error (Exceptions are never thrown to represent Excel errors).