net.sf.saxon.s9api
public class XdmNode extends XdmItem
An XdmNode is implemented as a wrapper around an object of type NodeInfo. Because this is a key interface within Saxon, it is exposed via this API.
The XdmNode interface exposes basic properties of the node, such as its name, its string value, and its typed value. Navigation to other nodes is supported through a single method, XdmNode, which allows other nodes to be retrieved by following any of the XPath axes.
Note that node identity cannot be inferred from object identity. The same node may be represented
by different XdmNode
instances at different times, or even at the same time. The equals()
method on this class can be used to test for node identity.
Since: 9.0
Constructor Summary | |
---|---|
protected | XdmNode(NodeInfo node) |
Method Summary | |
---|---|
Source | asSource()
Get a JAXP Source object corresponding to this node, allowing the node to be
used as input to transformations or queries.
|
XdmSequenceIterator | axisIterator(Axis axis)
Get an iterator over the nodes reachable from this node via a given axis.
|
XdmSequenceIterator | axisIterator(Axis axis, QName name)
Get an iterator over the nodes reachable from this node via a given axis, selecting only
those nodes with a specified name.
|
boolean | equals(Object other)
The equals() relation between two XdmNode objects is true if they both represent the same
node. |
String | getAttributeValue(QName name)
Get the string value of a named attribute of this element |
URI | getBaseURI()
Get the base URI of this node
|
int | getColumnNumber()
Get the column number of the node in a source document. |
URI | getDocumentURI()
Get the document URI of this node. |
Object | getExternalNode()
In the case of an XdmNode that wraps a node in an external object model such as DOM, JDOM,
XOM, or DOM4J, get the underlying wrapped node |
int | getLineNumber()
Get the line number of the node in a source document. |
XdmNodeKind | getNodeKind()
Get the kind of node. |
QName | getNodeName()
Get the name of the node, as a QName
|
XdmNode | getParent()
Get the parent of this node
|
Processor | getProcessor()
Get the Processor that was used to construct this node. |
XdmValue | getTypedValue()
Get the typed value of this node, as defined in XDM
|
NodeInfo | getUnderlyingNode()
Get the underlying Saxon implementation object representing this node. |
int | hashCode()
The hashcode is such that two XdmNode instances have the same hashCode if they represent the same
node. |
String | toString()
The toString() method returns a simple XML serialization of the node
with defaulted serialization parameters.
|
The Source object that is returned will generally be one that is acceptable to Saxon interfaces
that expect an instance of javax.xml.transform.Source
. However, there is no guarantee
that it will be recognized by other products.
In fact, the current implementation always returns an instance of
net.sf.saxon.om.NodeInfo
.
Returns: a Source object corresponding to this node
Parameters: axis identifies which axis is to be navigated
Returns: an iterator over the nodes on the specified axis, starting from this node as the context node. The nodes are returned in axis order, that is, in document order for a forwards axis and in reverse document order for a reverse axis.
Parameters: axis identifies which axis is to be navigated name identifies the name of the nodes to be selected. The selected nodes will be those
whose node kind is the principal node kind of the axis (that is, attributes for the attribute
axis, namespaces for the namespace axis, and elements for all other axes) whose name matches
the specified name.
For example, specify new QName("", "item")
to select nodes with local name
"item", in no namespace.
Returns: an iterator over the nodes on the specified axis, starting from this node as the context node. The nodes are returned in axis order, that is, in document order for a forwards axis and in reverse document order for a reverse axis.
equals()
relation between two XdmNode objects is true if they both represent the same
node. That is, it corresponds to the "is" operator in XPath.
Parameters: other the object to be compared
Returns: true if and only if the other object is an XdmNode instance representing the same node
Parameters: name the name of the required attribute
Returns: null if this node is not an element, or if this element has no attribute with the specified name. Otherwise return the string value of the selected attribute node.
Returns: the base URI, as defined in the XDM model
Returns: the column number of the node, or -1 if not available.
Returns: the document URI, as defined in the XDM model. Returns null if no document URI is known
Since: 9.1
Returns: the underlying external node if there is one, or null if this is not an XdmNode that wraps such an external node
Since: 9.1.0.2
Returns: the line number of the node, or -1 if not available.
Returns: the name of the node. In the case of unnamed nodes (for example, text and comment nodes) return null.
Returns: the parent of this node (a document or element node), or null if this node has no parent.
Returns: the Processor used to construct this node, either via a DocumentBuilder, or by executing XSLT or XQuery code.
Since: 9.2
Returns: the typed value. If the typed value is atomic, this will be returned as an instance of XdmAtomicValue
Throws: SaxonApiException if an error occurs obtaining the typed value, for example because the node is an element with element-only content
Returns: the underlying implementation object
Returns: a hashCode representing node identity
In the case of an element node, the result will be a well-formed XML document serialized as defined in the W3C XSLT/XQuery serialization specification, using options method="xml", indent="yes", omit-xml-declaration="yes".
In the case of a document node, the result will be a well-formed XML document provided that the document node contains exactly one element child, and no text node children. In other cases it will be a well-formed external general parsed entity.
In the case of an attribute node, the output is a string in the form
name="value"
. The name will use the original namespace prefix.
In the case of a namespace node, the output is a string in the form of a namespace
declaration, that is xmlns="uri"
or xmlns:pre="uri"
.
Other nodes, such as text nodes, comments, and processing instructions, are represented as they would appear in lexical XML.
For more control over serialization, use the Serializer class.
Returns: a simple XML serialization of the node. Under error conditions the method may return an error message which will always begin with the label "Error: ".