Package org.apache.poi.ss.formula.function

Class FunctionMetadataRegistry

java.lang.Object

org.apache.poi.ss.formula.function.FunctionMetadataRegistry

public final class FunctionMetadataRegistry
extends Object

Allows clients to get FunctionMetadata instances for any built-in function of Excel.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	FUNCTION_INDEX_CHOOSE
static final short	FUNCTION_INDEX_EXTERNAL
static final int	FUNCTION_INDEX_IF
static final short	FUNCTION_INDEX_INDIRECT
static final short	FUNCTION_INDEX_SUM
static final String	FUNCTION_NAME_IF	The name of the IF function (i.e.

Method Summary

Modifier and Type	Method	Description
static FunctionMetadata	getCetabFunctionByIndex(int index)
static FunctionMetadata	getFunctionByIndex(int index)
static FunctionMetadata	getFunctionByName(String name)
static short	lookupIndexByName(String name)	Resolves a built-in function index.

Methods inherited from class java.lang.Object

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

Field Details

FUNCTION_NAME_IF

public static final String FUNCTION_NAME_IF

The name of the IF function (i.e. "IF"). Extracted as a constant for clarity.

See Also:

• Constant Field Values

FUNCTION_INDEX_IF

public static final int FUNCTION_INDEX_IF

See Also:

• Constant Field Values

FUNCTION_INDEX_SUM

public static final short FUNCTION_INDEX_SUM

See Also:

• Constant Field Values

FUNCTION_INDEX_CHOOSE

public static final int FUNCTION_INDEX_CHOOSE

See Also:

• Constant Field Values

FUNCTION_INDEX_INDIRECT

public static final short FUNCTION_INDEX_INDIRECT

See Also:

• Constant Field Values

FUNCTION_INDEX_EXTERNAL

public static final short FUNCTION_INDEX_EXTERNAL

See Also:

• Constant Field Values

Method Details

getFunctionByIndex

public static FunctionMetadata getFunctionByIndex(int index)

getCetabFunctionByIndex

public static FunctionMetadata getCetabFunctionByIndex(int index)

lookupIndexByName

public static short lookupIndexByName(String name)

Resolves a built-in function index.

Parameters:

name - uppercase function name

Returns:

a negative value if the function name is not found. This typically occurs for external functions.

getFunctionByName

public static FunctionMetadata getFunctionByName(String name)