org.licas_xml.abs

Interface Node

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

Element

All Known Implementing Classes:

ElementImpl, NodeImpl

public interface Node
extends java.io.Serializable

A base interface for all of the XML elements. This class describes the functionality required by an XML node.

Author:

Kieran Greer

Method Summary

Modifier and Type	Method and Description
void	addChild(Node childNode) Add a child node to this node.
void	addContent(int position, Node childNode) Add the child node to this node at the specified position.
void	addContent(Node childNode) Add the child node to this node.
java.lang.Object	clone() Return a deep copy of this node, including copies of all sub-nodes.
Node	detach() Detach this node from its parent node.
Element	getChild(java.lang.String nodeName) Get the first child node with the specified name.
java.util.Vector<Node>	getChildren() Get the child nodes of this node.
int	getChildrenCount() Get the number of child nodes.
java.lang.String	getName() Get the name of this node.
java.lang.String	getValue() Get the node value.
boolean	hasChildren() Return true if this node has child nodes.
boolean	removeChild(java.lang.String nodeName) Remove the first child node with the specified name.
void	setName(java.lang.String nodeName) Set the name of the node.
void	setValue(java.lang.String theValue) Set the node value.

Method Detail

setName

void setName(java.lang.String nodeName)

Set the name of the node.

Parameters:

nodeName - the name of the node.

getName

java.lang.String getName()

Get the name of this node.

Returns:

the node's name.

setValue

void setValue(java.lang.String theValue)

Set the node value.

Parameters:

theValue - the String-based value of the node.

getValue

java.lang.String getValue()

Get the node value.

Returns:

the text-based value of the element.

hasChildren

boolean hasChildren()

Return true if this node has child nodes.

Returns:

true if this node has children.

getChildrenCount

int getChildrenCount()

Get the number of child nodes.

Returns:

a count of the number of child nodes.

addChild

void addChild(Node childNode)

Add a child node to this node.

Parameters:

childNode - the node to add as a child node.

getChild

Element getChild(java.lang.String nodeName)

Get the first child node with the specified name.

Parameters:

nodeName - the name of the node to return.

Returns:

the first node with the specified name or null if none exist.

getChildren

java.util.Vector<Node> getChildren()

Get the child nodes of this node.

Returns:

the child nodes of this node.

removeChild

boolean removeChild(java.lang.String nodeName)

Remove the first child node with the specified name.

Parameters:

nodeName - the name of the node to remove.

Returns:

true if an node is removed or false otherwise.

addContent

void addContent(Node childNode)

Add the child node to this node.

Parameters:

childNode - the node to add as a child node.

addContent

void addContent(int position,
                Node childNode)

Add the child node to this node at the specified position.

Parameters:

position - the position at which to add the child node.

childNode - the node to add as a child node.

detach

Node detach()

Detach this node from its parent node.

Returns:

this node detached from its parent node.

clone

java.lang.Object clone()

Return a deep copy of this node, including copies of all sub-nodes.

Returns:

a deep copy of this node.