org.vishia.xmlReader

Class XmlDataNode

java.lang.Object

org.vishia.xmlReader.XmlDataNode

All Implemented Interfaces:

XmlAddData_ifc

public class XmlDataNode
extends java.lang.Object
implements XmlAddData_ifc

This is an universal data container as output for XmlJzReader without semantic sorting of attributes and nodes. The XmlJzReader can now be used adequate a DOM XML reader, reads all what is found. This is the destination. The semantic sorting should be done by evaluation of the content. This instance represents all nodes and refers all sub nodes. If it is the root of a read XML file, it is the sum of all data.
The concept of XmlJzReader till before was only: Only store adequate a given config file. Now using this class the config file should only contain namespace declarations, no more.

Since:

2024-05-26

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	XmlDataNode.OnlyOneNode Dummy class to offer an iterator with one or zero nodes

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<XmlDataNode>	allNodes List of all sub nodes in order of appearance in the node.
java.util.Map<java.lang.String,java.lang.String>	attribs Index of all attributes sorted by name.
java.util.Map<java.lang.String,java.util.List<XmlDataNode>>	multiNodes As alternative to members in singleNodes: Index of sub nodes with a defined key as <name ...
protected XmlDataNode	parent
java.util.Map<java.lang.String,XmlDataNode>	singleNodes Index of sub nodes with a defined key as <name ...
java.lang.String	tag
java.lang.String	text If this element is set, the node has only one text.
static java.lang.String	version Version, history and license.

Constructor Summary

Constructors

Constructor and Description
XmlDataNode(XmlDataNode parent, java.lang.String tag, java.util.Map<java.lang.String,java.lang.String> attribs)

Method Summary

Modifier and Type	Method and Description
void	addNode(XmlAddData_ifc node) Adds a new parsed node to the current list of nodes.
void	addText(java.lang.String text) Add a plain text to the node.
java.lang.String	getAttrib(java.lang.String key)
XmlDataNode	getFirstNode(java.lang.String key)
java.lang.String	getText() Get the whole plain text inside the node.
java.util.ListIterator<XmlDataNode>	iterListNodes(java.lang.String tag) ListIterator over all nodes of a defined tag, also applicable if no node is given.
java.lang.Iterable<XmlDataNode>	iterNodes(java.lang.String tag) Iterator over all nodes of a defined tag, also applicable if no node is given.
XmlAddData_ifc	newNode(java.lang.String tag, java.util.Map<java.lang.String,java.lang.String> attribs) Creates a new node with all given attrib values.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

version

public static final java.lang.String version

Version, history and license.

• 2024-09-19 new #getTextSub() for special cases, for example LibreOffc span is sometimes deep nested without necessity.
• 2024-06-23 new iterNodes(String) and XmlDataNode.OnlyOneNode to evaluate a dedicated tag of nodes.
• 2024-05-25 Hartmut created because the structure of an XML file should not be explored on first usage, but XmlJzReader should be used adequate a DOM XML reader, reads all what is found. This is the destination.

Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL is not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

parent

protected final XmlDataNode parent

tag

public final java.lang.String tag

text

public java.lang.String text

If this element is set, the node has only one text.

attribs

public final java.util.Map<java.lang.String,java.lang.String> attribs

Index of all attributes sorted by name.

singleNodes

public final java.util.Map<java.lang.String,XmlDataNode> singleNodes

Index of sub nodes with a defined key as <name ... but only with one member in the node. This allows simple select a sub node with a defined <name

multiNodes

public final java.util.Map<java.lang.String,java.util.List<XmlDataNode>> multiNodes

As alternative to members in singleNodes: Index of sub nodes with a defined key as <name ... with more as one member in the node. This allows simple select all sub nodes with a defined <name in order of their appearance in the node.

allNodes

public final java.util.List<XmlDataNode> allNodes

List of all sub nodes in order of appearance in the node. To evaluate in given order.

Constructor Detail

XmlDataNode

public XmlDataNode(XmlDataNode parent,
                   java.lang.String tag,
                   java.util.Map<java.lang.String,java.lang.String> attribs)

Method Detail

newNode

public XmlAddData_ifc newNode(java.lang.String tag,
                              java.util.Map<java.lang.String,java.lang.String> attribs)

Description copied from interface: XmlAddData_ifc

Creates a new node with all given attrib values.

Specified by:

newNode in interface XmlAddData_ifc

Returns:

data for this node, whereas the attribs are already stored.

addNode

public void addNode(XmlAddData_ifc node)

Description copied from interface: XmlAddData_ifc

Adds a new parsed node to the current list of nodes.

Specified by:

addNode in interface XmlAddData_ifc

addText

public void addText(java.lang.String text)

Add a plain text to the node. If the node is empty yet, the text is stored in text for a simple text. If the node is not empty, then all texts are stored in order of all sub nodes in the List allNodes. A simple text before stored is added also there, but on first position because it was stored as first.

Specified by:

addText in interface XmlAddData_ifc

getAttrib

public java.lang.String getAttrib(java.lang.String key)

getFirstNode

public XmlDataNode getFirstNode(java.lang.String key)

iterNodes

public java.lang.Iterable<XmlDataNode> iterNodes(java.lang.String tag)

Iterator over all nodes of a defined tag, also applicable if no node is given.

Parameters:

tag -

Returns:

always an Iterator, it is empty if the node does not exists.

Since:

2024-06-23

iterListNodes

public java.util.ListIterator<XmlDataNode> iterListNodes(java.lang.String tag)

ListIterator over all nodes of a defined tag, also applicable if no node is given.

Parameters:

tag -

Returns:

always an ListIterator, it is empty if the node does not exists.

Since:

2024-09-23

getText

public java.lang.String getText()

Get the whole plain text inside the node. Either there is exact one text part, it is stored in text and returned. Or there are some more text parts, stored as node with tag="$" in multiNodes. Then all these text parts are concatenated and returned as one.

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object