org.vishia.xmlReader

Class XmlCfg.XmlCfgNode

java.lang.Object

org.vishia.xmlReader.XmlCfg.XmlCfgNode

Enclosing class:

XmlCfg

public static class XmlCfg.XmlCfgNode
extends java.lang.Object

This class describes one node as pattern how the content of a parsed xml file should be stored. It is an output instance while the config.xml is read.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.util.Map<java.lang.String,DataAccess.IntegerIx>	allArgNames Argument names from attributes which are used for the new_<&element> but also 4 possible standard argument names: tag, name, value, text.
(package private) java.util.Map<java.lang.String,XmlCfg.AttribDstCheck>	attribs Key (attribute name with xmlns:name) and reflection path to store the attribute value.
(package private) java.util.Map<java.lang.String,XmlCfg.AttribDstCheck>	attribsArg All attributes which's values are use to call the ctor of the instance to store the data.
(package private) java.util.Map<java.lang.String,XmlCfg.AttribDstCheck>	attribsForCheck If not null, contains attribute names which's name and value are used to build the key to found the proper xml node in the config file.
(package private) java.util.Map<java.lang.String,XmlCfg.AttribDstCheck>	attribsSet All attributes which's values are set via the XmlCfg.AttribDstCheck.daccess to the data instance of the node.
(package private) DataAccess.DatapathElement	attribsUnspec If set, the attrib dst for not found attributes to store in a common way.
(package private) boolean	bCheckAttributeNode The first node in some equal nodes in cfg, which determines the attributes used for check.
(package private) boolean	bList true then this node as child is stored with more as one instance.
(package private) boolean	bStoreAttribsInNewContent True if the value of attributes should be stored in the new content.
(package private) boolean	bTextMoreOccurrences True if there is more as one occurrence of text inside other nodes.
(package private) XmlCfg	cfg Back reference to the whole config.
(package private) java.lang.String	cfgSubtreeName If not null, this element refers its attribs and subnodes in a config-subtree.
(package private) DataAccess.DatapathElement	contentStorePath Reflection path to store the content as String.
(package private) java.lang.String	dstClassName Name of the class where the data are stored.
(package private) DataAccess.DatapathElement	elementCreatePath Reflection path either to store the content of the node or also to get an instance as "sub node" to store the content.
(package private) DataAccess.DatapathElement	elementFinishPath Reflection path of usual an operation which is called on end of the node.
(package private) DataAccess.DatapathElement	nameSpaceDef If not null, the attrib dst for name space definition.
(package private) XmlCfg.XmlCfgNode	parent Parent node, to navigate in debug, to store this node if attribsForCheck are present.
(package private) java.util.Map<java.lang.String,XmlCfg.XmlCfgNode>	subnodes Key (tag name with xmlns:name) and configuration for a sub node.
(package private) java.lang.CharSequence	tag

Constructor Summary

Constructors

Constructor and Description
XmlCfgNode(XmlCfg.XmlCfgNode parent, XmlCfg cfg, java.lang.CharSequence tag)

Method Summary

Modifier and Type	Method and Description
void	addAttribStorePath(java.lang.String key, java.lang.String sAttrValue) This method is invoked from the xml configuration reader to create a new attribute entry for the found attribute.
(package private) void	addFromSubtree(XmlCfg.XmlCfgNode subtree) Adds the elements from a given <xmlinput:subtree ...
(package private) void	addSubnode(java.lang.String key, XmlCfg.XmlCfgNode node)
XmlCfg.XmlCfgNode	addSubTree(java.lang.CharSequence name) Invoked via reflection from XmlCfg.newCfgCfg()-given configuration.
private boolean	cmpDataAccess(java.lang.CharSequence tag, java.lang.String what, DataAccess.DatapathElement d1, DataAccess.DatapathElement d2, LogMessage log)
boolean	cmpNode(XmlCfg.XmlCfgNode nodeCmp, LogMessage log) This operation is only a helper to check whether the subtree entry is okay for manual changes.
(package private) XmlCfg.XmlCfgNode	newElement(java.lang.CharSequence name) This method is invoked from the xml configuration reader to create a new subNode for a found elmeent.
(package private) void	setContentStorePath(java.lang.String dstPath) This method is invoked from the xml configuration reader to create a DataAccess element for the content of the node..
void	setFinishElementPath(java.lang.String dstPath) Sets the path for the "set element" invocation see elementFinishPath.
void	setList()
void	setNameSpaceStorePath(java.lang.String dstPath) Set the dataAccess for storing a namespace definition.
void	setNewElementPath(java.lang.String dstPath) Sets the path for the "new element" invocation see elementCreatePath.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

cfg

final XmlCfg cfg

Back reference to the whole config. Especially XmlCfg.xmlnsAssign is used to evaluate attributes. The nameSpace is singular for the whole config.

parent

final XmlCfg.XmlCfgNode parent

Parent node, to navigate in debug, to store this node if attribsForCheck are present.

elementCreatePath

DataAccess.DatapathElement elementCreatePath

Reflection path either to store the content of the node or also to get an instance as "sub node" to store the content.

It is noted in the immediately child node, not in the maybe associated subtree ( if cfgSubtreeName is set), because the subtree defines the kind of node, and not the occurrence in the parent. Because this operation can call different ctor, and store already the new created node, it is a stuff of the parent node.

The DataAccess.DatapathElement#args contains the arguments for new_...(...). This comes from the textual given expression. This values are necessary to store in the created class, but final.

elementFinishPath

DataAccess.DatapathElement elementFinishPath

Reflection path of usual an operation which is called on end of the node. This is on </tag> or also on /> if the node has not further sub nodes.

It is noted in the immediately child node, not in the maybe associated subtree ( if cfgSubtreeName is set), because the subtree defines the kind of node, and not the occurrence in the parent.

This operation can be sensible, if the data for the node should be post-prepared if all information inside the node are available. This element can be null if #elementCreatePath already adds the element.

bList

boolean bList

true then this node as child is stored with more as one instance. It is noted in the immediately child node, not in the maybe associated subtree ( if cfgSubtreeName is set), because the subtree defines the kind of node, and not the occurrence in the parent.

allArgNames

java.util.Map<java.lang.String,DataAccess.IntegerIx> allArgNames

Argument names from attributes which are used for the new_<&element> but also 4 possible standard argument names: tag, name, value, text. It is not the arguments of the new_<&element>(...) only, it can be all possible and unnecessary arguments. Place holder for possible ones. See elementCreatePath

bCheckAttributeNode

boolean bCheckAttributeNode

The first node in some equal nodes in cfg, which determines the attributes used for check.

bStoreAttribsInNewContent

boolean bStoreAttribsInNewContent

True if the value of attributes should be stored in the new content. False if attributes are stored only in the attribute map and evaluate especially by the invocation of elementCreatePath It is set if at least one attributes with a store path (with "!...") is found.

attribsForCheck

java.util.Map<java.lang.String,XmlCfg.AttribDstCheck> attribsForCheck

If not null, contains attribute names which's name and value are used to build the key to found the proper xml node in the config file. Firstly all attributes should be checked whether their names are contained here.

attribsArg

java.util.Map<java.lang.String,XmlCfg.AttribDstCheck> attribsArg

All attributes which's values are use to call the ctor of the instance to store the data. They are the attributes designated with @attr="@nameArg". The 'nameArg' is stored in XmlCfg.AttribDstCheck.storeInMap.

attribsSet

java.util.Map<java.lang.String,XmlCfg.AttribDstCheck> attribsSet

All attributes which's values are set via the XmlCfg.AttribDstCheck.daccess to the data instance of the node. They are the attributes designated with @attr="set_Name(value)".

attribs

java.util.Map<java.lang.String,XmlCfg.AttribDstCheck> attribs

Key (attribute name with xmlns:name) and reflection path to store the attribute value. This map contains all attributes, also which are stored in the other idx, because the XmlJzReader searches only here.

attribsUnspec

DataAccess.DatapathElement attribsUnspec

If set, the attrib dst for not found attributes to store in a common way.

nameSpaceDef

DataAccess.DatapathElement nameSpaceDef

If not null, the attrib dst for name space definition.

subnodes

java.util.Map<java.lang.String,XmlCfg.XmlCfgNode> subnodes

Key (tag name with xmlns:name) and configuration for a sub node. Nodes of the read input which are not found here are not stored. Special case: If the key is "?" this is a 'unspecific node', taken anyway. The content is stored as for all nodes with the contentStorePath.

contentStorePath

DataAccess.DatapathElement contentStorePath

Reflection path to store the content as String. If null than the content won't be stored.

bTextMoreOccurrences

boolean bTextMoreOccurrences

True if there is more as one occurrence of text inside other nodes.

Notes: If only one occurrence is given, the text can usual stored in a simple String. That does not inform where the text content inside the child nodes are arranged. If the text occurs more as one, it is stored usual in a List<String>. But also then it is not possible to inform where the text is arranged between other child nodes. The only one possibility ot inform about the correct order is a maybe existing 'nodesAll'. But this is a part of the storing classes, which's operation is called via reflection with contentStorePath. Ot is not clarified here in the XML configuration.

tag

final java.lang.CharSequence tag

dstClassName

java.lang.String dstClassName

Name of the class where the data are stored. This element is not used for parsing. It is only used to create the java code for classes to store the data. It is set from XmlJzCfgAnalyzer#storeCfgNode(XmlCfgNode, org.vishia.xmlReader.XmlJzCfgAnalyzer.XmlStructureNode, boolean, int) to an identifier derived from the tag name. This is usual a proper default name for the (sub-) class to store. While parsing the class is the given type of the element to store, given as return value from elementCreatePath evaluation with the user's data, means the return value of this reflection called operation. Hence it is not necessary for parsing.

cfgSubtreeName

java.lang.String cfgSubtreeName

If not null, this element refers its attribs and subnodes in a config-subtree.

Constructor Detail

XmlCfgNode

XmlCfgNode(XmlCfg.XmlCfgNode parent,
           XmlCfg cfg,
           java.lang.CharSequence tag)

Method Detail

setNewElementPath

public void setNewElementPath(java.lang.String dstPath)
                       throws java.text.ParseException

Sets the path for the "new element" invocation see elementCreatePath.

Parameters:

dstPath - either a method or an access to a field.

Throws:

java.text.ParseException

setFinishElementPath

public void setFinishElementPath(java.lang.String dstPath)
                          throws java.text.ParseException

Sets the path for the "set element" invocation see elementFinishPath.

Parameters:

dstPath - either a method or an access to a field.

Throws:

java.text.ParseException

setList

public void setList()

addAttribStorePath

public void addAttribStorePath(java.lang.String key,
                               java.lang.String sAttrValue)
                        throws java.text.ParseException

This method is invoked from the xml configuration reader to create a new attribute entry for the found attribute.

• An instance of XmlCfg.AttribDstCheck is created.
• If 'dstPath' == "CHECK" then this is an attribute which's value is used to select the child node configuration. It is stored in attribsForCheck.
• If 'dstPath' starts with "@..." then this is an attribute which's value is used as argument to create the instance to store the child node data, used as argument with the name after '@'. This name is stored in XmlCfg.AttribDstCheck.storeInMap. It is stored in attribsArg.
• Else 'dstPath' is used as refection access to store the value in the destination instance for the node. It is usual an operation. The variable 'value' should be used their to access the attribute value. It is stored in attribsSet.
• All attributes are stored in attribs, this is used in XmlJzReader to detect usage of the attributes. The other specific container where the attributes are also stored are used to write out and access the confiuration.

Parameters:

key - ns:name of the found attribute in the config.xml

dstPath - datapath which is found as value in the config.xml. The datapath is used for the user.xml to store the attribute value.

Throws:

java.text.ParseException

setNameSpaceStorePath

public void setNameSpaceStorePath(java.lang.String dstPath)
                           throws java.text.ParseException

Set the dataAccess for storing a namespace definition. This is yet only used for XmlJzCfgAnalyzer. For reading data from Xml usual a namespace definition should not be used in the read data (...?)

Parameters:

dstPath -

Throws:

java.text.ParseException

addFromSubtree

void addFromSubtree(XmlCfg.XmlCfgNode subtree)

Adds the elements from a given <xmlinput:subtree ... in the xmlcfg.xml to the used xmlcfg.

• The subnodes in the <xmlinput:subtree ... are also referred in original from this subnodes
• The attributes from the <xmlinput:subtree are only taken if this attribs does not contain the attribute. It means the <xmlinput:subtree ... attribs are not meaningful if they exists in the current element already. The entry in the current element is then significant (the called store operation as attribute value). But both should be equivalent.
• The setContentStorePath(String) is not taken from the subtree (ignored, 2024-05-12)
• The elementCreatePath and elementFinishPath are not taken from the subtree ( ignored, 2024-05-12).

Parameters:

subtree -

addSubnode

void addSubnode(java.lang.String key,
                XmlCfg.XmlCfgNode node)

newElement

XmlCfg.XmlCfgNode newElement(java.lang.CharSequence name)

This method is invoked from the xml configuration reader to create a new subNode for a found elmeent.

Parameters:

name - ns:tag of the found element in the config.xml

Returns:

the sub node

setContentStorePath

void setContentStorePath(java.lang.String dstPath)
                  throws java.text.ParseException

This method is invoked from the xml configuration reader to create a DataAccess element for the content of the node..

Parameters:

text - should start with ! the dataPath to store the content

Throws:

java.text.ParseException

addSubTree

public XmlCfg.XmlCfgNode addSubTree(java.lang.CharSequence name)

Invoked via reflection from XmlCfg.newCfgCfg()-given configuration. It is invoked on <xmlinput:subtree name="..."

Parameters:

name - Value from attribute name

Returns:

A new config node for the subtree content.

cmpNode

public boolean cmpNode(XmlCfg.XmlCfgNode nodeCmp,
                       LogMessage log)

This operation is only a helper to check whether the subtree entry is okay for manual changes.

Parameters:

nodeCmp -

cmpDataAccess

private boolean cmpDataAccess(java.lang.CharSequence tag,
                              java.lang.String what,
                              DataAccess.DatapathElement d1,
                              DataAccess.DatapathElement d2,
                              LogMessage log)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object