org.girod.jgraphml.xml

Class XMLNode

java.lang.Object

org.girod.jgraphml.xml.XMLNode

Direct Known Subclasses:

XMLRoot

public class XMLNode
extends java.lang.Object

A Node in an XML File.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.String>	attributes The attributes.
protected java.util.List<XMLNode>	children The children nodes.
protected java.lang.String	name The node name.
protected XMLNode	nodeParent The node parent.

Constructor Summary

Constructors

Constructor and Description
XMLNode(java.lang.String nodeName) Create the Node.
XMLNode(XMLNode parent, java.lang.String nodeName) Create a Node.

Method Summary

Modifier and Type	Method and Description
void	addAttribute(java.lang.String attrName, boolean value) Add an attribute for this Node.
void	addAttribute(java.lang.String attrName, float value) Add an attribute for this Node.
void	addAttribute(java.lang.String attrName, int value) Add an attribute for this Node.
void	addAttribute(java.lang.String attrName, java.lang.String value) Add an attribute for this Node.
void	addChild(XMLNode child) Add a child to this Node.
XMLNode	copy() Create a copy of this node.
int	countAttributes() Return the number of attributes of the Node.
int	countChildren() Return the number of children of the Node.
boolean	equals(java.lang.Object obj)
java.util.List<XMLNode>	getAllChildren(java.lang.String name) Return the list of all children of this node having a specified name.
java.util.Map<java.lang.String,java.lang.String>	getAttributes() Return the Map of attributes for this node.
java.lang.String	getAttributeValue(java.lang.String attrName) Return the value of an attribute of a specified name.
boolean	getAttributeValueAsBoolean(java.lang.String attrName) Return the value of an attribute of a specified name as a boolean.
boolean	getAttributeValueAsBoolean(java.lang.String attrName, boolean defaultValue) Return the value of an attribute of a specified name as a boolean.
float	getAttributeValueAsFloat(java.lang.String attrName) Return the value of an attribute of a specified name as a float.
float	getAttributeValueAsFloat(java.lang.String attrName, float defaultValue) Return the value of an attribute of a specified name as a float.
int	getAttributeValueAsInt(java.lang.String attrName) Return the value of an attribute of a specified name as an int.
int	getAttributeValueAsInt(java.lang.String attrName, int defaultValue) Return the value of an attribute of a specified name as an int.
java.lang.String	getCDATA() Return the CDATA content for the node.
java.util.List<XMLNode>	getChildren() Return the ordered list of children of this Node.
XMLNode	getFirstChild() Return the first child of the Node.
XMLNode	getLastChild() Return the last child of the Node.
java.lang.String	getName() Return the Node qualified name.
XMLNode	getNextSibling() Return the next sibling of the Node.
XMLNode	getParent() Return the Node parent (or null if the Node is the root of the XML File).
XMLNode	getPreviousSibling() Return the previous sibling of the Node.
boolean	hasAttribute(java.lang.String attrName) Return true if the Node has an attribute of a specified name.
boolean	hasCDATA() Return true if there is a the CDATA content for the node.
boolean	hasChildren() Return true if this Node has children.
int	hashCode()
void	setCDATA(java.lang.String cData) Set the CDATA content for the node.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

name

protected java.lang.String name

The node name.

nodeParent

protected XMLNode nodeParent

The node parent.

children

protected final java.util.List<XMLNode> children

The children nodes.

attributes

protected final java.util.Map<java.lang.String,java.lang.String> attributes

The attributes.

Constructor Detail

XMLNode

public XMLNode(java.lang.String nodeName)

Create the Node.

Parameters:

nodeName - the Node name

XMLNode

public XMLNode(XMLNode parent,
               java.lang.String nodeName)

Create a Node.

Parameters:

parent - the Node parent

nodeName - the Node name

Method Detail

copy

public XMLNode copy()

Create a copy of this node. It will also copy all the children under this node.

Returns:

the Node copy.

getAllChildren

public java.util.List<XMLNode> getAllChildren(java.lang.String name)

Return the list of all children of this node having a specified name. The list will include all children, including children of children Nodes.

Parameters:

name - the name

Returns:

the list

getParent

public XMLNode getParent()

Return the Node parent (or null if the Node is the root of the XML File).

Returns:

the Node parent (or null if the Node is the root of the XML File)

getName

public java.lang.String getName()

Return the Node qualified name.

Returns:

the Node qualified name.

getChildren

public java.util.List<XMLNode> getChildren()

Return the ordered list of children of this Node.

Returns:

the ordered list of children of this Node

getFirstChild

public XMLNode getFirstChild()

Return the first child of the Node.

Returns:

the first child of the Node

getLastChild

public XMLNode getLastChild()

Return the last child of the Node.

Returns:

the last child of the Node

getNextSibling

public XMLNode getNextSibling()

Return the next sibling of the Node.

Returns:

the next sibling of the Node

getPreviousSibling

public XMLNode getPreviousSibling()

Return the previous sibling of the Node.

Returns:

the previous sibling of the Node

addChild

public void addChild(XMLNode child)

Add a child to this Node.

Parameters:

child - the Node child

hasChildren

public boolean hasChildren()

Return true if this Node has children.

Returns:

true if this Node has children

countChildren

public int countChildren()

Return the number of children of the Node.

Returns:

the number of children of the Node

countAttributes

public int countAttributes()

Return the number of attributes of the Node.

Returns:

the number of attributes of the Node

getAttributes

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

Return the Map of attributes for this node.

Returns:

the Map of attributes for this node

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String attrName)

Return the value of an attribute of a specified name.

Parameters:

attrName - the attribute name

Returns:

the value of the attribute

getAttributeValueAsBoolean

public boolean getAttributeValueAsBoolean(java.lang.String attrName)

Return the value of an attribute of a specified name as a boolean.

Parameters:

attrName - the attribute name

Returns:

the value of the attribute

getAttributeValueAsBoolean

public boolean getAttributeValueAsBoolean(java.lang.String attrName,
                                          boolean defaultValue)

Return the value of an attribute of a specified name as a boolean.

Parameters:

attrName - the attribute name

defaultValue - the default value

Returns:

the value of the attribute

getAttributeValueAsFloat

public float getAttributeValueAsFloat(java.lang.String attrName)

Return the value of an attribute of a specified name as a float.

Parameters:

attrName - the attribute name

Returns:

the value of the attribute

getAttributeValueAsFloat

public float getAttributeValueAsFloat(java.lang.String attrName,
                                      float defaultValue)

Return the value of an attribute of a specified name as a float.

Parameters:

attrName - the attribute name

defaultValue - the default value

Returns:

the value of the attribute

getAttributeValueAsInt

public int getAttributeValueAsInt(java.lang.String attrName)

Return the value of an attribute of a specified name as an int.

Parameters:

attrName - the attribute name

Returns:

the value of the attribute

getAttributeValueAsInt

public int getAttributeValueAsInt(java.lang.String attrName,
                                  int defaultValue)

Return the value of an attribute of a specified name as an int.

Parameters:

attrName - the attribute name

defaultValue - the default value

Returns:

the value of the attribute

addAttribute

public void addAttribute(java.lang.String attrName,
                         int value)

Add an attribute for this Node.

Parameters:

attrName - the attribute name

value - the attribute value

addAttribute

public void addAttribute(java.lang.String attrName,
                         java.lang.String value)

Add an attribute for this Node.

Parameters:

attrName - the attribute name

value - the attribute value

addAttribute

public void addAttribute(java.lang.String attrName,
                         float value)

Add an attribute for this Node.

Parameters:

attrName - the attribute name

value - the attribute value

addAttribute

public void addAttribute(java.lang.String attrName,
                         boolean value)

Add an attribute for this Node.

Parameters:

attrName - the attribute name

value - the attribute value

setCDATA

public void setCDATA(java.lang.String cData)

Set the CDATA content for the node.

Parameters:

cData - the CDATA content

getCDATA

public java.lang.String getCDATA()

Return the CDATA content for the node.

Returns:

the CDATA content

hasCDATA

public boolean hasCDATA()

Return true if there is a the CDATA content for the node.

Returns:

true if there is a the CDATA content for the nodet

hasAttribute

public boolean hasAttribute(java.lang.String attrName)

Return true if the Node has an attribute of a specified name.

Parameters:

attrName - the attribute name

Returns:

true if the Node has an attribute of the specified name

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object