spase.parser130
Class PhysicalParameter

java.lang.Object
  spase.parser130.XMLParser
      spase.parser130.PhysicalParameter

public class PhysicalParameter
extends XMLParser

A container of PhysicalParameter information.

Constructor Summary

PhysicalParameter()

PhysicalParameter(boolean forEdit)

PhysicalParameter(org.w3c.dom.Node node)

Method Summary

java.lang.String	getCadence()
java.lang.String	getCaveats()
CoordinateSystem	getCoordinateSystem()
java.lang.String	getDescription()
java.lang.String	getFillValue()
Measured	getMeasured()
XMLParser	getMemberNode(java.lang.String name) Locates a node in a structure based on the the "name" associated with the member.
java.lang.String	getName()
java.lang.String	getParameterKey()
Structure	getStructure()
Support	getSupport()
java.lang.String	getUnits()
java.lang.String	getUnitsConversion()
java.lang.String	getValidMax()
java.lang.String	getValidMin()
java.lang.String	getXMLDocument(int n) Return a string containing an XML representation of this instance.
java.lang.String	getXMLDocument(int n, boolean inUseOnly) Return a string containing an XML representation of this instance.
java.lang.String	getXMLDocument(int n, java.lang.String path, int key) Return a string containing an XML representation of this isntance.
java.lang.String	getXMLDocument(int n, java.lang.String path, int key, boolean inUseOnly) Return a string containing an XML representation of this isntance.
static java.util.ArrayList<Pair>	getXPathPairs(java.lang.String prefix, java.util.ArrayList<PhysicalParameter> list)
java.util.ArrayList<Pair>	getXPathPairs(java.lang.String prefix, int index) Return an ArrayList of string Pairs which contains for each node in the XML document an XPath as the "left" value of the pair and the value as the "right" value of pair.
static void	main(java.lang.String[] args)
void	makeEditNodes() Create an instance of all nodes for use when editing.
void	makeNewMember(java.lang.String item) Create a new member.
void	makeSkeletonNodes() Create all nodes for use when editing which currently do not exist.
void	removeMember(java.lang.String item, int index) Remove an elment of a member.
void	reset()
void	setCadence(java.lang.String value)
void	setCadence(java.lang.String[] value)
void	setCaveats(java.lang.String value)
void	setCaveats(java.lang.String[] value)
void	setCoordinateSystem(org.w3c.dom.Node node)
void	setDescription(java.lang.String value)
void	setDescription(java.lang.String[] value)
void	setFillValue(java.lang.String value)
void	setFillValue(java.lang.String[] value)
void	setMeasured(org.w3c.dom.Node node)
void	setName(java.lang.String value)
void	setName(java.lang.String[] value)
void	setParameterKey(java.lang.String value)
void	setParameterKey(java.lang.String[] value)
void	setRequired()
void	setStructure(org.w3c.dom.Node node)
void	setSupport(org.w3c.dom.Node node)
void	setUnits(java.lang.String value)
void	setUnits(java.lang.String[] value)
void	setUnitsConversion(java.lang.String value)
void	setUnitsConversion(java.lang.String[] value)
void	setValidMax(java.lang.String value)
void	setValidMax(java.lang.String[] value)
void	setValidMin(java.lang.String value)
void	setValidMin(java.lang.String[] value)

Methods inherited from class spase.parser130.XMLParser

addRequired, dump, dumpData, dumpNode, entityEncode, findNode, getAllValues, getBranchText, getClassName, getDefaultStyleSheet, getDocument, getElementPath, getMemberName, getMemberNodeIndex, getMemberNodeName, getMemberParent, getMemberPath, getNodes, getNodes, getNodes, getNodeText, getPath, getPathName, getRequired, getStringReader, getTagClose, getTaggedList, getTaggedList, getTaggedValue, getTaggedValue, getTagOpen, getTopParent, getValues, getValues, getWords, getXPathList, getXPathPairs, indent, isCommonWord, isInList, isInList, isInList, isInUse, isMatch, isRequired, load, load, load, makeTagContent, parseWords, parseXML, parseXML, parseXMLString, printXML, processNode, setClassName, setMember, setMember, setMember, splitMixed, toImproperCase

Methods inherited from class java.lang.Object

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

Constructor Detail

PhysicalParameter

public PhysicalParameter()

PhysicalParameter

public PhysicalParameter(boolean forEdit)

PhysicalParameter

public PhysicalParameter(org.w3c.dom.Node node)
                  throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

main

public static void main(java.lang.String[] args)

reset

public void reset()

setRequired

public void setRequired()

makeEditNodes

public void makeEditNodes()

Description copied from class: XMLParser

Create an instance of all nodes for use when editing. To be implemented in each derived class.

Overrides:

makeEditNodes in class XMLParser

makeSkeletonNodes

public void makeSkeletonNodes()

Description copied from class: XMLParser

Create all nodes for use when editing which currently do not exist. To be implemented in each derived class.

Overrides:

makeSkeletonNodes in class XMLParser

getMemberNode

public XMLParser getMemberNode(java.lang.String name)

Description copied from class: XMLParser

Locates a node in a structure based on the the "name" associated with the member. A "node" is a member of a class which also has members. To be implemented in each derived class. A name may have an option index. The full syntax is: "name[index]"

Overrides:

getMemberNode in class XMLParser

Parameters:

name - the name associated with a member.

makeNewMember

public void makeNewMember(java.lang.String item)

Description copied from class: XMLParser

Create a new member. To be implemented in each derived class.

Overrides:

makeNewMember in class XMLParser

Parameters:

item - the name of the member to create.

removeMember

public void removeMember(java.lang.String item,
                         int index)

Description copied from class: XMLParser

Remove an elment of a member. To be implemented in each derived class.

Overrides:

removeMember in class XMLParser

Parameters:

item - the name of the member to create.

index - the index of the element to remove.

getXMLDocument

public java.lang.String getXMLDocument(int n)

Description copied from class: XMLParser

Return a string containing an XML representation of this instance. To be implemented in each derived class.

Overrides:

getXMLDocument in class XMLParser

Parameters:

n - the number of levels to indent the document.

getXMLDocument

public java.lang.String getXMLDocument(int n,
                                       boolean inUseOnly)

Description copied from class: XMLParser

Return a string containing an XML representation of this instance. To be implemented in each derived class.

Overrides:

getXMLDocument in class XMLParser

Parameters:

n - the number of levels to indent the document.

inUseOnly - indicates whether to include only those elements currently in use.

getXMLDocument

public java.lang.String getXMLDocument(int n,
                                       java.lang.String path,
                                       int key)

Description copied from class: XMLParser

Return a string containing an XML representation of this isntance. To be implemented in each derived class.

Overrides:

getXMLDocument in class XMLParser

Parameters:

n - the number of levels to indent the document.

path - the path to the element.

key - the index (key) of the element at the path.

getXMLDocument

public java.lang.String getXMLDocument(int n,
                                       java.lang.String path,
                                       int key,
                                       boolean inUseOnly)

Description copied from class: XMLParser

Return a string containing an XML representation of this isntance. To be implemented in each derived class.

Overrides:

getXMLDocument in class XMLParser

Parameters:

n - the number of levels to indent the document.

path - the path to the element.

key - the index (key) of the element at the path.

setName

public void setName(java.lang.String value)

setName

public void setName(java.lang.String[] value)

getName

public java.lang.String getName()

setParameterKey

public void setParameterKey(java.lang.String value)

setParameterKey

public void setParameterKey(java.lang.String[] value)

getParameterKey

public java.lang.String getParameterKey()

setDescription

public void setDescription(java.lang.String value)

setDescription

public void setDescription(java.lang.String[] value)

getDescription

public java.lang.String getDescription()

setCaveats

public void setCaveats(java.lang.String value)

setCaveats

public void setCaveats(java.lang.String[] value)

getCaveats

public java.lang.String getCaveats()

setCadence

public void setCadence(java.lang.String value)

setCadence

public void setCadence(java.lang.String[] value)

getCadence

public java.lang.String getCadence()

setUnits

public void setUnits(java.lang.String value)

setUnits

public void setUnits(java.lang.String[] value)

getUnits

public java.lang.String getUnits()

setUnitsConversion

public void setUnitsConversion(java.lang.String value)

setUnitsConversion

public void setUnitsConversion(java.lang.String[] value)

getUnitsConversion

public java.lang.String getUnitsConversion()

setCoordinateSystem

public void setCoordinateSystem(org.w3c.dom.Node node)
                         throws java.lang.Exception

Throws:

java.lang.Exception

getCoordinateSystem

public CoordinateSystem getCoordinateSystem()

setStructure

public void setStructure(org.w3c.dom.Node node)
                  throws java.lang.Exception

Throws:

java.lang.Exception

getStructure

public Structure getStructure()

setValidMin

public void setValidMin(java.lang.String value)

setValidMin

public void setValidMin(java.lang.String[] value)

getValidMin

public java.lang.String getValidMin()

setValidMax

public void setValidMax(java.lang.String value)

setValidMax

public void setValidMax(java.lang.String[] value)

getValidMax

public java.lang.String getValidMax()

setFillValue

public void setFillValue(java.lang.String value)

setFillValue

public void setFillValue(java.lang.String[] value)

getFillValue

public java.lang.String getFillValue()

setMeasured

public void setMeasured(org.w3c.dom.Node node)
                 throws java.lang.Exception

Throws:

java.lang.Exception

getMeasured

public Measured getMeasured()

setSupport

public void setSupport(org.w3c.dom.Node node)
                throws java.lang.Exception

Throws:

java.lang.Exception

getSupport

public Support getSupport()

getXPathPairs

public java.util.ArrayList<Pair> getXPathPairs(java.lang.String prefix,
                                               int index)

Description copied from class: XMLParser

Return an ArrayList of string Pairs which contains for each node in the XML document an XPath as the "left" value of the pair and the value as the "right" value of pair. The Prefix will be added to each path. If index is other than zero then the prefix will be modified to include the index.

Overrides:

getXPathPairs in class XMLParser

Parameters:

prefix - the leading path to add to each XPath.

index - the index of the item if part of an array. Indexes start a 1, a value of 0 indicates it is not part of an array.

getXPathPairs

public static java.util.ArrayList<Pair> getXPathPairs(java.lang.String prefix,
                                                      java.util.ArrayList<PhysicalParameter> list)