<!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:27 GMT 2011 --> <TITLE> XsltTransformer </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="XsltTransformer"; } } </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/XsltExecutable.ParameterDetails.html" title="class in net.sf.saxon.s9api"><B>PREV CLASS</B></A> NEXT CLASS</FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?net/sf/saxon/s9api/XsltTransformer.html" target="_top"><B>FRAMES</B></A> <A HREF="XsltTransformer.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 XsltTransformer</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.XsltTransformer</B> </PRE> <DL> <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../net/sf/saxon/s9api/Destination.html" title="interface in net.sf.saxon.s9api">Destination</A></DD> </DL> <HR> <DL> <DT><PRE>public class <B>XsltTransformer</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="../../../../net/sf/saxon/s9api/Destination.html" title="interface in net.sf.saxon.s9api">Destination</A></DL> </PRE> <P> An <code>XsltTransformer</code> represents a compiled and loaded stylesheet ready for execution. The <code>XsltTransformer</code> holds details of the dynamic evaluation context for the stylesheet. <p/> <p>An <code>XsltTransformer</code> must not be used concurrently in multiple threads. It is safe, however, to reuse the object within a single thread to run the same stylesheet several times. Running the stylesheet does not change the context that has been established.</p> <p/> <p>An <code>XsltTransformer</code> is always constructed by running the <code>Load</code> method of an <A HREF="../../../../net/sf/saxon/s9api/XsltExecutable.html" title="class in net.sf.saxon.s9api"><CODE>XsltExecutable</CODE></A>.</p> <p/> <p>An <code>XsltTransformer</code> is itself a <code>Destination</code>. This means it is possible to use one <code>XsltTransformer</code> as the destination to receive the results of another transformation, this providing a simple way for transformations to be chained into a pipeline. Note however that a when the input to a transformation is supplied in this way, it will always be built as a tree in memory, rather than the transformation being streamed.</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/XsltTransformer.html#XsltTransformer(net.sf.saxon.s9api.Processor, net.sf.saxon.Controller)">XsltTransformer</A></B>(<A HREF="../../../../net/sf/saxon/s9api/Processor.html" title="class in net.sf.saxon.s9api">Processor</A> processor, <A HREF="../../../../net/sf/saxon/Controller.html" title="class in net.sf.saxon">Controller</A> controller)</CODE> <BR> Protected constructor</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> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XsltTransformer.html#close()">close</A></B>()</CODE> <BR> Close this destination, allowing resources to be released.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XsltTransformer.html#getBaseOutputURI()">getBaseOutputURI</A></B>()</CODE> <BR> Get the base output URI.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/saxon/s9api/Destination.html" title="interface in net.sf.saxon.s9api">Destination</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XsltTransformer.html#getDestination()">getDestination</A></B>()</CODE> <BR> Get the destination that was specified in a previous call of <A HREF="../../../../net/sf/saxon/s9api/XsltTransformer.html#setDestination(net.sf.saxon.s9api.Destination)"><CODE>setDestination(net.sf.saxon.s9api.Destination)</CODE></A></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/s9api/XsltTransformer.html#getErrorListener()">getErrorListener</A></B>()</CODE> <BR> Get the ErrorListener being used during this compilation episode</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/XsltTransformer.html#getInitialContextNode()">getInitialContextNode</A></B>()</CODE> <BR> Get the initial context node for the transformation, if one has been set</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/saxon/s9api/QName.html" title="class in net.sf.saxon.s9api">QName</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XsltTransformer.html#getInitialMode()">getInitialMode</A></B>()</CODE> <BR> Get the name of the initial mode for the transformation, if one has been set.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/saxon/s9api/QName.html" title="class in net.sf.saxon.s9api">QName</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XsltTransformer.html#getInitialTemplate()">getInitialTemplate</A></B>()</CODE> <BR> Get the initial named template for the transformation, if one has been set</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/saxon/s9api/MessageListener.html" title="interface in net.sf.saxon.s9api">MessageListener</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XsltTransformer.html#getMessageListener()">getMessageListener</A></B>()</CODE> <BR> Get the MessageListener to be notified whenever the stylesheet evaluates an <code>xsl:message</code> instruction.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/saxon/s9api/XdmValue.html" title="class in net.sf.saxon.s9api">XdmValue</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XsltTransformer.html#getParameter(net.sf.saxon.s9api.QName)">getParameter</A></B>(<A HREF="../../../../net/sf/saxon/s9api/QName.html" title="class in net.sf.saxon.s9api">QName</A> name)</CODE> <BR> Get the value that has been set for a stylesheet parameter</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/saxon/event/Receiver.html" title="interface in net.sf.saxon.event">Receiver</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XsltTransformer.html#getReceiver(net.sf.saxon.Configuration)">getReceiver</A></B>(<A HREF="../../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon">Configuration</A> config)</CODE> <BR> Return a Receiver which can be used to supply the principal source document for the transformation.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/saxon/s9api/ValidationMode.html" title="enum in net.sf.saxon.s9api">ValidationMode</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XsltTransformer.html#getSchemaValidationMode()">getSchemaValidationMode</A></B>()</CODE> <BR> Get the schema validation mode for the transformation.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/saxon/lib/TraceListener.html" title="interface in net.sf.saxon.lib">TraceListener</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XsltTransformer.html#getTraceListener()">getTraceListener</A></B>()</CODE> <BR> Get the TraceListener to be notified of all events occurring during the transformation.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../net/sf/saxon/Controller.html" title="class in net.sf.saxon">Controller</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XsltTransformer.html#getUnderlyingController()">getUnderlyingController</A></B>()</CODE> <BR> Get the underlying Controller used to implement this XsltTransformer.</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/URIResolver.html?is-external=true" title="class or interface in javax.xml.transform">URIResolver</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/s9api/XsltTransformer.html#getURIResolver()">getURIResolver</A></B>()</CODE> <BR> Get the URI resolver.</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/XsltTransformer.html#setBaseOutputURI(java.lang.String)">setBaseOutputURI</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> uri)</CODE> <BR> Set the base output URI.</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/XsltTransformer.html#setDestination(net.sf.saxon.s9api.Destination)">setDestination</A></B>(<A HREF="../../../../net/sf/saxon/s9api/Destination.html" title="interface in net.sf.saxon.s9api">Destination</A> destination)</CODE> <BR> Set the destination to be used for the result of the transformation.</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/XsltTransformer.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 the ErrorListener to be used during this transformation</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/XsltTransformer.html#setInitialContextNode(net.sf.saxon.s9api.XdmNode)">setInitialContextNode</A></B>(<A HREF="../../../../net/sf/saxon/s9api/XdmNode.html" title="class in net.sf.saxon.s9api">XdmNode</A> node)</CODE> <BR> Set the initial context node for the transformation.</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/XsltTransformer.html#setInitialMode(net.sf.saxon.s9api.QName)">setInitialMode</A></B>(<A HREF="../../../../net/sf/saxon/s9api/QName.html" title="class in net.sf.saxon.s9api">QName</A> modeName)</CODE> <BR> Set the initial mode for the transformation</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/XsltTransformer.html#setInitialTemplate(net.sf.saxon.s9api.QName)">setInitialTemplate</A></B>(<A HREF="../../../../net/sf/saxon/s9api/QName.html" title="class in net.sf.saxon.s9api">QName</A> templateName)</CODE> <BR> Set the initial named template for the transformation</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/XsltTransformer.html#setMessageListener(net.sf.saxon.s9api.MessageListener)">setMessageListener</A></B>(<A HREF="../../../../net/sf/saxon/s9api/MessageListener.html" title="interface in net.sf.saxon.s9api">MessageListener</A> listener)</CODE> <BR> Set the MessageListener to be notified whenever the stylesheet evaluates an <code>xsl:message</code> instruction.</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/XsltTransformer.html#setParameter(net.sf.saxon.s9api.QName, net.sf.saxon.s9api.XdmValue)">setParameter</A></B>(<A HREF="../../../../net/sf/saxon/s9api/QName.html" title="class in net.sf.saxon.s9api">QName</A> name, <A HREF="../../../../net/sf/saxon/s9api/XdmValue.html" title="class in net.sf.saxon.s9api">XdmValue</A> value)</CODE> <BR> Set the value of a stylesheet parameter</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/XsltTransformer.html#setSchemaValidationMode(net.sf.saxon.s9api.ValidationMode)">setSchemaValidationMode</A></B>(<A HREF="../../../../net/sf/saxon/s9api/ValidationMode.html" title="enum in net.sf.saxon.s9api">ValidationMode</A> mode)</CODE> <BR> Set the schema validation mode for the transformation.</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/XsltTransformer.html#setSource(javax.xml.transform.Source)">setSource</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> Set the source document for the transformation.</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/XsltTransformer.html#setTraceListener(net.sf.saxon.lib.TraceListener)">setTraceListener</A></B>(<A HREF="../../../../net/sf/saxon/lib/TraceListener.html" title="interface in net.sf.saxon.lib">TraceListener</A> listener)</CODE> <BR> Set a TraceListener to be notified of all events occurring during the transformation.</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/XsltTransformer.html#setURIResolver(javax.xml.transform.URIResolver)">setURIResolver</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/URIResolver.html?is-external=true" title="class or interface in javax.xml.transform">URIResolver</A> resolver)</CODE> <BR> Set an object that will be used to resolve URIs used in fn:doc() and related functions.</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/XsltTransformer.html#transform()">transform</A></B>()</CODE> <BR> Perform the transformation.</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="XsltTransformer(net.sf.saxon.s9api.Processor, net.sf.saxon.Controller)"><!-- --></A><H3> XsltTransformer</H3> <PRE> protected <B>XsltTransformer</B>(<A HREF="../../../../net/sf/saxon/s9api/Processor.html" title="class in net.sf.saxon.s9api">Processor</A> processor, <A HREF="../../../../net/sf/saxon/Controller.html" title="class in net.sf.saxon">Controller</A> controller)</PRE> <DL> <DD>Protected constructor <P> <DL> <DT><B>Parameters:</B><DD><CODE>processor</CODE> - the S9API processor<DD><CODE>controller</CODE> - the Saxon controller object</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="setInitialTemplate(net.sf.saxon.s9api.QName)"><!-- --></A><H3> setInitialTemplate</H3> <PRE> public void <B>setInitialTemplate</B>(<A HREF="../../../../net/sf/saxon/s9api/QName.html" title="class in net.sf.saxon.s9api">QName</A> templateName) throws <A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></PRE> <DL> <DD>Set the initial named template for the transformation <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>templateName</CODE> - the name of the initial template, or null to indicate that there should be no initial named template <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 there is no named template with this name</DL> </DD> </DL> <HR> <A NAME="getInitialTemplate()"><!-- --></A><H3> getInitialTemplate</H3> <PRE> public <A HREF="../../../../net/sf/saxon/s9api/QName.html" title="class in net.sf.saxon.s9api">QName</A> <B>getInitialTemplate</B>()</PRE> <DL> <DD>Get the initial named template for the transformation, if one has been set <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the name of the initial template, or null if none has been set</DL> </DD> </DL> <HR> <A NAME="setInitialMode(net.sf.saxon.s9api.QName)"><!-- --></A><H3> setInitialMode</H3> <PRE> public void <B>setInitialMode</B>(<A HREF="../../../../net/sf/saxon/s9api/QName.html" title="class in net.sf.saxon.s9api">QName</A> modeName)</PRE> <DL> <DD>Set the initial mode for the transformation <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>modeName</CODE> - the name of the initial mode, or null to indicate the default (unnamed) mode</DL> </DD> </DL> <HR> <A NAME="getInitialMode()"><!-- --></A><H3> getInitialMode</H3> <PRE> public <A HREF="../../../../net/sf/saxon/s9api/QName.html" title="class in net.sf.saxon.s9api">QName</A> <B>getInitialMode</B>()</PRE> <DL> <DD>Get the name of the initial mode for the transformation, if one has been set. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the initial mode for the transformation. Returns null if no mode has been set, or if the mode was set to null to represent the default (unnamed) mode</DL> </DD> </DL> <HR> <A NAME="setSchemaValidationMode(net.sf.saxon.s9api.ValidationMode)"><!-- --></A><H3> setSchemaValidationMode</H3> <PRE> public void <B>setSchemaValidationMode</B>(<A HREF="../../../../net/sf/saxon/s9api/ValidationMode.html" title="enum in net.sf.saxon.s9api">ValidationMode</A> mode)</PRE> <DL> <DD>Set the schema validation mode for the transformation. This indicates how source documents loaded specifically for this transformation will be handled. This applies to the principal source document if supplied as a SAXSource or StreamSource, and to all documents loaded during the transformation using the <code>doc()</code>, <code>document()</code>, or <code>collection()</code> functions. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>mode</CODE> - the validation mode. Passing null causes no change to the existing value. Passing <A HREF="../../../../net/sf/saxon/s9api/ValidationMode.html#DEFAULT"><CODE>ValidationMode.DEFAULT</CODE></A> resets to the initial value, which determines the validation requirements from the Saxon Configuration.</DL> </DD> </DL> <HR> <A NAME="getSchemaValidationMode()"><!-- --></A><H3> getSchemaValidationMode</H3> <PRE> public <A HREF="../../../../net/sf/saxon/s9api/ValidationMode.html" title="enum in net.sf.saxon.s9api">ValidationMode</A> <B>getSchemaValidationMode</B>()</PRE> <DL> <DD>Get the schema validation mode for the transformation. This indicates how source documents loaded specifically for this transformation will be handled. This applies to the principal source document if supplied as a SAXSource or StreamSource, and to all documents loaded during the transformation using the <code>doc()</code>, <code>document()</code>, or <code>collection()</code> functions. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the validation mode.</DL> </DD> </DL> <HR> <A NAME="setSource(javax.xml.transform.Source)"><!-- --></A><H3> setSource</H3> <PRE> public void <B>setSource</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>Set the source document for the transformation. <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>, the supplied node is used directly as the context node of the query.</p> <p/> <p>If the source is 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>, the DOM node identified by the DOMSource is wrapped as a Saxon node, and this is then used as the context item</p> <p/> <p>In all other cases a new Saxon tree will be built by the transformation engine when the transformation starts, unless it is a Saxon-EE streaming transformation, in which case the document is processed in streaming fashion as it is being parsed.</p> <p/> <p>To run a transformation in streaming mode, the source should be supplied as an instance of <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>, <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>, or <A HREF="../../../../net/sf/saxon/event/Transmitter.html" title="class in net.sf.saxon.event"><CODE>Transmitter</CODE></A>.</p> <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>source</CODE> - the principal source document for the transformation <DT><B>Throws:</B> <DD><CODE><A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></CODE></DL> </DD> </DL> <HR> <A NAME="setInitialContextNode(net.sf.saxon.s9api.XdmNode)"><!-- --></A><H3> setInitialContextNode</H3> <PRE> public void <B>setInitialContextNode</B>(<A HREF="../../../../net/sf/saxon/s9api/XdmNode.html" title="class in net.sf.saxon.s9api">XdmNode</A> node)</PRE> <DL> <DD>Set the initial context node for the transformation. <p>This is ignored in the case where the <A HREF="../../../../net/sf/saxon/s9api/XsltTransformer.html" title="class in net.sf.saxon.s9api"><CODE>XsltTransformer</CODE></A> is used as the <A HREF="../../../../net/sf/saxon/s9api/Destination.html" title="interface in net.sf.saxon.s9api"><CODE>Destination</CODE></A> of another process. In that case the initial context node will always be the document node of the document that is being streamed to this destination.</p> <p>Calling this method has the side-effect of setting the initial source to null.</p> <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>node</CODE> - the initial context node, or null if there is to be no initial context node</DL> </DD> </DL> <HR> <A NAME="getInitialContextNode()"><!-- --></A><H3> getInitialContextNode</H3> <PRE> public <A HREF="../../../../net/sf/saxon/s9api/XdmNode.html" title="class in net.sf.saxon.s9api">XdmNode</A> <B>getInitialContextNode</B>()</PRE> <DL> <DD>Get the initial context node for the transformation, if one has been set <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the initial context node, or null if none has been set. This will not necessarily be the same <A HREF="../../../../net/sf/saxon/s9api/XdmNode.html" title="class in net.sf.saxon.s9api"><CODE>XdmNode</CODE></A> instance as was supplied, but it will be an XdmNode object that represents the same underlying node.</DL> </DD> </DL> <HR> <A NAME="setParameter(net.sf.saxon.s9api.QName, net.sf.saxon.s9api.XdmValue)"><!-- --></A><H3> setParameter</H3> <PRE> public void <B>setParameter</B>(<A HREF="../../../../net/sf/saxon/s9api/QName.html" title="class in net.sf.saxon.s9api">QName</A> name, <A HREF="../../../../net/sf/saxon/s9api/XdmValue.html" title="class in net.sf.saxon.s9api">XdmValue</A> value)</PRE> <DL> <DD>Set the value of a stylesheet parameter <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the stylesheet parameter, as a QName<DD><CODE>value</CODE> - the value of the stylesheet parameter, or null to clear a previously set value</DL> </DD> </DL> <HR> <A NAME="getParameter(net.sf.saxon.s9api.QName)"><!-- --></A><H3> getParameter</H3> <PRE> public <A HREF="../../../../net/sf/saxon/s9api/XdmValue.html" title="class in net.sf.saxon.s9api">XdmValue</A> <B>getParameter</B>(<A HREF="../../../../net/sf/saxon/s9api/QName.html" title="class in net.sf.saxon.s9api">QName</A> name)</PRE> <DL> <DD>Get the value that has been set for a stylesheet parameter <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>name</CODE> - the parameter whose name is required <DT><B>Returns:</B><DD>the value that has been set for the parameter, or null if no value has been set</DL> </DD> </DL> <HR> <A NAME="setDestination(net.sf.saxon.s9api.Destination)"><!-- --></A><H3> setDestination</H3> <PRE> public void <B>setDestination</B>(<A HREF="../../../../net/sf/saxon/s9api/Destination.html" title="interface in net.sf.saxon.s9api">Destination</A> destination)</PRE> <DL> <DD>Set the destination to be used for the result of the transformation. <p>This method can be used to chain transformations into a pipeline, by using one <A HREF="../../../../net/sf/saxon/s9api/XsltTransformer.html" title="class in net.sf.saxon.s9api"><CODE>XsltTransformer</CODE></A> as the destination of another</p> <p>If the destination is a <A HREF="../../../../net/sf/saxon/s9api/Serializer.html" title="class in net.sf.saxon.s9api"><CODE>Serializer</CODE></A>, then a side-effect of this method is to set the base output URI for the transformation. This acts as the base URI for resolving the <code>href</code> attribute of any <code>xsl:result-document</code> instruction. The serialiation parameters defined in the <code>Serializer</code> override any serialization parameters defined using <code>xsl:output</code> for the principal output of the transformation. However, they have no effect on any output produced using <code>xsl:result-document</code>. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>destination</CODE> - the destination to be used</DL> </DD> </DL> <HR> <A NAME="getDestination()"><!-- --></A><H3> getDestination</H3> <PRE> public <A HREF="../../../../net/sf/saxon/s9api/Destination.html" title="interface in net.sf.saxon.s9api">Destination</A> <B>getDestination</B>()</PRE> <DL> <DD>Get the destination that was specified in a previous call of <A HREF="../../../../net/sf/saxon/s9api/XsltTransformer.html#setDestination(net.sf.saxon.s9api.Destination)"><CODE>setDestination(net.sf.saxon.s9api.Destination)</CODE></A> <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the destination, or null if none has been supplied</DL> </DD> </DL> <HR> <A NAME="setBaseOutputURI(java.lang.String)"><!-- --></A><H3> setBaseOutputURI</H3> <PRE> public void <B>setBaseOutputURI</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> uri)</PRE> <DL> <DD>Set the base output URI. <p/> <p>This defaults to the system ID of the Destination for the principal output of the transformation if this is known; if it is not known, it defaults to the current directory.</p> <p/> <p>If no base output URI is supplied, but the <code>Destination</code> of the transformation is a <code>Serializer</code> that writes to a file, then the URI of this file is used as the base output URI.</p> <p/> <p> The base output URI is used for resolving relative URIs in the <code>href</code> attribute of the <code>xsl:result-document</code> instruction.</p> <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>uri</CODE> - the base output URI<DT><B>Since:</B></DT> <DD>9.2</DD> </DL> </DD> </DL> <HR> <A NAME="getBaseOutputURI()"><!-- --></A><H3> getBaseOutputURI</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>getBaseOutputURI</B>()</PRE> <DL> <DD>Get the base output URI. <p/> <p>This returns the value set using the <A HREF="../../../../net/sf/saxon/s9api/XsltTransformer.html#setBaseOutputURI(java.lang.String)"><CODE>setBaseOutputURI(java.lang.String)</CODE></A> method. If no value has been set explicitly, then the method returns null if called before the transformation, or the computed default base output URI if called after the transformation.</p> <p/> <p> The base output URI is used for resolving relative URIs in the <code>href</code> attribute of the <code>xsl:result-document</code> instruction.</p> <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the base output URI<DT><B>Since:</B></DT> <DD>9.2</DD> </DL> </DD> </DL> <HR> <A NAME="setURIResolver(javax.xml.transform.URIResolver)"><!-- --></A><H3> setURIResolver</H3> <PRE> public void <B>setURIResolver</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/URIResolver.html?is-external=true" title="class or interface in javax.xml.transform">URIResolver</A> resolver)</PRE> <DL> <DD>Set an object that will be used to resolve URIs used in fn:doc() and related functions. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>resolver</CODE> - An object that implements the URIResolver interface, or null.<DT><B>Since:</B></DT> <DD>9.3</DD> </DL> </DD> </DL> <HR> <A NAME="getURIResolver()"><!-- --></A><H3> getURIResolver</H3> <PRE> public <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/URIResolver.html?is-external=true" title="class or interface in javax.xml.transform">URIResolver</A> <B>getURIResolver</B>()</PRE> <DL> <DD>Get the URI resolver. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the user-supplied URI resolver if there is one, or null otherwise<DT><B>Since:</B></DT> <DD>9.3</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 the ErrorListener to be used during this transformation <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>listener</CODE> - The error listener to be used. This is notified of all dynamic errors detected during the transformation.<DT><B>Since:</B></DT> <DD>9.2</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 being used during this compilation episode <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>listener The error listener in use. This is notified of all dynamic errors detected during the transformation. If no user-supplied ErrorListener has been set the method will return a system-supplied ErrorListener.<DT><B>Since:</B></DT> <DD>9.2</DD> </DL> </DD> </DL> <HR> <A NAME="setMessageListener(net.sf.saxon.s9api.MessageListener)"><!-- --></A><H3> setMessageListener</H3> <PRE> public void <B>setMessageListener</B>(<A HREF="../../../../net/sf/saxon/s9api/MessageListener.html" title="interface in net.sf.saxon.s9api">MessageListener</A> listener)</PRE> <DL> <DD>Set the MessageListener to be notified whenever the stylesheet evaluates an <code>xsl:message</code> instruction. If no MessageListener is nominated, the output of <code>xsl:message</code> instructions will be serialized and sent to the standard error stream. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>listener</CODE> - the MessageListener to be used<DT><B>Since:</B></DT> <DD>9.1</DD> </DL> </DD> </DL> <HR> <A NAME="getMessageListener()"><!-- --></A><H3> getMessageListener</H3> <PRE> public <A HREF="../../../../net/sf/saxon/s9api/MessageListener.html" title="interface in net.sf.saxon.s9api">MessageListener</A> <B>getMessageListener</B>()</PRE> <DL> <DD>Get the MessageListener to be notified whenever the stylesheet evaluates an <code>xsl:message</code> instruction. If no MessageListener has been nominated, return null <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the user-supplied MessageListener, or null if none has been supplied<DT><B>Since:</B></DT> <DD>9.1</DD> </DL> </DD> </DL> <HR> <A NAME="setTraceListener(net.sf.saxon.lib.TraceListener)"><!-- --></A><H3> setTraceListener</H3> <PRE> public void <B>setTraceListener</B>(<A HREF="../../../../net/sf/saxon/lib/TraceListener.html" title="interface in net.sf.saxon.lib">TraceListener</A> listener)</PRE> <DL> <DD>Set a TraceListener to be notified of all events occurring during the transformation. This will only be effective if the stylesheet was compiled with trace code enabled (see <A HREF="../../../../net/sf/saxon/s9api/XsltCompiler.html#setCompileWithTracing(boolean)"><CODE>XsltCompiler.setCompileWithTracing(boolean)</CODE></A>) <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>listener</CODE> - the TraceListener to be used. Note that the TraceListener has access to interal Saxon interfaces which may vary from one release to the next. It is also possible that the TraceListener interface itself may be changed in future releases.<DT><B>Since:</B></DT> <DD>9.2</DD> </DL> </DD> </DL> <HR> <A NAME="getTraceListener()"><!-- --></A><H3> getTraceListener</H3> <PRE> public <A HREF="../../../../net/sf/saxon/lib/TraceListener.html" title="interface in net.sf.saxon.lib">TraceListener</A> <B>getTraceListener</B>()</PRE> <DL> <DD>Get the TraceListener to be notified of all events occurring during the transformation. If no TraceListener has been nominated, return null <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the user-supplied TraceListener, or null if none has been supplied<DT><B>Since:</B></DT> <DD>9.2</DD> </DL> </DD> </DL> <HR> <A NAME="transform()"><!-- --></A><H3> transform</H3> <PRE> public void <B>transform</B>() throws <A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></PRE> <DL> <DD>Perform the transformation. If this method is used, a destination must have been supplied previously <P> <DD><DL> </DL> </DD> <DD><DL> <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 dynamic error occurs during the transformation <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if no destination has been supplied</DL> </DD> </DL> <HR> <A NAME="getReceiver(net.sf.saxon.Configuration)"><!-- --></A><H3> getReceiver</H3> <PRE> public <A HREF="../../../../net/sf/saxon/event/Receiver.html" title="interface in net.sf.saxon.event">Receiver</A> <B>getReceiver</B>(<A HREF="../../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon">Configuration</A> config) throws <A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></PRE> <DL> <DD>Return a Receiver which can be used to supply the principal source document for the transformation. This method is intended primarily for internal use, though it can also be called by a user application that wishes to feed events into the transformation engine. <p/> <p>Saxon calls this method to obtain a Receiver, to which it then sends a sequence of events representing the content of an XML document. This method is provided so that <code>XsltTransformer</code> implements <code>Destination</code>, allowing one transformation to receive the results of another in a pipeline.</p> <p/> <p>Before calling this method, the <A HREF="../../../../net/sf/saxon/s9api/XsltTransformer.html#setDestination(net.sf.saxon.s9api.Destination)"><CODE>setDestination(net.sf.saxon.s9api.Destination)</CODE></A> method must be called to supply a destination for the transformation.</p> <p/> <p>Note that when an <code>XsltTransformer</code> is used as a <code>Destination</code>, the initial context node set on that <code>XsltTransformer</code> using <A HREF="../../../../net/sf/saxon/s9api/XsltTransformer.html#setInitialContextNode(net.sf.saxon.s9api.XdmNode)"><CODE>setInitialContextNode(XdmNode)</CODE></A> is ignored, as is the source set using <A HREF="../../../../net/sf/saxon/s9api/XsltTransformer.html#setSource(javax.xml.transform.Source)"><CODE>setSource(javax.xml.transform.Source)</CODE></A>.</p> <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/s9api/Destination.html#getReceiver(net.sf.saxon.Configuration)">getReceiver</A></CODE> in interface <CODE><A HREF="../../../../net/sf/saxon/s9api/Destination.html" title="interface in net.sf.saxon.s9api">Destination</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>config</CODE> - The Saxon configuration. This is supplied so that the destination can use information from the configuration (for example, a reference to the name pool) to construct or configure the returned Receiver. <DT><B>Returns:</B><DD>the Receiver to which events are to be sent. <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 the Receiver cannot be created <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if no Destination has been supplied</DL> </DD> </DL> <HR> <A NAME="close()"><!-- --></A><H3> close</H3> <PRE> public void <B>close</B>() throws <A HREF="../../../../net/sf/saxon/s9api/SaxonApiException.html" title="class in net.sf.saxon.s9api">SaxonApiException</A></PRE> <DL> <DD>Close this destination, allowing resources to be released. Used when this XsltTransformer is acting as the destination of another transformation. Saxon calls this method when it has finished writing to the destination. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../net/sf/saxon/s9api/Destination.html#close()">close</A></CODE> in interface <CODE><A HREF="../../../../net/sf/saxon/s9api/Destination.html" title="interface in net.sf.saxon.s9api">Destination</A></CODE></DL> </DD> <DD><DL> <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</DL> </DD> </DL> <HR> <A NAME="getUnderlyingController()"><!-- --></A><H3> getUnderlyingController</H3> <PRE> public <A HREF="../../../../net/sf/saxon/Controller.html" title="class in net.sf.saxon">Controller</A> <B>getUnderlyingController</B>()</PRE> <DL> <DD>Get the underlying Controller used to implement this XsltTransformer. This provides access to lower-level methods not otherwise available in the s9api interface. Note that classes and methods obtained by this route cannot be guaranteed stable from release to release. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Since:</B></DT> <DD>9.0.0.4</DD> </DL> </DD> </DL> <!-- ========= END OF CLASS DATA ========= --> <HR> <!-- ======= START OF BOTTOM NAVBAR ====== --> <A NAME="navbar_bottom"><!-- --></A> <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../net/sf/saxon/s9api/XsltExecutable.ParameterDetails.html" title="class in net.sf.saxon.s9api"><B>PREV CLASS</B></A> NEXT CLASS</FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?net/sf/saxon/s9api/XsltTransformer.html" target="_top"><B>FRAMES</B></A> <A HREF="XsltTransformer.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>