Package com.apama.dashboard.function

Interface IFunctionDescriptor

  • public interface IFunctionDescriptor
    IFunctionDescriptor is an interface that represents a description of a DashboardSutdio function. Function libraries return a List of IFunctionDescriptor to identify the functions they implement. Use the factory class FunctionDescriptorFactory to create instances of IFunctionDescriptor.

    • Field Detail

      • RETURN_TYPE_TABLE

        static final int RETURN_TYPE_TABLE
        Function returns an instance of TabularData
        See Also:
        Constant Field Values

      • RETURN_TYPE_INTEGER

        static final int RETURN_TYPE_INTEGER
        Function returns an instance of Integer
        See Also:
        Constant Field Values

      • RETURN_TYPE_DOUBLE

        static final int RETURN_TYPE_DOUBLE
        Function returns an instance of Double
        See Also:
        Constant Field Values

      • RETURN_TYPE_STRING

        static final int RETURN_TYPE_STRING
        Function returns an instance of String
        See Also:
        Constant Field Values

    • Method Detail

      • getArgNames

        java.lang.String[] getArgNames()
        Get the argument names to the function.
        Returns:
        Array of argument names.

      • getArgVarNames

        java.lang.String[] getArgVarNames()
        Get the array of variable names to hold argument values.
        Returns:
        Array of variable names.

      • getDescription

        java.lang.String getDescription()
        Get the description of function.
        Returns:
        Function description.

      • getName

        java.lang.String getName()
        Get the name of the function.
        Returns:
        Function name.

      • getReturnColumnNames

        java.lang.String[] getReturnColumnNames()
        Get the columns names if the function returns a table.
        Returns:
        Array of column names.

      • getReturnType

        int getReturnType()
        Get the return type of the function. Possible values:
      • IFunctionDescriptor.RETURN_TYPE_TABLE
      • IFunctionDescriptor.RETURN_TYPE_STRING
      • IFunctionDescriptor.RETURN_TYPE_INTEGER
      • IFunctionDescriptor.RETURN_TYPE_DOUBLE