com.mockturtlesolutions.snifflib.reposconfig.database

Class RepositoryStorageDOM

java.lang.Object

com.mockturtlesolutions.snifflib.reposconfig.database.AbstractRepositoryStorage

com.mockturtlesolutions.snifflib.reposconfig.database.RepositoryStorageDOM

All Implemented Interfaces:

DOMStorable, RepositoryStorage, RepositoryStorageTransfer

Direct Known Subclasses:

CanonicalSetDOM, DblMatrixDOM, FlatFileDOM, FlatFileSetDOM, GridElementDOM, GroovyScriptDOM, ImageFileDOM, ImageStackDOM, MCMCDOM, MCMCRunDOM, MCMCTraceDOM, MyrtleDOM, ParameterSetDOM, ProposalDistributionDOM, ReservedFunctionDOM, StatisticalModelDOM, TimerDOM, TimerListenerDOM, WedgeDOM, WordDOM, XppBettyDOM, XppOdeDOM

public class RepositoryStorageDOM
extends AbstractRepositoryStorage

DOM storage variant for RepositoryStorage. Importantly it sports an empty constructor since it is independent of any persistent repository. DOM are typically transient existing only for the duration of a program execution. They often facilitate transfer between persistent RepositoryStorage classes.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.w3c.dom.Document	document
protected boolean	dostylesheets
protected org.w3c.dom.Element	storageRoot
protected org.w3c.dom.Element	templateDOM

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

nickname, reposListeners, transferAgent

Constructor Summary

Constructors

Constructor and Description
RepositoryStorageDOM() Create a default buffer with the given name.
RepositoryStorageDOM(java.lang.String nn)

Method Summary

Methods

Modifier and Type	Method and Description
protected org.w3c.dom.Element	createElementByName(java.lang.String ElmName, java.lang.String AttrName, java.lang.String name)
protected org.w3c.dom.Element	getAttributeByElementName(java.lang.String ElmName, java.lang.String AttrName, java.lang.String expname)
java.lang.String	getComment() Gets the descriptive comment for this Wedge inverse problem as a whole.
java.lang.String	getCommentElementName()
java.lang.String	getCreatedBy()
java.lang.String	getCreatedByAttributeName()
java.lang.String	getCreatedOn()
java.lang.String	getCreatedOnAttributeName()
java.lang.Class	getDefaultGraphicalEditorClass()
protected org.w3c.dom.Document	getDocument()
java.lang.Class	getDOMStorageClass() Returns a DOM storage variant of this storage instance.
java.lang.String	getEnabled() Gets the state of the (possibly remote) storage.
java.lang.String	getEnabledAttributeName()
java.lang.String	getNickname() Gets the project name for this Wedge inverse problem.
java.lang.String	getNicknameAttributeName()
java.lang.String	getRootElementName()
RepositoryStorage	getStorage(RepositoryElement elem)
protected org.w3c.dom.Element	getStorageRoot() Probably should not even allow protected access here.
protected java.lang.String	getStylesheetRef() Returns the hyper-reference to the style sheet to be used in formating the XML translation of this DOM.
org.w3c.dom.Element	getTemplateDOM()
java.lang.String	getTextNodeByElementName(java.lang.String field)
boolean	isValidXML(java.io.File xmlfile) Allows validation the XML against schema.
void	readXML(java.io.File out) This will need to be overridden by subclasses unless we can verify XML document structure is valid via some DTD somewhere.
void	setComment(java.lang.String n) Gets the descriptive comment for this Wedge inverse problem as a whole.
void	setCreatedBy(java.lang.String st)
void	setCreatedOn(java.lang.String st)
void	setEnabled(java.lang.String n) Sets the enabled state of the (possibly remote) storage instance.
void	setNickname(java.lang.String n) Sets the project name for this Wedge inverse problem.
protected void	setProcessingInstructions() Override this method if you want to specify in detail your own XML processing instructions.
void	setTextNodeByElementName(java.lang.String field, java.lang.String n)
void	show()
void	show(java.lang.String title)
protected void	specifyStorage(org.w3c.dom.Document doc, org.w3c.dom.Element el)
void	useStyleSheetInfo(boolean x)
boolean	usingStyleSheetInfo()
void	writeTemplateXML(java.io.File out) Writes the original template DOM to an XML flat file.
void	writeXML(java.io.File out) Writes the current state of the DOM to an XML flat file.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

document

protected org.w3c.dom.Document document

templateDOM

protected org.w3c.dom.Element templateDOM

storageRoot

protected org.w3c.dom.Element storageRoot

dostylesheets

protected boolean dostylesheets

Constructor Detail

RepositoryStorageDOM

public RepositoryStorageDOM(java.lang.String nn)

RepositoryStorageDOM

public RepositoryStorageDOM()

Create a default buffer with the given name.

Method Detail

useStyleSheetInfo

public void useStyleSheetInfo(boolean x)

usingStyleSheetInfo

public boolean usingStyleSheetInfo()

getStylesheetRef

protected java.lang.String getStylesheetRef()

Returns the hyper-reference to the style sheet to be used in formating the XML translation of this DOM. Override this method if you want to provide your own style file for the class instance. If you want more detailed control or want to set multiple processing instructions consider overriding the setProcessingInstructions method.

See Also:

setProcessingInstructions()

setProcessingInstructions

protected void setProcessingInstructions()

Override this method if you want to specify in detail your own XML processing instructions. This default implementation sets an xml-stylesheet processing instruction. If you only want to specify the particular stylesheet to be used, consider overriding the method getStylesheetRef instead.

See Also:

getStylesheetRef()

specifyStorage

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

getDefaultGraphicalEditorClass

public java.lang.Class getDefaultGraphicalEditorClass()

getAttributeByElementName

protected org.w3c.dom.Element getAttributeByElementName(java.lang.String ElmName,
                                            java.lang.String AttrName,
                                            java.lang.String expname)

createElementByName

protected org.w3c.dom.Element createElementByName(java.lang.String ElmName,
                                      java.lang.String AttrName,
                                      java.lang.String name)

getCommentElementName

public java.lang.String getCommentElementName()

getRootElementName

public java.lang.String getRootElementName()

getEnabledAttributeName

public java.lang.String getEnabledAttributeName()

getNicknameAttributeName

public java.lang.String getNicknameAttributeName()

getCreatedByAttributeName

public java.lang.String getCreatedByAttributeName()

getCreatedOnAttributeName

public java.lang.String getCreatedOnAttributeName()

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

Specified by:

getDOMStorageClass in class AbstractRepositoryStorage

getEnabled

public java.lang.String getEnabled()

Gets the state of the (possibly remote) storage. For example, dis-enabled storages may be slated for deletion from some repostories. Typically a storage is backed by static information stored in a database.

Specified by:

getEnabled in interface RepositoryStorage

Specified by:

getEnabled in class AbstractRepositoryStorage

setEnabled

public void setEnabled(java.lang.String n)

Sets the enabled state of the (possibly remote) storage instance. Typically a storage is backed by static information stored in a database.

Specified by:

setEnabled in interface RepositoryStorage

Specified by:

setEnabled in class AbstractRepositoryStorage

getNickname

public java.lang.String getNickname()

Gets the project name for this Wedge inverse problem.

Specified by:

getNickname in interface RepositoryStorage

Specified by:

getNickname in class AbstractRepositoryStorage

setNickname

public void setNickname(java.lang.String n)

Sets the project name for this Wedge inverse problem.

Specified by:

setNickname in interface RepositoryStorage

Specified by:

setNickname in class AbstractRepositoryStorage

getCreatedBy

public java.lang.String getCreatedBy()

Specified by:

getCreatedBy in interface RepositoryStorage

Specified by:

getCreatedBy in class AbstractRepositoryStorage

setCreatedBy

public void setCreatedBy(java.lang.String st)

Specified by:

setCreatedBy in interface RepositoryStorage

Specified by:

setCreatedBy in class AbstractRepositoryStorage

getCreatedOn

public java.lang.String getCreatedOn()

Specified by:

getCreatedOn in interface RepositoryStorage

Specified by:

getCreatedOn in class AbstractRepositoryStorage

setCreatedOn

public void setCreatedOn(java.lang.String st)

Specified by:

setCreatedOn in interface RepositoryStorage

Specified by:

setCreatedOn in class AbstractRepositoryStorage

setTextNodeByElementName

public void setTextNodeByElementName(java.lang.String field,
                            java.lang.String n)

getTextNodeByElementName

public java.lang.String getTextNodeByElementName(java.lang.String field)

setComment

public void setComment(java.lang.String n)

Gets the descriptive comment for this Wedge inverse problem as a whole.

Specified by:

setComment in interface RepositoryStorage

Specified by:

setComment in class AbstractRepositoryStorage

getComment

public java.lang.String getComment()

Description copied from class: AbstractRepositoryStorage

Gets the descriptive comment for this Wedge inverse problem as a whole.

Specified by:

getComment in interface RepositoryStorage

Specified by:

getComment in class AbstractRepositoryStorage

show

public void show()

Overrides:

show in class AbstractRepositoryStorage

show

public void show(java.lang.String title)

writeTemplateXML

public void writeTemplateXML(java.io.File out)

Writes the original template DOM to an XML flat file. This method can be useful when developing/refining schema.

writeXML

public void writeXML(java.io.File out)

Writes the current state of the DOM to an XML flat file.

isValidXML

public boolean isValidXML(java.io.File xmlfile)

Allows validation the XML against schema. This default implementation simply returns true in all cases.

readXML

public void readXML(java.io.File out)

This will need to be overridden by subclasses unless we can verify XML document structure is valid via some DTD somewhere. Now where do we get these DTD?? Don't want to have to use internet. What if DTD structure changes -- then what?? Inevitably some error handling in here is going to be needed and regardless the developmer is going to need to override this method.

getTemplateDOM

public org.w3c.dom.Element getTemplateDOM()

getStorageRoot

protected org.w3c.dom.Element getStorageRoot()

Probably should not even allow protected access here.

getDocument

protected org.w3c.dom.Document getDocument()

getStorage

public RepositoryStorage getStorage(RepositoryElement elem)