net.sf.saxon.dom

Class ElementOverNodeInfo

public class ElementOverNodeInfo extends NodeOverNodeInfo implements Element

This class is an implementation of the DOM Element class that wraps a Saxon NodeInfo representation of an element node.

The class provides read-only access to the tree; methods that request updates all fail with an UnsupportedOperationException.

Note that contrary to the DOM specification, this implementation does not expose namespace declarations as attributes.

Method Summary
StringgetAttribute(String name)
Retrieves an attribute value by name.
AttrgetAttributeNode(String name)
Retrieves an attribute node by name.
AttrgetAttributeNodeNS(String namespaceURI, String localName)
Retrieves an Attr node by local name and namespace URI.
StringgetAttributeNS(String namespaceURI, String localName)
Retrieves an attribute value by local name and namespace URI.
NodeListgetElementsByTagName(String name)
Returns a NodeList of all descendant Elements with a given tag name, in document order.
NodeListgetElementsByTagNameNS(String namespaceURI, String localName)
Returns a NodeList of all the descendant Elements with a given local name and namespace URI in document order.
TypeInfogetSchemaTypeInfo()
Get the schema type information for this node.
StringgetTagName()
The name of the element (DOM interface).
booleanhasAttribute(String name)
Returns true when an attribute with a given name is specified on this element or has a default value, false otherwise.
booleanhasAttributeNS(String namespaceURI, String localName)
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.
voidremoveAttribute(String oldAttr)
Removes the specified attribute.
AttrremoveAttributeNode(Attr oldAttr)
Removes the specified attribute node.
voidremoveAttributeNS(String namespaceURI, String localName)
Removes an attribute by local name and namespace URI.
voidsetAttribute(String name, String value)
Adds a new attribute.
AttrsetAttributeNode(Attr newAttr)
Adds a new attribute node.
AttrsetAttributeNodeNS(Attr newAttr)
Add a new attribute.
voidsetAttributeNS(String namespaceURI, String qualifiedName, String value)
Adds a new attribute.
voidsetIdAttribute(String name, boolean isId)
Mark an attribute as an ID.
voidsetIdAttributeNode(Attr idAttr, boolean isId)
Mark an attribute as an ID.
voidsetIdAttributeNS(String namespaceURI, String localName, boolean isId)
Mark an attribute as an ID.

Method Detail

getAttribute

public String getAttribute(String name)
Retrieves an attribute value by name. This implementation does not expose namespace nodes as attributes.

Parameters: name The QName 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.

getAttributeNode

public Attr getAttributeNode(String name)
Retrieves an attribute node by name. This implementation does not expose namespace nodes as attributes.
To retrieve an attribute node by qualified name and namespace URI, use the getAttributeNodeNS method.

Parameters: name 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.

getAttributeNodeNS

public Attr getAttributeNodeNS(String namespaceURI, String localName)
Retrieves an Attr node by local name and namespace URI. This implementation does not expose namespace nodes as attributes.

Parameters: namespaceURI The namespace URI of the attribute to retrieve. localName 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

getAttributeNS

public String getAttributeNS(String namespaceURI, String localName)
Retrieves an attribute value by local name and namespace URI. This implementation does not expose namespace nodes as attributes.

Parameters: namespaceURI The namespace URI of the attribute to retrieve. localName 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

getElementsByTagName

public NodeList getElementsByTagName(String name)
Returns a NodeList of all descendant Elements with a given tag name, in document order.

Parameters: name The name of the tag to match on. The special value "*" matches all tags.

Returns: A list of matching Element nodes.

getElementsByTagNameNS

public NodeList getElementsByTagNameNS(String namespaceURI, String localName)
Returns a NodeList of all the descendant Elements with a given local name and namespace URI in document order.

Parameters: namespaceURI The namespace URI of the elements to match on. The special value "*" matches all namespaces. localName The local name of the elements to match on. The special value "*" matches all local names.

Returns: A new NodeList object containing all the matched Elements.

Throws: org.w3c.dom.DOMException NOT_SUPPORTED_ERR: May be raised if the implementation does not support the feature "XML" and the language exposed through the Document does not support XML Namespaces (such as [HTML 4.01]).

Since: DOM Level 2

getSchemaTypeInfo

public TypeInfo getSchemaTypeInfo()
Get the schema type information for this node.

Returns: the type information. Returns null for an untyped node.

getTagName

public String getTagName()
The name of the element (DOM interface).

hasAttribute

public boolean hasAttribute(String name)
Returns true when an attribute with a given name is specified on this element or has a default value, false otherwise. This implementation does not expose namespace nodes as attributes.

Parameters: name 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 localName)
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. This implementation does not expose namespace nodes as attributes.

Parameters: namespaceURI The namespace URI of the attribute to look for. localName 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

removeAttribute

public void removeAttribute(String oldAttr)
Removes the specified attribute. Always fails

Throws: org.w3c.dom.DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

removeAttributeNode

public Attr removeAttributeNode(Attr oldAttr)
Removes the specified attribute node. Always fails

Throws: org.w3c.dom.DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

removeAttributeNS

public void removeAttributeNS(String namespaceURI, String localName)
Removes an attribute by local name and namespace URI. Always fails

Throws: org.w3c.dom.DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

Since: DOM Level 2

setAttribute

public void setAttribute(String name, String value)
Adds a new attribute. Always fails

Parameters: name The name of the attribute to create or alter. value Value to set in string form.

Throws: org.w3c.dom.DOMException INVALID_CHARACTER_ERR: Raised if the specified name is not an XML name according to the XML version in use specified in the Document.xmlVersion attribute.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

setAttributeNode

public Attr setAttributeNode(Attr newAttr)
Adds a new attribute node. Always fails

Throws: org.w3c.dom.DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

setAttributeNodeNS

public Attr setAttributeNodeNS(Attr newAttr)
Add a new attribute. Always fails.

Parameters: newAttr 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.

Throws: org.w3c.dom.DOMException
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

Since: DOM Level 2

setAttributeNS

public void setAttributeNS(String namespaceURI, String qualifiedName, String value)
Adds a new attribute. Always fails.

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.

Throws: org.w3c.dom.DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

setIdAttribute

public void setIdAttribute(String name, boolean isId)
Mark an attribute as an ID. Always fails.

Throws: DOMException

setIdAttributeNode

public void setIdAttributeNode(Attr idAttr, boolean isId)
Mark an attribute as an ID. Always fails.

Throws: DOMException

setIdAttributeNS

public void setIdAttributeNS(String namespaceURI, String localName, boolean isId)
Mark an attribute as an ID. Always fails.

Throws: DOMException