com.teamkonzept.dom4jb.dom
Class Element

java.lang.Object
  |
  +--com.teamkonzept.dom4jb.dom.NodeList
        |
        +--com.teamkonzept.dom4jb.dom.Node
              |
              +--com.teamkonzept.dom4jb.dom.NamedNode
                    |
                    +--com.teamkonzept.dom4jb.dom.Element

All Implemented Interfaces:

Element, Node, NodeList

Direct Known Subclasses:

Element

public class Element

extends NamedNode

implements Element

Field Summary

Fields inherited from class com.teamkonzept.dom4jb.dom.Node

document

Fields inherited from class com.teamkonzept.dom4jb.dom.NodeList

EMPTY, initialCapacity, nodeData, nodeIterator, parent, size

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Constructor Summary

Element(Document document, ElementDescriptor descriptor, Object bean)
Creates new Element

Element(Document document, String qualifiedName, Object bean)
Creates new Element

Method Summary

NodeList	_getChildNodes() A NodeList that contains all children of this node.
boolean	accept(Filter filter)
String	getAttribute(String qualifiedName) Retrieves an attribute value by name.
Attr	getAttributeNode(String qualifiedName) Retrieves an attribute node by name.
Attr	getAttributeNodeNS(String namespaceURI, String name) Retrieves an Attr node by local name and namespace URI.
String	getAttributeNS(String namespaceURI, String name) Retrieves an attribute value by local name and namespace URI.
NamedNodeMap	getAttributes() A NamedNodeMap containing the attributes of this node
NodeList	getChildNodes() A NodeList that contains all children of this node.
NodeList	getElementsByTagName(String qualName) Returns a NodeList of all descendant Elements with a given tag name, in the order in which they are encountered in a preorder traversal of this Element tree.
NodeList	getElementsByTagNameNS(String namespaceURI, String name) Returns a NodeList of all the descendant Elements with a given local name and namespace URI in the order in which they are encountered in a preorder traversal of this Element tree.
short	getNodeType() A code representing the type of the Element
String	getTagName() The name of the element.
boolean	hasAttribute(String qualifiedName) Returns true when an attribute with a given name is specified on this element or has a default value, false otherwise.
boolean	hasAttributeNS(String namespaceURI, String name) Returns true when an attribute with a given local name and namespace URI is specified on this element or has a default value, false otherwise.
void	removeAttribute(String name) Removes an attribute by name.
Attr	removeAttributeNode(Attr attr) Removes the specified attribute node.
void	removeAttributeNS(String namespaceURI, String localName) Removes an attribute by local name and namespace URI.
void	setAttribute(String name, String value) Adds a new attribute.
Attr	setAttributeNode(Attr attr) Adds a new attribute node.
Attr	setAttributeNodeNS(Attr attr) Adds a new attribute.
void	setAttributeNS(String namespaceURI, String qualifiedName, String value) Adds a new attribute.

Methods inherited from class com.teamkonzept.dom4jb.dom.NamedNode

getLocalName, getNamespaceURI, getNamingItem, getNodeName, getPrefix, setPrefix

Methods inherited from class com.teamkonzept.dom4jb.dom.Node

appendChild, attach, cloneNode, getChildIndex, getFirstChild, getLastChild, getNextSibling, getNodeValue, getOwnerDocument, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue

Methods inherited from class com.teamkonzept.dom4jb.dom.NodeList

add, clear, ensureCapacity, get, getLength, getParentNode, isEmpty, item, setIterator, setParentNode, size, trimToSize

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix

Constructor Detail

Element

public Element(Document document,
               ElementDescriptor descriptor,
               Object bean)

Creates new Element

Element

public Element(Document document,
               String qualifiedName,
               Object bean)

Creates new Element

Method Detail

getNodeType

public final short getNodeType()

A code representing the type of the Element

Specified by:

getNodeType in interface Node

Returns:

Node.ELEMENT_NODE

getTagName

public String getTagName()

The name of the element. For example, in:

 <elementExample
 id="demo"> ... </elementExample> , 

tagName has the value "elementExample". Note that this is case-preserving in XML, as are all of the operations of the DOM. The HTML DOM returns the tagName of an HTML element in the canonical uppercase form, regardless of the case in the source HTML document.

Specified by:

getTagName in interface Element

getElementsByTagName

public NodeList getElementsByTagName(String qualName)

Returns a NodeList of all descendant Elements with a given tag name, in the order in which they are encountered in a preorder traversal of this Element tree.

Specified by:

getElementsByTagName in interface Element

Returns:

A list of matching Element nodes.

getElementsByTagNameNS

public NodeList getElementsByTagNameNS(String namespaceURI,
                                       String name)

Returns a NodeList of all the descendant Elements with a given local name and namespace URI in the order in which they are encountered in a preorder traversal of this Element tree.
HTML-only DOM implementations do not need to implement this method.

Specified by:

getElementsByTagNameNS in interface Element

Parameters:

namespaceURI - The namespace URI of the elements to match on. The special value "*" matches all namespaces.

Returns:

A new NodeList object containing all the matched Elements.

Since:

DOM Level 2

getAttributes

public NamedNodeMap getAttributes()

A NamedNodeMap containing the attributes of this node

Specified by:

getAttributes in interface Node

Overrides:

getAttributes in class Node

getAttributeNS

public String getAttributeNS(String namespaceURI,
                             String name)

Retrieves an attribute value by local name and namespace URI. HTML-only DOM implementations do not need to implement this method.

Specified by:

getAttributeNS in interface Element

Parameters:

namespaceURI - The namespace URI of the attribute to retrieve.

name - The local name of the attribute to retrieve.

Returns:

The Attr value as a string, or the empty string if that attribute does not have a specified or default value.

Since:

DOM Level 2

getAttribute

public String getAttribute(String qualifiedName)

Retrieves an attribute value by name.

Specified by:

getAttribute in interface Element

Parameters:

qualifiedName - The name of the attribute to retrieve.

Returns:

The Attr value as a string, or the empty string if that attribute does not have a specified or default value.

getAttributeNodeNS

public Attr getAttributeNodeNS(String namespaceURI,
                               String name)

Retrieves an Attr node by local name and namespace URI. HTML-only DOM implementations do not need to implement this method.

Specified by:

getAttributeNodeNS in interface Element

Parameters:

namespaceURI - The namespace URI of the attribute to retrieve.

name - The local name of the attribute to retrieve.

Returns:

The Attr node with the specified attribute local name and namespace URI or null if there is no such attribute.

Since:

DOM Level 2

getAttributeNode

public Attr getAttributeNode(String qualifiedName)

Retrieves an attribute node by name.
To retrieve an attribute node by qualified name and namespace URI, use the getAttributeNodeNS method.

Specified by:

getAttributeNode in interface Element

Parameters:

qualifiedName - The name (nodeName) of the attribute to retrieve.

Returns:

The Attr node with the specified name ( nodeName) or null if there is no such attribute.

hasAttribute

public boolean hasAttribute(String qualifiedName)

Returns true when an attribute with a given name is specified on this element or has a default value, false otherwise.

Specified by:

hasAttribute in interface Element

Parameters:

qualifiedName - The name of the attribute to look for.

Returns:

true if an attribute with the given name is specified on this element or has a default value, false otherwise.

Since:

DOM Level 2

hasAttributeNS

public boolean hasAttributeNS(String namespaceURI,
                              String name)

Returns true when an attribute with a given local name and namespace URI is specified on this element or has a default value, false otherwise. HTML-only DOM implementations do not need to implement this method.

Specified by:

hasAttributeNS in interface Element

Parameters:

namespaceURI - The namespace URI of the attribute to look for.

name - The local name of the attribute to look for.

Returns:

true if an attribute with the given local name and namespace URI is specified or has a default value on this element, false otherwise.

Since:

DOM Level 2

removeAttributeNode

public Attr removeAttributeNode(Attr attr)

Removes the specified attribute node. If the removed Attr has a default value it is immediately replaced. The replacing attribute has the same namespace URI and local name, as well as the original prefix, when applicable.

Specified by:

removeAttributeNode in interface Element

Parameters:

attr - The Attr node to remove from the attribute list.

Returns:

The Attr node that was removed.

removeAttributeNS

public void removeAttributeNS(String namespaceURI,
                              String localName)

Removes an attribute by local name and namespace URI. If the removed attribute has a default value it is immediately replaced. The replacing attribute has the same namespace URI and local name, as well as the original prefix.
HTML-only DOM implementations do not need to implement this method.

Specified by:

removeAttributeNS in interface Element

Parameters:

namespaceURI - The namespace URI of the attribute to remove.

localName - The local name of the attribute to remove.

Since:

DOM Level 2

removeAttribute

public void removeAttribute(String name)

Removes an attribute by name. If the removed attribute is known to have a default value, an attribute immediately appears containing the default value as well as the corresponding namespace URI, local name, and prefix when applicable.
To remove an attribute by local name and namespace URI, use the removeAttributeNS method.

Specified by:

removeAttribute in interface Element

Parameters:

name - The name of the attribute to remove.

_getChildNodes

public final NodeList _getChildNodes()

A NodeList that contains all children of this node. If there are no children, this is a NodeList containing no nodes.

getChildNodes

public NodeList getChildNodes()

A NodeList that contains all children of this node. If there are no children, this is a NodeList containing no nodes.

Specified by:

getChildNodes in interface Node

Overrides:

getChildNodes in class Node

setAttribute

public void setAttribute(String name,
                         String value)

Adds a new attribute. If an attribute with that name is already present in the element, its value is changed to be that of the value parameter. This value is a simple string; it is not parsed as it is being set. So any markup (such as syntax to be recognized as an entity reference) is treated as literal text, and needs to be appropriately escaped by the implementation when it is written out. In order to assign an attribute value that contains entity references, the user must create an Attr node plus any Text and EntityReference nodes, build the appropriate subtree, and use setAttributeNode to assign it as the value of an attribute.
To set an attribute with a qualified name and namespace URI, use the setAttributeNS method.

Specified by:

setAttribute in interface Element

Parameters:

name - The name of the attribute to create or alter.

value - Value to set in string form.

setAttributeNode

public Attr setAttributeNode(Attr attr)

Adds a new attribute node. If an attribute with that name ( nodeName) is already present in the element, it is replaced by the new one.
To add a new attribute node with a qualified name and namespace URI, use the setAttributeNodeNS method.

Specified by:

setAttributeNode in interface Element

Parameters:

attr - The Attr node to add to the attribute list.

Returns:

If the newAttr attribute replaces an existing attribute, the replaced Attr node is returned, otherwise null is returned.

setAttributeNodeNS

public Attr setAttributeNodeNS(Attr attr)

Adds a new attribute. If an attribute with that local name and that namespace URI is already present in the element, it is replaced by the new one.
HTML-only DOM implementations do not need to implement this method.

Specified by:

setAttributeNodeNS in interface Element

Parameters:

attr - The Attr node to add to the attribute list.

Returns:

If the newAttr attribute replaces an existing attribute with the same local name and namespace URI, the replaced Attr node is returned, otherwise null is returned.

Since:

DOM Level 2

setAttributeNS

public void setAttributeNS(String namespaceURI,
                           String qualifiedName,
                           String value)

Adds a new attribute. If an attribute with the same local name and namespace URI is already present on the element, its prefix is changed to be the prefix part of the qualifiedName, and its value is changed to be the value parameter. This value is a simple string; it is not parsed as it is being set. So any markup (such as syntax to be recognized as an entity reference) is treated as literal text, and needs to be appropriately escaped by the implementation when it is written out. In order to assign an attribute value that contains entity references, the user must create an Attr node plus any Text and EntityReference nodes, build the appropriate subtree, and use setAttributeNodeNS or setAttributeNode to assign it as the value of an attribute.
HTML-only DOM implementations do not need to implement this method.

Specified by:

setAttributeNS in interface Element

Parameters:

namespaceURI - The namespace URI of the attribute to create or alter.

qualifiedName - The qualified name of the attribute to create or alter.

value - The value to set in string form.

Since:

DOM Level 2

accept

public boolean accept(Filter filter)

Specified by:

accept in class Node

See Also:

Node.accept(Filter)