com.icl.saxon.tree
Class ElementWithAttributes

java.lang.Object
  |
  +--com.icl.saxon.om.AbstractNode
        |
        +--com.icl.saxon.tree.NodeImpl
              |
              +--com.icl.saxon.tree.ParentNodeImpl
                    |
                    +--com.icl.saxon.tree.ElementImpl
                          |
                          +--com.icl.saxon.tree.ElementWithAttributes

All Implemented Interfaces:

DOMLocator, Element, NamedNodeMap, Node, NodeInfo, Source, SourceLocator

Direct Known Subclasses:

StyleElement

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:

Field Summary

protected AttributeCollection	attributeList
protected int[]	namespaceList

Fields inherited from class com.icl.saxon.tree.ElementImpl

nameCode, root, sequence

Fields inherited from class com.icl.saxon.tree.NodeImpl

emptyArray, index, parent

Fields inherited from class com.icl.saxon.om.AbstractNode

NODE_LETTER

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

Fields inherited from interface com.icl.saxon.om.NodeInfo

ATTRIBUTE, COMMENT, ELEMENT, NAMESPACE, NODE, NONE, NUMBER_OF_TYPES, PI, ROOT, TEXT

Constructor Summary

ElementWithAttributes()

Method Summary

void	addNamespaceNodes(ElementImpl owner, java.util.Vector list, boolean addXML) Make the set of all namespace nodes associated with this element.
void	copy(Outputter out, boolean allNamespaces) Copy this node to a given outputter (supporting xsl:copy-of)
java.lang.String	getAttribute(java.lang.String name) Retrieves an attribute value by name.
AttributeCollection	getAttributeList() Get the attribute list for this element.
Attr	getAttributeNode(java.lang.String name) Retrieves an attribute node by name.
Attr	getAttributeNodeNS(java.lang.String namespaceURI, java.lang.String localName) Retrieves an Attr node by local name and namespace URI.
java.lang.String	getAttributeNS(java.lang.String namespaceURI, java.lang.String localName) Retrieves an attribute value by local name and namespace URI.
NamedNodeMap	getAttributes() A NamedNodeMap containing the attributes of this element.
java.lang.String	getAttributeValue(int fingerprint) Get the value of a given attribute of this node
java.lang.String	getAttributeValue(java.lang.String name) Find the value of a given attribute of this element.
java.lang.String	getAttributeValue(java.lang.String uri, java.lang.String localName) Find the value of a given attribute of this node.
int	getLength() Get number of attributes (DOM NamedNodeMap method).
Node	getNamedItem(java.lang.String name) Get named attribute (DOM NamedNodeMap method) Treats namespace declarations as attributes.
Node	getNamedItemNS(java.lang.String uri, java.lang.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.
java.lang.String	getPrefixForURI(java.lang.String uri) Search the NamespaceList for a given URI, returning the corresponding prefix.
short	getURICodeForPrefix(java.lang.String prefix) Search the NamespaceList for a given prefix, returning the corresponding URI.
boolean	hasAttribute(java.lang.String name) Returns true when an attribute with a given name is specified on this element or has a default value, false otherwise.
boolean	hasAttributeNS(java.lang.String namespaceURI, java.lang.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.
boolean	hasAttributes() Returns whether this node (if it is an element) has any attributes.
void	initialise(int nameCode, AttributeCollection atts, NodeInfo parent, java.lang.String baseURI, int lineNumber, int sequenceNumber) Initialise a new ElementWithAttributes with an element name and attribute list
Node	item(int index) Get n'th attribute (DOM NamedNodeMap method).
void	outputNamespaceNodes(Outputter out, boolean includeAncestors) Output all namespace nodes associated with this element.
void	removeAttribute(java.lang.String name) Removes an attribute by name.
Attr	removeAttributeNode(Attr oldAttr) Removes the specified attribute node.
void	removeAttributeNS(java.lang.String namespaceURI, java.lang.String localName) Removes an attribute by local name and namespace URI.
Node	removeNamedItem(java.lang.String name) Remove named attribute (DOM NamedNodeMap method: always fails)
Node	removeNamedItemNS(java.lang.String uri, java.lang.String localName) Remove named attribute (DOM NamedNodeMap method: always fails)
void	setAttribute(java.lang.String name, java.lang.String value) Set the value of an attribute on the current element.
Attr	setAttributeNode(Attr newAttr) Adds a new attribute node.
Attr	setAttributeNodeNS(Attr newAttr) Add a new attribute.
void	setAttributeNS(java.lang.String namespaceURI, java.lang.String qualifiedName, java.lang.String value) Adds a new attribute.
Node	setNamedItem(Node arg) Set named attribute (DOM NamedNodeMap method: always fails)
Node	setNamedItemNS(Node arg) Set named attribute (DOM NamedNodeMap method: always fails)
void	setNamespaceDeclarations(int[] namespaces, int namespacesUsed) Set the namespace declarations for the element

Methods inherited from class com.icl.saxon.tree.ElementImpl

addChild, compact, copy, copyStringValue, dropChildren, enumerateChildren, generateId, getBaseURI, getChildNodes, getDocumentRoot, getFirstChild, getLastChild, getLineNumber, getNameCode, getNodeType, getNodeValue, getNthChild, getSequenceNumber, getStringValue, getSystemId, hasChildNodes, makeNameCode, removeChild, renumberChildren, setLineNumber, setNameCode, setSystemId, useChildrenArray

Methods inherited from class com.icl.saxon.tree.NodeImpl

compareOrder, getDisplayName, getDocumentElement, getEnumeration, getFingerprint, getLocalName, getNamePool, getNextInDocument, getNextSibling, getOriginatingNode, getParent, getPrefix, getPreviousInDocument, getPreviousSibling, getURI, isSameNode, removeNode

Methods inherited from class com.icl.saxon.om.AbstractNode

appendChild, appendData, cloneNode, createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createProcessingInstruction, createTextNode, deleteData, disallowUpdate, getColumnNumber, getData, getDoctype, getElementById, getElementsByTagName, getElementsByTagNameNS, getImplementation, getName, getNamespaceURI, getNodeName, getOwnerDocument, getOwnerElement, getParentNode, getPublicId, getSpecified, getTagName, getValue, importNode, insertBefore, insertData, isSupported, normalize, removeChild, replaceChild, replaceData, setData, setNodeValue, setPrefix, setValue, splitText, substringData, supports

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.Element

getElementsByTagName, getElementsByTagNameNS, getTagName

Methods inherited from interface org.w3c.dom.Node

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

Field Detail

attributeList

protected AttributeCollection attributeList

namespaceList

protected int[] namespaceList

Constructor Detail

ElementWithAttributes

public ElementWithAttributes()

Method Detail

initialise

public void initialise(int nameCode,
                       AttributeCollection atts,
                       NodeInfo parent,
                       java.lang.String baseURI,
                       int lineNumber,
                       int sequenceNumber)

Initialise a new ElementWithAttributes with an element name and attribute list

Overrides:

initialise in class ElementImpl

Parameters:

atts - The attribute list, after namespace processing

parent - The parent node

setNamespaceDeclarations

public void setNamespaceDeclarations(int[] namespaces,
                                     int namespacesUsed)

Set the namespace declarations for the element

getURICodeForPrefix

public short getURICodeForPrefix(java.lang.String prefix)
                          throws NamespaceException

Search the NamespaceList for a given prefix, returning the corresponding URI.

Overrides:

getURICodeForPrefix in class ElementImpl

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.

getPrefixForURI

public java.lang.String getPrefixForURI(java.lang.String uri)

Search the NamespaceList for a given URI, returning the corresponding prefix.

Overrides:

getPrefixForURI in class ElementImpl

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.

addNamespaceNodes

public void addNamespaceNodes(ElementImpl owner,
                              java.util.Vector list,
                              boolean addXML)

Make the set of all namespace nodes associated with this element.

Overrides:

addNamespaceNodes in class ElementImpl

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

outputNamespaceNodes

public void outputNamespaceNodes(Outputter out,
                                 boolean includeAncestors)
                          throws TransformerException

Output all namespace nodes associated with this element.

Specified by:

outputNamespaceNodes in interface NodeInfo

Overrides:

outputNamespaceNodes in class ElementImpl

Parameters:

out - The relevant outputter

TransformerException

getNamespaceCodes

protected int[] getNamespaceCodes()

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

getAttributeList

public AttributeCollection getAttributeList()

Get the attribute list for this element.

Overrides:

getAttributeList in class ElementImpl

Returns:

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

hasAttributes

public boolean hasAttributes()

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

Specified by:

hasAttributes in interface Node

Overrides:

hasAttributes in class NodeImpl

Returns:

true if this node has any attributes, false otherwise.

Since:

DOM Level 2

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String uri,
                                          java.lang.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.

Specified by:

getAttributeValue in interface NodeInfo

Overrides:

getAttributeValue in class NodeImpl

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 java.lang.String getAttributeValue(java.lang.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().

Overrides:

getAttributeValue in class ElementImpl

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 java.lang.String getAttributeValue(int fingerprint)

Get the value of a given attribute of this node

Specified by:

getAttributeValue in interface NodeInfo

Overrides:

getAttributeValue in class NodeImpl

Parameters:

fingerprint - The fingerprint of the attribute name

Returns:

the attribute value if it exists or null if not

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.String value)
                  throws DOMException

Set the value of an attribute on the current element. This affects subsequent calls of getAttribute() for that element.

Specified by:

setAttribute in interface Element

Overrides:

setAttribute in class ElementImpl

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.

copy

public void copy(Outputter out,
                 boolean allNamespaces)
          throws TransformerException

Copy this node to a given outputter (supporting xsl:copy-of)

Overrides:

copy in class ElementImpl

Parameters:

out - The outputter

allNamespaces - true if namespaces for ancestor nodes must be output

TransformerException

getAttribute

public java.lang.String getAttribute(java.lang.String name)

Retrieves an attribute value by name. Namespace declarations are not returned.

Specified by:

getAttribute in interface Element

Overrides:

getAttribute in class AbstractNode

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).

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.

Specified by:

getAttributes in interface Node

Overrides:

getAttributes in class NodeImpl

removeAttribute

public void removeAttribute(java.lang.String name)

Removes an attribute by name.

Specified by:

removeAttribute in interface Element

Overrides:

removeAttribute in class AbstractNode

Parameters:

name - The name of the attribute to remove.

getAttributeNode

public Attr getAttributeNode(java.lang.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.

Specified by:

getAttributeNode in interface Element

Overrides:

getAttributeNode in class AbstractNode

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.

setAttributeNode

public Attr setAttributeNode(Attr newAttr)
                      throws DOMException

Adds a new attribute node. Always fails

Specified by:

setAttributeNode in interface Element

Overrides:

setAttributeNode in class AbstractNode

Throws:

DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

removeAttributeNode

public Attr removeAttributeNode(Attr oldAttr)
                         throws DOMException

Removes the specified attribute node. Always fails

Specified by:

removeAttributeNode in interface Element

Overrides:

removeAttributeNode in class AbstractNode

Throws:

DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

getAttributeNS

public java.lang.String getAttributeNS(java.lang.String namespaceURI,
                                       java.lang.String localName)

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

Overrides:

getAttributeNS in class AbstractNode

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

setAttributeNS

public void setAttributeNS(java.lang.String namespaceURI,
                           java.lang.String qualifiedName,
                           java.lang.String value)
                    throws DOMException

Adds a new attribute. Always fails.

Specified by:

setAttributeNS in interface Element

Overrides:

setAttributeNS in class AbstractNode

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.

removeAttributeNS

public void removeAttributeNS(java.lang.String namespaceURI,
                              java.lang.String localName)
                       throws DOMException

Removes an attribute by local name and namespace URI. Always fails

Specified by:

removeAttributeNS in interface Element

Overrides:

removeAttributeNS in class AbstractNode

Throws:

DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

Since:

DOM Level 2

getAttributeNodeNS

public Attr getAttributeNodeNS(java.lang.String namespaceURI,
                               java.lang.String localName)

Retrieves an Attr node by local name and namespace URI. DOM method, so namespace declarations count as attributes.

Specified by:

getAttributeNodeNS in interface Element

Overrides:

getAttributeNodeNS in class AbstractNode

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

setAttributeNodeNS

public Attr setAttributeNodeNS(Attr newAttr)
                        throws DOMException

Add a new attribute. Always fails.

Specified by:

setAttributeNodeNS in interface Element

Overrides:

setAttributeNodeNS in class AbstractNode

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

hasAttribute

public boolean hasAttribute(java.lang.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.

Specified by:

hasAttribute in interface Element

Overrides:

hasAttribute in class AbstractNode

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(java.lang.String namespaceURI,
                              java.lang.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.

Specified by:

hasAttributeNS in interface Element

Overrides:

hasAttributeNS in class AbstractNode

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

getNamedItem

public Node getNamedItem(java.lang.String name)

Get named attribute (DOM NamedNodeMap method) Treats namespace declarations as attributes.

Specified by:

getNamedItem in interface NamedNodeMap

setNamedItem

public Node setNamedItem(Node arg)
                  throws DOMException

Set named attribute (DOM NamedNodeMap method: always fails)

Specified by:

setNamedItem in interface NamedNodeMap

DOMException

removeNamedItem

public Node removeNamedItem(java.lang.String name)
                     throws DOMException

Remove named attribute (DOM NamedNodeMap method: always fails)

Specified by:

removeNamedItem in interface NamedNodeMap

DOMException

item

public Node item(int index)

Get n'th attribute (DOM NamedNodeMap method). Namespace declarations are not returned.

Specified by:

item in interface NamedNodeMap

getLength

public int getLength()

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

Specified by:

getLength in interface NamedNodeMap

Overrides:

getLength in class AbstractNode

getNamedItemNS

public Node getNamedItemNS(java.lang.String uri,
                           java.lang.String localName)

Get named attribute (DOM NamedNodeMap method) Treats namespace declarations as attributes.

Specified by:

getNamedItemNS in interface NamedNodeMap

setNamedItemNS

public Node setNamedItemNS(Node arg)
                    throws DOMException

Set named attribute (DOM NamedNodeMap method: always fails)

Specified by:

setNamedItemNS in interface NamedNodeMap

DOMException

removeNamedItemNS

public Node removeNamedItemNS(java.lang.String uri,
                              java.lang.String localName)
                       throws DOMException

Remove named attribute (DOM NamedNodeMap method: always fails)

Specified by:

removeNamedItemNS in interface NamedNodeMap

DOMException