<!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:01 GMT 2011 -->
<TITLE>
Transform
</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="Transform";
}
}
</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/TemplatesHandlerImpl.html" title="class in net.sf.saxon"><B>PREV CLASS</B></A>
<A HREF="../../../net/sf/saxon/TransformerFactoryImpl.html" title="class in net.sf.saxon"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?net/sf/saxon/Transform.html" target="_top"><B>FRAMES</B></A>
<A HREF="Transform.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <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</FONT>
<BR>
Class Transform</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.Transform</B>
</PRE>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../net/sf/saxon/dom/DOMTransform.html" title="class in net.sf.saxon.dom">DOMTransform</A>, <A HREF="../../../net/sf/saxon/option/jdom/JDOMTransform.html" title="class in net.sf.saxon.option.jdom">JDOMTransform</A>, <A HREF="../../../com/saxonica/Transform.html" title="class in com.saxonica">Transform</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>Transform</B><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL>
</PRE>
<P>
This <b>Transform</b> class is the command-line entry point to the Saxon XSLT Processor.
<p>It is possible to subclass this class to provide a customized command line interface. In writing such
a subclass:</p>
<ul>
<li>The <A HREF="../../../net/sf/saxon/Transform.html#main(java.lang.String[])"><CODE>main(java.lang.String[])</CODE></A> method should instantiate the class and call the <A HREF="../../../net/sf/saxon/Transform.html#doTransform(java.lang.String[], java.lang.String)"><CODE>doTransform(java.lang.String[], java.lang.String)</CODE></A> method, passing the
argument list. The argument list can be augmented or modified if required: for example, by adding a -config
argument to cause the configuration to be initialized from a configuration file.</li>
<li>The <A HREF="../../../net/sf/saxon/Transform.html#setFactoryConfiguration(boolean, java.lang.String)"><CODE>setFactoryConfiguration(boolean, java.lang.String)</CODE></A> method can be implemented
<P>
<P>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_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>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected <A HREF="../../../net/sf/saxon/trans/CompilerInfo.html" title="class in net.sf.saxon.trans">CompilerInfo</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../net/sf/saxon/Transform.html#compilerInfo">compilerInfo</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected <A HREF="../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon">Configuration</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../net/sf/saxon/Transform.html#config">config</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../net/sf/saxon/Transform.html#repeat">repeat</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../net/sf/saxon/Transform.html#showTime">showTime</A></B></CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../net/sf/saxon/Transform.html#useURLs">useURLs</A></B></CODE>
<BR>
</TD>
</TR>
</TABLE>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../net/sf/saxon/Transform.html#Transform()">Transform</A></B>()</CODE>
<BR>
</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>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../net/sf/saxon/Transform.html#applyLocalOptions(net.sf.saxon.trans.CommandLineOptions, net.sf.saxon.Configuration)">applyLocalOptions</A></B>(<A HREF="../../../net/sf/saxon/trans/CommandLineOptions.html" title="class in net.sf.saxon.trans">CommandLineOptions</A> options,
<A HREF="../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon">Configuration</A> config)</CODE>
<BR>
Customisation hook: apply options defined locally in a subclass.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../net/sf/saxon/Transform.html#badUsage(java.lang.String)">badUsage</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> message)</CODE>
<BR>
Report incorrect usage of the command line, with a list of the options and arguments that are available</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/Transform.html#doTransform(java.lang.String[], java.lang.String)">doTransform</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>[] args,
<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> command)</CODE>
<BR>
Support method for main program.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected <A HREF="../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon">Configuration</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../net/sf/saxon/Transform.html#getConfiguration()">getConfiguration</A></B>()</CODE>
<BR>
Get the configuration.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../net/sf/saxon/Transform.html#initializeConfiguration(net.sf.saxon.Configuration)">initializeConfiguration</A></B>(<A HREF="../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon">Configuration</A> config)</CODE>
<BR>
Customisation hook called immediately after the Configuration
object is instantiated.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../net/sf/saxon/Transform.html#main(java.lang.String[])">main</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>[] args)</CODE>
<BR>
Main program, can be used directly from the command line.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected <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/Transform.html#newController(javax.xml.transform.Templates, net.sf.saxon.trans.CommandLineOptions, java.io.PrintStream)">newController</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/Templates.html?is-external=true" title="class or interface in javax.xml.transform">Templates</A> sheet,
<A HREF="../../../net/sf/saxon/trans/CommandLineOptions.html" title="class in net.sf.saxon.trans">CommandLineOptions</A> options,
<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</A> traceDestination)</CODE>
<BR>
Create a new Controller.</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></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../net/sf/saxon/Transform.html#preprocess(java.util.List)">preprocess</A></B>(<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> sources)</CODE>
<BR>
Preprocess the list of sources.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected static void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../net/sf/saxon/Transform.html#quit(java.lang.String, int)">quit</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> message,
int code)</CODE>
<BR>
Exit with a message</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/Transform.html#setFactoryConfiguration(boolean, java.lang.String)">setFactoryConfiguration</A></B>(boolean schemaAware,
<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> className)</CODE>
<BR>
Customisation hook called immediately after the Configuration
object is instantiated.</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/Transform.html#setPermittedOptions(net.sf.saxon.trans.CommandLineOptions)">setPermittedOptions</A></B>(<A HREF="../../../net/sf/saxon/trans/CommandLineOptions.html" title="class in net.sf.saxon.trans">CommandLineOptions</A> options)</CODE>
<BR>
Set the options that are recognized on the command line.</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>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_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>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="config"><!-- --></A><H3>
config</H3>
<PRE>
protected <A HREF="../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon">Configuration</A> <B>config</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="compilerInfo"><!-- --></A><H3>
compilerInfo</H3>
<PRE>
protected <A HREF="../../../net/sf/saxon/trans/CompilerInfo.html" title="class in net.sf.saxon.trans">CompilerInfo</A> <B>compilerInfo</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="useURLs"><!-- --></A><H3>
useURLs</H3>
<PRE>
protected boolean <B>useURLs</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="showTime"><!-- --></A><H3>
showTime</H3>
<PRE>
protected boolean <B>showTime</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>
<A NAME="repeat"><!-- --></A><H3>
repeat</H3>
<PRE>
protected int <B>repeat</B></PRE>
<DL>
<DL>
</DL>
</DL>
<!-- ========= 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="Transform()"><!-- --></A><H3>
Transform</H3>
<PRE>
public <B>Transform</B>()</PRE>
<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="main(java.lang.String[])"><!-- --></A><H3>
main</H3>
<PRE>
public static void <B>main</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>[] args)
throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></PRE>
<DL>
<DD>Main program, can be used directly from the command line.
<p>The format is:</P>
<p>java net.sf.saxon.Transform [options] <I>source-file</I> <I>style-file</I> ><I>output-file</I></P>
<p>followed by any number of parameters in the form {keyword=value}... which can be
referenced from within the stylesheet.</p>
<p>This program applies the XSL style sheet in style-file to the source XML document in source-file.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>args</CODE> - List of arguments supplied on operating system command line
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</A></CODE> - Indicates that a compile-time or
run-time error occurred</DL>
</DD>
</DL>
<HR>
<A NAME="setPermittedOptions(net.sf.saxon.trans.CommandLineOptions)"><!-- --></A><H3>
setPermittedOptions</H3>
<PRE>
public void <B>setPermittedOptions</B>(<A HREF="../../../net/sf/saxon/trans/CommandLineOptions.html" title="class in net.sf.saxon.trans">CommandLineOptions</A> options)</PRE>
<DL>
<DD>Set the options that are recognized on the command line. This method can be overridden in a subclass
to define additional command line options.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>options</CODE> - the CommandLineOptions in which the recognized options are to be registered.</DL>
</DD>
</DL>
<HR>
<A NAME="doTransform(java.lang.String[], java.lang.String)"><!-- --></A><H3>
doTransform</H3>
<PRE>
public void <B>doTransform</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>[] args,
<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> command)</PRE>
<DL>
<DD>Support method for main program. This support method can also be invoked from subclasses
that support the same command line interface
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>args</CODE> - the command-line arguments<DD><CODE>command</CODE> - the form of the command as written by the user. Not used, retained for backwards compatibility</DL>
</DD>
</DL>
<HR>
<A NAME="initializeConfiguration(net.sf.saxon.Configuration)"><!-- --></A><H3>
initializeConfiguration</H3>
<PRE>
protected void <B>initializeConfiguration</B>(<A HREF="../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon">Configuration</A> config)</PRE>
<DL>
<DD>Customisation hook called immediately after the Configuration
object is instantiated. The intended purpose of this hook is to allow
a subclass to supply an OEM license key programmatically, but it can also
be used for other initialization of the Configuration. This method is
called before analyzing the command line options, so configuration settings
made at this stage may be overridden when the command line options are processed.
However, if a configuration file is used, the settings defined in the configuration
file will have been applied.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>config</CODE> - the Configuration object</DL>
</DD>
</DL>
<HR>
<A NAME="setFactoryConfiguration(boolean, java.lang.String)"><!-- --></A><H3>
setFactoryConfiguration</H3>
<PRE>
public void <B>setFactoryConfiguration</B>(boolean schemaAware,
<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> className)
throws <A HREF="../../../net/sf/saxon/trans/LicenseException.html" title="class in net.sf.saxon.trans">LicenseException</A></PRE>
<DL>
<DD>Customisation hook called immediately after the Configuration
object is instantiated. This hook is retained for backwards
compatibility but it is recommended to implement <A HREF="../../../net/sf/saxon/Transform.html#initializeConfiguration(net.sf.saxon.Configuration)"><CODE>initializeConfiguration(net.sf.saxon.Configuration)</CODE></A>
in preference. This method is called after <A HREF="../../../net/sf/saxon/Transform.html#initializeConfiguration(net.sf.saxon.Configuration)"><CODE>initializeConfiguration(net.sf.saxon.Configuration)</CODE></A>,
but only if the configuration was not created using a configuration file.
The default implementation does nothing.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>schemaAware</CODE> - True if the transformation is to be schema-aware<DD><CODE>className</CODE> - Always null.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../net/sf/saxon/trans/LicenseException.html" title="class in net.sf.saxon.trans">LicenseException</A></CODE> - can be thrown if there is no valid license available</DL>
</DD>
</DL>
<HR>
<A NAME="applyLocalOptions(net.sf.saxon.trans.CommandLineOptions, net.sf.saxon.Configuration)"><!-- --></A><H3>
applyLocalOptions</H3>
<PRE>
protected void <B>applyLocalOptions</B>(<A HREF="../../../net/sf/saxon/trans/CommandLineOptions.html" title="class in net.sf.saxon.trans">CommandLineOptions</A> options,
<A HREF="../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon">Configuration</A> config)</PRE>
<DL>
<DD>Customisation hook: apply options defined locally in a subclass. This method
allows a subclass to recognize and implement command line options that are not recognized
by the superclass. To prevent Saxon rejecting such options as errors, the method
<A HREF="../../../net/sf/saxon/Transform.html#setPermittedOptions(net.sf.saxon.trans.CommandLineOptions)"><CODE>setPermittedOptions(net.sf.saxon.trans.CommandLineOptions)</CODE></A> must be overridden in the subclass to add details of
options recognized in the subclass.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>options</CODE> - the CommandLineOptions. This will contain details of all the options
that were specified on the command line. Those that are recognized by the standard Saxon
command line interface will already have been processed; other options can now be processed
by the subclass.<DD><CODE>config</CODE> - the Saxon Configuration</DL>
</DD>
</DL>
<HR>
<A NAME="preprocess(java.util.List)"><!-- --></A><H3>
preprocess</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> <B>preprocess</B>(<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> sources)
throws <A HREF="../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE>
<DL>
<DD>Preprocess the list of sources. This method exists so that it can be
overridden in a subclass
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>sources</CODE> - the list of Source objects
<DT><B>Returns:</B><DD>a revised list of Source objects
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getConfiguration()"><!-- --></A><H3>
getConfiguration</H3>
<PRE>
protected <A HREF="../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon">Configuration</A> <B>getConfiguration</B>()</PRE>
<DL>
<DD>Get the configuration.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the Saxon configuration</DL>
</DD>
</DL>
<HR>
<A NAME="quit(java.lang.String, int)"><!-- --></A><H3>
quit</H3>
<PRE>
protected static void <B>quit</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> message,
int code)</PRE>
<DL>
<DD>Exit with a message
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>message</CODE> - The message to be output<DD><CODE>code</CODE> - The result code to be returned to the operating
system shell</DL>
</DD>
</DL>
<HR>
<A NAME="newController(javax.xml.transform.Templates, net.sf.saxon.trans.CommandLineOptions, java.io.PrintStream)"><!-- --></A><H3>
newController</H3>
<PRE>
protected <A HREF="../../../net/sf/saxon/Controller.html" title="class in net.sf.saxon">Controller</A> <B>newController</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/Templates.html?is-external=true" title="class or interface in javax.xml.transform">Templates</A> sheet,
<A HREF="../../../net/sf/saxon/trans/CommandLineOptions.html" title="class in net.sf.saxon.trans">CommandLineOptions</A> options,
<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</A> traceDestination)
throws <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/TransformerException.html?is-external=true" title="class or interface in javax.xml.transform">TransformerException</A></PRE>
<DL>
<DD>Create a new Controller. This method is protected so it can be overridden in a subclass, allowing additional
options to be set on the Controller
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>sheet</CODE> - The Templates object representing the compiled stylesheet<DD><CODE>options</CODE> - The commmand line options<DD><CODE>traceDestination</CODE> - destination for trace output
<DT><B>Returns:</B><DD>the newly constructed Controller to be used for the transformation
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/TransformerException.html?is-external=true" title="class or interface in javax.xml.transform">TransformerException</A></CODE> - if any error occurs</DL>
</DD>
</DL>
<HR>
<A NAME="badUsage(java.lang.String)"><!-- --></A><H3>
badUsage</H3>
<PRE>
protected void <B>badUsage</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> message)</PRE>
<DL>
<DD>Report incorrect usage of the command line, with a list of the options and arguments that are available
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>message</CODE> - The error message</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/TemplatesHandlerImpl.html" title="class in net.sf.saxon"><B>PREV CLASS</B></A>
<A HREF="../../../net/sf/saxon/TransformerFactoryImpl.html" title="class in net.sf.saxon"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?net/sf/saxon/Transform.html" target="_top"><B>FRAMES</B></A>
<A HREF="Transform.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <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>
