Top Description Fields Constructors Methods

org.apache.poi.ss.formula.function

public final Class FunctionMetadataRegistry

Class Inheritance

extends Object

java.lang.Object
org.apache.poi.ss.formula.function.FunctionMetadataRegistry

Imports

java.util.Map, .Set

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

Field Summary

Modifier and Type	Field and Description
private final FunctionMetadata[]	_functionDataByIndex
private final Map<String, FunctionMetadata>	_functionDataByName
private static FunctionMetadataRegistry	_instance
private static FunctionMetadataRegistry	_instanceCetab
public static final int	FUNCTION_INDEX_CHOOSE
public static final short	FUNCTION_INDEX_EXTERNAL
public static final int	FUNCTION_INDEX_IF
public static final short	FUNCTION_INDEX_INDIRECT
public static final short	FUNCTION_INDEX_SUM
public static final String	FUNCTION_NAME_IF The name of the IF function (i.e. "IF").

Constructor Summary

Access	Constructor and Description
pack-priv	FunctionMetadataRegistry(FunctionMetadata[] functionDataByIndex, Map<String, FunctionMetadata> functionDataByName)

Method Summary

Modifier and Type	Method and Description
pack-priv Set<String>	getAllFunctionNames()
public static FunctionMetadata	getCetabFunctionByIndex(int index)
public static FunctionMetadata	getFunctionByIndex(int index)
private FunctionMetadata	getFunctionByIndexInternal(int index)
public static FunctionMetadata	getFunctionByName(String name)
private FunctionMetadata	getFunctionByNameInternal(String name)
private static FunctionMetadataRegistry	getInstance()
private static FunctionMetadataRegistry	getInstanceCetab()
public static short	Returns: a negative value if the function name is not found. This typically occurs for external functions. lookupIndexByName(String uppercase function name name) Resolves a built-in function index.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_functionDataByIndex	back to summary
private final FunctionMetadata[] _functionDataByIndex

_functionDataByName	back to summary
private final Map<String, FunctionMetadata> _functionDataByName

_instance	back to summary
private static FunctionMetadataRegistry _instance

_instanceCetab	back to summary
private static FunctionMetadataRegistry _instanceCetab

FUNCTION_INDEX_CHOOSE	back to summary
public static final int FUNCTION_INDEX_CHOOSE

FUNCTION_INDEX_EXTERNAL	back to summary
public static final short FUNCTION_INDEX_EXTERNAL

FUNCTION_INDEX_IF	back to summary
public static final int FUNCTION_INDEX_IF

FUNCTION_INDEX_INDIRECT	back to summary
public static final short FUNCTION_INDEX_INDIRECT

FUNCTION_INDEX_SUM	back to summary
public static final short FUNCTION_INDEX_SUM

FUNCTION_NAME_IF	back to summary
public static final String FUNCTION_NAME_IF The name of the IF function (i.e. "IF"). Extracted as a constant for clarity.

Constructor Detail

FunctionMetadataRegistry	back to summary
pack-priv FunctionMetadataRegistry(FunctionMetadata[] functionDataByIndex, Map<String, FunctionMetadata> functionDataByName)

Method Detail

getAllFunctionNames	back to summary
pack-priv Set<String> getAllFunctionNames()

getCetabFunctionByIndex	back to summary
public static FunctionMetadata getCetabFunctionByIndex(int index)

getFunctionByIndex	back to summary
public static FunctionMetadata getFunctionByIndex(int index)

getFunctionByIndexInternal	back to summary
private FunctionMetadata getFunctionByIndexInternal(int index)

getFunctionByName	back to summary
public static FunctionMetadata getFunctionByName(String name)

getFunctionByNameInternal	back to summary
private FunctionMetadata getFunctionByNameInternal(String name)

getInstance	back to summary
private static FunctionMetadataRegistry getInstance()

getInstanceCetab	back to summary
private static FunctionMetadataRegistry getInstanceCetab()

lookupIndexByName

back to summary

public static short lookupIndexByName(String name)

Resolves a built-in function index.

Parameters

name:String: uppercase function name

Returns:short

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