com.mockturtlesolutions.snifflib.spreadsheets

Class AbstractReservedFunction

java.lang.Object

com.mockturtlesolutions.snifflib.spreadsheets.AbstractReservedFunction

All Implemented Interfaces:

ReservedFunction, java.lang.Comparable

public abstract class AbstractReservedFunction
extends java.lang.Object
implements ReservedFunction

A convenience abstract class for ReservedFunctions operating on the values of spreadsheet cells.

Constructor Summary

Constructors

Constructor and Description
AbstractReservedFunction()

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(java.lang.Object c)
abstract java.lang.Object	evaluate(java.lang.Object[] args, DefaultSpreadsheetPanel p, DefaultSpreadsheetTable t)
int	getArgCount()
java.lang.String	getCategory()
java.lang.String	getComment() Returns examples string.
abstract java.lang.String	getDescription()
int	getMaxArgCount() Sets the minimum number of arguments.
int	getMinArgCount() Sets the minimum number of arguments.
abstract java.lang.String	getName()
static boolean	parseBoolean(java.lang.Object arg2, DefaultSpreadsheetPanel p)
static DblMatrix	parseDblMatrix(java.lang.Object arg0, DefaultSpreadsheetPanel p)
static java.lang.String[][]	parseStringMatrix(java.lang.Object arg0, DefaultSpreadsheetPanel p)
void	setArgCount(int n)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractReservedFunction

public AbstractReservedFunction()

Method Detail

parseDblMatrix

public static DblMatrix parseDblMatrix(java.lang.Object arg0,
                       DefaultSpreadsheetPanel p)

parseStringMatrix

public static java.lang.String[][] parseStringMatrix(java.lang.Object arg0,
                                     DefaultSpreadsheetPanel p)

parseBoolean

public static boolean parseBoolean(java.lang.Object arg2,
                   DefaultSpreadsheetPanel p)

getCategory

public java.lang.String getCategory()

Specified by:

getCategory in interface ReservedFunction

getMinArgCount

public 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.

Specified by:

getMinArgCount in interface ReservedFunction

getMaxArgCount

public int getMaxArgCount()

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

Specified by:

getMaxArgCount in interface ReservedFunction

getArgCount

public int getArgCount()

Specified by:

getArgCount in interface ReservedFunction

setArgCount

public void setArgCount(int n)

Specified by:

setArgCount in interface ReservedFunction

getName

public abstract java.lang.String getName()

Specified by:

getName in interface ReservedFunction

getDescription

public abstract java.lang.String getDescription()

Specified by:

getDescription in interface ReservedFunction

getComment

public java.lang.String getComment()

Returns examples string. This default convenience implementation returns null.

Specified by:

getComment in interface ReservedFunction

evaluate

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

Specified by:

evaluate in interface ReservedFunction

toString

public java.lang.String toString()

Specified by:

toString in interface ReservedFunction

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(java.lang.Object c)

Specified by:

compareTo in interface ReservedFunction

Specified by:

compareTo in interface java.lang.Comparable