org.vishia.xmlSimple

Class XmlNodeSimple<UserData>

java.lang.Object

org.vishia.util.TreeNodeBase<XmlNodeSimple<UserData>,UserData,XmlNode>

org.vishia.xmlSimple.XmlNodeSimple<UserData>

All Implemented Interfaces:

java.lang.Iterable<XmlNodeSimple<UserData>>, SortedTree<XmlNode>, TreeNode_ifc<XmlNodeSimple<UserData>,UserData>, XmlNode

public class XmlNodeSimple<UserData>
extends TreeNodeBase<XmlNodeSimple<UserData>,UserData,XmlNode>
implements XmlNode

Representation of a XML node. It contains a tree of nodes or text content. Hint: The possibility to reference data is additional to XML concepts, not usable for the XML output but for management of data. The referenced data are present if the appropriate constructors are used: XmlNodeSimple(String, Object) and XmlNodeSimple(String, String, Object). Elsewhere the TreeNodeBase.nd_data is left empty. This is for ordinary XML data.

Nested Class Summary

Nested classes/interfaces inherited from class org.vishia.util.TreeNodeBase

TreeNodeBase.IteratorDerivedImpl, TreeNodeBase.IteratorDerivedNode, TreeNodeBase.IteratorImpl, TreeNodeBase.IteratorMetaNode, TreeNodeBase.IteratorOneNode, TreeNodeBase.MetaNode<DerivedNode extends TreeNodeBase<DerivedNode,Data,IfcType> & SortedTree<IfcType>,Data,IfcType extends SortedTree<IfcType>>, TreeNodeBase.TreeNode<Data>

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.lang.String	name The tag name of the node or the text if namespaceKey is "$".
(package private) java.lang.String	namespaceKey The namespace-key.
(package private) java.util.TreeMap<java.lang.String,java.lang.String>	namespaces List of namespace declaration, typical null because only top elements has it.
(package private) java.lang.String	text Text of an attribute or text of a text node.
static int	version Version, history and license.

Fields inherited from class org.vishia.util.TreeNodeBase

nd_data, nd_firstChild, nd_idxChildren, nd_key, nd_lastChild, nd_leafData, nd_next, nd_nrofChildren, nd_parent, nd_prev

Constructor Summary

Constructors

Modifier	Constructor and Description
	XmlNodeSimple(java.lang.String name) Creates a XML node.
	XmlNodeSimple(java.lang.String name, java.lang.String namespaceKey) Creates a XML node.
protected	XmlNodeSimple(java.lang.String key, java.lang.String text, boolean isText) Creates a XML node with text.
	XmlNodeSimple(java.lang.String name, java.lang.String namespaceKey, java.lang.String namespace) Creates a XML node.
	XmlNodeSimple(java.lang.String name, java.lang.String namespaceKey, UserData data) Creates a XML node.
	XmlNodeSimple(java.lang.String name, UserData data) Creates a XML node.

Method Summary

Modifier and Type	Method and Description
XmlNode	addContent(java.lang.String text) Adds textual content.
XmlNode	addContent(XmlNode child) Adds a child node.
void	addNamespaceDeclaration(java.lang.String name, java.lang.String value) Adds namespace declaration on the specified node.
XmlNode	addNewNode(java.lang.String name) adds and returns a new child node.
XmlNode	addNewNode(java.lang.String name, java.lang.String namespaceKey) adds and returns a new child node.
private static java.lang.String	calcKey(java.lang.String name, java.lang.String namespaceKey)
static XmlNode	createNewNode(java.lang.String name, java.lang.String namespaceKey) Creates an independent new XmlNode without data.
XmlNode	createNode(java.lang.String name, java.lang.String namespaceKey) creates a XmlNode from the same implementation type as this, but without adding to the XML-tree.
java.lang.String	getAttribute(java.lang.String name) returns the requested attribute or null if it is not existing.
java.util.List<java.lang.String[]>	getAttributeList() Prepares a List for attributes from given children.
java.util.Map<java.lang.String,java.lang.String>	getAttributes() Prepares a Map for attributes from given children.
java.lang.String	getName() Returns the text if it is a text node.
java.lang.String	getNamespaceKey() returns the alias or key of the namespace.
java.util.Map<java.lang.String,java.lang.String>	getNamespaces() Gets all namespace declaration at this node.
boolean	isTextNode() returns true if the node is a text, not a XML element.
protected XmlNodeSimple<UserData>	newNode(java.lang.String key, UserData data) This method has to be overridden in the derived class.
java.lang.String	removeAttribute(java.lang.String name) removes the requested attribute.
XmlNode	setAttribute(java.lang.String name, java.lang.String value) Sets an attribute by name.
void	setAttribute(java.lang.String name, java.lang.String namespaceKey, java.lang.String value) Sets an attribute by name.
java.lang.String	text() Returns the text of the node.
java.lang.String	toString() Returns either the simple text which is associated to the node (for attributes or simple text nodes) or returns "... or returns for empty nodes.
java.lang.String	toString1()

Methods inherited from class org.vishia.util.TreeNodeBase

addLeaf, addNode, addNode, addNodeFirst, addSiblingNext, addSiblingPrev, childNodes, childNodes, detach, firstChild, getChild, getContainerChildren, getKey, getNode, getOrCreateNode, getParent, getParentData, hasChildren, iterator, iteratorChildren, iteratorChildren, iterChildren, iterChildren, lastChild, listChildren, listChildren, movetoFirstChild, movetoSiblingNext, movetoSiblingPrev, nextSibling, nrofChildren, parent, parentEquals, prevSibling, removeChildren, swap, walkTree

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.vishia.xmlSimple.XmlNode

removeChildren

Methods inherited from interface org.vishia.util.SortedTree

getChild, getParent, iterChildren, iterChildren, listChildren, listChildren

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

version

public static final int version

Version, history and license.

• 2018-09-10: Hartmut new: setAttribute(String, String, String) with namespace
• 2013-03-21 Hartmut bugfix: store data in XmlNodeSimple(String, Object) if given.
• 2013-03-21 Hartmut chg: XmlNodeSimple(String, Object) etc. If "namespace:name" is given as parameter name the namespace is used.
• 2012-12-26 Hartmut chg: toString() returns the pure text if the node contains only text or it is an attribute. It is helpful for output data.
• 2012-12-26 Hartmut chg: If the node has a simple text as content, not more, then the text is stored in the text and no extra child is created for that. If the node has another children and the text is dispersed between them therefore, the text is stored as child node with "$"-key like before.
• 2012-11-24 Hartmut chg: The attributes are stored as children in the same tree as other content. It means that the attributes are visible too if the tree is evaluated as TreeNodeBase reference.
• 2012-11-24 Hartmut new: addContent(XmlNode) checks whether the child is an attribute node. Then it is added as attribute. Such nodes are created from ZbnfParser now. and the XmlNodeSimple#attributes may be removed.
• 2012-11-03 Hartmut Now this class is derived from TreeNodeBase directly. It is a TreeNode by itself.
• 2012-11-01 Hartmut The TreeNodeBase is used for the node structure. Reference #node. The algorithm to manage the node structure is deployed in the TreeNodeBase yet.
• 2008-04-02: Hartmut some changes
• 2008-01-15: Hartmut www.vishia.org creation

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 ist 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

name

final java.lang.String name

The tag name of the node or the text if namespaceKey is "$". Note: It is not the key in the TreeNodeBase. The key there is namespaceKey:name.

namespaceKey

final java.lang.String namespaceKey

The namespace-key. If it is "$", the node is a terminate text node.

text

java.lang.String text

Text of an attribute or text of a text node.

namespaces

java.util.TreeMap<java.lang.String,java.lang.String> namespaces

List of namespace declaration, typical null because only top elements has it.

Constructor Detail

XmlNodeSimple

public XmlNodeSimple(java.lang.String name)

Creates a XML node.

Parameters:

name - The tag name. If it contains a "namespace:name", the namespace will be separated.

XmlNodeSimple

public XmlNodeSimple(java.lang.String name,
                     UserData data)

Creates a XML node.

Parameters:

name - The tag name. If it contains a "namespace:name", the namespace will be separated.

data - Additional data stored in the TreeNodeBase.nd_data

XmlNodeSimple

protected XmlNodeSimple(java.lang.String key,
                        java.lang.String text,
                        boolean isText)

Creates a XML node with text.

Parameters:

key -

text -

isText - not used. It is a marker only to select this constructor.

XmlNodeSimple

public XmlNodeSimple(java.lang.String name,
                     java.lang.String namespaceKey,
                     UserData data)

Creates a XML node.

Parameters:

name - The tag name. If it contains a "namespace:name", the namespace will be separated.

namespaceKey - A given namespace if not contained in name. This argument wins if "namespace:name"

data - Additional data stored in the TreeNodeBase.nd_data

XmlNodeSimple

public XmlNodeSimple(java.lang.String name,
                     java.lang.String namespaceKey)

Creates a XML node.

Parameters:

name - The tag name. If it contains a "namespace:name", the namespace will be separated.

namespaceKey - A given namespace if not contained in name. This argument wins if "namespace:name"

XmlNodeSimple

public XmlNodeSimple(java.lang.String name,
                     java.lang.String namespaceKey,
                     java.lang.String namespace)

Creates a XML node.

Parameters:

name - The tag name. If it contains a "namespace:name", the namespace will be separated.

namespaceKey - A given namespace if not contained in name. This argument wins if "namespace:name"

namespace - the string associated to the namespaceKey

Method Detail

calcKey

private static java.lang.String calcKey(java.lang.String name,
                                        java.lang.String namespaceKey)

newNode

protected XmlNodeSimple<UserData> newNode(java.lang.String key,
                                          UserData data)

Description copied from class: TreeNodeBase

This method has to be overridden in the derived class. It has to be created an instance of the DerivedNode type.

Overrides:

newNode in class TreeNodeBase<XmlNodeSimple<UserData>,UserData,XmlNode>

Returns:

Instance of the DerivedNode class

createNode

public XmlNode createNode(java.lang.String name,
                          java.lang.String namespaceKey)

Description copied from interface: XmlNode

creates a XmlNode from the same implementation type as this, but without adding to the XML-tree. The node can be added later, using XmlNode.addContent(XmlNode), because it may be necessary to built a sub tree with the new node first, and than add, if there are multi threads.

Specified by:

createNode in interface XmlNode

namespaceKey - The this-node should know the key, otherwise an XmlException is thrown.

Returns:

createNewNode

public static XmlNode createNewNode(java.lang.String name,
                                    java.lang.String namespaceKey)

Creates an independent new XmlNode without data. It is static, does not presume existing nodes, in opposite to createNode(String, String)

Parameters:

name - Tag name or "namespacekey:name" if argument namespaceKey is null

namespaceKey - extra argument as name space key. This is not the namespace itself, it is the key defined in xml with an attribute: xmlns:namespaceKey="www.url/of/namespace"

Returns:

the created node.

Since:

2022-06 as supplement to createNode(String, String) which needs an instance.

setAttribute

public XmlNode setAttribute(java.lang.String name,
                            java.lang.String value)

Description copied from interface: XmlNode

Sets an attribute by name.

Specified by:

setAttribute in interface XmlNode

Returns:

this

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.String namespaceKey,
                         java.lang.String value)

Description copied from interface: XmlNode

Sets an attribute by name.

Specified by:

setAttribute in interface XmlNode

addNamespaceDeclaration

public void addNamespaceDeclaration(java.lang.String name,
                                    java.lang.String value)

Description copied from interface: XmlNode

Adds namespace declaration on the specified node.

Specified by:

addNamespaceDeclaration in interface XmlNode

Parameters:

name - namespace alias (key)

value - namespace uri.

addContent

public XmlNode addContent(java.lang.String text)

Description copied from interface: XmlNode

Adds textual content.

Specified by:

addContent in interface XmlNode

addNewNode

public XmlNode addNewNode(java.lang.String name,
                          java.lang.String namespaceKey)
                   throws XmlException

Description copied from interface: XmlNode

adds and returns a new child node.

Specified by:

addNewNode in interface XmlNode

Returns:

the new created node.

Throws:

XmlException

addNewNode

public XmlNode addNewNode(java.lang.String name)
                   throws XmlException

Description copied from interface: XmlNode

adds and returns a new child node.

Specified by:

addNewNode in interface XmlNode

Returns:

the new created node.

Throws:

XmlException

addContent

public XmlNode addContent(XmlNode child)
                   throws XmlException

Description copied from interface: XmlNode

Adds a child node. If the child nodes XmlNode.getName() starts with "@", it is added as an attribute to this with the XmlNode.text() as attribute value. This opens the possibility to create a XmlNode independent of a parent and independent of checking whether it should be an attribute, and convert it to an attribute later.

Specified by:

addContent in interface XmlNode

Parameters:

child - to add

Returns:

this itself to add something else.

Throws:

XmlException

isTextNode

public boolean isTextNode()

Description copied from interface: XmlNode

returns true if the node is a text, not a XML element. A textual content is also represent as node.

Specified by:

isTextNode in interface XmlNode

Returns:

text

public java.lang.String text()

Returns the text of the node. If it isn't a text node, the tagName is returned.

Specified by:

text in interface XmlNode

getName

public java.lang.String getName()

Returns the text if it is a text node. If it isn't a text node, the tagName is returned.

Specified by:

getName in interface XmlNode

getNamespaceKey

public java.lang.String getNamespaceKey()

Description copied from interface: XmlNode

returns the alias or key of the namespace.

Specified by:

getNamespaceKey in interface XmlNode

getAttribute

public java.lang.String getAttribute(java.lang.String name)

Description copied from interface: XmlNode

returns the requested attribute or null if it is not existing.

Specified by:

getAttribute in interface XmlNode

getAttributes

public java.util.Map<java.lang.String,java.lang.String> getAttributes()

Prepares a Map for attributes from given children. Invokes TreeNodeBase.listChildren() and checks whether the name starts with "@".

Specified by:

getAttributes in interface XmlNode

Since:

2018-09: regard nameSpace for attributes

See Also:

XmlNode.getAttributes()

getAttributeList

public java.util.List<java.lang.String[]> getAttributeList()

Prepares a List for attributes from given children. Invokes TreeNodeBase.listChildren() and checks whether the name starts with "@".

Specified by:

getAttributeList in interface XmlNode

Returns:

List of : element[0] is the namespace:name, element[1] is the value.

Since:

2019-01: because attributes should be sorted in given order, not in alphabetic one.

See Also:

XmlNode.getAttributes()

getNamespaces

public java.util.Map<java.lang.String,java.lang.String> getNamespaces()

Description copied from interface: XmlNode

Gets all namespace declaration at this node.

Specified by:

getNamespaces in interface XmlNode

removeAttribute

public java.lang.String removeAttribute(java.lang.String name)

Description copied from interface: XmlNode

removes the requested attribute. If the attribute is not existing, this method does nothing.

Specified by:

removeAttribute in interface XmlNode

toString

public java.lang.String toString()

Returns either the simple text which is associated to the node (for attributes or simple text nodes) or returns "... or returns for empty nodes. This operation is need for output the tree especially in the org.vishia.zbatch.ZbatchExecuter.

Overrides:

toString in class TreeNodeBase<XmlNodeSimple<UserData>,UserData,XmlNode>

See Also:

TreeNodeBase.toString()

toString1

public java.lang.String toString1()