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.
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.
- compareOrder in interface NodeInfo
- compareOrder in interface AbstractNode
other
- The other node, whose position is to be compared with this node
- -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)
- generateId in interface NodeInfo
- generateId in interface AbstractNode
- a string.
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.
- getAttributeValue in interface NodeInfo
- getAttributeValue in interface AbstractNode
uri
- the namespace uri of an attributelocalName
- the local name of an attribute
- 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
- getAttributeValue in interface NodeInfo
- getAttributeValue in interface AbstractNode
fingerprint
- The fingerprint of the attribute name
- the attribute value if it exists or null if not
getAttributes
public NamedNodeMap getAttributes()
Return a NamedNodeMap
containing the attributes of this node (if
it is an Element
) or null
otherwise. (DOM method)
- getAttributes in interface AbstractNode
getBaseURI
public String getBaseURI()
Get the base URI for the node. Default implementation for child nodes.
- getBaseURI in interface NodeInfo
- getBaseURI in interface AbstractNode
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.
- getChildNodes in interface AbstractNode
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.
- getDisplayName in interface NodeInfo
- getDisplayName in interface AbstractNode
- The display name of this node.
For a node with no name, return an empty string.
getDocumentElement
public Element getDocumentElement()
Get the outermost element.
- getDocumentElement in interface AbstractNode
- 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.
getEnumeration
public AxisEnumeration getEnumeration(byte axisNumber,
NodeTest nodeTest)
Return an enumeration over the nodes reached by the given axis from this node
- getEnumeration in interface NodeInfo
- getEnumeration in interface AbstractNode
nodeTest
- A pattern to be matched by the returned nodes
- 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.
- getFingerprint in interface NodeInfo
- getFingerprint in interface AbstractNode
getFirstChild
public Node getFirstChild()
Get first child - default implementation used for leaf nodes
- getFirstChild in interface AbstractNode
- null
getLastChild
public Node getLastChild()
Get last child - default implementation used for leaf nodes
- getLastChild in interface AbstractNode
- null
getLineNumber
public int getLineNumber()
Get the line number of the node within its source document entity
- getLineNumber in interface NodeInfo
- getLineNumber in interface AbstractNode
getLocalName
public String getLocalName()
Get the local name of this node.
- getLocalName in interface NodeInfo
- getLocalName in interface AbstractNode
- 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
- getNameCode in interface NodeInfo
- getNameCode in interface AbstractNode
getNamePool
public NamePool getNamePool()
Get the NamePool
getNextInDocument
public NodeImpl getNextInDocument(NodeImpl anchor)
Get the next node in document order
- the next node in the document, or null if there is no such node
getNextSibling
public Node getNextSibling()
Get next sibling node
- getNextSibling in interface AbstractNode
- 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
- getOriginatingNode in interface AbstractNode
getParent
public final NodeInfo getParent()
Find the parent node of this node.
- getParent in interface NodeInfo
- getParent in interface AbstractNode
- 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.
- getPrefix in interface NodeInfo
- getPrefix in interface AbstractNode
- 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
- 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
- getPreviousSibling in interface AbstractNode
- 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.
- getSystemId in interface NodeInfo
- getSystemId in interface AbstractNode
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.
- getURI in interface NodeInfo
- getURI in interface AbstractNode
- 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.
- hasAttributes in interface AbstractNode
true
if this node has any attributes,
false
otherwise.
- DOM Level 2
hasChildNodes
public boolean hasChildNodes()
Determine whether the node has any children.
- hasChildNodes in interface NodeInfo
- hasChildNodes in interface AbstractNode
true
if the node has any children,
false
if the node has no children.
isSameNode
public boolean isSameNode(NodeInfo other)
Determine whether this is the same node as another node
- isSameNode in interface NodeInfo
- isSameNode in interface AbstractNode
- 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)
throws TransformerException
Output all namespace nodes associated with this element. Does nothing if
the node is not an element.
- outputNamespaceNodes in interface NodeInfo
- outputNamespaceNodes in interface AbstractNode
out
- The relevant outputterincludeAncestors
- 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