spase.parser134
Class RenderingHints

java.lang.Object
  spase.parser134.XMLParser
      spase.parser134.RenderingHints

public class RenderingHints
extends XMLParser

A container of RenderingHints information.

Constructor Summary

RenderingHints()

RenderingHints(boolean forEdit)

RenderingHints(org.w3c.dom.Node node)

Method Summary

java.lang.String	getAxisLabel()
java.lang.String	getDisplayType()
XMLParser	getMemberNode(java.lang.String name) Locates a node in a structure based on the the "name" associated with the member.
java.lang.String	getScaleMax()
java.lang.String	getScaleMin()
java.lang.String	getScaleType()
java.lang.String	getValueFormat()
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<RenderingHints> 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	setAxisLabel(java.lang.String value)
void	setAxisLabel(java.lang.String[] value)
void	setDisplayType(java.lang.String value)
void	setDisplayType(java.lang.String[] value)
void	setRequired()
void	setScaleMax(java.lang.String value)
void	setScaleMax(java.lang.String[] value)
void	setScaleMin(java.lang.String value)
void	setScaleMin(java.lang.String[] value)
void	setScaleType(java.lang.String value)
void	setScaleType(java.lang.String[] value)
void	setValueFormat(java.lang.String value)
void	setValueFormat(java.lang.String[] value)

Methods inherited from class spase.parser134.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

RenderingHints

public RenderingHints()

RenderingHints

public RenderingHints(boolean forEdit)

RenderingHints

public RenderingHints(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.

setDisplayType

public void setDisplayType(java.lang.String value)

setDisplayType

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

getDisplayType

public java.lang.String getDisplayType()

setAxisLabel

public void setAxisLabel(java.lang.String value)

setAxisLabel

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

getAxisLabel

public java.lang.String getAxisLabel()

setValueFormat

public void setValueFormat(java.lang.String value)

setValueFormat

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

getValueFormat

public java.lang.String getValueFormat()

setScaleMin

public void setScaleMin(java.lang.String value)

setScaleMin

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

getScaleMin

public java.lang.String getScaleMin()

setScaleMax

public void setScaleMax(java.lang.String value)

setScaleMax

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

getScaleMax

public java.lang.String getScaleMax()

setScaleType

public void setScaleType(java.lang.String value)

setScaleType

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

getScaleType

public java.lang.String getScaleType()

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<RenderingHints> list)