com.mockturtlesolutions.snifflib.util.database

Class GridElementDOM

java.lang.Object

com.mockturtlesolutions.snifflib.reposconfig.database.AbstractRepositoryStorage

com.mockturtlesolutions.snifflib.reposconfig.database.RepositoryStorageDOM

com.mockturtlesolutions.snifflib.util.database.GridElementDOM

All Implemented Interfaces:

DOMStorable, RepositoryStorage, RepositoryStorageTransfer, GridElementStorage, GriddedRegion, GridElement

public class GridElementDOM
extends RepositoryStorageDOM
implements GridElementStorage

Field Summary

Fields

Modifier and Type	Field and Description
protected org.w3c.dom.Element	childrenRoot

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
GridElementDOM()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAllChildGridElements(java.util.Vector elems) Adds all RepositoryElements in Vector as child grids.
void	addChildGridElement(RepositoryElement elem) Adds the specified child GridElementStorage to this storage.
void	addGriddedRegionListener(GriddedRegionListener l)
void	addVertexListener(VertexListener l)
int	childCount() Returns the number of child GridElements
void	clearChildGrids() Removes all child GridElementStorages from this storage.
void	clearGridCoordinates() Removes all vertices information from this GridElementStorage.
java.io.File[]	exportUNG() Exports the grid in Arc/Info Ungenerate ASCII file format.
java.io.File[]	exportUNG(java.io.File hdrFile, java.io.File datFile) Exports the grid in Arc/Info Ungenerate ASCII file format.
void	fireGriddedRegionEvent(GriddedRegionEvent dv)
void	fireVertexEvent(VertexEvent dv)
java.lang.String	getAlternate() Gets the Alternate name for this GridElementStorage.
DblMatrix	getCentroid()
RepositoryElement	getChildGridElement(int k) Returns a RepositoryElement for the storage of the indicated child GridElementStorage.
java.util.Vector	getChildGridElements() Returns Vector of RepositoryElements pointing to the child grids.
RepositoryElement	getCoordinateRepositoryElement() Gets the vertices storage for this GridElementStorage.
DblMatrix	getCoords()
DblMatrix	getCoordsOf(java.lang.Integer row)
java.lang.Class	getDefaultGraphicalEditorClass()
int	getDimension()
java.lang.Class	getDOMStorageClass() Returns a DOM storage variant of this storage instance.
int	getGridCount()
GridElement	getGridElement(int index)
java.lang.Integer	getIndex(int j)
java.lang.String	getLabel()
java.lang.String	getLongName() Gets the LongName for this GridElementStorage.
GridElement	getParent()
DblMatrix	getPerimeter() Returns the perimeter (2D only) of this simplex.
java.lang.String	getRootElementName()
java.lang.Class	getStorageTransferAgentClass() This method should be overridden by subclasses wanting to extend the transfer method.
protected java.lang.String	getStylesheetRef() Returns the hyper-reference to the style sheet to be used in formating the XML translation of this DOM.
DblMatrix	getVolume() Returns the volume (area in 2D) of this element.
DblMatrix	getXData() Gets just the x-coordinate data for this GridElementStorage.
DblMatrix	getYData() Gets just the y-coordinate data for this GridElementStorage.
java.util.Iterator	gridIterator()
void	importAsChildUNG(java.io.File headrFile, java.io.File datFile) Import all grids from data saved in Arc/Info Ungenerate ASCII file format.
void	importAsChildUNG(java.io.File headrFile, java.io.File datFile, int nskips) Import all grids from data saved in Arc/Info Ungenerate ASCII file format.
void	importAsChildUNG(java.util.Set targets, java.io.File hdrFile, java.io.File datFile, int nskips) Imports the indicated grid data as a child grid under this grid.
void	importAsChildUNG(java.lang.String idxident, java.io.File hdrFile, java.io.File datFile, int nskips) Imports the indicated grid data as a child grid under this grid.
void	importVerticesUNG(java.lang.String idxident, java.io.File datFile) Imports the indicated grid data into this GridElementStorage's vertices.
void	importVerticesUNG(java.lang.String idxident, java.io.File datFile, int nskips) Imports the indicated grid data into this GridElementStorage's vertices.
void	removeChildGridElement(int k)
void	removeChildGridElement(RepositoryElement elem) Removes the specified child GridElementStorage from this storage.
void	removeGriddedRegionListener(GriddedRegionListener l)
void	removeVertexListener(VertexListener l)
void	setAlternate(java.lang.String st) Sets the Alternate name for this GridElementStorage.
void	setCoordinateRepositoryElement(RepositoryElement elem) Specifies vertices storage for this GridElementStorage.
void	setLabel(java.lang.String st) Sets the Label for this GridElementStorage.
void	setLongName(java.lang.String st) Sets the LongName for this GridElementStorage.
void	setParentGridElement(RepositoryElement elem) Sets the parent GridElementStorage
int	size()
protected void	specifyStorage(org.w3c.dom.Document doc, org.w3c.dom.Element root)
java.util.Vector	subFacesOf()
java.util.Vector	verticesOf() Returns a Vector of Integers indexing into the coordinate data.

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

createElementByName, getAttributeByElementName, getComment, getCommentElementName, getCreatedBy, getCreatedByAttributeName, getCreatedOn, getCreatedOnAttributeName, getDocument, getEnabled, getEnabledAttributeName, getNickname, getNicknameAttributeName, getStorage, getStorageRoot, getTemplateDOM, getTextNodeByElementName, isValidXML, readXML, setComment, setCreatedBy, setCreatedOn, setEnabled, setNickname, setProcessingInstructions, setTextNodeByElementName, show, 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.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

Field Detail

childrenRoot

protected org.w3c.dom.Element childrenRoot

Constructor Detail

GridElementDOM

public GridElementDOM()

Method Detail

addVertexListener

public void addVertexListener(VertexListener l)

Specified by:

addVertexListener in interface GridElement

removeVertexListener

public void removeVertexListener(VertexListener l)

Specified by:

removeVertexListener in interface GridElement

fireVertexEvent

public void fireVertexEvent(VertexEvent dv)

Specified by:

fireVertexEvent in interface GridElement

addGriddedRegionListener

public void addGriddedRegionListener(GriddedRegionListener l)

Specified by:

addGriddedRegionListener in interface GriddedRegion

removeGriddedRegionListener

public void removeGriddedRegionListener(GriddedRegionListener l)

Specified by:

removeGriddedRegionListener in interface GriddedRegion

fireGriddedRegionEvent

public void fireGriddedRegionEvent(GriddedRegionEvent dv)

Specified by:

fireGriddedRegionEvent in interface GriddedRegion

setLabel

public void setLabel(java.lang.String st)

Description copied from interface: GridElementStorage

Sets the Label for this GridElementStorage.

Specified by:

setLabel in interface GridElementStorage

Specified by:

setLabel in interface GridElement

setAlternate

public void setAlternate(java.lang.String st)

Description copied from interface: GridElementStorage

Sets the Alternate name for this GridElementStorage.

Specified by:

setAlternate in interface GridElementStorage

setLongName

public void setLongName(java.lang.String st)

Description copied from interface: GridElementStorage

Sets the LongName for this GridElementStorage.

Specified by:

setLongName in interface GridElementStorage

getLabel

public java.lang.String getLabel()

Specified by:

getLabel in interface GridElement

getAlternate

public java.lang.String getAlternate()

Description copied from interface: GridElementStorage

Gets the Alternate name for this GridElementStorage.

Specified by:

getAlternate in interface GridElementStorage

getLongName

public java.lang.String getLongName()

Description copied from interface: GridElementStorage

Gets the LongName for this GridElementStorage.

Specified by:

getLongName in interface GridElementStorage

specifyStorage

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

Overrides:

specifyStorage in class RepositoryStorageDOM

getCoordinateRepositoryElement

public RepositoryElement getCoordinateRepositoryElement()

Description copied from interface: GridElementStorage

Gets the vertices storage for this GridElementStorage.

Specified by:

getCoordinateRepositoryElement in interface GridElementStorage

getChildGridElements

public java.util.Vector getChildGridElements()

Description copied from interface: GridElementStorage

Returns Vector of RepositoryElements pointing to the child grids.

Specified by:

getChildGridElements in interface GridElementStorage

childCount

public int childCount()

Description copied from interface: GridElementStorage

Returns the number of child GridElements

Specified by:

childCount in interface GridElementStorage

clearGridCoordinates

public void clearGridCoordinates()

Description copied from interface: GridElementStorage

Removes all vertices information from this GridElementStorage.

Specified by:

clearGridCoordinates in interface GridElementStorage

clearChildGrids

public void clearChildGrids()

Description copied from interface: GridElementStorage

Removes all child GridElementStorages from this storage.

Specified by:

clearChildGrids in interface GridElementStorage

setCoordinateRepositoryElement

public void setCoordinateRepositoryElement(RepositoryElement elem)

Description copied from interface: GridElementStorage

Specifies vertices storage for this GridElementStorage.

Specified by:

setCoordinateRepositoryElement in interface GridElementStorage

getChildGridElement

public RepositoryElement getChildGridElement(int k)

Description copied from interface: GridElementStorage

Returns a RepositoryElement for the storage of the indicated child GridElementStorage.

Specified by:

getChildGridElement in interface GridElementStorage

addChildGridElement

public void addChildGridElement(RepositoryElement elem)

Description copied from interface: GridElementStorage

Adds the specified child GridElementStorage to this storage.

Specified by:

addChildGridElement in interface GridElementStorage

removeChildGridElement

public void removeChildGridElement(RepositoryElement elem)

Description copied from interface: GridElementStorage

Removes the specified child GridElementStorage from this storage.

Specified by:

removeChildGridElement in interface GridElementStorage

removeChildGridElement

public void removeChildGridElement(int k)

setParentGridElement

public void setParentGridElement(RepositoryElement elem)

Description copied from interface: GridElementStorage

Sets the parent GridElementStorage

Specified by:

setParentGridElement in interface GridElementStorage

getDefaultGraphicalEditorClass

public java.lang.Class getDefaultGraphicalEditorClass()

Specified by:

getDefaultGraphicalEditorClass in interface RepositoryStorage

Overrides:

getDefaultGraphicalEditorClass in class RepositoryStorageDOM

getRootElementName

public java.lang.String getRootElementName()

Overrides:

getRootElementName in class RepositoryStorageDOM

getStylesheetRef

protected java.lang.String getStylesheetRef()

Description copied from class: RepositoryStorageDOM

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.

Overrides:

getStylesheetRef in class RepositoryStorageDOM

See Also:

RepositoryStorageDOM.setProcessingInstructions()

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 RepositoryStorageDOM

exportUNG

public java.io.File[] exportUNG(java.io.File hdrFile,
                       java.io.File datFile)

Description copied from interface: GridElementStorage

Exports the grid in Arc/Info Ungenerate ASCII file format. The basename is applied to the created header and data Files which are returned in an File[].

Specified by:

exportUNG in interface GridElementStorage

exportUNG

public java.io.File[] exportUNG()

Description copied from interface: GridElementStorage

Exports the grid in Arc/Info Ungenerate ASCII file format. The basename of the export files is taken to be this storage's nickname and applied to the created header and data Files which are returned in an File[]..

Specified by:

exportUNG in interface GridElementStorage

importAsChildUNG

public void importAsChildUNG(java.lang.String idxident,
                    java.io.File hdrFile,
                    java.io.File datFile,
                    int nskips)

Imports the indicated grid data as a child grid under this grid.

Specified by:

importAsChildUNG in interface GridElementStorage

importAsChildUNG

public void importAsChildUNG(java.util.Set targets,
                    java.io.File hdrFile,
                    java.io.File datFile,
                    int nskips)

Imports the indicated grid data as a child grid under this grid.

Specified by:

importAsChildUNG in interface GridElementStorage

importVerticesUNG

public void importVerticesUNG(java.lang.String idxident,
                     java.io.File datFile,
                     int nskips)

Imports the indicated grid data into this GridElementStorage's vertices.

Specified by:

importVerticesUNG in interface GridElementStorage

importVerticesUNG

public void importVerticesUNG(java.lang.String idxident,
                     java.io.File datFile)

Imports the indicated grid data into this GridElementStorage's vertices.

Specified by:

importVerticesUNG in interface GridElementStorage

importAsChildUNG

public void importAsChildUNG(java.io.File headrFile,
                    java.io.File datFile)

Import all grids from data saved in Arc/Info Ungenerate ASCII file format.

Specified by:

importAsChildUNG in interface GridElementStorage

importAsChildUNG

public void importAsChildUNG(java.io.File headrFile,
                    java.io.File datFile,
                    int nskips)

Import all grids from data saved in Arc/Info Ungenerate ASCII file format.

Specified by:

importAsChildUNG in interface GridElementStorage

addAllChildGridElements

public void addAllChildGridElements(java.util.Vector elems)

Description copied from interface: GridElementStorage

Adds all RepositoryElements in Vector as child grids.

Specified by:

addAllChildGridElements in interface GridElementStorage

getXData

public DblMatrix getXData()

Description copied from interface: GridElementStorage

Gets just the x-coordinate data for this GridElementStorage.

Specified by:

getXData in interface GridElementStorage

getYData

public DblMatrix getYData()

Description copied from interface: GridElementStorage

Gets just the y-coordinate data for this GridElementStorage.

Specified by:

getYData in interface GridElementStorage

getCoords

public DblMatrix getCoords()

Specified by:

getCoords in interface GridElement

gridIterator

public java.util.Iterator gridIterator()

Specified by:

gridIterator in interface GriddedRegion

getGridCount

public int getGridCount()

Specified by:

getGridCount in interface GriddedRegion

getGridElement

public GridElement getGridElement(int index)

Specified by:

getGridElement in interface GriddedRegion

getParent

public GridElement getParent()

Specified by:

getParent in interface GridElement

verticesOf

public java.util.Vector verticesOf()

Returns a Vector of Integers indexing into the coordinate data.

Specified by:

verticesOf in interface GridElement

subFacesOf

public java.util.Vector subFacesOf()

Specified by:

subFacesOf in interface GridElement

getDimension

public int getDimension()

Specified by:

getDimension in interface GridElement

getIndex

public java.lang.Integer getIndex(int j)

Specified by:

getIndex in interface GridElement

size

public int size()

Specified by:

size in interface GridElement

getCoordsOf

public DblMatrix getCoordsOf(java.lang.Integer row)

Specified by:

getCoordsOf in interface GridElement

getPerimeter

public DblMatrix getPerimeter()

Returns the perimeter (2D only) of this simplex.

Specified by:

getPerimeter in interface GridElement

getVolume

public DblMatrix getVolume()

Returns the volume (area in 2D) of this element. Note: Currently the algorithm assumes the region is 2D polygonal. Classes having other geometries should override this method.

Specified by:

getVolume in interface GridElement

getCentroid

public DblMatrix getCentroid()

Specified by:

getCentroid in interface GridElement