com.icl.saxon.tree

Class ElementWithAttributes

public class ElementWithAttributes extends ElementImpl implements Element, NamedNodeMap

A node in the XML parse tree representing an XML element.

This class is an implementation of NodeInfo

Version: 8 August 2000: separated from ElementImpl

Author: Michael H. Kay

Field Summary
protected AttributeCollectionattributeList
protected int[]namespaceList
Method Summary
voidaddNamespaceNodes(ElementImpl owner, Vector list, boolean addXML)
Make the set of all namespace nodes associated with this element.
voidcopy(Outputter out, boolean allNamespaces)
Copy this node to a given outputter (supporting xsl:copy-of)
StringgetAttribute(String name)
Retrieves an attribute value by name.
AttributeCollectiongetAttributeList()
Get the attribute list for this element.
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.
NamedNodeMapgetAttributes()
A NamedNodeMap containing the attributes of this element.
StringgetAttributeValue(String uri, String localName)
Find the value of a given attribute of this node.
StringgetAttributeValue(String name)
Find the value of a given attribute of this element.
StringgetAttributeValue(int fingerprint)
Get the value of a given attribute of this node
intgetLength()
Get number of attributes (DOM NamedNodeMap method).
NodegetNamedItem(String name)
Get named attribute (DOM NamedNodeMap method) Treats namespace declarations as attributes.
NodegetNamedItemNS(String uri, String localName)
Get named attribute (DOM NamedNodeMap method) Treats namespace declarations as attributes.
protected int[]getNamespaceCodes()
Get the list of in-scope namespaces for this element as an array of namespace codes.
StringgetPrefixForURI(String uri)
Search the NamespaceList for a given URI, returning the corresponding prefix.
shortgetURICodeForPrefix(String prefix)
Search the NamespaceList for a given prefix, returning the corresponding URI.
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.
booleanhasAttributes()
Returns whether this node (if it is an element) has any attributes.
voidinitialise(int nameCode, AttributeCollection atts, NodeInfo parent, String baseURI, int lineNumber, int sequenceNumber)
Initialise a new ElementWithAttributes with an element name and attribute list
Nodeitem(int index)
Get n'th attribute (DOM NamedNodeMap method).
voidoutputNamespaceNodes(Outputter out, boolean includeAncestors)
Output all namespace nodes associated with this element.
voidremoveAttribute(String name)
Removes an attribute by name.
AttrremoveAttributeNode(Attr oldAttr)
Removes the specified attribute node.
voidremoveAttributeNS(String namespaceURI, String localName)
Removes an attribute by local name and namespace URI.
NoderemoveNamedItem(String name)
Remove named attribute (DOM NamedNodeMap method: always fails)
NoderemoveNamedItemNS(String uri, String localName)
Remove named attribute (DOM NamedNodeMap method: always fails)
voidsetAttribute(String name, String value)
Set the value of an attribute on the current element.
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.
NodesetNamedItem(Node arg)
Set named attribute (DOM NamedNodeMap method: always fails)
NodesetNamedItemNS(Node arg)
Set named attribute (DOM NamedNodeMap method: always fails)
voidsetNamespaceDeclarations(int[] namespaces, int namespacesUsed)
Set the namespace declarations for the element

Field Detail

attributeList

protected AttributeCollection attributeList

namespaceList

protected int[] namespaceList

Method Detail

addNamespaceNodes

public void addNamespaceNodes(ElementImpl owner, Vector list, boolean addXML)
Make the set of all namespace nodes associated with this element.

Parameters: owner The element owning these namespace nodes. list a Vector containing NamespaceImpl objects representing the namespaces in scope for this element; the method appends nodes to this Vector, which should initially be empty. Note that the returned list will never contain the XML namespace (to get this, the NamespaceEnumeration class adds it itself). The list WILL include an entry for the undeclaration xmlns=""; again it is the job of NamespaceEnumeration to ignore this, since it doesn't represent a true namespace node. addXML Add a namespace node for the XML namespace

copy

public void copy(Outputter out, boolean allNamespaces)
Copy this node to a given outputter (supporting xsl:copy-of)

Parameters: out The outputter allNamespaces true if namespaces for ancestor nodes must be output

getAttribute

public String getAttribute(String name)
Retrieves an attribute value by name. Namespace declarations are not returned.

Parameters: name 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. (Note the difference from getAttributeValue(), which returns null if there is no value).

getAttributeList

public AttributeCollection getAttributeList()
Get the attribute list for this element.

Returns: The attribute list. This will not include any namespace attributes. The attribute names will be in expanded form, with prefixes replaced by URIs

getAttributeNode

public Attr getAttributeNode(String name)
Retrieves an attribute node by name. Namespace declarations are not returned.
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. DOM method, so namespace declarations count 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. HTML-only DOM implementations do not need to implement this method.

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

getAttributes

public NamedNodeMap getAttributes()
A NamedNodeMap containing the attributes of this element. This is a DOM method, so the list of attributes includes namespace declarations.

getAttributeValue

public String getAttributeValue(String uri, String localName)
Find the value of a given attribute of this node.
This method is defined on all nodes to meet XSL requirements, but for nodes other than elements it will always return null.

Parameters: uri the namespace uri of an attribute localName the local name of an attribute

Returns: the value of the attribute, if it exists, otherwise null

getAttributeValue

public String getAttributeValue(String name)
Find the value of a given attribute of this element.
This is a short-cut method; the full capability to examine attributes is offered via the getAttributeList() method.
The attribute may either be one that was present in the original XML document, or one that has been set by the application using setAttribute().

Parameters: name the name of an attribute. There must be no prefix in the name.

Returns: the value of the attribute, if it exists, otherwise null

getAttributeValue

public String getAttributeValue(int fingerprint)
Get the value of a given attribute of this node

Parameters: fingerprint The fingerprint of the attribute name

Returns: the attribute value if it exists or null if not

getLength

public int getLength()
Get number of attributes (DOM NamedNodeMap method). Treats namespace declarations as attributes.

getNamedItem

public Node getNamedItem(String name)
Get named attribute (DOM NamedNodeMap method) Treats namespace declarations as attributes.

getNamedItemNS

public Node getNamedItemNS(String uri, String localName)
Get named attribute (DOM NamedNodeMap method) Treats namespace declarations as attributes.

getNamespaceCodes

protected int[] getNamespaceCodes()
Get the list of in-scope namespaces for this element as an array of namespace codes. (Used by LiteralResultElement)

getPrefixForURI

public String getPrefixForURI(String uri)
Search the NamespaceList for a given URI, returning the corresponding prefix.

Parameters: uri The URI to be matched.

Returns: The prefix corresponding to this URI. If not found, return null. If there is more than one prefix matching the URI, the first one found is returned. If the URI matches the default namespace, return an empty string.

getURICodeForPrefix

public short getURICodeForPrefix(String prefix)
Search the NamespaceList for a given prefix, returning the corresponding URI.

Parameters: prefix The prefix to be matched. To find the default namespace, supply ""

Returns: The URI code corresponding to this namespace. If it is an unnamed default namespace, return Namespace.NULL_CODE.

Throws: NamespaceException if the prefix has not been declared on this NamespaceList.

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. Namespace declarations are not included.

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 is a DOM method so namespace declarations are treated 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

hasAttributes

public boolean hasAttributes()
Returns whether this node (if it is an element) has any attributes.

Returns: true if this node has any attributes, false otherwise.

Since: DOM Level 2

initialise

public void initialise(int nameCode, AttributeCollection atts, NodeInfo parent, String baseURI, int lineNumber, int sequenceNumber)
Initialise a new ElementWithAttributes with an element name and attribute list

Parameters: name The element name, with namespaces resolved atts The attribute list, after namespace processing parent The parent node

item

public Node item(int index)
Get n'th attribute (DOM NamedNodeMap method). Namespace declarations are not returned.

outputNamespaceNodes

public void outputNamespaceNodes(Outputter out, boolean includeAncestors)
Output all namespace nodes associated with this element.

Parameters: out The relevant outputter

removeAttribute

public void removeAttribute(String name)
Removes an attribute by name.

Parameters: name The name of the attribute to remove.

removeAttributeNode

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

Throws: 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: DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

Since: DOM Level 2

removeNamedItem

public Node removeNamedItem(String name)
Remove named attribute (DOM NamedNodeMap method: always fails)

removeNamedItemNS

public Node removeNamedItemNS(String uri, String localName)
Remove named attribute (DOM NamedNodeMap method: always fails)

setAttribute

public void setAttribute(String name, String value)
Set the value of an attribute on the current element. This affects subsequent calls of getAttribute() for that element.

Parameters: name The name of the attribute to be set. Any prefix is interpreted relative to the namespaces defined for this element. value The new value of the attribute. Set this to null to remove the attribute.

Throws: DOMException (always): Saxon trees are immutable.

setAttributeNode

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

Throws: 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: 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: DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

setNamedItem

public Node setNamedItem(Node arg)
Set named attribute (DOM NamedNodeMap method: always fails)

setNamedItemNS

public Node setNamedItemNS(Node arg)
Set named attribute (DOM NamedNodeMap method: always fails)

setNamespaceDeclarations

public void setNamespaceDeclarations(int[] namespaces, int namespacesUsed)
Set the namespace declarations for the element