Package org.yamcs.studio.autocomplete.sim

Class DSFunctionSet

java.lang.Object

org.yamcs.studio.autocomplete.sim.DSFunctionSet

Direct Known Subclasses:

SimDSFunctionSet

public class DSFunctionSet
extends Object

A set of functions that can be used in the data source.

Objects of this class can be registered in the DSFunctionRegistry and the functions will be available in the data source language.

Field Summary

Fields

Modifier and Type	Field	Description
static Pattern	namePattern

Constructor Summary

Constructors

Constructor	Description
DSFunctionSet(DSFunctionSetDescription functionSetDescription)	Creates a new set of functions to be registered in the data source language.

Method Summary

Modifier and Type	Method	Description
final Collection<DSFunction>	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<DSFunction>	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

Field Details

namePattern

public static Pattern namePattern

Constructor Details

DSFunctionSet

public DSFunctionSet(DSFunctionSetDescription functionSetDescription)

Creates a new set of functions to be registered in the data source 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<DSFunction> 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<DSFunction> getFunctions()

Returns all functions in the set.

Returns:

the functions in the set