org.vishia.xmlSimple

Interface XmlNode

All Superinterfaces:

SortedTree<XmlNode>

All Known Implementing Classes:

XmlNodeSimple

public interface XmlNode
extends SortedTree<XmlNode>

Interface to Access to a XML node. It contains a tree of nodes or text content. This class is a simple way using XML, some features will not supported yet:

• Namespaces on attributes.
• Check of namespace correctness: The user works with the aliases (keys). They will be written in the node. if the aliases are incorrect, the XML-tree is incorrect.

Type of children returned from SortedTree.listChildren():

• Children which are XML elements.
• Children which are plain texts. Use isTextNode() to differ it.
• Note that the attributes are not returned as children. Use getAttributes().

Field Summary

Fields

Modifier and Type	Field and Description
static int	version Version, history and license.

Method Summary

Modifier and Type	Method and Description
XmlNode	addContent(java.lang.String text) Adds textual content.
XmlNode	addContent(XmlNode node) 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.
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() Returns a list of attributes in its given order.
java.util.Map<java.lang.String,java.lang.String>	getAttributes() returns all attributes Sorted by "namespace:name" or "name".
java.lang.String	getName() Returns the tagname of the 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.
java.lang.String	removeAttribute(java.lang.String name) removes the requested attribute.
void	removeChildren() removes all children, also textual content, but not attributes.
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.

Methods inherited from interface org.vishia.util.SortedTree

getChild, getParent, iterChildren, iterChildren, listChildren, listChildren

Field Detail

version

static final int version

Version, history and license.

• 2018-09-10: Hartmut new: setAttribute(String, String, String) with namespace
• 2012-12-26: Hartmut chg: text() instead getText(). It is compatible with XPATH-expressions.
• 2012-10-05: The XmlNodeSimple is removed as dependency, so this class is the same like in the past.
• 2012-10-04: The mainly usage class XmlNodeSimple is derived from TreeNodeBase yet. Because both inherit from SortedTree, the generic type have to be the same. Up to now it is not possible to use a indirect related type, the XmlNodeSimple is used here. It is not able yet to mix different implementations of XmlNode in one tree (is it necessary?)
• 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

Method Detail

createNode

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

creates a XmlNode from the same implementation type as this, but without adding to the XML-tree. The node can be added later, using 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.

Parameters:

name -

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

Returns:

Throws:

XmlException

setAttribute

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

Sets an attribute by name.

Parameters:

name -

value -

Returns:

this

setAttribute

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

Sets an attribute by name.

Parameters:

name -

value -

Throws:

XmlException

addNamespaceDeclaration

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

Adds namespace declaration on the specified node.

Parameters:

name - namespace alias (key)

value - namespace uri.

getNamespaces

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

Gets all namespace declaration at this node.

addContent

XmlNode addContent(java.lang.String text)

Adds textual content.

addContent

XmlNode addContent(XmlNode node)
            throws XmlException

Adds a child node. If the child nodes getName() starts with "@", it is added as an attribute to this with the 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.

Parameters:

node - to add

Returns:

this itself to add something else.

Throws:

XmlException

addNewNode

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

adds and returns a new child node.

Parameters:

name -

namespaceKey -

Returns:

the new created node.

Throws:

XmlException

addNewNode

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

adds and returns a new child node.

Parameters:

name -

namespaceKey -

Returns:

the new created node.

Throws:

XmlException

removeChildren

void removeChildren()

removes all children, also textual content, but not attributes.

isTextNode

boolean isTextNode()

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

Returns:

text

java.lang.String text()

Returns the text of the node. If it isn't a text node, the summary text of all child text-nodes is returned. It is similar like XPATH, access to text with "path/text()"

getName

java.lang.String getName()

Returns the tagname of the node.
Special cases:

• If it is a text-node, the behavior is not determined. To check whether it is a text node, call isTextNode().
• The name can start with a "@". Then it should be esteemed as an XML attribute.

getNamespaceKey

java.lang.String getNamespaceKey()

returns the alias or key of the namespace.

getAttribute

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

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

getAttributes

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

returns all attributes Sorted by "namespace:name" or "name".

getAttributeList

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

Returns a list of attributes in its given order.

Returns:

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

removeAttribute

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

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