com.sl.gmsjrtview
Class GmsRtViewCustomFunctionHandler

java.lang.Object
  com.sl.gmsjrtview.GmsRtViewCustomFunctionHandler

public class GmsRtViewCustomFunctionHandler
extends java.lang.Object

The GmsRtViewCustomFunctionHandler class provides a way to implement custom functions. Subclasses should override the getFunctionDescriptors() method in addition to the get result method for each data type their custom functions return.

Constructor Summary

GmsRtViewCustomFunctionHandler()

Method Summary

double	getDoubleResult(java.lang.String functionName, GmsRtViewFunctionDescriptor functionDesc, GmsModelVariables functionIcon) Returns the function result for the specified function.
java.util.Vector	getFunctionDescriptors() Returns a Vector of GmsRtViewFunctionDescriptor.
int	getIntResult(java.lang.String functionName, GmsRtViewFunctionDescriptor functionDesc, GmsModelVariables functionIcon) Returns the function result for the specified function.
java.lang.String	getStringResult(java.lang.String functionName, GmsRtViewFunctionDescriptor functionDesc, GmsModelVariables functionIcon) Returns the function result for the specified function.
GmsTabularData	getTabularResult(java.lang.String functionName, GmsRtViewFunctionDescriptor functionDesc, GmsModelVariables functionIcon) Returns the function result for the specified function.

Methods inherited from class java.lang.Object

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

Constructor Detail

GmsRtViewCustomFunctionHandler

public GmsRtViewCustomFunctionHandler()

Method Detail

getDoubleResult

public double getDoubleResult(java.lang.String functionName,
                              GmsRtViewFunctionDescriptor functionDesc,
                              GmsModelVariables functionIcon)

Returns the function result for the specified function. This function will get called from obj_function when the values of any of the argument variables for this function change if this function returns a double.

Parameters:

functionName - the name of the function to update

functionDesc - the descriptor of the function

functionIcon - the function icon Warning: The argument functionDesc could be null if the caller of this code is a function that uses the old API.

getFunctionDescriptors

public java.util.Vector getFunctionDescriptors()

Returns a Vector of GmsRtViewFunctionDescriptor. This Vector must contain a function descriptor for each function handled in this class.

getIntResult

public int getIntResult(java.lang.String functionName,
                        GmsRtViewFunctionDescriptor functionDesc,
                        GmsModelVariables functionIcon)

Returns the function result for the specified function. This function will get called from obj_function when the values of any of the argument variables for this function change if this function returns an int.

Parameters:

functionName - the name of the function to update

functionDesc - the descriptor of the function

functionIcon - the function icon Warning: The argument functionDesc could be null if the caller of this code is a function that uses the old API.

getStringResult

public java.lang.String getStringResult(java.lang.String functionName,
                                        GmsRtViewFunctionDescriptor functionDesc,
                                        GmsModelVariables functionIcon)

Returns the function result for the specified function. This function will get called from obj_function when the values of any of the argument variables for this function change if this function returns a string.

Parameters:

functionName - the name of the function to update

functionDesc - the descriptor of the function

functionIcon - the function icon Warning: The argument functionDesc could be null if the caller of this code is a function that uses the old API.

getTabularResult

public GmsTabularData getTabularResult(java.lang.String functionName,
                                       GmsRtViewFunctionDescriptor functionDesc,
                                       GmsModelVariables functionIcon)

Returns the function result for the specified function. This function will get called from obj_function when the values of any of the argument variables for this function change if this function returns a GmsTabularData.

Parameters:

functionName - the name of the function to update

functionDesc - the descriptor of the function

functionIcon - the function icon Warning: The argument functionDesc could be null if the caller of this code is a function that uses the old API.