org.vishia.xmlReader

Class XmlJzCfgAnalyzer.XmlStructureNode

java.lang.Object

org.vishia.xmlReader.ZmlReader.ZmlNode

org.vishia.xmlReader.XmlJzCfgAnalyzer.XmlStructureNode

Enclosing class:

XmlJzCfgAnalyzer

static class XmlJzCfgAnalyzer.XmlStructureNode
extends ZmlReader.ZmlNode

This class is one node for one element to store the structure of a XML file via XmlJzReader.

• An instance of this class should be created as root node. The root node from the XML file is stored there as the first level. It means, this root instance is not presented in the XML file, and the root instance has one member: The root node of the XML file.
• Instances are created for any found element with different tags in the XML tree. This instances are stored in the internal ZmlReader.ZmlNode.nodes tree.
• If elements with the same tag name are found on one level of the XML file, only one instance of this is stored in ZmlReader.ZmlNode.nodes. It means an instance presents not the content of the XML file but the structure. An instance of this contains the sum of all found attributes.
• If an element with a known tag is found in a deeper level of the XML file,

The information of the built tree of this class can be used to

• Write a config file template, using XmlJzCfgAnalyzer.writeCfgTemplate(File)

This class builds the root node and any child node too.

 XmlCfgNodeBuilder<*>--nodes-->XmlCfgNodeBuilder
                                  <*> 
                                   |
                                   +--attribs--->String
 

Field Summary

Fields

Modifier and Type	Field and Description
(package private) boolean	bDependencyChecked
(package private) boolean	bText Set if at least one of the occurrences has a text content.
(package private) java.util.Map<java.lang.String,java.lang.String>	nodesLocal Only for test whether or not a node is found twice.
(package private) int	nrofAttributes
(package private) boolean	onlySingle Set if the node is only one time in all found trees.
(package private) java.lang.String	sSubtreenode
(package private) java.lang.String	tagIdent Tag name of the element as written in Java code, only identifier chars.
(package private) XmlJzCfgAnalyzer.XmlStructureData	xmlStructData
(package private) boolean	XXXbDetermineWithParent

Fields inherited from class org.vishia.xmlReader.ZmlReader.ZmlNode

attribs, attribsUnnamed, bNewAttributes, nameSpaces, nodes, parent, tag

Constructor Summary

Constructors

Constructor and Description
XmlStructureNode(XmlJzCfgAnalyzer.XmlStructureNode parent, java.lang.String tag, XmlJzCfgAnalyzer.XmlStructureData xmlStructData)

Method Summary

Modifier and Type	Method and Description
XmlJzCfgAnalyzer.XmlStructureNode	addElement(java.lang.String tag) Returns an instance to store the occurrence of a XML-element.
void	addNamespace(java.lang.String key, java.lang.String value)
void	setAttribute(java.lang.String namespacename) It is invoked via reflection from XmlJzCfgAnalyzer.newCfgReadStruct()
void	setTextOccurrence()
java.lang.String	toString()
(package private) void	writeData(java.lang.Appendable out, int indent)
(package private) void	writeNodeData(java.lang.Appendable out, int indent)

Methods inherited from class org.vishia.xmlReader.ZmlReader.ZmlNode

addAttribute, addAttributeUnnamed, putSubnode

Methods inherited from class java.lang.Object

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

Field Detail

tagIdent

final java.lang.String tagIdent

Tag name of the element as written in Java code, only identifier chars.

sSubtreenode

java.lang.String sSubtreenode

bText

boolean bText

Set if at least one of the occurrences has a text content.

XXXbDetermineWithParent

boolean XXXbDetermineWithParent

bDependencyChecked

boolean bDependencyChecked

onlySingle

boolean onlySingle

Set if the node is only one time in all found trees. It means that a variable is sufficient to store the content of all attributes and the text if no subNodes exists.

nodesLocal

java.util.Map<java.lang.String,java.lang.String> nodesLocal

Only for test whether or not a node is found twice. If twice, onlySingle is set to false for this node.

nrofAttributes

int nrofAttributes

xmlStructData

final XmlJzCfgAnalyzer.XmlStructureData xmlStructData

Constructor Detail

XmlStructureNode

XmlStructureNode(XmlJzCfgAnalyzer.XmlStructureNode parent,
                 java.lang.String tag,
                 XmlJzCfgAnalyzer.XmlStructureData xmlStructData)

Method Detail

addElement

public XmlJzCfgAnalyzer.XmlStructureNode addElement(java.lang.String tag)

Returns an instance to store the occurrence of a XML-element. If more XML-elements with the same tag name are found, only one occurrence of this element type is stored. If an element with the same tag name is given, which is already registered, then the same instance is returned from the found element before. With them maybe new occurring attributes or new occurring elements are stored. It is invoked via reflection from XmlJzCfgAnalyzer.newCfgReadStruct()

Parameters:

tag -

Returns:

addNamespace

public void addNamespace(java.lang.String key,
                         java.lang.String value)

setAttribute

public void setAttribute(java.lang.String namespacename)

It is invoked via reflection from XmlJzCfgAnalyzer.newCfgReadStruct()

Parameters:

tag -

setTextOccurrence

public void setTextOccurrence()

writeNodeData

void writeNodeData(java.lang.Appendable out,
                   int indent)
            throws java.io.IOException

Throws:

java.io.IOException

writeData

void writeData(java.lang.Appendable out,
               int indent)
        throws java.io.IOException

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object