|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.saxon.s9api.XdmValue net.sf.saxon.s9api.XdmItem net.sf.saxon.s9api.XdmNode
public class XdmNode
This class represents a node in the XDM data model. A Node is an XdmItem
, and is therefore an
XdmValue
in its own right, and may also participate as one item within a sequence value.
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, axisIterator(net.sf.saxon.s9api.Axis)
,
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.
Constructor Summary | |
---|---|
XdmNode(NodeInfo node)
Construct an XdmNode as a wrapper around an existing NodeInfo object |
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. |
Methods inherited from class net.sf.saxon.s9api.XdmItem |
---|
getStringValue, isAtomicValue, newAtomicValue, size, wrapItem |
Methods inherited from class net.sf.saxon.s9api.XdmValue |
---|
append, getUnderlyingValue, itemAt, iterator, setValue, wrap |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public XdmNode(NodeInfo node)
node
- the NodeInfo object to be wrapped. This can be retrieved using the
getUnderlyingNode()
method.Method Detail |
---|
public XdmNodeKind getNodeKind()
XdmNodeKind.ELEMENT
or XdmNodeKind.ATTRIBUTE
public QName getNodeName()
public XdmValue getTypedValue() throws SaxonApiException
XdmAtomicValue
SaxonApiException
- if an error occurs obtaining the typed value, for example because
the node is an element with element-only contentpublic int getLineNumber()
public int getColumnNumber()
public Source asSource()
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
.
public XdmSequenceIterator axisIterator(Axis axis)
axis
- identifies which axis is to be navigated
public XdmSequenceIterator axisIterator(Axis axis, QName name)
axis
- identifies which axis is to be navigatedname
- 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.
public XdmNode getParent()
public String getAttributeValue(QName name)
name
- the name of the required attribute
public URI getBaseURI()
IllegalStateException
- if the base URI property of the underlying node is not a valid URI.public URI getDocumentURI()
IllegalStateException
- if the document URI property of the underlying node is not a valid URI.public int hashCode()
hashCode
in class Object
public boolean equals(Object other)
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.
equals
in class Object
other
- the object to be compared
public String toString()
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.
toString
in class Object
public Processor getProcessor()
DocumentBuilder
,
or by executing XSLT or XQuery code.public NodeInfo getUnderlyingNode()
public Object getExternalNode()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |