org.vishia.xmlReader

Class XmlJzCfgAnalyzer.XmlStructureNode

java.lang.Object

org.vishia.xmlReader.XmlJzCfgAnalyzer.XmlStructureNode

Enclosing class:

XmlJzCfgAnalyzer

static class XmlJzCfgAnalyzer.XmlStructureNode
extends java.lang.Object

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 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 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) java.util.Map<java.lang.String,XmlJzCfgAnalyzer.AttribRead>	attribs Found attributes.
(package private) java.util.List<java.lang.String>	attribsUnnamed
(package private) boolean	bDependencyChecked
(package private) boolean	bNewAttributes Set if new attributes are found.
(package private) boolean	bText Set if at least one of the occurrences has a text content.
(package private) long	mGroup This bit mask is set by one bit per occurrence of a node with same tag to characteristic groups with same sub nodes.
(package private) java.util.Map<java.lang.String,java.lang.String>	nameSpaces The declared name spaces for this node.
(package private) java.util.Map<java.lang.String,XmlJzCfgAnalyzer.XmlStructureNode>	nodes Found sub nodes.
(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) XmlJzCfgAnalyzer.XmlStructureNode	parent
(package private) java.lang.String	sSubtreenode Name of the representation of the node structure in a subtree.
(package private) java.lang.String	tag Tag name of the element.
(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

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
void	addAttribute(java.lang.String namespacename, java.lang.String attribValue) It is invoked via reflection from XmlJzCfgAnalyzer.newCfgReadStruct()
void	addAttributeUnnamed(java.lang.String value) Adds a value String found in the data presentation, which is not designated by a name.
XmlJzCfgAnalyzer.XmlStructureNode	addElement(java.lang.String tag) Returns the instance to store the occurrence of a XML-element in a node.
void	addNamespace(java.lang.String key, java.lang.String value)
(package private) void	putSubnode(XmlJzCfgAnalyzer.XmlStructureNode subNode)
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 java.lang.Object

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

Field Detail

tag

final java.lang.String tag

Tag name of the element.

parent

final XmlJzCfgAnalyzer.XmlStructureNode parent

nodes

java.util.Map<java.lang.String,XmlJzCfgAnalyzer.XmlStructureNode> nodes

Found sub nodes. The list is supplemented if new sub nodes are found on further occurrences of elements. It contains the same tag element only one time. that is tested in addElement(String).

attribs

java.util.Map<java.lang.String,XmlJzCfgAnalyzer.AttribRead> attribs

Found attributes. The list is supplemented if new attribute names are found on further occurrences of elements.

bNewAttributes

boolean bNewAttributes

Set if new attributes are found. Then the

nameSpaces

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

The declared name spaces for this node.

attribsUnnamed

java.util.List<java.lang.String> attribsUnnamed

tagIdent

final java.lang.String tagIdent

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

sSubtreenode

java.lang.String sSubtreenode

Name of the representation of the node structure in a subtree. After recognizing (selection) of the node, in the XmlCfg, the XmlCfg.XmlCfgNode can be substituted with the subtree content with this name.

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

mGroup

long mGroup

This bit mask is set by one bit per occurrence of a node with same tag to characteristic groups with same sub nodes.

Constructor Detail

XmlStructureNode

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

Method Detail

addAttribute

public void addAttribute(java.lang.String namespacename,
                         java.lang.String attribValue)

It is invoked via reflection from XmlJzCfgAnalyzer.newCfgReadStruct()

Parameters:

tag -

addAttributeUnnamed

public void addAttributeUnnamed(java.lang.String value)

Adds a value String found in the data presentation, which is not designated by a name. It may be designated by its distinguished content or by its position. The post preparation should decide about usage.

Parameters:

value - value to add to attribsUnnamed.

putSubnode

void putSubnode(XmlJzCfgAnalyzer.XmlStructureNode subNode)

addElement

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

Returns the instance to store the occurrence of a XML-element in a node. If more XML-elements with the same tag name are found in the same node, only one occurrence for this element tag is stored. With them maybe new occurring attributes or new occurring elements are stored.
Additionally via XmlStructureData#addStructureNodeOccurence(XmlStructureNode) all elements in the whole xml file with the same tag are registered any later evaluated, if there are semantically also the same.
This operation 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