<!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:19 GMT 2011 -->
<TITLE>
AugmentedSource
</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="AugmentedSource";
}
}
</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">
PREV CLASS
<A HREF="../../../../net/sf/saxon/lib/CollationURIResolver.html" title="interface in net.sf.saxon.lib"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/lib/AugmentedSource.html" target="_top"><B>FRAMES</B></A>
<A HREF="AugmentedSource.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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <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.lib</FONT>
<BR>
Class AugmentedSource</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.lib.AugmentedSource</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><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></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>AugmentedSource</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><DT>implements <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></DL>
</PRE>
<P>
This class is an extension of the JAXP Source interface. The class can be used
wherever a JAXP Source object can be used, and it provides additional information
about the way that the Source is to be processed: for example, it indicates
whether or not it should be validated against a schema. Other options that can
be set include the SAX XMLReader to be used, and the choice of whether a source
in the form of an existing tree should be copied or wrapped.
<p>Internally, an AugmentedSource combines an underlying Source object with a
<A HREF="../../../../net/sf/saxon/lib/ParseOptions.html" title="class in net.sf.saxon.lib"><CODE>ParseOptions</CODE></A> object holding the selected options. Many Saxon interfaces allow
the ParseOptions to be supplied directly, making this class unnecessary; but it is useful
when passing a Source to a JAXP interface that does not allow further options to be
supplied.</p>
<P>
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>8.8</DD>
</DL>
<HR>
<P>
<!-- ========== 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> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/lib/AugmentedSource.html#addFilter(net.sf.saxon.event.FilterFactory)">addFilter</A></B>(<A HREF="../../../../net/sf/saxon/event/FilterFactory.html" title="interface in net.sf.saxon.event">FilterFactory</A> filter)</CODE>
<BR>
Add a filter to the list of filters to be applied to the raw input</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/lib/AugmentedSource.html#close()">close</A></B>()</CODE>
<BR>
Close any resources held by this Source.</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/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/lib/AugmentedSource.html#getContainedSource()">getContainedSource</A></B>()</CODE>
<BR>
Get the Source object wrapped by this AugmentedSource</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/lib/AugmentedSource.html#getDTDValidation()">getDTDValidation</A></B>()</CODE>
<BR>
Get whether or not DTD validation of this source is required</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/org/xml/sax/EntityResolver.html?is-external=true" title="class or interface in org.xml.sax">EntityResolver</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/lib/AugmentedSource.html#getEntityResolver()">getEntityResolver</A></B>()</CODE>
<BR>
Get the EntityResolver that will be used when parsing</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/javax/xml/transform/ErrorListener.html?is-external=true" title="class or interface in javax.xml.transform">ErrorListener</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/lib/AugmentedSource.html#getErrorListener()">getErrorListener</A></B>()</CODE>
<BR>
Get the ErrorListener that will be used when parsing</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/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../net/sf/saxon/event/FilterFactory.html" title="interface in net.sf.saxon.event">FilterFactory</A>></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/lib/AugmentedSource.html#getFilters()">getFilters</A></B>()</CODE>
<BR>
Get the list of filters to be applied to the input.</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/lib/AugmentedSource.html#getModel()">getModel</A></B>()</CODE>
<BR>
Get the tree model that will be used.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/lib/ParseOptions.html" title="class in net.sf.saxon.lib">ParseOptions</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/lib/AugmentedSource.html#getParseOptions()">getParseOptions</A></B>()</CODE>
<BR>
Get the ParseOptions defined in this AugmentedSource</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/lib/AugmentedSource.html#getSchemaValidation()">getSchemaValidation</A></B>()</CODE>
<BR>
Get whether or not schema validation of this source is required</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/lib/AugmentedSource.html#getStripSpace()">getStripSpace</A></B>()</CODE>
<BR>
Get the space-stripping action to be applied to the 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/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/lib/AugmentedSource.html#getSystemId()">getSystemId</A></B>()</CODE>
<BR>
Get the System ID.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/om/StructuredQName.html" title="class in net.sf.saxon.om">StructuredQName</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/lib/AugmentedSource.html#getTopLevelElement()">getTopLevelElement</A></B>()</CODE>
<BR>
Get the name of the top-level element for validation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/type/SchemaType.html" title="interface in net.sf.saxon.type">SchemaType</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/lib/AugmentedSource.html#getTopLevelType()">getTopLevelType</A></B>()</CODE>
<BR>
Get the type of the document element for validation.</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/lib/AugmentedSource.html#getTreeModel()">getTreeModel</A></B>()</CODE>
<BR>
<B>Deprecated.</B> <I>since 9.2: use <A HREF="../../../../net/sf/saxon/lib/AugmentedSource.html#getModel()"><CODE>getModel()</CODE></A></I></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/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/lib/AugmentedSource.html#getWrapDocument()">getWrapDocument</A></B>()</CODE>
<BR>
Assuming that the contained Source is a node in a tree, determine whether a tree will be created
as a view of this supplied tree, or as a copy.</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/org/xml/sax/XMLReader.html?is-external=true" title="class or interface in org.xml.sax">XMLReader</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/lib/AugmentedSource.html#getXMLReader()">getXMLReader</A></B>()</CODE>
<BR>
Get the SAX parser (XMLReader) to be used</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/lib/AugmentedSource.html#isLineNumbering()">isLineNumbering</A></B>()</CODE>
<BR>
Get whether line numbers are to be maintained in the constructed document</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/lib/AugmentedSource.html#isLineNumberingSet()">isLineNumberingSet</A></B>()</CODE>
<BR>
Determine whether setLineNumbering() has been called</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/lib/AugmentedSource.html#isPleaseCloseAfterUse()">isPleaseCloseAfterUse</A></B>()</CODE>
<BR>
Determine whether or not the user of this Source is encouraged to close it as soon as reading is
finished.</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/lib/AugmentedSource.html#isXIncludeAware()">isXIncludeAware</A></B>()</CODE>
<BR>
Get state of XInclude processing.</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/lib/AugmentedSource.html#isXIncludeAwareSet()">isXIncludeAwareSet</A></B>()</CODE>
<BR>
Determine whether setXIncludeAware() has been called.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../../../net/sf/saxon/lib/AugmentedSource.html" title="class in net.sf.saxon.lib">AugmentedSource</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/lib/AugmentedSource.html#makeAugmentedSource(javax.xml.transform.Source)">makeAugmentedSource</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>
Create an AugmentedSource that wraps a given Source object.</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/lib/AugmentedSource.html#setDTDValidationMode(int)">setDTDValidationMode</A></B>(int option)</CODE>
<BR>
Set whether or not DTD validation of this source is required</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/lib/AugmentedSource.html#setEntityResolver(org.xml.sax.EntityResolver)">setEntityResolver</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/org/xml/sax/EntityResolver.html?is-external=true" title="class or interface in org.xml.sax">EntityResolver</A> resolver)</CODE>
<BR>
Set an EntityResolver to be used when parsing.</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/lib/AugmentedSource.html#setErrorListener(javax.xml.transform.ErrorListener)">setErrorListener</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/ErrorListener.html?is-external=true" title="class or interface in javax.xml.transform">ErrorListener</A> listener)</CODE>
<BR>
Set an ErrorListener to be used when parsing</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/lib/AugmentedSource.html#setLineNumbering(boolean)">setLineNumbering</A></B>(boolean lineNumbering)</CODE>
<BR>
Set whether line numbers are to be maintained in the constructed document</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/lib/AugmentedSource.html#setModel(net.sf.saxon.om.TreeModel)">setModel</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 use.</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/lib/AugmentedSource.html#setPleaseCloseAfterUse(boolean)">setPleaseCloseAfterUse</A></B>(boolean close)</CODE>
<BR>
Set whether or not the user of this Source is encouraged to close it as soon as reading is finished.</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/lib/AugmentedSource.html#setSchemaValidationMode(int)">setSchemaValidationMode</A></B>(int option)</CODE>
<BR>
Set whether or not schema validation of this source is required</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/lib/AugmentedSource.html#setStripSpace(int)">setStripSpace</A></B>(int stripAction)</CODE>
<BR>
Set the space-stripping action to be applied to the source document</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/lib/AugmentedSource.html#setSystemId(java.lang.String)">setSystemId</A></B>(<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> id)</CODE>
<BR>
Set the System ID.</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/lib/AugmentedSource.html#setTopLevelElement(net.sf.saxon.om.StructuredQName)">setTopLevelElement</A></B>(<A HREF="../../../../net/sf/saxon/om/StructuredQName.html" title="class in net.sf.saxon.om">StructuredQName</A> elementName)</CODE>
<BR>
Set the name of the top-level element for validation.</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/lib/AugmentedSource.html#setTopLevelType(net.sf.saxon.type.SchemaType)">setTopLevelType</A></B>(<A HREF="../../../../net/sf/saxon/type/SchemaType.html" title="interface in net.sf.saxon.type">SchemaType</A> type)</CODE>
<BR>
Set the type of the top-level element for validation.</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/lib/AugmentedSource.html#setTreeModel(int)">setTreeModel</A></B>(int model)</CODE>
<BR>
<B>Deprecated.</B> <I>since 9.2: use <A HREF="../../../../net/sf/saxon/lib/AugmentedSource.html#setModel(net.sf.saxon.om.TreeModel)"><CODE>setModel(net.sf.saxon.om.TreeModel)</CODE></A></I></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/lib/AugmentedSource.html#setWrapDocument(java.lang.Boolean)">setWrapDocument</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</A> wrap)</CODE>
<BR>
Assuming that the contained Source is a node in a tree, indicate whether a tree should be created
as a view of this supplied tree, or as a copy.</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/lib/AugmentedSource.html#setXIncludeAware(boolean)">setXIncludeAware</A></B>(boolean state)</CODE>
<BR>
Set state of XInclude processing.</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/lib/AugmentedSource.html#setXMLReader(org.xml.sax.XMLReader)">setXMLReader</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/org/xml/sax/XMLReader.html?is-external=true" title="class or interface in org.xml.sax">XMLReader</A> parser)</CODE>
<BR>
Set the SAX parser (XMLReader) to be used</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>
<!-- ============ 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="makeAugmentedSource(javax.xml.transform.Source)"><!-- --></A><H3>
makeAugmentedSource</H3>
<PRE>
public static <A HREF="../../../../net/sf/saxon/lib/AugmentedSource.html" title="class in net.sf.saxon.lib">AugmentedSource</A> <B>makeAugmentedSource</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)</PRE>
<DL>
<DD>Create an AugmentedSource that wraps a given Source object. If this is already
an AugmentedSource, the original AugmentedSource is returned. Note that this means that
setting any properties on the returned AugmentedSource will also affect the original.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>source</CODE> - the Source object to be wrapped
<DT><B>Returns:</B><DD>an AugmentedSource<DT><B>Since:</B></DT>
<DD>8.8</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="addFilter(net.sf.saxon.event.FilterFactory)"><!-- --></A><H3>
addFilter</H3>
<PRE>
public void <B>addFilter</B>(<A HREF="../../../../net/sf/saxon/event/FilterFactory.html" title="interface in net.sf.saxon.event">FilterFactory</A> filter)</PRE>
<DL>
<DD>Add a filter to the list of filters to be applied to the raw input
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>filter</CODE> - a factory for the filter to be added</DL>
</DD>
</DL>
<HR>
<A NAME="getFilters()"><!-- --></A><H3>
getFilters</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../net/sf/saxon/event/FilterFactory.html" title="interface in net.sf.saxon.event">FilterFactory</A>> <B>getFilters</B>()</PRE>
<DL>
<DD>Get the list of filters to be applied to the input. Returns null if there are no filters.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the list of filters, if there are any</DL>
</DD>
</DL>
<HR>
<A NAME="getContainedSource()"><!-- --></A><H3>
getContainedSource</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>getContainedSource</B>()</PRE>
<DL>
<DD>Get the Source object wrapped by this AugmentedSource
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the contained Source object<DT><B>Since:</B></DT>
<DD>8.8</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getParseOptions()"><!-- --></A><H3>
getParseOptions</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/lib/ParseOptions.html" title="class in net.sf.saxon.lib">ParseOptions</A> <B>getParseOptions</B>()</PRE>
<DL>
<DD>Get the ParseOptions defined in this AugmentedSource
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the ParseOptions, a bundle of options equivalent to obtaining all the
properties individually. Changes to this object will be live, that is, they will
affect the AugmentedSource from which they came.</DL>
</DD>
</DL>
<HR>
<A NAME="setStripSpace(int)"><!-- --></A><H3>
setStripSpace</H3>
<PRE>
public void <B>setStripSpace</B>(int stripAction)</PRE>
<DL>
<DD>Set the space-stripping action to be applied to the source document
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>stripAction</CODE> - one of <A HREF="../../../../net/sf/saxon/value/Whitespace.html#IGNORABLE"><CODE>Whitespace.IGNORABLE</CODE></A>,
<A HREF="../../../../net/sf/saxon/value/Whitespace.html#ALL"><CODE>Whitespace.ALL</CODE></A>, or <A HREF="../../../../net/sf/saxon/value/Whitespace.html#NONE"><CODE>Whitespace.NONE</CODE></A><DT><B>Since:</B></DT>
<DD>8.8</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getStripSpace()"><!-- --></A><H3>
getStripSpace</H3>
<PRE>
public int <B>getStripSpace</B>()</PRE>
<DL>
<DD>Get the space-stripping action to be applied to the source document
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>one of <A HREF="../../../../net/sf/saxon/value/Whitespace.html#IGNORABLE"><CODE>Whitespace.IGNORABLE</CODE></A>,
<A HREF="../../../../net/sf/saxon/value/Whitespace.html#ALL"><CODE>Whitespace.ALL</CODE></A>, or <A HREF="../../../../net/sf/saxon/value/Whitespace.html#NONE"><CODE>Whitespace.NONE</CODE></A><DT><B>Since:</B></DT>
<DD>8.8</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="setTreeModel(int)"><!-- --></A><H3>
setTreeModel</H3>
<PRE>
public void <B>setTreeModel</B>(int model)</PRE>
<DL>
<DD><B>Deprecated.</B> <I>since 9.2: use <A HREF="../../../../net/sf/saxon/lib/AugmentedSource.html#setModel(net.sf.saxon.om.TreeModel)"><CODE>setModel(net.sf.saxon.om.TreeModel)</CODE></A></I>
<P>
<DD>Set the tree model to use. Default is the tiny tree
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>model</CODE> - one of <A HREF="../../../../net/sf/saxon/event/Builder.html#TINY_TREE"><CODE>Builder.TINY_TREE</CODE></A>, <A HREF="../../../../net/sf/saxon/event/Builder.html#TINY_TREE_CONDENSED"><CODE>Builder.TINY_TREE_CONDENSED</CODE></A> or
<A HREF="../../../../net/sf/saxon/event/Builder.html#LINKED_TREE"><CODE>Builder.LINKED_TREE</CODE></A><DT><B>Since:</B></DT>
<DD>8.9 (Condensed tree added in 9.2)</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getTreeModel()"><!-- --></A><H3>
getTreeModel</H3>
<PRE>
public int <B>getTreeModel</B>()</PRE>
<DL>
<DD><B>Deprecated.</B> <I>since 9.2: use <A HREF="../../../../net/sf/saxon/lib/AugmentedSource.html#getModel()"><CODE>getModel()</CODE></A></I>
<P>
<DD>Get the tree model that will be used.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>one of <A HREF="../../../../net/sf/saxon/event/Builder.html#TINY_TREE"><CODE>Builder.TINY_TREE</CODE></A>, <A HREF="../../../../net/sf/saxon/event/Builder.html#TINY_TREE_CONDENSED"><CODE>Builder.TINY_TREE_CONDENSED</CODE></A>,
<A HREF="../../../../net/sf/saxon/event/Builder.html#LINKED_TREE"><CODE>Builder.LINKED_TREE</CODE></A>, or {link Builder#UNSPECIFIED_TREE_MODEL}
if no call on setTreeModel() has been made<DT><B>Since:</B></DT>
<DD>8.9 (Condensed tree added in 9.2)</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="setModel(net.sf.saxon.om.TreeModel)"><!-- --></A><H3>
setModel</H3>
<PRE>
public void <B>setModel</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 use. Default is the tiny tree
<P>
<DD><DL>
</DL>
</DD>
<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>. 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="getModel()"><!-- --></A><H3>
getModel</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/om/TreeModel.html" title="class in net.sf.saxon.om">TreeModel</A> <B>getModel</B>()</PRE>
<DL>
<DD>Get the tree model that will be used.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>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="setSchemaValidationMode(int)"><!-- --></A><H3>
setSchemaValidationMode</H3>
<PRE>
public void <B>setSchemaValidationMode</B>(int option)</PRE>
<DL>
<DD>Set whether or not schema validation of this source is required
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>option</CODE> - one of <A HREF="../../../../net/sf/saxon/lib/Validation.html#STRICT"><CODE>Validation.STRICT</CODE></A>,
<A HREF="../../../../net/sf/saxon/lib/Validation.html#LAX"><CODE>Validation.LAX</CODE></A>, <A HREF="../../../../net/sf/saxon/lib/Validation.html#STRIP"><CODE>Validation.STRIP</CODE></A>,
<A HREF="../../../../net/sf/saxon/lib/Validation.html#PRESERVE"><CODE>Validation.PRESERVE</CODE></A>, <A HREF="../../../../net/sf/saxon/lib/Validation.html#DEFAULT"><CODE>Validation.DEFAULT</CODE></A><DT><B>Since:</B></DT>
<DD>8.8</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getSchemaValidation()"><!-- --></A><H3>
getSchemaValidation</H3>
<PRE>
public int <B>getSchemaValidation</B>()</PRE>
<DL>
<DD>Get whether or not schema validation of this source is required
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the validation mode requested, or <A HREF="../../../../net/sf/saxon/lib/Validation.html#DEFAULT"><CODE>Validation.DEFAULT</CODE></A>
to use the default validation mode from the Configuration.<DT><B>Since:</B></DT>
<DD>8.8</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="setTopLevelElement(net.sf.saxon.om.StructuredQName)"><!-- --></A><H3>
setTopLevelElement</H3>
<PRE>
public void <B>setTopLevelElement</B>(<A HREF="../../../../net/sf/saxon/om/StructuredQName.html" title="class in net.sf.saxon.om">StructuredQName</A> elementName)</PRE>
<DL>
<DD>Set the name of the top-level element for validation.
If a top-level element is set then the document
being validated must have this as its outermost element
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>elementName</CODE> - the QName of the required top-level element, or null to unset the value<DT><B>Since:</B></DT>
<DD>9.0</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getTopLevelElement()"><!-- --></A><H3>
getTopLevelElement</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/om/StructuredQName.html" title="class in net.sf.saxon.om">StructuredQName</A> <B>getTopLevelElement</B>()</PRE>
<DL>
<DD>Get the name of the top-level element for validation.
If a top-level element is set then the document
being validated must have this as its outermost element
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the QName of the required top-level element, or null if no value is set<DT><B>Since:</B></DT>
<DD>9.0</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="setTopLevelType(net.sf.saxon.type.SchemaType)"><!-- --></A><H3>
setTopLevelType</H3>
<PRE>
public void <B>setTopLevelType</B>(<A HREF="../../../../net/sf/saxon/type/SchemaType.html" title="interface in net.sf.saxon.type">SchemaType</A> type)</PRE>
<DL>
<DD>Set the type of the top-level element for validation.
If this is set then the document element is validated against this type
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>type</CODE> - the schema type required for the document element, or null to unset the value<DT><B>Since:</B></DT>
<DD>9.0</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getTopLevelType()"><!-- --></A><H3>
getTopLevelType</H3>
<PRE>
public <A HREF="../../../../net/sf/saxon/type/SchemaType.html" title="interface in net.sf.saxon.type">SchemaType</A> <B>getTopLevelType</B>()</PRE>
<DL>
<DD>Get the type of the document element for validation.
If this is set then the document element of the document
being validated must have this type
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the type of the required top-level element, or null if no value is set<DT><B>Since:</B></DT>
<DD>9.0</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="setDTDValidationMode(int)"><!-- --></A><H3>
setDTDValidationMode</H3>
<PRE>
public void <B>setDTDValidationMode</B>(int option)</PRE>
<DL>
<DD>Set whether or not DTD validation of this source is required
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>option</CODE> - one of <A HREF="../../../../net/sf/saxon/lib/Validation.html#STRICT"><CODE>Validation.STRICT</CODE></A>,
<A HREF="../../../../net/sf/saxon/lib/Validation.html#STRIP"><CODE>Validation.STRIP</CODE></A>, <A HREF="../../../../net/sf/saxon/lib/Validation.html#DEFAULT"><CODE>Validation.DEFAULT</CODE></A><DT><B>Since:</B></DT>
<DD>8.8</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getDTDValidation()"><!-- --></A><H3>
getDTDValidation</H3>
<PRE>
public int <B>getDTDValidation</B>()</PRE>
<DL>
<DD>Get whether or not DTD validation of this source is required
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the validation mode requested, or <A HREF="../../../../net/sf/saxon/lib/Validation.html#DEFAULT"><CODE>Validation.DEFAULT</CODE></A>
to use the default validation mode from the Configuration.<DT><B>Since:</B></DT>
<DD>8.8</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="setLineNumbering(boolean)"><!-- --></A><H3>
setLineNumbering</H3>
<PRE>
public void <B>setLineNumbering</B>(boolean lineNumbering)</PRE>
<DL>
<DD>Set whether line numbers are to be maintained in the constructed document
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>lineNumbering</CODE> - true if line numbers are to be maintained<DT><B>Since:</B></DT>
<DD>8.8</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="isLineNumbering()"><!-- --></A><H3>
isLineNumbering</H3>
<PRE>
public boolean <B>isLineNumbering</B>()</PRE>
<DL>
<DD>Get whether line numbers are to be maintained in the constructed document
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if line numbers are maintained<DT><B>Since:</B></DT>
<DD>8.8</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="isLineNumberingSet()"><!-- --></A><H3>
isLineNumberingSet</H3>
<PRE>
public boolean <B>isLineNumberingSet</B>()</PRE>
<DL>
<DD>Determine whether setLineNumbering() has been called
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if setLineNumbering() has been called<DT><B>Since:</B></DT>
<DD>8.9</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="setXMLReader(org.xml.sax.XMLReader)"><!-- --></A><H3>
setXMLReader</H3>
<PRE>
public void <B>setXMLReader</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/org/xml/sax/XMLReader.html?is-external=true" title="class or interface in org.xml.sax">XMLReader</A> parser)</PRE>
<DL>
<DD>Set the SAX parser (XMLReader) to be used
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>parser</CODE> - the SAX parser<DT><B>Since:</B></DT>
<DD>8.8</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getXMLReader()"><!-- --></A><H3>
getXMLReader</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/6/docs/api/org/xml/sax/XMLReader.html?is-external=true" title="class or interface in org.xml.sax">XMLReader</A> <B>getXMLReader</B>()</PRE>
<DL>
<DD>Get the SAX parser (XMLReader) to be used
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the parser<DT><B>Since:</B></DT>
<DD>8.8</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="setWrapDocument(java.lang.Boolean)"><!-- --></A><H3>
setWrapDocument</H3>
<PRE>
public void <B>setWrapDocument</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</A> wrap)</PRE>
<DL>
<DD>Assuming that the contained Source is a node in a tree, indicate whether a tree should be created
as a view of this supplied tree, or as a copy.
<p>This option is used only when the Source is supplied to an interface such as the JAXP
Transformer.transform() method where there is no other way of indicating whether a supplied
external document should be wrapped or copied. It is not used when the Source is supplied to
a Saxon-defined interface.</p>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>wrap</CODE> - if true, the node in the supplied Source is wrapped, to create a view. If false, the node
and its contained subtree is copied. If null, the system default is chosen.<DT><B>Since:</B></DT>
<DD>8.8</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getWrapDocument()"><!-- --></A><H3>
getWrapDocument</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</A> <B>getWrapDocument</B>()</PRE>
<DL>
<DD>Assuming that the contained Source is a node in a tree, determine whether a tree will be created
as a view of this supplied tree, or as a copy.
<p>This option is used only when the Source is supplied to an interface such as the JAXP
Transformer.transform() method where there is no other way of indicating whether a supplied
external document should be wrapped or copied. It is not used when the Source is supplied to
a Saxon-defined interface.</p>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>if true, the node in the supplied Source is wrapped, to create a view. If false, the node
and its contained subtree is copied. If null, the system default is chosen.<DT><B>Since:</B></DT>
<DD>8.8</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="setSystemId(java.lang.String)"><!-- --></A><H3>
setSystemId</H3>
<PRE>
public void <B>setSystemId</B>(<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> id)</PRE>
<DL>
<DD>Set the System ID. This sets the System Id on the underlying Source object.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/Source.html?is-external=true#setSystemId(java.lang.String)" title="class or interface in javax.xml.transform">setSystemId</A></CODE> in interface <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></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>id</CODE> - the System ID. This provides a base URI for the document, and also the result
of the document-uri() function<DT><B>Since:</B></DT>
<DD>8.8</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getSystemId()"><!-- --></A><H3>
getSystemId</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>getSystemId</B>()</PRE>
<DL>
<DD>Get the System ID. This gets the System Id on the underlying Source object.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/Source.html?is-external=true#getSystemId()" title="class or interface in javax.xml.transform">getSystemId</A></CODE> in interface <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></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the System ID: effectively the base URI.<DT><B>Since:</B></DT>
<DD>8.8</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="setXIncludeAware(boolean)"><!-- --></A><H3>
setXIncludeAware</H3>
<PRE>
public void <B>setXIncludeAware</B>(boolean state)</PRE>
<DL>
<DD><p>Set state of XInclude processing.</p>
<p/>
<p>If XInclude markup is found in the document instance, should it be
processed as specified in <a href="http://www.w3.org/TR/xinclude/">
XML Inclusions (XInclude) Version 1.0</a>.</p>
<p/>
<p>XInclude processing defaults to <code>false</code>.</p>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>state</CODE> - Set XInclude processing to <code>true</code> or
<code>false</code><DT><B>Since:</B></DT>
<DD>8.9</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="isXIncludeAwareSet()"><!-- --></A><H3>
isXIncludeAwareSet</H3>
<PRE>
public boolean <B>isXIncludeAwareSet</B>()</PRE>
<DL>
<DD><p>Determine whether setXIncludeAware() has been called.</p>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if setXIncludeAware() has been called<DT><B>Since:</B></DT>
<DD>8.9</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="isXIncludeAware()"><!-- --></A><H3>
isXIncludeAware</H3>
<PRE>
public boolean <B>isXIncludeAware</B>()</PRE>
<DL>
<DD><p>Get state of XInclude processing.</p>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>current state of XInclude processing. Default value is false.<DT><B>Since:</B></DT>
<DD>8.9</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="setEntityResolver(org.xml.sax.EntityResolver)"><!-- --></A><H3>
setEntityResolver</H3>
<PRE>
public void <B>setEntityResolver</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/org/xml/sax/EntityResolver.html?is-external=true" title="class or interface in org.xml.sax">EntityResolver</A> resolver)</PRE>
<DL>
<DD>Set an EntityResolver to be used when parsing. Note this is used only
when a system-allocated parser is used; when a user-supplied parser
is used (for example in a SAXSource), the EntityResolver should be preinitialized.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>resolver</CODE> - the EntityResolver to be used<DT><B>Since:</B></DT>
<DD>8.9. The method had no useful effect in releases prior to 9.2.</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getEntityResolver()"><!-- --></A><H3>
getEntityResolver</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/6/docs/api/org/xml/sax/EntityResolver.html?is-external=true" title="class or interface in org.xml.sax">EntityResolver</A> <B>getEntityResolver</B>()</PRE>
<DL>
<DD>Get the EntityResolver that will be used when parsing
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the EntityResolver, if one has been set using <A HREF="../../../../net/sf/saxon/lib/AugmentedSource.html#setEntityResolver(org.xml.sax.EntityResolver)"><CODE>setEntityResolver(org.xml.sax.EntityResolver)</CODE></A>,
otherwise null.<DT><B>Since:</B></DT>
<DD>8.9 The method had no useful effect in releases prior to 9.2.</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="setErrorListener(javax.xml.transform.ErrorListener)"><!-- --></A><H3>
setErrorListener</H3>
<PRE>
public void <B>setErrorListener</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/ErrorListener.html?is-external=true" title="class or interface in javax.xml.transform">ErrorListener</A> listener)</PRE>
<DL>
<DD>Set an ErrorListener to be used when parsing
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>listener</CODE> - the ErrorListener to be used<DT><B>Since:</B></DT>
<DD>8.9</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getErrorListener()"><!-- --></A><H3>
getErrorListener</H3>
<PRE>
public <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/ErrorListener.html?is-external=true" title="class or interface in javax.xml.transform">ErrorListener</A> <B>getErrorListener</B>()</PRE>
<DL>
<DD>Get the ErrorListener that will be used when parsing
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the ErrorListener, if one has been set using <A HREF="../../../../net/sf/saxon/lib/AugmentedSource.html#setErrorListener(javax.xml.transform.ErrorListener)"><CODE>setErrorListener(javax.xml.transform.ErrorListener)</CODE></A>,
otherwise null.<DT><B>Since:</B></DT>
<DD>8.9</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="setPleaseCloseAfterUse(boolean)"><!-- --></A><H3>
setPleaseCloseAfterUse</H3>
<PRE>
public void <B>setPleaseCloseAfterUse</B>(boolean close)</PRE>
<DL>
<DD>Set whether or not the user of this Source is encouraged to close it as soon as reading is finished.
Normally the expectation is that any Stream in a StreamSource will be closed by the component that
created the Stream. However, in the case of a Source returned by a URIResolver, there is no suitable
interface (the URIResolver has no opportunity to close the stream). Also, in some cases such as reading
of stylesheet modules, it is possible to close the stream long before control is returned to the caller
who supplied it. This tends to make a difference on .NET, where a file often can't be opened if there
is a stream attached to it.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>close</CODE> - true if the source should be closed as soon as it has been consumed<DT><B>Since:</B></DT>
<DD>8.8</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="isPleaseCloseAfterUse()"><!-- --></A><H3>
isPleaseCloseAfterUse</H3>
<PRE>
public boolean <B>isPleaseCloseAfterUse</B>()</PRE>
<DL>
<DD>Determine whether or not the user of this Source is encouraged to close it as soon as reading is
finished.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if the source should be closed as soon as it has been consumed<DT><B>Since:</B></DT>
<DD>8.8</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="close()"><!-- --></A><H3>
close</H3>
<PRE>
public void <B>close</B>()</PRE>
<DL>
<DD>Close any resources held by this Source. This only works if the underlying Source is one that is
recognized as holding closable resources.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Since:</B></DT>
<DD>8.8</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">
PREV CLASS
<A HREF="../../../../net/sf/saxon/lib/CollationURIResolver.html" title="interface in net.sf.saxon.lib"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/lib/AugmentedSource.html" target="_top"><B>FRAMES</B></A>
<A HREF="AugmentedSource.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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <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>
