com.mockturtlesolutions.snifflib.spreadsheets.database

Class ReservedFunctionXML

java.lang.Object

com.mockturtlesolutions.snifflib.reposconfig.database.AbstractRepositoryStorage

com.mockturtlesolutions.snifflib.reposconfig.database.RepositoryStorageXML

com.mockturtlesolutions.snifflib.spreadsheets.database.ReservedFunctionXML

All Implemented Interfaces:

GroovyScriptStorage, DOMStorable, RepositoryStorage, RepositoryStorageTransfer, ReservedFunctionStorage, ReservedFunction, java.lang.Comparable

public class ReservedFunctionXML
extends RepositoryStorageXML
implements ReservedFunctionStorage

Field Summary

Fields inherited from class com.mockturtlesolutions.snifflib.reposconfig.database.AbstractRepositoryStorage

nickname, reposListeners, transferAgent

Constructor Summary

Constructors

Constructor and Description
ReservedFunctionXML(RepositoryConnectivity conn, java.lang.String storagename)

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.Class	getDefaultGraphicalEditorClass()
java.lang.String	getDescription()
java.lang.Class	getDOMStorageClass() Returns a DOM storage variant of this storage instance.
java.lang.String	getFunctionName()
java.lang.String	getGroovyText()
int	getMaxArgCount() Sets the minimum number of arguments.
int	getMinArgCount() Sets the minimum number of arguments.
java.lang.String	getName()
java.lang.String	getShortDescription()
java.lang.Class	getStorageTransferAgentClass() This method should be overridden by subclasses wanting to extend the transfer method.
void	importGroovyFile(java.io.File file)
Script	parseGroovyScript()
void	setArgCount(int m)
void	setCategory(java.lang.String cat)
void	setGroovyText(java.lang.String s)
void	setMaxArgCount(int m)
void	setMinArgCount(int m)
void	setShortDescription(java.lang.String desc)
void	show()
java.lang.String	toString()
void	writeGroovyFile(java.io.File x)

Methods inherited from class com.mockturtlesolutions.snifflib.reposconfig.database.RepositoryStorageXML

copyStorage, getComment, getCreatedBy, getCreatedOn, getDOM, getEnabled, getNickname, getStorage, getXMLDirectory, getXMLFilename, setComment, setCreatedBy, setCreatedOn, setEnabled, setNickname, transferStorage, writeXML

Methods inherited from class com.mockturtlesolutions.snifflib.reposconfig.database.AbstractRepositoryStorage

addRepositoryListener, afterCopyStorage, afterTransferStorage, beforeCopyStorage, beforeTransferStorage, copyStorageCommands, getStorageCalculationsAgentClass, removeRepositoryListener, transferStorageCommands

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.mockturtlesolutions.snifflib.spreadsheets.ReservedFunction

getComment

Methods inherited from interface com.mockturtlesolutions.snifflib.reposconfig.database.RepositoryStorage

addRepositoryListener, getComment, getCreatedBy, getCreatedOn, getEnabled, getNickname, removeRepositoryListener, setComment, setCreatedBy, setCreatedOn, setEnabled, setNickname

Methods inherited from interface com.mockturtlesolutions.snifflib.reposconfig.database.RepositoryStorageTransfer

afterCopyStorage, afterTransferStorage, beforeCopyStorage, beforeTransferStorage, copyStorage, copyStorageCommands, transferStorage, transferStorageCommands

Constructor Detail

ReservedFunctionXML

public ReservedFunctionXML(RepositoryConnectivity conn,
                   java.lang.String storagename)

Method Detail

getDefaultGraphicalEditorClass

public java.lang.Class getDefaultGraphicalEditorClass()

Specified by:

getDefaultGraphicalEditorClass in interface RepositoryStorage

Overrides:

getDefaultGraphicalEditorClass in class RepositoryStorageXML

getStorageTransferAgentClass

public java.lang.Class getStorageTransferAgentClass()

Description copied from class: AbstractRepositoryStorage

This method should be overridden by subclasses wanting to extend the transfer method.

Overrides:

getStorageTransferAgentClass in class AbstractRepositoryStorage

getDOMStorageClass

public java.lang.Class getDOMStorageClass()

Description copied from class: AbstractRepositoryStorage

Returns a DOM storage variant of this storage instance. DOM storage classes, because they are independent of any repository, are by definition transient and often used when transfering amond RepositoryStorage classes which may be more persistent (e.g. backed by an XML or an SQL repository).

Specified by:

getDOMStorageClass in interface DOMStorable

Overrides:

getDOMStorageClass in class RepositoryStorageXML

importGroovyFile

public void importGroovyFile(java.io.File file)

Specified by:

importGroovyFile in interface GroovyScriptStorage

writeGroovyFile

public void writeGroovyFile(java.io.File x)

Specified by:

writeGroovyFile in interface GroovyScriptStorage

getGroovyText

public java.lang.String getGroovyText()

Specified by:

getGroovyText in interface GroovyScriptStorage

setGroovyText

public void setGroovyText(java.lang.String s)

Specified by:

setGroovyText in interface GroovyScriptStorage

parseGroovyScript

public Script parseGroovyScript()

Specified by:

parseGroovyScript in interface GroovyScriptStorage

setCategory

public void setCategory(java.lang.String cat)

Specified by:

setCategory in interface GroovyScriptStorage

Specified by:

setCategory in interface ReservedFunctionStorage

getCategory

public java.lang.String getCategory()

Specified by:

getCategory in interface GroovyScriptStorage

Specified by:

getCategory in interface ReservedFunctionStorage

Specified by:

getCategory in interface ReservedFunction

setShortDescription

public void setShortDescription(java.lang.String desc)

Specified by:

setShortDescription in interface GroovyScriptStorage

getShortDescription

public java.lang.String getShortDescription()

Specified by:

getShortDescription in interface GroovyScriptStorage

show

public void show()

Overrides:

show in class AbstractRepositoryStorage

setMaxArgCount

public void setMaxArgCount(int m)

Specified by:

setMaxArgCount in interface ReservedFunctionStorage

setMinArgCount

public void setMinArgCount(int m)

Specified by:

setMinArgCount in interface ReservedFunctionStorage

getMaxArgCount

public int getMaxArgCount()

Description copied from interface: ReservedFunction

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

Specified by:

getMaxArgCount in interface ReservedFunctionStorage

Specified by:

getMaxArgCount in interface ReservedFunction

getMinArgCount

public int getMinArgCount()

Description copied from interface: ReservedFunction

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 ReservedFunctionStorage

Specified by:

getMinArgCount in interface ReservedFunction

getFunctionName

public java.lang.String getFunctionName()

Specified by:

getFunctionName in interface ReservedFunctionStorage

setArgCount

public void setArgCount(int m)

Specified by:

setArgCount in interface ReservedFunction

getArgCount

public int getArgCount()

Specified by:

getArgCount in interface ReservedFunction

getName

public java.lang.String getName()

Specified by:

getName in interface ReservedFunction

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface ReservedFunction

evaluate

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

Specified by:

evaluate in interface ReservedFunctionStorage

Specified by:

evaluate in interface ReservedFunction

toString

public java.lang.String toString()

Specified by:

toString in interface ReservedFunctionStorage

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