net.jxta.impl.document
Class DOMXMLElement

java.lang.Object
  net.jxta.impl.document.DOMXMLElement

All Implemented Interfaces:

Attributable, Element<DOMXMLElement>, TextElement<DOMXMLElement>, XMLElement<DOMXMLElement>

Direct Known Subclasses:

DOMXMLDocument

public class DOMXMLElement
extends Object
implements XMLElement<DOMXMLElement>

This class represent an element of an XML document. XML Documents are formed as a hierarchy of elements. Each element provides a proxy for DOM elements and the text nodes containing values.

root

protected DOMXMLDocument root

domNode

protected Node domNode

The DOM node for which this element is a proxy.

DOMXMLElement

protected DOMXMLElement(DOMXMLDocument root,
                        Node node)

Constructor for associating a DOM node with a StructuredDocument Element.

Parameters:

root - the DOM not which is to be associated with this element.

node - the DOM node

getKey

public String getKey()

Get the name associated with an element.

Specified by:

getKey in interface Element<DOMXMLElement>

Specified by:

getKey in interface TextElement<DOMXMLElement>

Returns:

A string containing the key of this element.

getValue

public String getValue()

Get the value (if any) associated with an element.

Specified by:

getValue in interface Element<DOMXMLElement>

Specified by:

getValue in interface TextElement<DOMXMLElement>

Returns:

A string containing the value of this element, if any, otherwise null.

getName

public String getName()

Get the name associated with an element.

Specified by:

getName in interface TextElement<DOMXMLElement>

Returns:

A string containing the name of this element.

getTextValue

public String getTextValue()

Get the value (if any) associated with an element.

Specified by:

getTextValue in interface TextElement<DOMXMLElement>

Returns:

A string containing the value of this element, if any, otherwise null.

getRoot

public DOMXMLDocument getRoot()

Get the root element of the hierarchy this element belongs to.

Specified by:

getRoot in interface Element<DOMXMLElement>

Specified by:

getRoot in interface TextElement<DOMXMLElement>

Specified by:

getRoot in interface XMLElement<DOMXMLElement>

Returns:

StructuredDocument root of this element's hierarchy.

getParent

public DOMXMLElement getParent()

Get the parent of this element. If the element has not been inserted into the Document then null is returned. If this element is the root of the Document then it returns itself.

Specified by:

getParent in interface Element<DOMXMLElement>

Returns:

The parent of this element. If the element has no parent then null will be returned. If the element is the root Element of the hierarchy then it will return itself.

appendChild

public void appendChild(DOMXMLElement element)

Add a child element to this element

Specified by:

appendChild in interface Element<DOMXMLElement>

Parameters:

element - the element to be added as a child

getChildren

public Enumeration<DOMXMLElement> getChildren()

Returns an enumeration of the immediate children of this element

Specified by:

getChildren in interface Element<DOMXMLElement>

Returns:

An enumeration containing all of the children of this element.

getChildren

public Enumeration<DOMXMLElement> getChildren(Object key)

Returns an enumeration of the immediate children of this element whose name match the specified string.

Specified by:

getChildren in interface Element<DOMXMLElement>

Parameters:

key - The key which will be matched against.

Returns:

enumeration containing all of the children of this element.

getChildren

public Enumeration<DOMXMLElement> getChildren(String name)

Returns an enumeration of the immediate children of this element whose name match the specified string.

Specified by:

getChildren in interface TextElement<DOMXMLElement>

Parameters:

name - The name which will be matched against.

Returns:

An enumeration containing all of the children of this element.

equals

public boolean equals(Object element)

Tests two elements for equality. For the XML document the definition of equality is:

• the item compared against must be an XML Element.
• The items must belong to the same document.
• The items must have the same name.
• The items must have the save textual value.

Overrides:

equals in class Object

Parameters:

element - the element to be compared against.

Returns:

true if the elements are equal

getAssocNode

protected Node getAssocNode()

Returns the DOM Node associated with this StructuredDocument element.

Returns:

Node The DOM Node associated with this StructuredDocument element.

addAttribute

public String addAttribute(String name,
                           String value)

Adds an attribute with the given name and value. Some implementations may support only a single value for each distinct name. Others may support multiple values for each name. If the value being provided replaces some other value then that value is returned otherwise null is returned.

Specified by:

addAttribute in interface Attributable

Parameters:

name - name of the attribute.

value - value for the attribute.

Returns:

String containing previous value for this name if the value is being replaced otherwise null.

addAttribute

public String addAttribute(Attribute newAttrib)

Adds an attribute with the given name and value. Some implementations may support only a single value for each distinct name. Others may support multiple values for each name. If the value being provided replaces some other value then that value is returned otherwise null is returned.

Specified by:

addAttribute in interface Attributable

Parameters:

newAttrib - new attribute.

Returns:

String containing previous value for this name if the value is being replaced otherwise null.

getAttributes

public Enumeration<Attribute> getAttributes()

Returns an enumerations of the attributes assosicated with this object. Each element is of type Attribute.

Specified by:

getAttributes in interface Attributable

Returns:

Enumeration the attributes associated with this object.

getAttribute

public Attribute getAttribute(String name)

returns a single attribute which matches the name provided. If no such named attribute exists then null is returned. For impelementations of this interface which support multiple values for each name only the first value will be returned. To access all values for a name you must use getAttributes.

Specified by:

getAttribute in interface Attributable

Parameters:

name - the attribute name

Returns:

Attribute the attributes matching the given name.