org.licas_xml.abs

Interface Element

All Superinterfaces:

Node, java.io.Serializable

All Known Implementing Classes:

ElementImpl

public interface Element
extends Node

This interface defines the additional methods that need to be impkemented by an Element.

Author:

Kieran Greer

Method Summary

Modifier and Type	Method and Description
void	addContent(Element 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.
java.util.List<Attribute>	getAttributeList() Get the list of attributes of this element.
java.lang.String	getAttributeValue(java.lang.String attrName) Get the value of the specified attribute.
Element	getElementChildAtIndex(int index) Returns the child at a specific index.
java.lang.String	getText() Get the text value of the element.
void	removeAttribute(java.lang.String attrName) Remove the attribute with the specified name.
void	setAttribute(java.lang.String attrName, java.lang.String attrValue) Add a new attribute and set its value.
void	setText(java.lang.String theText) Set the text value of the element.

Methods inherited from interface org.licas_xml.abs.Node

addChild, addContent, addContent, detach, getChild, getChildren, getChildrenCount, getName, getValue, hasChildren, removeChild, setName, setValue

Method Detail

setAttribute

void setAttribute(java.lang.String attrName,
                  java.lang.String attrValue)

Add a new attribute and set its value.

Parameters:

attrName - the name of the attribute.

attrValue - the attribute value.

getAttributeList

java.util.List<Attribute> getAttributeList()

Get the list of attributes of this element.

Returns:

a list of all attributes. Of type Attribute.

getAttributeValue

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

Get the value of the specified attribute.

Parameters:

attrName - the attribute name.

Returns:

the value of the attribute with the specified name.

removeAttribute

void removeAttribute(java.lang.String attrName)

Remove the attribute with the specified name.

Parameters:

attrName - the attribute name.

setText

void setText(java.lang.String theText)

Set the text value of the element.

Parameters:

theText - the value of a text element.

getText

java.lang.String getText()

Get the text value of the element.

Returns:

the text-based value of this element.

getElementChildAtIndex

Element getElementChildAtIndex(int index)
                        throws java.lang.Exception

Returns the child at a specific index.

Parameters:

index - the index of the child

Returns:

the non-null child

Throws:

java.lang.Exception - any error.

addContent

void addContent(Element childNode)

Add the child node to this node.

Parameters:

childNode - the node to add as a child node.

clone

java.lang.Object clone()

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

Specified by:

clone in interface Node

Returns:

a deep copy of this node.