net.sf.saxon.tree

Class ElementWithAttributes

public class ElementWithAttributes extends ElementImpl

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
voidcopy(Receiver out, int whichNamespaces, boolean copyAnnotations, int locationId)
Copy this node to a given outputter (supporting xsl:copy-of)
AttributeCollectiongetAttributeList()
Get the attribute list for this element.
StringgetAttributeValue(int fingerprint)
Get the value of a given attribute of this node
int[]getDeclaredNamespaces(int[] buffer)
Get all namespace undeclarations and undeclarations defined on this element.
int[]getInScopeNamespaceCodes()
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.
StringgetURIForPrefix(String prefix, boolean useDefault)
Get the namespace URI corresponding to a given prefix.
voidinitialise(int nameCode, AttributeCollectionImpl atts, NodeInfo parent, String baseURI, int lineNumber, int sequenceNumber)
Initialise a new ElementWithAttributes with an element name and attribute list
IteratoriteratePrefixes()
Get an iterator over all the prefixes declared in this namespace context.
voidsendNamespaceDeclarations(Receiver out, boolean includeAncestors)
Output all namespace nodes associated with this element.
voidsetNamespaceDeclarations(int[] namespaces, int namespacesUsed)
Set the namespace declarations for the element

Field Detail

attributeList

protected AttributeCollection attributeList

namespaceList

protected int[] namespaceList

Method Detail

copy

public void copy(Receiver out, int whichNamespaces, boolean copyAnnotations, int locationId)
Copy this node to a given outputter (supporting xsl:copy-of)

Parameters: out The outputter whichNamespaces indicates which namespaces should be output: all, none, or local namespaces only (those not declared on the parent element)

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

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

getDeclaredNamespaces

public int[] getDeclaredNamespaces(int[] buffer)
Get all namespace undeclarations and undeclarations defined on this element.

Parameters: buffer If this is non-null, and the result array fits in this buffer, then the result may overwrite the contents of this array, to avoid the cost of allocating a new array on the heap.

Returns: An array of integers representing the namespace declarations and undeclarations present on this element. For a node other than an element, return null. Otherwise, the returned array is a sequence of namespace codes, whose meaning may be interpreted by reference to the name pool. The top half word of each namespace code represents the prefix, the bottom half represents the URI. If the bottom half is zero, then this is a namespace undeclaration rather than a declaration. The XML namespace is never included in the list. If the supplied array is larger than required, then the first unused entry will be set to -1.

For a node other than an element, the method returns null.

getInScopeNamespaceCodes

public int[] getInScopeNamespaceCodes()
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.

getURIForPrefix

public String getURIForPrefix(String prefix, boolean useDefault)
Get the namespace URI corresponding to a given prefix. Return null if the prefix is not in scope.

Parameters: prefix the namespace prefix. May be the zero-length string, indicating that there is no prefix. This indicates either the default namespace or the null namespace, depending on the value of useDefault. useDefault true if the default namespace is to be used when the prefix is "". If false, the method returns "" when the prefix is "".

Returns: the uri for the namespace, or null if the prefix is not in scope. The "null namespace" is represented by the pseudo-URI "".

initialise

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

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

iteratePrefixes

public Iterator iteratePrefixes()
Get an iterator over all the prefixes declared in this namespace context. This will include the default namespace (prefix="") and the XML namespace where appropriate

sendNamespaceDeclarations

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

Parameters: out The relevant outputter

setNamespaceDeclarations

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