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.
atomize
public Value atomize()
throws XPathException
Get the typed value. The result of this method will always be consistent with the method
Item.getTypedValue()
. However, this method is often more convenient and may be
more efficient, especially in the common case where the value is expected to be a singleton.
- atomize in interface NodeInfo
- the typed value. If requireSingleton is set to true, the result will always be an
AtomicValue. In other cases it may be a Value representing a sequence whose items are atomic
values.
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
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())
equals
public boolean equals(Object other)
The equals() method compares nodes for identity. It is defined to give the same result
as isSameNodeInfo().
- equals in interface NodeInfo
other
- the node to be compared with this node
- true if this NodeInfo object and the supplied NodeInfo object represent
the same node in the tree.
- 8.7 Previously, the effect of the equals() method was not defined. Callers
should therefore be aware that third party implementations of the NodeInfo interface may
not implement the correct semantics. It is safer to use isSameNodeInfo() for this reason.
The equals() method has been defined because it is useful in contexts such as a Java Set or HashMap.
generateId
public void generateId(FastStringBuffer buffer)
Get a character string that uniquely identifies this node within this document
(The calling code will prepend a document identifier)
- generateId in interface NodeInfo
getAttributeValue
public String getAttributeValue(int fingerprint)
Get the value of a given attribute of this node
- getAttributeValue in interface NodeInfo
fingerprint
- The fingerprint of the attribute name
- 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.
- getBaseURI in interface NodeInfo
getColumnNumber
public int getColumnNumber()
Get the column number of the node.
The default implementation returns -1, meaning unknown
getDeclaredNamespaces
public int[] getDeclaredNamespaces(int[] buffer)
Get all namespace undeclarations and undeclarations defined on this element.
- getDeclaredNamespaces in interface NodeInfo
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.
- 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.
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
- The display name of this node.
For a node with no name, return an empty string.
getDocumentNumber
public int getDocumentNumber()
Get the document number of the document containing this node. For a free-standing
orphan node, just return the hashcode.
- getDocumentNumber in interface NodeInfo
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
getFirstChild
public NodeInfo getFirstChild()
Get first child - default implementation used for leaf nodes
getLastChild
public NodeInfo getLastChild()
Get last child - default implementation used for leaf nodes
getLineNumber
public int getLineNumber()
Get the line number of the node within its source document entity
- getLineNumber in interface NodeInfo
getLocalPart
public String getLocalPart()
Get the local name of this node.
- getLocalPart in interface NodeInfo
- The local name of this node.
For a node with no name, return "",.
getNameCode
public int getNameCode()
Get the nameCode of the node. This is used to locate the name in the NamePool
- getNameCode in interface NodeInfo
getNextInDocument
public NodeImpl getNextInDocument(NodeImpl anchor)
Get the next node in document order
anchor
- the scan stops when it reaches a node that is not a descendant of the specified
anchor node
- the next node in the document, or null if there is no such node
getNextSibling
public NodeInfo getNextSibling()
Get next sibling node
- The next sibling node of the required type. Returns null if the current node is the last
child of its parent.
getParent
public final NodeInfo getParent()
Find the parent node of this node.
- getParent in interface NodeInfo
- 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
- 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 NodeInfo getPreviousSibling()
Get the previous sibling of the node
- The previous sibling node. Returns null if the current node is the first
child of its parent.
getPublicId
public String getPublicId()
Get the public identifier of the document entity containing this node.
The default implementation returns null, meaning unknown
getRoot
public NodeInfo getRoot()
Get the root node
- getRoot in interface NodeInfo
- the NodeInfo representing the containing document
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
getTypeAnnotation
public int getTypeAnnotation()
Get the type annotation of this node, if any
- getTypeAnnotation in interface NodeInfo
getTypedValue
public SequenceIterator getTypedValue()
throws XPathException
Get the typed value of this node.
If there is no type annotation, we return the string value, as an instance
of xs:untypedAtomic
- getTypedValue in interface Item
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
- The URI of the namespace of this node. For the default namespace, return an
empty string. For an unnamed node, return the empty string.
hasChildNodes
public boolean hasChildNodes()
Determine whether the node has any children.
- hasChildNodes in interface NodeInfo
true
if the node has any children,
false
if the node has no children.
hashCode
public int hashCode()
The hashCode() method obeys the contract for hashCode(): that is, if two objects are equal
(represent the same node) then they must have the same hashCode()
- hashCode in interface NodeInfo
- 8.7 Previously, the effect of the equals() and hashCode() methods was not defined. Callers
should therefore be aware that third party implementations of the NodeInfo interface may
not implement the correct semantics.
isSameNodeInfo
public boolean isSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node
- isSameNodeInfo in interface NodeInfo
- true if this Node object and the supplied Node object represent the
same node in the tree.
iterateAxis
public AxisIterator iterateAxis(byte axisNumber)
Return an enumeration over the nodes reached by the given axis from this node
- iterateAxis in interface NodeInfo
axisNumber
- The axis to be iterated over
- an AxisIterator that scans the nodes reached by the axis in turn.
iterateAxis
public AxisIterator iterateAxis(byte axisNumber,
NodeTest nodeTest)
Return an enumeration over the nodes reached by the given axis from this node
- iterateAxis in interface NodeInfo
axisNumber
- The axis to be iterated overnodeTest
- A pattern to be matched by the returned nodes
- an AxisIterator that scans the nodes reached by the axis in turn.
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