Package org.pentaho.libformula.editor.function

Class FunctionLib

java.lang.Object

org.pentaho.libformula.editor.function.FunctionLib

public class FunctionLib
extends Object

Constructor Summary

Constructors

Constructor	Description
FunctionLib(String filename)

Method Summary

Modifier and Type	Method	Description
String[]	getFunctionCategories()
FunctionDescription	getFunctionDescription(String functionName)
String[]	getFunctionNames()
List<FunctionDescription>	getFunctions()
String[]	getFunctionsForACategory(String category)	Get all the function names for a certain category
void	setFunctions(List<FunctionDescription> functions)

Methods inherited from class java.lang.Object

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

Constructor Details

FunctionLib

public FunctionLib(String filename)
            throws org.pentaho.di.core.exception.KettleXMLException

Throws:

org.pentaho.di.core.exception.KettleXMLException

Method Details

getFunctions

public List<FunctionDescription> getFunctions()

Returns:

the functions

setFunctions

public void setFunctions(List<FunctionDescription> functions)

Parameters:

functions - the functions to set

getFunctionNames

public String[] getFunctionNames()

Returns:

A sorted array of function names, extracted from the function descriptions...

getFunctionCategories

public String[] getFunctionCategories()

Returns:

A sorted array of unique categories, extracted from the function descriptions...

getFunctionsForACategory

public String[] getFunctionsForACategory(String category)

Get all the function names for a certain category

Parameters:

category - the category name to look for

Returns:

the sorted array of function names for the specified category

getFunctionDescription

public FunctionDescription getFunctionDescription(String functionName)

Parameters:

functionName - the name of the function to look for

Returns:

the corresponding function description or null if nothing was found.