net.sf.saxon.om
public interface NodeInfo extends Source, Item, ValueRepresentation
Note that several NodeInfo objects may represent the same node. To test node identity, the method isSameNodeInfo should be used. An exception to this rule applies for document nodes, where the correspondence between document nodes and DocumentInfo objects is one to one. NodeInfo objects are never reused: a given NodeInfo object represents the same node for its entire lifetime.
This is the primary interface for accessing trees in Saxon, and it forms part of the public Saxon API. The only subclass of NodeInfo that applications should normally use is DocumentInfo, which represents a document node. Methods that form part of the public API are (since Saxon 8.4) labelled with a JavaDoc "since" tag: classes and methods that have no such label should not be regarded as stable interfaces.
The interface represented by this class is at a slightly higher level than the abstraction described in the W3C data model specification, in that it includes support for the XPath axes, rather than exposing the lower-level properties (such as "parent" and "children") directly. All navigation within trees, except for a few convenience methods, is done by following the axes using the NodeInfo method. This allows different implementations of the XPath tree model to implement axis navigation in different ways. Some implementations may choose to use the helper methods provided in class Navigator.
Note that the stability of this interface applies to classes that use the interface, not to classes that implement it. The interface may be extended in future to add new methods.
Since: 8.4
Field Summary | |
---|---|
int | ALL_NAMESPACES
Copy all in-scope namespaces |
int[] | EMPTY_NAMESPACE_LIST |
static int | IS_DTD_TYPE
Bit setting in the returned type annotation indicating a DTD_derived type on an attribute node |
int | LOCAL_NAMESPACES
Copy namespaces declared (or undeclared) on this element, but not namespaces inherited from a parent element |
int | NO_NAMESPACES
Don't copy any namespace nodes. |
Method Summary | |
---|---|
Value | atomize()
Get the typed value. |
int | compareOrder(NodeInfo other)
Determine the relative position of this node and another node, in document order.
|
void | copy(Receiver out, int whichNamespaces, boolean copyAnnotations, int locationId)
Copy this node to a given outputter.
|
boolean | equals(Object other)
The equals() method compares nodes for identity. |
void | generateId(FastStringBuffer buffer)
Construct a character string that uniquely identifies this node.
|
String | getAttributeValue(int fingerprint)
Get the string value of a given attribute of this node
|
String | getBaseURI()
Get the Base URI for the node, that is, the URI used for resolving a relative URI contained
in the node. |
Configuration | getConfiguration()
Get the configuration used to build the tree containing this node. |
int[] | getDeclaredNamespaces(int[] buffer)
Get all namespace undeclarations and undeclarations defined on this element.
|
String | getDisplayName()
Get the display name of this node, in the form of a lexical QName.
|
int | getDocumentNumber()
Get the document number of the document containing this node. |
DocumentInfo | getDocumentRoot()
Get the root node, if it is a document node.
|
int | getFingerprint()
Get fingerprint. |
int | getLineNumber()
Get line number. |
String | getLocalPart()
Get the local part of the name of this node. |
int | getNameCode()
Get name code. |
NamePool | getNamePool()
Get the NamePool that holds the namecode for this node |
int | getNodeKind()
Get the kind of node. |
NodeInfo | getParent()
Get the NodeInfo object representing the parent of this node
|
String | getPrefix()
Get the prefix of the name of the node. |
NodeInfo | getRoot()
Get the root node of the tree containing this node
|
String | getStringValue()
Return the string value of the node. |
String | getSystemId()
Get the System ID for the node. |
int | getTypeAnnotation()
Get the type annotation of this node, if any. |
String | getURI()
Get the URI part of the name of this node. |
boolean | hasChildNodes()
Determine whether the node has any children.
|
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() |
boolean | isSameNodeInfo(NodeInfo other)
Determine whether this is the same node as another node.
|
AxisIterator | iterateAxis(byte axisNumber)
Return an iteration over all the nodes reached by the given axis from this node
|
AxisIterator | iterateAxis(byte axisNumber, NodeTest nodeTest)
Return an iteration over all the nodes reached by the given axis from this node
that match a given NodeTest
|
void | sendNamespaceDeclarations(Receiver out, boolean includeAncestors)
Output all namespace declarations associated with this element. |
Returns: the typed value. This will either be a single AtomicValue or a Value whose items are atomic values.
Since: 8.5
The other node must always be in the same tree; the effect of calling this method when the two nodes are in different trees is undefined. To obtain a global ordering of nodes, the application should first compare the result of getDocumentNumber(), and only if the document number is the same should compareOrder() be called.
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())
Since: 8.4
This method is primarily for internal use. It should not be considered a stable part of the Saxon API.
Parameters: out the Receiver to which the node should be copied whichNamespaces in the case of an element, controls which namespace nodes should be copied. Values are NO_NAMESPACES, LOCAL_NAMESPACES, ALL_NAMESPACES copyAnnotations indicates whether the type annotations of element and attribute nodes should be copied locationId If non-zero, identifies the location of the instruction that requested this copy. If zero, indicates that the location information for the original node is to be copied; in this case the Receiver must be a LocationCopier
Throws: XPathException
Parameters: other the node to be compared with this node
Returns: true if this NodeInfo object and the supplied NodeInfo object represent the same node in the tree.
Since: 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.
Parameters: buffer a buffer which will be updated to hold a string that uniquely identifies this node, across all documents. buffer
Since: 8.7
Changed in Saxon 8.7 to generate the ID value in a client-supplied buffer
Parameters: fingerprint The fingerprint of the attribute name
Returns: the attribute value if it exists, or null if it does not exist. Always returns null if this node is not an element.
Since: 8.4
Returns: the base URI of the node. This may be null if the base URI is unknown.
Since: 8.4
Returns: the Configuration
Since: 8.4
This method is intended primarily for internal use. User applications needing
information about the namespace context of a node should use iterateAxis(Axis.NAMESPACE)
.
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.
Returns: The display name of this node. For a node with no name, returns an empty string.
Since: 8.4
Since: 8.4
Returns: the DocumentInfo representing the containing document. If this node is part of a tree that does not have a document node as its root, returns null.
Since: 8.4
Returns: an integer fingerprint; two nodes with the same fingerprint have the same expanded QName. For unnamed nodes (text nodes, comments, document nodes, and namespace nodes for the default namespace), returns -1.
Since: 8.4
The granularity of line numbering is normally the element level: for other nodes such as text nodes and attributes, the line number of the parent element will normally be returned.
In the case of a tree constructed by taking input from a SAX parser, the line number will reflect the SAX rules: that is, the line number of an element is the line number where the start tag ends. This may be a little confusing where elements have many attributes spread over multiple lines, or where single attributes (as can easily happen with XSLT 2.0 stylesheets) occupy several lines.
In the case of a tree constructed by a stylesheet or query, the line number may reflect the line in the stylesheet or query that caused the node to be constructed.
The line number can be read from within an XPath expression using the Saxon extension function saxon:line-number()
Returns: the line number of the node in its original source document; or -1 if not available
Since: 8.4
Returns: the local part of the name. For an unnamed node, returns "". Unlike the DOM interface, this returns the full name in the case of a non-namespaced name.
Since: 8.4
Returns: an integer name code, which may be used to obtain the actual node name from the name pool. For unnamed nodes (text nodes, comments, document nodes, and namespace nodes for the default namespace), returns -1.
Since: 8.4
See Also: allocate
getFingerprint
Returns: the namepool
Since: 8.4
Returns: an integer identifying the kind of node. These integer values are the same as those used in the DOM
Since: 8.4
See Also: Type
Returns: the parent of this node; null if this node has no parent
Since: 8.4
Returns: The prefix of the name of the node.
Since: 8.4
Returns: the NodeInfo representing the top-level ancestor of this node. This will not necessarily be a document node. If this node has no parent, then the method returns this node.
Since: 8.4
The interpretation of this depends on the type of node. For an element it is the accumulated character content of the element, including descendant elements.
This method returns the string value as if the node were untyped. Unlike the string value accessor in the XPath 2.0 data model, it does not report an error if the element has a complex type, instead it returns the concatenation of the descendant text nodes as it would if the element were untyped.
Returns: the string value of the node
Since: 8.4
Returns: the System Identifier of the entity in the source document containing the node, or null if not known.
Since: 8.4
The bit IS_DTD_TYPE (1<<30) will be set in the case of an attribute node if the type annotation is one of ID, IDREF, or IDREFS and this is derived from DTD rather than schema validation.
Returns: the type annotation of the node, under the mask NamePool.FP_MASK, and optionally the
bit setting IS_DTD_TYPE in the case of a DTD-derived ID or IDREF/S type (which is treated
as untypedAtomic for the purposes of obtaining the typed value).
The result is undefined for nodes other than elements and attributes.
Since: 8.4
Returns: The URI of the namespace of this node. For an unnamed node, or for an element or attribute that is not in a namespace, or for a processing instruction, returns an empty string.
Since: 8.4
Note: the result is equivalent to
iterateAxis(Axis.CHILD).next() != null
Returns: True if the node has one or more children
Since: 8.4
Since: 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.
Note that two different NodeInfo instances can represent the same conceptual node. Therefore the "==" operator should not be used to test node identity. The equals() method is not overridden for nodes, so it has the same effect as using "==".
Note: a.isSameNodeInfo(b) if and only if generateId(a)==generateId(b).
This method has the same semantics as isSameNode() in DOM Level 3, but works on Saxon NodeInfo objects rather than DOM Node objects.
Parameters: other the node to be compared with this node
Returns: true if this NodeInfo object and the supplied NodeInfo object represent the same node in the tree.
Parameters: axisNumber an integer identifying the axis; one of the constants defined in class Axis
Returns: an AxisIterator that scans the nodes reached by the axis in turn.
Throws: UnsupportedOperationException if the namespace axis is requested and this axis is not supported for this implementation.
Since: 8.4
See Also: Axis
Parameters: axisNumber an integer identifying the axis; one of the constants defined in class Axis nodeTest A pattern to be matched by the returned nodes; nodes that do not match this pattern are not included in the result
Returns: a NodeEnumeration that scans the nodes reached by the axis in turn.
Throws: UnsupportedOperationException if the namespace axis is requested and this axis is not supported for this implementation.
Since: 8.4
See Also: Axis
This method is primarily for internal use. It should not be considered a stable part of the Saxon API.
Parameters: out The relevant Receiver includeAncestors True if namespaces declared on ancestor elements must be output; false if it is known that these are