<!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>
DocumentBuilder
</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="DocumentBuilder";
}
}
</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/Destination.html" title="interface in net.sf.saxon.s9api"><B>PREV CLASS</B></A>
<A HREF="../../../../net/sf/saxon/s9api/DOMDestination.html" title="class 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/DocumentBuilder.html" target="_top"><B>FRAMES</B></A>
<A HREF="DocumentBuilder.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 DocumentBuilder</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 "><B>net.sf.saxon.s9api.DocumentBuilder</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>DocumentBuilder</B><DT>extends <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></DL>
</PRE>
<P>
A document builder holds properties controlling how a Saxon document tree should be built, and
provides methods to invoke the tree construction.
<p/>
<p>This class has no public constructor. Users should construct a DocumentBuilder
by calling the factory method <A HREF="../../../../net/sf/saxon/s9api/Processor.html#newDocumentBuilder()"><CODE>Processor.newDocumentBuilder()</CODE></A>.</p>
<p/>
<p>All documents used in a single Saxon query, transformation, or validation episode must
be built with the same <A HREF="../../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon"><CODE>Configuration</CODE></A>. However, there is no requirement that they
should use the same <code>DocumentBuilder</code>.</p>
<p/>
<p>Sharing of a <code>DocumentBuilder</code> across multiple threads is not recommended. However,
in the current implementation sharing a <code>DocumentBuilder</code> (once initialized) will only
cause problems if a <code>SchemaValidator</code> is used.</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 ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected </CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/DocumentBuilder.html#DocumentBuilder(net.sf.saxon.Configuration)">DocumentBuilder</A></B>(<A HREF="../../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon">Configuration</A> config)</CODE>
<BR>
Create a DocumentBuilder.</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="../../../../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/DocumentBuilder.html#build(java.io.File)">build</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> file)</CODE>
<BR>
Build a document from a supplied XML file</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/DocumentBuilder.html#build(javax.xml.transform.Source)">build</A></B>(<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> source)</CODE>
<BR>
Load an XML document, to create a tree representation of the document in memory.</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/DocumentBuilder.html#getBaseURI()">getBaseURI</A></B>()</CODE>
<BR>
Get the base URI of documents loaded using this DocumentBuilder when no other URI is available.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/s9api/XQueryExecutable.html" title="class in net.sf.saxon.s9api">XQueryExecutable</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/DocumentBuilder.html#getDocumentProjectionQuery()">getDocumentProjectionQuery</A></B>()</CODE>
<BR>
Get the compiled query to be used for implementing document projection.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/s9api/SchemaValidator.html" title="class in net.sf.saxon.s9api">SchemaValidator</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/DocumentBuilder.html#getSchemaValidator()">getSchemaValidator</A></B>()</CODE>
<BR>
Get the SchemaValidator used to validate documents loaded using this
<code>DocumentBuilder</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/om/TreeModel.html" title="class in net.sf.saxon.om">TreeModel</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/DocumentBuilder.html#getTreeModel()">getTreeModel</A></B>()</CODE>
<BR>
Get the tree model to be used for documents constructed using this DocumentBuilder.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/s9api/WhitespaceStrippingPolicy.html" title="class in net.sf.saxon.s9api">WhitespaceStrippingPolicy</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/DocumentBuilder.html#getWhitespaceStrippingPolicy()">getWhitespaceStrippingPolicy</A></B>()</CODE>
<BR>
Get the white whitespace stripping policy applied when loading a document
using this <code>DocumentBuilder</code>.</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/DocumentBuilder.html#isDTDValidation()">isDTDValidation</A></B>()</CODE>
<BR>
Ask whether DTD validation is to be applied to documents loaded using this <code>DocumentBuilder</code></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/DocumentBuilder.html#isLineNumbering()">isLineNumbering</A></B>()</CODE>
<BR>
Ask whether line numbering is enabled for documents loaded using this
<code>DocumentBuilder</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/s9api/BuildingContentHandler.html" title="interface in net.sf.saxon.s9api">BuildingContentHandler</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/DocumentBuilder.html#newBuildingContentHandler()">newBuildingContentHandler</A></B>()</CODE>
<BR>
Get an <A HREF="http://download.oracle.com/javase/6/docs/api/org/xml/sax/ContentHandler.html?is-external=true" title="class or interface in org.xml.sax"><CODE>ContentHandler</CODE></A> that may be used to build the document programmatically.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/s9api/BuildingStreamWriterImpl.html" title="class in net.sf.saxon.s9api">BuildingStreamWriterImpl</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/DocumentBuilder.html#newBuildingStreamWriter()">newBuildingStreamWriter</A></B>()</CODE>
<BR>
Get an <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream"><CODE>XMLStreamWriter</CODE></A> that may be used to build the document programmatically.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/DocumentBuilder.html#setBaseURI(java.net.URI)">setBaseURI</A></B>(<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> uri)</CODE>
<BR>
Set the base URI of a document loaded using this <code>DocumentBuilder</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/DocumentBuilder.html#setDocumentProjectionQuery(net.sf.saxon.s9api.XQueryExecutable)">setDocumentProjectionQuery</A></B>(<A HREF="../../../../net/sf/saxon/s9api/XQueryExecutable.html" title="class in net.sf.saxon.s9api">XQueryExecutable</A> query)</CODE>
<BR>
Set a compiled query to be used for implementing document projection.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/DocumentBuilder.html#setDTDValidation(boolean)">setDTDValidation</A></B>(boolean option)</CODE>
<BR>
Set whether DTD validation should be applied to documents loaded using this
<code>DocumentBuilder</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/DocumentBuilder.html#setLineNumbering(boolean)">setLineNumbering</A></B>(boolean option)</CODE>
<BR>
Say whether line numbering is to be enabled for documents constructed using this DocumentBuilder.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/DocumentBuilder.html#setSchemaValidator(net.sf.saxon.s9api.SchemaValidator)">setSchemaValidator</A></B>(<A HREF="../../../../net/sf/saxon/s9api/SchemaValidator.html" title="class in net.sf.saxon.s9api">SchemaValidator</A> validator)</CODE>
<BR>
Set the schemaValidator to be used.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/DocumentBuilder.html#setTreeModel(net.sf.saxon.om.TreeModel)">setTreeModel</A></B>(<A HREF="../../../../net/sf/saxon/om/TreeModel.html" title="class in net.sf.saxon.om">TreeModel</A> model)</CODE>
<BR>
Set the tree model to be used for documents constructed using this DocumentBuilder.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/DocumentBuilder.html#setWhitespaceStrippingPolicy(net.sf.saxon.s9api.WhitespaceStrippingPolicy)">setWhitespaceStrippingPolicy</A></B>(<A HREF="../../../../net/sf/saxon/s9api/WhitespaceStrippingPolicy.html" title="class in net.sf.saxon.s9api">WhitespaceStrippingPolicy</A> policy)</CODE>
<BR>
Set the whitespace stripping policy applied when loading a document
using this <code>DocumentBuilder</code>.</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/DocumentBuilder.html#wrap(java.lang.Object)">wrap</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> node)</CODE>
<BR>
Create a node by wrapping a recognized external node from a supported object model.</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#equals(java.lang.Object)" title="class or interface in java.lang">equals</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#hashCode()" title="class or interface in java.lang">hashCode</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#toString()" title="class or interface in java.lang">toString</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="DocumentBuilder(net.sf.saxon.Configuration)"><!-- --></A><H3>
DocumentBuilder</H3>
<PRE>
protected <B>DocumentBuilder</B>(<A HREF="../../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon">Configuration</A> config)</PRE>
<DL>
<DD>Create a DocumentBuilder. This is a protected constructor. Users should construct a DocumentBuilder
by calling the factory method <A HREF="../../../../net/sf/saxon/s9api/Processor.html#newDocumentBuilder()"><CODE>Processor.newDocumentBuilder()</CODE></A>.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>config</CODE> - the Saxon configuration</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="setTreeModel(net.sf.saxon.om.TreeModel)"><!-- --></A><H3>
setTreeModel</H3>
<PRE>
public void <B>setTreeModel</B>(<A HREF="../../../../net/sf/saxon/om/TreeModel.html" title="class in net.sf.saxon.om">TreeModel</A> model)</PRE>
<DL>
<DD>Set the tree model to be used for documents constructed using this DocumentBuilder.
By default, the TinyTree is used (irrespective of the TreeModel set in the underlying
Configuration).
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>model</CODE> - typically one of the constants <A HREF="../../../../net/sf/saxon/om/TreeModel.html#TINY_TREE"><CODE>TreeModel.TINY_TREE</CODE></A>,
<A HREF="../../../../net/sf/saxon/om/TreeModel.html#TINY_TREE_CONDENSED"><CODE>TreeModel.TINY_TREE_CONDENSED</CODE></A>, or <A HREF="../../../../net/sf/saxon/om/TreeModel.html#LINKED_TREE"><CODE>TreeModel.LINKED_TREE</CODE></A>. It can also be
an external object model such as <A HREF="../../../../net/sf/saxon/option/xom/XOMObjectModel.html" title="class in net.sf.saxon.option.xom"><CODE>XOMObjectModel</CODE></A><DT><B>Since:</B></DT>
<DD>9.2</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getTreeModel()"><!-- --></A><H3>
getTreeModel</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/om/TreeModel.html" title="class in net.sf.saxon.om">TreeModel</A> <B>getTreeModel</B>()</PRE>
<DL>
<DD>Get the tree model to be used for documents constructed using this DocumentBuilder.
By default, the TinyTree is used (irrespective of the TreeModel set in the underlying
Configuration).
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the tree model in use: typically one of the constants <A HREF="../../../../net/sf/saxon/om/TreeModel.html#TINY_TREE"><CODE>TreeModel.TINY_TREE</CODE></A>,
<A HREF="../../../../net/sf/saxon/om/TreeModel.html#TINY_TREE_CONDENSED"><CODE>TreeModel.TINY_TREE_CONDENSED</CODE></A>, or <A HREF="../../../../net/sf/saxon/om/TreeModel.html#LINKED_TREE"><CODE>TreeModel.LINKED_TREE</CODE></A>. However, in principle
a user-defined tree model can be used.<DT><B>Since:</B></DT>
<DD>9.2</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="setLineNumbering(boolean)"><!-- --></A><H3>
setLineNumbering</H3>
<PRE>
public void <B>setLineNumbering</B>(boolean option)</PRE>
<DL>
<DD>Say whether line numbering is to be enabled for documents constructed using this DocumentBuilder.
This has the effect that the line number in the original source document is maintained in the constructed
tree, for each element node (and only for elements). The line number in question is generally the line number
on which the closing ">" of the element start tag appears.
<p/>
<p>By default, line numbers are not maintained.</p>
<p/>
<p>Errors relating to document parsing and validation will generally contain line numbers whether or not
this option is set, because such errors are detected during document construction.</p>
<p/>
<p>Line numbering is not available for all kinds of source: for example,
it is not available when loading from an existing DOM Document.</p>
<p/>
<p>The resulting line numbers are accessible to applications using the
XPath extension function saxon:line-number() applied to a node, or using the
Java method <A HREF="../../../../net/sf/saxon/om/NodeInfo.html#getLineNumber()"><CODE>NodeInfo.getLineNumber()</CODE></A> </p>
<p/>
<p>Line numbers are maintained only for element nodes; the line number
returned for any other node will be that of the most recent element. For an element node, the
line number is generally that of the closing angle bracket at the end of the start tag
(this is what a SAX parser notifies)</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>option</CODE> - true if line numbers are to be maintained, false otherwise.</DL>
</DD>
</DL>
<HR>
<A NAME="isLineNumbering()"><!-- --></A><H3>
isLineNumbering</H3>
<PRE>
public boolean <B>isLineNumbering</B>()</PRE>
<DL>
<DD>Ask whether line numbering is enabled for documents loaded using this
<code>DocumentBuilder</code>.
<p/>
<p>By default, line numbering is disabled.</p>
<p/>
<p>Line numbering is not available for all kinds of source: in particular,
it is not available when loading from an existing XmlDocument.</p>
<p/>
<p>The resulting line numbers are accessible to applications using the
extension function saxon:line-number() applied to a node, or using the
Java method <A HREF="../../../../net/sf/saxon/om/NodeInfo.html#getLineNumber()"><CODE>NodeInfo.getLineNumber()</CODE></A></p>
<p/>
<p>Line numbers are maintained only for element nodes; the line number
returned for any other node will be that of the most recent element. For an element node, the
line number is generally that of the closing angle bracket at the end of the start tag
(this is what a SAX parser notifies)</p>
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true if line numbering is enabled</DL>
</DD>
</DL>
<HR>
<A NAME="setSchemaValidator(net.sf.saxon.s9api.SchemaValidator)"><!-- --></A><H3>
setSchemaValidator</H3>
<PRE>
public void <B>setSchemaValidator</B>(<A HREF="../../../../net/sf/saxon/s9api/SchemaValidator.html" title="class in net.sf.saxon.s9api">SchemaValidator</A> validator)</PRE>
<DL>
<DD>Set the schemaValidator to be used. This determines whether schema validation is applied to an input
document and whether type annotations in a supplied document are retained. If no schemaValidator
is supplied, then schema validation does not take place.
<p/>
<p>This option requires the schema-aware version of the Saxon product (Saxon-EE).</p>
<p/>
<p>Since a <code>SchemaValidator</code> is serially reusable but not thread-safe, using this
method is not appropriate when the <code>DocumentBuilder</code> is shared between threads.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>validator</CODE> - the SchemaValidator to be used</DL>
</DD>
</DL>
<HR>
<A NAME="getSchemaValidator()"><!-- --></A><H3>
getSchemaValidator</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/SchemaValidator.html" title="class in net.sf.saxon.s9api">SchemaValidator</A> <B>getSchemaValidator</B>()</PRE>
<DL>
<DD>Get the SchemaValidator used to validate documents loaded using this
<code>DocumentBuilder</code>.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the SchemaValidator if one has been set; otherwise null.</DL>
</DD>
</DL>
<HR>
<A NAME="setDTDValidation(boolean)"><!-- --></A><H3>
setDTDValidation</H3>
<PRE>
public void <B>setDTDValidation</B>(boolean option)</PRE>
<DL>
<DD>Set whether DTD validation should be applied to documents loaded using this
<code>DocumentBuilder</code>.
<p/>
<p>By default, no DTD validation takes place.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>option</CODE> - true if DTD validation is to be applied to the document</DL>
</DD>
</DL>
<HR>
<A NAME="isDTDValidation()"><!-- --></A><H3>
isDTDValidation</H3>
<PRE>
public boolean <B>isDTDValidation</B>()</PRE>
<DL>
<DD>Ask whether DTD validation is to be applied to documents loaded using this <code>DocumentBuilder</code>
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true if DTD validation is to be applied</DL>
</DD>
</DL>
<HR>
<A NAME="setWhitespaceStrippingPolicy(net.sf.saxon.s9api.WhitespaceStrippingPolicy)"><!-- --></A><H3>
setWhitespaceStrippingPolicy</H3>
<PRE>
public void <B>setWhitespaceStrippingPolicy</B>(<A HREF="../../../../net/sf/saxon/s9api/WhitespaceStrippingPolicy.html" title="class in net.sf.saxon.s9api">WhitespaceStrippingPolicy</A> policy)</PRE>
<DL>
<DD>Set the whitespace stripping policy applied when loading a document
using this <code>DocumentBuilder</code>.
<p/>
<p>By default, whitespace text nodes appearing in element-only content
are stripped, and all other whitespace text nodes are retained.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>policy</CODE> - the policy for stripping whitespace-only text nodes from
source documents</DL>
</DD>
</DL>
<HR>
<A NAME="getWhitespaceStrippingPolicy()"><!-- --></A><H3>
getWhitespaceStrippingPolicy</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/WhitespaceStrippingPolicy.html" title="class in net.sf.saxon.s9api">WhitespaceStrippingPolicy</A> <B>getWhitespaceStrippingPolicy</B>()</PRE>
<DL>
<DD>Get the white whitespace stripping policy applied when loading a document
using this <code>DocumentBuilder</code>.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the policy for stripping whitespace-only text nodes</DL>
</DD>
</DL>
<HR>
<A NAME="setBaseURI(java.net.URI)"><!-- --></A><H3>
setBaseURI</H3>
<PRE>
public void <B>setBaseURI</B>(<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> uri)</PRE>
<DL>
<DD>Set the base URI of a document loaded using this <code>DocumentBuilder</code>.
<p/>
<p>This is used for resolving any relative URIs appearing
within the document, for example in references to DTDs and external entities.</p>
<p/>
<p>This information is required when the document is loaded from a source that does not
provide an intrinsic URI, notably when loading from a Stream or a DOMSource. The value is
ignored when loading from a source that does have an intrinsic base URI.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>uri</CODE> - the base URI of documents loaded using this <code>DocumentBuilder</code>. This
must be an absolute URI.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the baseURI supplied is not an absolute URI</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 documents loaded using this DocumentBuilder when no other URI is available.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the base URI to be used, or null if no value has been set.</DL>
</DD>
</DL>
<HR>
<A NAME="setDocumentProjectionQuery(net.sf.saxon.s9api.XQueryExecutable)"><!-- --></A><H3>
setDocumentProjectionQuery</H3>
<PRE>
public void <B>setDocumentProjectionQuery</B>(<A HREF="../../../../net/sf/saxon/s9api/XQueryExecutable.html" title="class in net.sf.saxon.s9api">XQueryExecutable</A> query)</PRE>
<DL>
<DD>Set a compiled query to be used for implementing document projection. The effect of using
this option is that the tree constructed by the DocumentBuilder contains only those parts
of the source document that are needed to answer this query. Running this query against
the projected document should give the same results as against the raw document, but the
projected document typically occupies significantly less memory. It is permissible to run
other queries against the projected document, but unless they are carefully chosen, they
will give the wrong answer, because the document being used is different from the original.
<p>The query should be written to use the projected document as its initial context item.
For example, if the query is <code>//ITEM[COLOR='blue')</code>, then only <code>ITEM</code>
elements and their <code>COLOR</code> children will be retained in the projected document.</p>
<p>This facility is only available in Saxon-EE; if the facility is not available,
calling this method has no effect.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>query</CODE> - the compiled query used to control document projection<DT><B>Since:</B></DT>
<DD>9.3</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getDocumentProjectionQuery()"><!-- --></A><H3>
getDocumentProjectionQuery</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/XQueryExecutable.html" title="class in net.sf.saxon.s9api">XQueryExecutable</A> <B>getDocumentProjectionQuery</B>()</PRE>
<DL>
<DD>Get the compiled query to be used for implementing document projection.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the query set using <A HREF="../../../../net/sf/saxon/s9api/DocumentBuilder.html#setDocumentProjectionQuery(net.sf.saxon.s9api.XQueryExecutable)"><CODE>setDocumentProjectionQuery(net.sf.saxon.s9api.XQueryExecutable)</CODE></A> if this
has been called, or null otherwise<DT><B>Since:</B></DT>
<DD>9.3. In 9.4 the unused and undocumented first argument is removed.</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="build(javax.xml.transform.Source)"><!-- --></A><H3>
build</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/XdmNode.html" title="class in net.sf.saxon.s9api">XdmNode</A> <B>build</B>(<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> source)
throws <A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></PRE>
<DL>
<DD>Load an XML document, to create a tree representation of the document in memory.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>source</CODE> - A JAXP Source object identifying the source of the document. This can always be
a <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/stream/StreamSource.html?is-external=true" title="class or interface in javax.xml.transform.stream"><CODE>StreamSource</CODE></A> or a <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/sax/SAXSource.html?is-external=true" title="class or interface in javax.xml.transform.sax"><CODE>SAXSource</CODE></A>.
Some kinds of Source are consumed by this method, and should only be used once.
<p/>
<p>If a SAXSource is supplied, the XMLReader held within the SAXSource may be modified (by setting
features and properties) to reflect the options selected on this DocumentBuilder.</p>
<p>An instance of <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/dom/DOMSource.html?is-external=true" title="class or interface in javax.xml.transform.dom"><CODE>DOMSource</CODE></A> is accepted provided that the Saxon support
code for DOM (in saxon9-dom.jar) is on the classpath.</p>
<p/>
<p>If the source is an instance of <A HREF="../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om"><CODE>NodeInfo</CODE></A> then the subtree rooted at this node
will be copied (applying schema validation if requested) to create a new tree.</p>
<p/>
<p>Saxon also accepts an instance of <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/stax/StAXSource.html?is-external=true" title="class or interface in javax.xml.transform.stax"><CODE>StAXSource</CODE></A> or
<A HREF="../../../../net/sf/saxon/pull/PullSource.html" title="class in net.sf.saxon.pull"><CODE>PullSource</CODE></A>, which can be used to supply a document that is to be parsed
using a StAX parser.</p>
<p>(9.2) This method no longer accepts an instance of <A HREF="../../../../net/sf/saxon/lib/AugmentedSource.html" title="class in net.sf.saxon.lib"><CODE>AugmentedSource</CODE></A>, because of
confusion over interactions between the properties of the AugmentedSource and the properties
of this DocumentBuilder.</p>
<DT><B>Returns:</B><DD>An <code>XdmNode</code>. This will be
the document node at the root of the tree of the resulting in-memory document.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if the source argument is null
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the kind of source is not recognized
<DD><CODE><A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></CODE> - if any other failure occurs building the document, for example
a parsing error</DL>
</DD>
</DL>
<HR>
<A NAME="build(java.io.File)"><!-- --></A><H3>
build</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/XdmNode.html" title="class in net.sf.saxon.s9api">XdmNode</A> <B>build</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> file)
throws <A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></PRE>
<DL>
<DD>Build a document from a supplied XML file
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>file</CODE> - the supplied file
<DT><B>Returns:</B><DD>the XdmNode representing the root of the document tree
<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 any failure occurs retrieving or parsing the document</DL>
</DD>
</DL>
<HR>
<A NAME="newBuildingContentHandler()"><!-- --></A><H3>
newBuildingContentHandler</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/BuildingContentHandler.html" title="interface in net.sf.saxon.s9api">BuildingContentHandler</A> <B>newBuildingContentHandler</B>()
throws <A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></PRE>
<DL>
<DD>Get an <A HREF="http://download.oracle.com/javase/6/docs/api/org/xml/sax/ContentHandler.html?is-external=true" title="class or interface in org.xml.sax"><CODE>ContentHandler</CODE></A> that may be used to build the document programmatically.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a newly constructed <A HREF="../../../../net/sf/saxon/s9api/BuildingContentHandler.html" title="interface in net.sf.saxon.s9api"><CODE>BuildingContentHandler</CODE></A>, which implements the <code>ContentHandler</code>
interface. If schema validation has been requested for this <code>DocumentBuilder</code>, then the document constructed
using the <code>ContentHandler</code> will be validated as it is written.
<p>Note that the returned <code>ContentHandler</code> expects namespace scopes to be indicated
explicitly by calls to <A HREF="http://download.oracle.com/javase/6/docs/api/org/xml/sax/ContentHandler.html?is-external=true#startPrefixMapping(java.lang.String, java.lang.String)" title="class or interface in org.xml.sax"><CODE>ContentHandler.startPrefixMapping(java.lang.String, java.lang.String)</CODE></A> and
<A HREF="http://download.oracle.com/javase/6/docs/api/org/xml/sax/ContentHandler.html?is-external=true#endPrefixMapping(java.lang.String)" title="class or interface in org.xml.sax"><CODE>ContentHandler.endPrefixMapping(java.lang.String)</CODE></A>.</p>
<p>If the stream of events supplied to the <code>ContentHandler</code> does not constitute
a well formed (and namespace-well-formed) document, the effect is undefined; Saxon may fail
to detect the error, and construct an unusable tree. </p>
<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 any failure occurs<DT><B>Since:</B></DT>
<DD>9.3</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="newBuildingStreamWriter()"><!-- --></A><H3>
newBuildingStreamWriter</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/BuildingStreamWriterImpl.html" title="class in net.sf.saxon.s9api">BuildingStreamWriterImpl</A> <B>newBuildingStreamWriter</B>()
throws <A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></PRE>
<DL>
<DD>Get an <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/stream/XMLStreamWriter.html?is-external=true" title="class or interface in javax.xml.stream"><CODE>XMLStreamWriter</CODE></A> that may be used to build the document programmatically.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a newly constructed <A HREF="../../../../net/sf/saxon/s9api/BuildingStreamWriter.html" title="interface in net.sf.saxon.s9api"><CODE>BuildingStreamWriter</CODE></A>, which implements the <code>XMLStreamWriter</code>
interface. If schema validation has been requested for this <code>DocumentBuilder</code>, then the document constructed
using the <code>XMLStreamWriter</code> will be validated as it is written.
<p>If the stream of events supplied to the <code>XMLStreamWriter</code> does not constitute
a well formed (and namespace-well-formed) document, the effect is undefined; Saxon may fail
to detect the error, and construct an unusable tree. </p>
<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 any failure occurs<DT><B>Since:</B></DT>
<DD>9.3</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="wrap(java.lang.Object)"><!-- --></A><H3>
wrap</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/s9api/XdmNode.html" title="class in net.sf.saxon.s9api">XdmNode</A> <B>wrap</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> node)
throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
<DL>
<DD>Create a node by wrapping a recognized external node from a supported object model.
<p>If the supplied object implements the <A HREF="../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om"><CODE>NodeInfo</CODE></A> interface then it
will be wrapped as an <code>XdmNode</code> without copying and without change. The <code>NodeInfo</code>
must have been created using a <A HREF="../../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon"><CODE>Configuration</CODE></A> compatible
with the one used by this <code>Processor</code> (specifically, one that uses the same
<A HREF="../../../../net/sf/saxon/om/NamePool.html" title="class in net.sf.saxon.om"><CODE>NamePool</CODE></A>)</p>
<p>To wrap nodes from other object models, such as DOM, the support module for the external object
model must be on the class path and registered with the Saxon configuration. The support modules
for DOM, JDOM, DOM4J and XOM are registered automatically if they can be found on the classpath.</p>
<p>It is best to avoid calling this method repeatedly to wrap different nodes in the same document.
Each such wrapper conceptually creates a new XDM tree instance with its own identity. Although the
memory is shared, operations that rely on node identity might not have the expected result. It is
best to create a single wrapper for the document node, and then to navigate to the other nodes in the
tree using S9API interfaces.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - the node in the external tree representation. Either an instance of
<A HREF="../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om"><CODE>NodeInfo</CODE></A>, or an instances of a node in an external object model.
Nodes in other object models (such as DOM, JDOM, etc) are recognized only if
the support module for the external object model is known to the Configuration.
<DT><B>Returns:</B><DD>the supplied node wrapped as an XdmNode
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the type of object supplied is not recognized. This may be because
node was created using a different Saxon Processor, or because the required code for the external
object model is not on the class path</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/Destination.html" title="interface in net.sf.saxon.s9api"><B>PREV CLASS</B></A>
<A HREF="../../../../net/sf/saxon/s9api/DOMDestination.html" title="class 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/DocumentBuilder.html" target="_top"><B>FRAMES</B></A>
<A HREF="DocumentBuilder.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>
