com.icl.saxon.tree

Class NodeImpl

public abstract class NodeImpl extends AbstractNode

A node in the XML parse tree representing an XML element, character content, or attribute.

This is the top-level class in the implementation class hierarchy; it essentially contains all those methods that can be defined using other primitive methods, without direct access to data.

Author: Michael H. Kay

Field Summary
protected static NodeInfo[]emptyArray
protected intindex
protected ParentNodeImplparent
Method Summary
intcompareOrder(NodeInfo other)
Determine the relative position of this node and another node, in document order.
StringgenerateId()
Get a character string that uniquely identifies this node within this document (The calling code will prepend a document identifier)
NamedNodeMapgetAttributes()
Return a NamedNodeMap containing the attributes of this node (if it is an Element ) or null otherwise.
StringgetAttributeValue(String uri, String localName)
Find the value of a given attribute of this node.
StringgetAttributeValue(int fingerprint)
Get the value of a given attribute of this node
StringgetBaseURI()
Get the base URI for the node.
NodeListgetChildNodes()
Return a NodeList that contains all children of this node.
StringgetDisplayName()
Get the display name of this node.
ElementgetDocumentElement()
Get the outermost element.
DocumentInfogetDocumentRoot()
Get the root (document) node
AxisEnumerationgetEnumeration(byte axisNumber, NodeTest nodeTest)
Return an enumeration over the nodes reached by the given axis from this node
intgetFingerprint()
Get the fingerprint of the node.
NodegetFirstChild()
Get first child - default implementation used for leaf nodes
NodegetLastChild()
Get last child - default implementation used for leaf nodes
intgetLineNumber()
Get the line number of the node within its source document entity
StringgetLocalName()
Get the local name of this node.
intgetNameCode()
Get the nameCode of the node.
NamePoolgetNamePool()
Get the NamePool
NodeImplgetNextInDocument(NodeImpl anchor)
Get the next node in document order
NodegetNextSibling()
Get next sibling node
NodegetOriginatingNode()
Get the node corresponding to this javax.xml.transform.dom.DOMLocator
NodeInfogetParent()
Find the parent node of this node.
StringgetPrefix()
Get the prefix part of the name of this node.
NodeImplgetPreviousInDocument()
Get the previous node in document order
NodegetPreviousSibling()
Get the previous sibling of the node
protected longgetSequenceNumber()
Get the node sequence number (in document order).
StringgetSystemId()
Get the system ID for the node.
StringgetURI()
Get the URI part of the name of this node.
booleanhasAttributes()
Returns whether this node (if it is an element) has any attributes.
booleanhasChildNodes()
Determine whether the node has any children.
booleanisSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node
voidoutputNamespaceNodes(Outputter out, boolean includeAncestors)
Output all namespace nodes associated with this element.
voidremoveNode()
Remove this node from the tree.
voidsetSystemId(String uri)
Set the system ID of this node.

Field Detail

emptyArray

protected static NodeInfo[] emptyArray

index

protected int index

parent

protected ParentNodeImpl parent

Method Detail

compareOrder

public final int compareOrder(NodeInfo other)
Determine the relative position of this node and another node, in document order. The other node will always be in the same document.

Parameters: other The other node, whose position is to be compared with this node

Returns: -1 if this node precedes the other node, +1 if it follows the other node, or 0 if they are the same node. (In this case, isSameNode() will always return true, and the two nodes will produce the same result for generateId())

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.

getAttributes

public NamedNodeMap getAttributes()
Return a NamedNodeMap containing the attributes of this node (if it is an Element ) or null otherwise. (DOM method)

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

getBaseURI

public String getBaseURI()
Get the base URI for the node. Default implementation for child nodes.

getChildNodes

public NodeList getChildNodes()
Return a NodeList that contains all children of this node. If there are no children, this is a NodeList containing no nodes.

getDisplayName

public String getDisplayName()
Get the display name of this node. For elements and attributes this is [prefix:]localname. For unnamed nodes, it is an empty string.

Returns: The display name of this node. For a node with no name, return an empty string.

getDocumentElement

public Element getDocumentElement()
Get the outermost element.

Returns: the Element node for the outermost element of the document. If the document is not well-formed, this returns the last element child of the root if there is one, otherwise null.

getDocumentRoot

public DocumentInfo getDocumentRoot()
Get the root (document) node

Returns: the DocumentInfo representing the containing document

getEnumeration

public AxisEnumeration getEnumeration(byte axisNumber, NodeTest nodeTest)
Return an enumeration over the nodes reached by the given axis from this node

Parameters: node NodeInfo representing the node from which the enumeration starts nodeType the type(s) of node to be included, e.g. NodeInfo.ELEMENT, NodeInfo.TEXT. The value NodeInfo.NODE means include any type of node. nodeTest A pattern to be matched by the returned nodes

Returns: an AxisEnumeration that scans the nodes reached by the axis in turn.

getFingerprint

public int getFingerprint()
Get the fingerprint of the node. This is used to compare whether two nodes have equivalent names. Return -1 for a node with no name.

getFirstChild

public Node getFirstChild()
Get first child - default implementation used for leaf nodes

Returns: null

getLastChild

public Node getLastChild()
Get last child - default implementation used for leaf nodes

Returns: null

getLineNumber

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

getLocalName

public String getLocalName()
Get the local name of this node.

Returns: The local name of this node. For a node with no name, return an empty string.

getNameCode

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

getNamePool

public NamePool getNamePool()
Get the NamePool

getNextInDocument

public NodeImpl getNextInDocument(NodeImpl anchor)
Get the next node in document order

Parameters: anchor: the scan stops when it reaches a node that is not a descendant of the specified anchor node

Returns: the next node in the document, or null if there is no such node

getNextSibling

public Node getNextSibling()
Get next sibling node

Returns: The next sibling node of the required type. Returns null if the current node is the last child of its parent.

getOriginatingNode

public Node getOriginatingNode()
Get the node corresponding to this javax.xml.transform.dom.DOMLocator

getParent

public final NodeInfo getParent()
Find the parent node of this node.

Returns: The Node object describing the containing element or root node.

getPrefix

public String getPrefix()
Get the prefix part of the name of this node. This is the name before the ":" if any.

Returns: the prefix part of the name. For an unnamed node, return an empty string.

getPreviousInDocument

public NodeImpl getPreviousInDocument()
Get the previous node in document order

Returns: the previous node in the document, or null if there is no such node

getPreviousSibling

public Node getPreviousSibling()
Get the previous sibling of the node

Returns: The previous sibling node. Returns null if the current node is the first child of its parent.

getSequenceNumber

protected long getSequenceNumber()
Get the node sequence number (in document order). Sequence numbers are monotonic but not consecutive. In the current implementation, parent nodes (elements and roots) have a zero least-significant word, while namespaces, attributes, text nodes, comments, and PIs have the top word the same as their owner and the bottom half reflecting their relative position. This is the default implementation for child nodes.

getSystemId

public String getSystemId()
Get the system ID for the node. Default implementation for child nodes.

getURI

public String getURI()
Get the URI part of the name of this node. This is the URI corresponding to the prefix, or the URI of the default namespace if appropriate.

Returns: The URI of the namespace of this node. For the default namespace, return an empty string. For an unnamed node, return null.

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

hasChildNodes

public boolean hasChildNodes()
Determine whether the node has any children.

Returns: true if the node has any children, false if the node has no children.

isSameNodeInfo

public boolean isSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node

Returns: true if this Node object and the supplied Node object represent the same node in the tree.

outputNamespaceNodes

public void outputNamespaceNodes(Outputter out, boolean includeAncestors)
Output all namespace nodes associated with this element. Does nothing if the node is not an element.

Parameters: out The relevant outputter includeAncestors True if namespaces declared on ancestor elements must be output; false if it is known that these are already on the result tree

removeNode

public void removeNode()
Remove this node from the tree. For system use only. When one or more nodes have been removed, renumberChildren() must be called to adjust the numbering of remaining nodes. PRECONDITION: The node must have a parent node.

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