Package com.apama.dashboard.function

Class FunctionDescriptorFactory

java.lang.Object

com.apama.dashboard.function.FunctionDescriptorFactory

public class FunctionDescriptorFactory
extends java.lang.Object

FunctionDescriptorFactory is a class that provides factory methods for creating new instances of classes that implement the IFunctionDescriptor interface.

Constructor Summary

Constructors

Constructor	Description
FunctionDescriptorFactory()

Method Summary

Modifier and Type	Method	Description
static IFunctionDescriptor	createFunctionDescriptor(java.lang.String name, java.lang.String[] argNames, java.lang.String[] argVarNames, int returnType, java.lang.String[] returnColumnNames, java.lang.String description)	Create a new IFunctionDescriptor.

Methods inherited from class java.lang.Object

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

Constructor Detail

FunctionDescriptorFactory

public FunctionDescriptorFactory()

Method Detail

createFunctionDescriptor

public static IFunctionDescriptor createFunctionDescriptor(java.lang.String name,
                                                           java.lang.String[] argNames,
                                                           java.lang.String[] argVarNames,
                                                           int returnType,
                                                           java.lang.String[] returnColumnNames,
                                                           java.lang.String description)

Create a new IFunctionDescriptor.

Parameters:

name - Name of function.

argNames - Array of argument names to function.

argVarNames - Array of variable names to hold values of arguments to function. There must be a one-to-one correspondence between argNames and argVarNames. Functions can have up to 10 arguments. The type of each argument is encoded into it's variable name. Possible names:

Table Arguments: argTableColumn, argTableColumn2 ... argTableColumn4

String Arguments: s_arg1, s_arg2 ... s_arg10

Integer Arguments: i_arg1, i_arg2 ... i_arg10

Double Arguments: arg1, arg2 ... arg10

returnType - Return type of function. Possible values:

IFunctionDescriptor.RETURN_TYPE_TABLE

IFunctionDescriptor.RETURN_TYPE_STRING

IFunctionDescriptor.RETURN_TYPE_INTEGER

IFunctionDescriptor.RETURN_TYPE_DOUBLE

returnColumnNames - For functions which return tables; the names of the columns in the returned table.

description - Description of function.