<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_18) on Fri Dec 09 20:48:26 GMT 2011 -->
<TITLE>
XdmNode
</TITLE>
<META NAME="date" CONTENT="2011-12-09">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="XdmNode";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../net/sf/saxon/s9api/XdmItem.html" title="class in net.sf.saxon.s9api"><B>PREV CLASS</B></A>
<A HREF="../../../../net/sf/saxon/s9api/XdmNodeKind.html" title="enum in net.sf.saxon.s9api"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/s9api/XdmNode.html" target="_top"><B>FRAMES</B></A>
<A HREF="XdmNode.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
net.sf.saxon.s9api</FONT>
<BR>
Class XdmNode</H2>
<PRE>
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../net/sf/saxon/s9api/XdmValue.html" title="class in net.sf.saxon.s9api">net.sf.saxon.s9api.XdmValue</A>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../net/sf/saxon/s9api/XdmItem.html" title="class in net.sf.saxon.s9api">net.sf.saxon.s9api.XdmItem</A>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>net.sf.saxon.s9api.XdmNode</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A><<A HREF="../../../../net/sf/saxon/s9api/XdmItem.html" title="class in net.sf.saxon.s9api">XdmItem</A>></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>XdmNode</B><DT>extends <A HREF="../../../../net/sf/saxon/s9api/XdmItem.html" title="class in net.sf.saxon.s9api">XdmItem</A></DL>
</PRE>
<P>
This class represents a node in the XDM data model. A Node is an <A HREF="../../../../net/sf/saxon/s9api/XdmItem.html" title="class in net.sf.saxon.s9api"><CODE>XdmItem</CODE></A>, and is therefore an
<A HREF="../../../../net/sf/saxon/s9api/XdmValue.html" title="class in net.sf.saxon.s9api"><CODE>XdmValue</CODE></A> in its own right, and may also participate as one item within a sequence value.
<p/>
<p>An XdmNode is implemented as a wrapper around an object of type <A HREF="../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om"><CODE>NodeInfo</CODE></A>.
Because this is a key interface within Saxon, it is exposed via this API.</p>
<p/>
<p>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, <A HREF="../../../../net/sf/saxon/s9api/XdmNode.html#axisIterator(net.sf.saxon.s9api.Axis)"><CODE>axisIterator(net.sf.saxon.s9api.Axis)</CODE></A>,
which allows other nodes to be retrieved by following any of the XPath axes.</p>
<p/>
<p>Note that node identity cannot be inferred from object identity. The same node may be represented
by different <code>XdmNode</code> instances at different times, or even at the same time. The equals()
method on this class can be used to test for node identity.</p>
<P>
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>9.0</DD>
</DL>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XdmNode.html#XdmNode(net.sf.saxon.om.NodeInfo)">XdmNode</A></B>(<A HREF="../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> node)</CODE>
<BR>
Construct an XdmNode as a wrapper around an existing NodeInfo object</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/Source.html?is-external=true" title="class or interface in javax.xml.transform">Source</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XdmNode.html#asSource()">asSource</A></B>()</CODE>
<BR>
Get a JAXP Source object corresponding to this node, allowing the node to be
used as input to transformations or queries.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/s9api/XdmSequenceIterator.html" title="class in net.sf.saxon.s9api">XdmSequenceIterator</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XdmNode.html#axisIterator(net.sf.saxon.s9api.Axis)">axisIterator</A></B>(<A HREF="../../../../net/sf/saxon/s9api/Axis.html" title="enum in net.sf.saxon.s9api">Axis</A> axis)</CODE>
<BR>
Get an iterator over the nodes reachable from this node via a given axis.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/s9api/XdmSequenceIterator.html" title="class in net.sf.saxon.s9api">XdmSequenceIterator</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XdmNode.html#axisIterator(net.sf.saxon.s9api.Axis, net.sf.saxon.s9api.QName)">axisIterator</A></B>(<A HREF="../../../../net/sf/saxon/s9api/Axis.html" title="enum in net.sf.saxon.s9api">Axis</A> axis,
<A HREF="../../../../net/sf/saxon/s9api/QName.html" title="class in net.sf.saxon.s9api">QName</A> name)</CODE>
<BR>
Get an iterator over the nodes reachable from this node via a given axis, selecting only
those nodes with a specified name.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XdmNode.html#equals(java.lang.Object)">equals</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> other)</CODE>
<BR>
The <code>equals()</code> relation between two XdmNode objects is true if they both represent the same
node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XdmNode.html#getAttributeValue(net.sf.saxon.s9api.QName)">getAttributeValue</A></B>(<A HREF="../../../../net/sf/saxon/s9api/QName.html" title="class in net.sf.saxon.s9api">QName</A> name)</CODE>
<BR>
Get the string value of a named attribute of this element</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XdmNode.html#getBaseURI()">getBaseURI</A></B>()</CODE>
<BR>
Get the base URI of this node</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XdmNode.html#getColumnNumber()">getColumnNumber</A></B>()</CODE>
<BR>
Get the column number of the node in a source document.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XdmNode.html#getDocumentURI()">getDocumentURI</A></B>()</CODE>
<BR>
Get the document URI of this node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XdmNode.html#getExternalNode()">getExternalNode</A></B>()</CODE>
<BR>
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</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XdmNode.html#getLineNumber()">getLineNumber</A></B>()</CODE>
<BR>
Get the line number of the node in a source document.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/s9api/XdmNodeKind.html" title="enum in net.sf.saxon.s9api">XdmNodeKind</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XdmNode.html#getNodeKind()">getNodeKind</A></B>()</CODE>
<BR>
Get the kind of node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/s9api/QName.html" title="class in net.sf.saxon.s9api">QName</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XdmNode.html#getNodeName()">getNodeName</A></B>()</CODE>
<BR>
Get the name of the node, as a QName</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/s9api/XdmNode.html" title="class in net.sf.saxon.s9api">XdmNode</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XdmNode.html#getParent()">getParent</A></B>()</CODE>
<BR>
Get the parent of this node</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/s9api/Processor.html" title="class in net.sf.saxon.s9api">Processor</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XdmNode.html#getProcessor()">getProcessor</A></B>()</CODE>
<BR>
Get the Processor that was used to construct this node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/s9api/XdmValue.html" title="class in net.sf.saxon.s9api">XdmValue</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XdmNode.html#getTypedValue()">getTypedValue</A></B>()</CODE>
<BR>
Get the typed value of this node, as defined in XDM</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XdmNode.html#getUnderlyingNode()">getUnderlyingNode</A></B>()</CODE>
<BR>
Get the underlying Saxon implementation object representing this node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XdmNode.html#hashCode()">hashCode</A></B>()</CODE>
<BR>
The hashcode is such that two XdmNode instances have the same hashCode if they represent the same
node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XdmNode.html#toString()">toString</A></B>()</CODE>
<BR>
The toString() method returns a simple XML serialization of the node
with defaulted serialization parameters.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_net.sf.saxon.s9api.XdmItem"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class net.sf.saxon.s9api.<A HREF="../../../../net/sf/saxon/s9api/XdmItem.html" title="class in net.sf.saxon.s9api">XdmItem</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../net/sf/saxon/s9api/XdmItem.html#getStringValue()">getStringValue</A>, <A HREF="../../../../net/sf/saxon/s9api/XdmItem.html#isAtomicValue()">isAtomicValue</A>, <A HREF="../../../../net/sf/saxon/s9api/XdmItem.html#newAtomicValue(java.lang.String, net.sf.saxon.s9api.ItemType)">newAtomicValue</A>, <A HREF="../../../../net/sf/saxon/s9api/XdmItem.html#size()">size</A>, <A HREF="../../../../net/sf/saxon/s9api/XdmItem.html#wrapItem(net.sf.saxon.om.Item)">wrapItem</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_net.sf.saxon.s9api.XdmValue"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class net.sf.saxon.s9api.<A HREF="../../../../net/sf/saxon/s9api/XdmValue.html" title="class in net.sf.saxon.s9api">XdmValue</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../net/sf/saxon/s9api/XdmValue.html#append(net.sf.saxon.s9api.XdmValue)">append</A>, <A HREF="../../../../net/sf/saxon/s9api/XdmValue.html#getUnderlyingValue()">getUnderlyingValue</A>, <A HREF="../../../../net/sf/saxon/s9api/XdmValue.html#itemAt(int)">itemAt</A>, <A HREF="../../../../net/sf/saxon/s9api/XdmValue.html#iterator()">iterator</A>, <A HREF="../../../../net/sf/saxon/s9api/XdmValue.html#setValue(net.sf.saxon.om.ValueRepresentation)">setValue</A>, <A HREF="../../../../net/sf/saxon/s9api/XdmValue.html#wrap(net.sf.saxon.om.ValueRepresentation)">wrap</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="XdmNode(net.sf.saxon.om.NodeInfo)"><!-- --></A><H3>
XdmNode</H3>
<PRE>
public <B>XdmNode</B>(<A HREF="../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> node)</PRE>
<DL>
<DD>Construct an XdmNode as a wrapper around an existing NodeInfo object
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - the NodeInfo object to be wrapped. This can be retrieved using the
<A HREF="../../../../net/sf/saxon/s9api/XdmNode.html#getUnderlyingNode()"><CODE>getUnderlyingNode()</CODE></A> method.<DT><B>Since:</B></DT>
<DD>9.2 (previously a protected constructor)</DD>
</DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getNodeKind()"><!-- --></A><H3>
getNodeKind</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/XdmNodeKind.html" title="enum in net.sf.saxon.s9api">XdmNodeKind</A> <B>getNodeKind</B>()</PRE>
<DL>
<DD>Get the kind of node.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the kind of node, for example <A HREF="../../../../net/sf/saxon/s9api/XdmNodeKind.html#ELEMENT"><CODE>XdmNodeKind.ELEMENT</CODE></A> or <A HREF="../../../../net/sf/saxon/s9api/XdmNodeKind.html#ATTRIBUTE"><CODE>XdmNodeKind.ATTRIBUTE</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getNodeName()"><!-- --></A><H3>
getNodeName</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/QName.html" title="class in net.sf.saxon.s9api">QName</A> <B>getNodeName</B>()</PRE>
<DL>
<DD>Get the name of the node, as a QName
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the name of the node. In the case of unnamed nodes (for example, text and comment nodes)
return null.</DL>
</DD>
</DL>
<HR>
<A NAME="getTypedValue()"><!-- --></A><H3>
getTypedValue</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/XdmValue.html" title="class in net.sf.saxon.s9api">XdmValue</A> <B>getTypedValue</B>()
throws <A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></PRE>
<DL>
<DD>Get the typed value of this node, as defined in XDM
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the typed value. If the typed value is atomic, this will be returned as an instance
of <A HREF="../../../../net/sf/saxon/s9api/XdmAtomicValue.html" title="class in net.sf.saxon.s9api"><CODE>XdmAtomicValue</CODE></A>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></CODE> - if an error occurs obtaining the typed value, for example because
the node is an element with element-only content</DL>
</DD>
</DL>
<HR>
<A NAME="getLineNumber()"><!-- --></A><H3>
getLineNumber</H3>
<PRE>
public int <B>getLineNumber</B>()</PRE>
<DL>
<DD>Get the line number of the node in a source document. For a document constructed using the document
builder, this is available only if the line numbering option was set when the document was built (and
then only for element nodes). If the line number is not available, the value -1 is returned. Line numbers
will typically be as reported by a SAX parser: this means that the line number for an element node is the
line number containing the closing ">" of the start tag.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the line number of the node, or -1 if not available.</DL>
</DD>
</DL>
<HR>
<A NAME="getColumnNumber()"><!-- --></A><H3>
getColumnNumber</H3>
<PRE>
public int <B>getColumnNumber</B>()</PRE>
<DL>
<DD>Get the column number of the node in a source document. For a document constructed using the document
builder, this is available only if the line numbering option was set when the document was built (and
then only for element nodes). If the column number is not available, the value -1 is returned. Column numbers
will typically be as reported by a SAX parser: this means that the column number for an element node is the
position of the closing ">" of the start tag.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the column number of the node, or -1 if not available.</DL>
</DD>
</DL>
<HR>
<A NAME="asSource()"><!-- --></A><H3>
asSource</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/Source.html?is-external=true" title="class or interface in javax.xml.transform">Source</A> <B>asSource</B>()</PRE>
<DL>
<DD>Get a JAXP Source object corresponding to this node, allowing the node to be
used as input to transformations or queries.
<p>The Source object that is returned will generally be one that is acceptable to Saxon interfaces
that expect an instance of <code>javax.xml.transform.Source</code>. However, there is no guarantee
that it will be recognized by other products.</p>
<p><i>In fact, the current implementation always returns an instance of
<code>net.sf.saxon.om.NodeInfo</code>.</i></p>
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a Source object corresponding to this node</DL>
</DD>
</DL>
<HR>
<A NAME="axisIterator(net.sf.saxon.s9api.Axis)"><!-- --></A><H3>
axisIterator</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/XdmSequenceIterator.html" title="class in net.sf.saxon.s9api">XdmSequenceIterator</A> <B>axisIterator</B>(<A HREF="../../../../net/sf/saxon/s9api/Axis.html" title="enum in net.sf.saxon.s9api">Axis</A> axis)</PRE>
<DL>
<DD>Get an iterator over the nodes reachable from this node via a given axis.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>axis</CODE> - identifies which axis is to be navigated
<DT><B>Returns:</B><DD>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.</DL>
</DD>
</DL>
<HR>
<A NAME="axisIterator(net.sf.saxon.s9api.Axis, net.sf.saxon.s9api.QName)"><!-- --></A><H3>
axisIterator</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/XdmSequenceIterator.html" title="class in net.sf.saxon.s9api">XdmSequenceIterator</A> <B>axisIterator</B>(<A HREF="../../../../net/sf/saxon/s9api/Axis.html" title="enum in net.sf.saxon.s9api">Axis</A> axis,
<A HREF="../../../../net/sf/saxon/s9api/QName.html" title="class in net.sf.saxon.s9api">QName</A> name)</PRE>
<DL>
<DD>Get an iterator over the nodes reachable from this node via a given axis, selecting only
those nodes with a specified name.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>axis</CODE> - identifies which axis is to be navigated<DD><CODE>name</CODE> - 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.
<p>For example, specify <code>new QName("", "item")</code> to select nodes with local name
"item", in no namespace.</p>
<DT><B>Returns:</B><DD>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.</DL>
</DD>
</DL>
<HR>
<A NAME="getParent()"><!-- --></A><H3>
getParent</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/XdmNode.html" title="class in net.sf.saxon.s9api">XdmNode</A> <B>getParent</B>()</PRE>
<DL>
<DD>Get the parent of this node
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the parent of this node (a document or element node), or null if this node has no parent.</DL>
</DD>
</DL>
<HR>
<A NAME="getAttributeValue(net.sf.saxon.s9api.QName)"><!-- --></A><H3>
getAttributeValue</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getAttributeValue</B>(<A HREF="../../../../net/sf/saxon/s9api/QName.html" title="class in net.sf.saxon.s9api">QName</A> name)</PRE>
<DL>
<DD>Get the string value of a named attribute of this element
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the required attribute
<DT><B>Returns:</B><DD>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.</DL>
</DD>
</DL>
<HR>
<A NAME="getBaseURI()"><!-- --></A><H3>
getBaseURI</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</A> <B>getBaseURI</B>()</PRE>
<DL>
<DD>Get the base URI of this node
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the base URI, as defined in the XDM model. The value may be null if no base URI is known for the
node, for example if the tree was built from a StreamSource with no associated URI, or if the node has
no parent.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the base URI property of the underlying node is not a valid URI.</DL>
</DD>
</DL>
<HR>
<A NAME="getDocumentURI()"><!-- --></A><H3>
getDocumentURI</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</A> <B>getDocumentURI</B>()</PRE>
<DL>
<DD>Get the document URI of this node.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the document URI, as defined in the XDM model. Returns null if no document URI is known
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the document URI property of the underlying node is not a valid URI.<DT><B>Since:</B></DT>
<DD>9.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="hashCode()"><!-- --></A><H3>
hashCode</H3>
<PRE>
public int <B>hashCode</B>()</PRE>
<DL>
<DD>The hashcode is such that two XdmNode instances have the same hashCode if they represent the same
node. Note that the same node might be represented by different XdmNode objects, but these will
compare equal.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A></CODE> in class <CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>a hashCode representing node identity</DL>
</DD>
</DL>
<HR>
<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
equals</H3>
<PRE>
public boolean <B>equals</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> other)</PRE>
<DL>
<DD>The <code>equals()</code> relation between two XdmNode objects is true if they both represent the same
node. That is, it corresponds to the "is" operator in XPath.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A></CODE> in class <CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>other</CODE> - the object to be compared
<DT><B>Returns:</B><DD>true if and only if the other object is an XdmNode instance representing the same node</DL>
</DD>
</DL>
<HR>
<A NAME="toString()"><!-- --></A><H3>
toString</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE>
<DL>
<DD>The toString() method returns a simple XML serialization of the node
with defaulted serialization parameters.
<p>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".</p>
<p>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.</p>
<p>In the case of an attribute node, the output is a string in the form
<code>name="value"</code>. The name will use the original namespace prefix.</p>
<p>In the case of a namespace node, the output is a string in the form of a namespace
declaration, that is <code>xmlns="uri"</code> or <code>xmlns:pre="uri"</code>.</p>
<p>Other nodes, such as text nodes, comments, and processing instructions, are
represented as they would appear in lexical XML.</p>
<p><i>For more control over serialization, use the <A HREF="../../../../net/sf/saxon/s9api/Serializer.html" title="class in net.sf.saxon.s9api"><CODE>Serializer</CODE></A> class.</i></p>
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A></CODE> in class <CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>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: ".</DL>
</DD>
</DL>
<HR>
<A NAME="getProcessor()"><!-- --></A><H3>
getProcessor</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/Processor.html" title="class in net.sf.saxon.s9api">Processor</A> <B>getProcessor</B>()</PRE>
<DL>
<DD>Get the Processor that was used to construct this node.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the Processor used to construct this node, either via a <A HREF="../../../../net/sf/saxon/s9api/DocumentBuilder.html" title="class in net.sf.saxon.s9api"><CODE>DocumentBuilder</CODE></A>,
or by executing XSLT or XQuery code.<DT><B>Since:</B></DT>
<DD>9.2</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getUnderlyingNode()"><!-- --></A><H3>
getUnderlyingNode</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A> <B>getUnderlyingNode</B>()</PRE>
<DL>
<DD>Get the underlying Saxon implementation object representing this node. This provides
access to classes and methods in the Saxon implementation that may be subject to change
from one release to another.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the underlying implementation object</DL>
</DD>
</DL>
<HR>
<A NAME="getExternalNode()"><!-- --></A><H3>
getExternalNode</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> <B>getExternalNode</B>()</PRE>
<DL>
<DD>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
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the underlying external node if there is one, or null if this is not an XdmNode that
wraps such an external node<DT><B>Since:</B></DT>
<DD>9.1.0.2</DD>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../net/sf/saxon/s9api/XdmItem.html" title="class in net.sf.saxon.s9api"><B>PREV CLASS</B></A>
<A HREF="../../../../net/sf/saxon/s9api/XdmNodeKind.html" title="enum in net.sf.saxon.s9api"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/s9api/XdmNode.html" target="_top"><B>FRAMES</B></A>
<A HREF="XdmNode.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright (c) 2004-2011 Saxonica Limited. All rights reserved.
</BODY>
</HTML>
