FormulaFunction (libformula Library (version 0.1.18))

Class FormulaFunction

public class FormulaFunction extends AbstractLValue

A function. Formulas consist of functions, references or static values, which are connected by operators.

Functions always have a cannonical name, which must be unique and which identifies the function. Functions can have a list of parameters. The number of parameters can vary, and not all parameters need to be filled.

Functions can have required and optional parameters. Mixing required and optional parameters is not allowed. Optional parameters cannot be ommited, unless they are the last parameter in the list.

This class provides the necessary wrapper functionality to fill in the parameters.

Author: Thomas Morgner

Constructor Summary
	FormulaFunction(String functionName, LValue[] parameters)

Constructor Summary

FormulaFunction(String functionName, LValue[] parameters)

Method Summary
Object	clone()
TypeValuePair	evaluate()
LValue[]	getChildValues() Returns any dependent lvalues (parameters and operands, mostly).
Function	getFunction() Returns the initialized function.
String	getFunctionName() Returns the function's name.
FunctionDescription	getMetaData() Returns the function's meta-data.
void	initialize(FormulaContext context)
boolean	isConstant() Checks, whether the LValue is constant.
String	toString()

Method Summary

Object

clone()

TypeValuePair

evaluate()

LValue[]

getChildValues()

Returns any dependent lvalues (parameters and operands, mostly).

Function

getFunction()

Returns the initialized function.

String

getFunctionName()

Returns the function's name.

FunctionDescription

getMetaData()

Returns the function's meta-data.

void

initialize(FormulaContext context)

boolean

isConstant()

Checks, whether the LValue is constant.

String

Returns the initialized function. Be aware that this method will return null if this LValue instance has not yet been initialized.

Returns: the function instance or null, if the FormulaFunction instance has not yet been initialized.

getFunctionName

Returns the function's name. This is the normalized name and may not be suitable for the user. Query the function's metadata to retrieve a display-name.

Returns: the function's name.

getMetaData

Returns the function's meta-data. Be aware that this method will return null if this LValue instance has not yet been initialized.

Returns: the function description instance or null, if the FormulaFunction instance has not yet been initialized.