com.mockturtlesolutions.snifflib.spreadsheets

Interface ReservedFunction

All Superinterfaces:

java.lang.Comparable

All Known Subinterfaces:

ReservedFunctionStorage

All Known Implementing Classes:

AbstractReservedFunction, GroovyScriptReservedFunction, ReservedFunctionDOM, ReservedFunctionFrame, ReservedFunctionPanel, ReservedFunctionXML

public interface ReservedFunction
extends java.lang.Comparable

Interface implemented by functions which operate on the values of spreadsheet entries. A user can call a reserved function by entering into a spreadsheet entry a formula beginning with "=" as in "=sum(#MyData)" where "sum" is the minor (right) component of a reverse fully qualified domain name (RFQDN or nickname) identifying the function (e.g. "com.mockturtlesolutions.sum"). Users can also call ReservedFunctions from within other scripts or other functions by using the evalFunction() method of DefaultSpreadsheetPanel as in: ParentPanel.evalFunction("com.mockturtlesolutions.sum",Args,ParentPanel,ParentTable);

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(java.lang.Object c)
java.lang.Object	evaluate(java.lang.Object[] args, DefaultSpreadsheetPanel p, DefaultSpreadsheetTable t)
int	getArgCount()
java.lang.String	getCategory()
java.lang.String	getComment()
java.lang.String	getDescription()
int	getMaxArgCount() Sets the minimum number of arguments.
int	getMinArgCount() Sets the minimum number of arguments.
java.lang.String	getName()
void	setArgCount(int n)
java.lang.String	toString()

Method Detail

getCategory

java.lang.String getCategory()

getMinArgCount

int getMinArgCount()

Sets the minimum number of arguments. A value of -1 implies no minimum constraint. Note, a value of -1 is operationally equivalent to a value of zero in this case. This default implementation returns a value of 1.

getMaxArgCount

int getMaxArgCount()

Sets the minimum number of arguments. This default implementation returns a value of 1.

getArgCount

int getArgCount()

setArgCount

void setArgCount(int n)

getName

java.lang.String getName()

getDescription

java.lang.String getDescription()

getComment

java.lang.String getComment()

evaluate

java.lang.Object evaluate(java.lang.Object[] args,
                        DefaultSpreadsheetPanel p,
                        DefaultSpreadsheetTable t)

toString

java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

int compareTo(java.lang.Object c)

Specified by:

compareTo in interface java.lang.Comparable