com.mockturtlesolutions.snifflib.spreadsheets.database

Class ReservedFunctionDOM

java.lang.Object

com.mockturtlesolutions.snifflib.reposconfig.database.AbstractRepositoryStorage

com.mockturtlesolutions.snifflib.reposconfig.database.RepositoryStorageDOM

com.mockturtlesolutions.snifflib.spreadsheets.database.ReservedFunctionDOM

All Implemented Interfaces:

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

public class ReservedFunctionDOM
extends RepositoryStorageDOM
implements ReservedFunctionStorage

Field Summary

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

document, dostylesheets, storageRoot, templateDOM

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

nickname, reposListeners, transferAgent

Constructor Summary

Constructors

Constructor and Description
ReservedFunctionDOM()

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.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	getRootElementName()
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 x)
Script	parseGroovyScript()
void	setArgCount(int m)
void	setCategory(java.lang.String cat)
void	setGroovyText(java.lang.String n)
void	setMaxArgCount(int m)
void	setMinArgCount(int m)
void	setShortDescription(java.lang.String cat)
void	show()
protected void	specifyStorage(org.w3c.dom.Document doc, org.w3c.dom.Element root)
void	writeGroovyFile(java.io.File x)

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

createElementByName, getAttributeByElementName, getComment, getCommentElementName, getCreatedBy, getCreatedByAttributeName, getCreatedOn, getCreatedOnAttributeName, getDocument, getDOMStorageClass, getEnabled, getEnabledAttributeName, getNickname, getNicknameAttributeName, getStorage, getStorageRoot, getStylesheetRef, getTemplateDOM, getTextNodeByElementName, isValidXML, readXML, setComment, setCreatedBy, setCreatedOn, setEnabled, setNickname, setProcessingInstructions, setTextNodeByElementName, show, useStyleSheetInfo, usingStyleSheetInfo, writeTemplateXML, writeXML

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.mockturtlesolutions.snifflib.spreadsheets.database.ReservedFunctionStorage

toString

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

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

getDOMStorageClass

Constructor Detail

ReservedFunctionDOM

public ReservedFunctionDOM()

Method Detail

specifyStorage

protected void specifyStorage(org.w3c.dom.Document doc,
                  org.w3c.dom.Element root)

Overrides:

specifyStorage in class RepositoryStorageDOM

getRootElementName

public java.lang.String getRootElementName()

Overrides:

getRootElementName in class RepositoryStorageDOM

getDefaultGraphicalEditorClass

public java.lang.Class getDefaultGraphicalEditorClass()

Specified by:

getDefaultGraphicalEditorClass in interface RepositoryStorage

Overrides:

getDefaultGraphicalEditorClass in class RepositoryStorageDOM

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

getGroovyText

public java.lang.String getGroovyText()

Specified by:

getGroovyText in interface GroovyScriptStorage

setGroovyText

public void setGroovyText(java.lang.String n)

Specified by:

setGroovyText in interface GroovyScriptStorage

writeGroovyFile

public void writeGroovyFile(java.io.File x)

Specified by:

writeGroovyFile in interface GroovyScriptStorage

importGroovyFile

public void importGroovyFile(java.io.File x)

Specified by:

importGroovyFile 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 cat)

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 RepositoryStorageDOM

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

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface ReservedFunction

getName

public java.lang.String getName()

Specified by:

getName 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

compareTo

public int compareTo(java.lang.Object c)

Specified by:

compareTo in interface ReservedFunction

Specified by:

compareTo in interface java.lang.Comparable