Package org.yamcs.studio.data.formula

Class FormulaFunctionSet

java.lang.Object

org.yamcs.studio.data.formula.FormulaFunctionSet

Direct Known Subclasses:

AlarmFunctionSet, ArrayFunctionSet, MathFunctionSet, VEnumFunctionSet, VNumberFunctionSet, VStringFunctionSet, VTableFunctionSet

public abstract class FormulaFunctionSet
extends Object

A set of functions that can be used in the formulas.

Objects of this class can be registered in the FormulaRegistry and the functions will be available in the formula language.

Constructor Summary

Constructors

Constructor	Description
FormulaFunctionSet(FormulaFunctionSetDescription functionSetDescription)	Creates a new ser of functions to be registered in the formula language.

Method Summary

Modifier and Type	Method	Description
final Collection<FormulaFunction>	findFunctions(String name)	Returns all the functions in the set with the given name.
final String	getDescription()	Returns the description of the function set.
final Collection<String>	getFunctionNames()	The names of all functions in this set.
final Collection<FormulaFunction>	getFunctions()	Returns all functions in the set.
final String	getName()	Returns the name of the function set.

Methods inherited from class java.lang.Object

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

Constructor Details

FormulaFunctionSet

public FormulaFunctionSet(FormulaFunctionSetDescription functionSetDescription)

Creates a new ser of functions to be registered in the formula language.

Parameters:

functionSetDescription - the description of the function set

Method Details

getName

public final String getName()

Returns the name of the function set.

Returns:

the function set name

getDescription

public final String getDescription()

Returns the description of the function set.

Returns:

the function set description

getFunctionNames

public final Collection<String> getFunctionNames()

The names of all functions in this set.

Returns:

the function names

findFunctions

public final Collection<FormulaFunction> findFunctions(String name)

Returns all the functions in the set with the given name.

Parameters:

name - the name of the function

Returns:

the matched functions; never null

getFunctions

public final Collection<FormulaFunction> getFunctions()

Returns all functions in the set.

Returns:

the functions in the set