org.diirt.datasource.formula

Interface FormulaFunction

All Known Implementing Classes:

AbstractVBooleanVBooleanToVBooleanFormulaFunction, AbstractVIntNumberVIntNumberToVIntNumberFormulaFunction, AbstractVNumberArrayVNumberArrayToVNumberArrayFormulaFunction, AbstractVNumberArrayVNumberToVNumberArrayFormulaFunction, AbstractVNumberToVNumberFormulaFunction, AbstractVNumberVNumberArrayToVNumberArrayFormulaFunction, AbstractVNumberVNumberToVBooleanFormulaFunction, AbstractVNumberVNumberToVNumberFormulaFunction, CaHistogramFormulaFunction, CFQueryFunction, ChannelFormulaFunction, ChannelsFormulaFunction, DynamicFormulaFunction, Histogram2DOfFormulaFunction, HistogramOfFormulaFunction, IntegrateFormulaFunction, PvFormulaFunction, PvsFormulaFunction, StatefulFormulaFunction, TCQueryFunction

public interface FormulaFunction

Definition for a function that can be integrated in the formula language.

Author:

carcassi

Method Summary

Modifier and Type	Method and Description
Object	calculate(List<Object> args) Calculate the result of the function given the arguments.
List<String>	getArgumentNames() The ordered list of the argument names.
List<Class<?>>	getArgumentTypes() The ordered list of the arguments type.
String	getDescription() Return the description of the function.
String	getName() Return the name of the function.
Class<?>	getReturnType() The type of the function result.
boolean	isPure() Whether the function is a pure function, given the same arguments always returns the same result.
boolean	isVarArgs() Whether the function takes a variable number of arguments.

Method Detail

isPure

boolean isPure()

Whether the function is a pure function, given the same arguments always returns the same result.

Returns:

true if it's a pure function

isVarArgs

boolean isVarArgs()

Whether the function takes a variable number of arguments.

Variable arguments can only be at the end of the argument list, and have the same type.

Returns:

true if the function can accept a variable number of arguments

getName

String getName()

Return the name of the function.

Returns:

the function name

getDescription

String getDescription()

Return the description of the function.

Returns:

the function description

getArgumentTypes

List<Class<?>> getArgumentTypes()

The ordered list of the arguments type.

Returns:

the types of the arguments

getArgumentNames

List<String> getArgumentNames()

The ordered list of the argument names.

Returns:

the names of the names

getReturnType

Class<?> getReturnType()

The type of the function result.

Returns:

the result type

calculate

Object calculate(List<Object> args)

Calculate the result of the function given the arguments.

Parameters:

args - the argument list

Returns:

the result of the function