com.icl.saxon.tree

Class ElementImpl

public class ElementImpl extends ParentNodeImpl implements Element

ElementImpl implements an element with no attributes or namespace declarations.

This class is an implementation of NodeInfo. For elements with attributes or namespace declarations, class ElementWithAttributes is used.

Author: Michael H. Kay

Field Summary
protected intnameCode
protected DocumentImplroot
Constructor Summary
ElementImpl()
Construct an empty ElementImpl
Method Summary
voidaddNamespaceNodes(ElementImpl owner, Vector list, boolean addXML)
Make the set of all namespace nodes associated with this element.
voidcopy(Outputter out)
Copy this node to a given outputter (supporting xsl:copy-of)
voidcopy(Outputter out, boolean allNamespaces)
Copy this node to a given outputter (supporting xsl:copy-of)
StringgenerateId()
Get a character string that uniquely identifies this node within this document (The calling code will prepend a document identifier)
AttributeCollectiongetAttributeList()
Get the attribute list for this element.
StringgetAttributeValue(String name)
Find the value of a given attribute of this element.
StringgetBaseURI()
Get the base URI of this element node.
DocumentInfogetDocumentRoot()
Get the root node
intgetLineNumber()
Get the line number of the node within its source document entity
intgetNameCode()
Get the nameCode of the node.
shortgetNodeType()
Return the type of node.
StringgetPrefixForURI(String uri)
Search the NamespaceList for a given URI, returning the corresponding prefix.
StringgetSystemId()
Get the system ID of the entity containing this element node.
shortgetURICodeForPrefix(String prefix)
Search the NamespaceList for a given prefix, returning the corresponding URI.
voidinitialise(int nameCode, AttributeCollection atts, NodeInfo parent, String baseURI, int lineNumber, int sequenceNumber)
Initialise a new ElementImpl with an element name
intmakeNameCode(String qname, boolean useDefault)
Make a NameCode, using this Element as the context for namespace resolution.
voidoutputNamespaceNodes(Outputter out, boolean includeAncestors)
Output all namespace nodes associated with this element.
voidsetAttribute(String name, String value)
Set the value of an attribute on the current element.
voidsetLineNumber(int line)
Set the line number of the element within its source document entity
voidsetNameCode(int nameCode)
Set the name code.
voidsetSystemId(String uri)
Set the system ID of this node.

Field Detail

nameCode

protected int nameCode

root

protected DocumentImpl root

Constructor Detail

ElementImpl

public ElementImpl()
Construct an empty ElementImpl

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 the XML namespace node to the list

copy

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

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

generateId

public String generateId()
Get a character string that uniquely identifies this node within this document (The calling code will prepend a document identifier)

Returns: a string.

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(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

getBaseURI

public String getBaseURI()
Get the base URI of this element node. This will be the same as the System ID unless xml:base has been used.

getDocumentRoot

public DocumentInfo getDocumentRoot()
Get the root node

getLineNumber

public int getLineNumber()
Get the line number of the node within its source document entity

getNameCode

public int getNameCode()
Get the nameCode of the node. This is used to locate the name in the NamePool

getNodeType

public final short getNodeType()
Return the type of node.

Returns: NodeInfo.ELEMENT

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.

getSystemId

public final String getSystemId()
Get the system ID of the entity containing this element node.

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.

initialise

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

Parameters: name The element name, with namespaces resolved atts The attribute list: always null parent The parent node

makeNameCode

public final int makeNameCode(String qname, boolean useDefault)
Make a NameCode, using this Element as the context for namespace resolution. The name will be entered in the namepool: therefore this method should not be called once the name pool is sealed.

Parameters: qname The name as written, in the form "[prefix:]localname"

UNKNOWN: useDefault Defines the action when there is no prefix. If true, use the default namespace URI (as for element names). If false, use no namespace URI (as for attribute names).

outputNamespaceNodes

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

Parameters: out The relevant outputter

setAttribute

public void setAttribute(String name, String value)
Set the value of an attribute on the current element.

Throws: DOMException (always): the Saxon tree is immutable

setLineNumber

public void setLineNumber(int line)
Set the line number of the element within its source document entity

setNameCode

public void setNameCode(int nameCode)
Set the name code. Used when creating a dummy element in the Stripper

setSystemId

public void setSystemId(String uri)
Set the system ID of this node. This method is provided so that a NodeInfo implements the javax.xml.transform.Source interface, allowing a node to be used directly as the Source of a transformation