| java.lang.Object
 net.sf.saxon.Transform
All known Subclasses: net.sf.saxon.dom.DOMTransform, net.sf.saxon.jdom.JDOMTransform,
| Transform | | public class Transform (Code) | | This Transform class is the entry point to the Saxon XSLT Processor. This
class is provided to control the processor from the command line.
The XSLT syntax supported conforms to the W3C XSLT 1.0 and XPath 1.0 recommendation.
Only the transformation language is implemented (not the formatting objects).
Saxon extensions are documented in the file extensions.html
author:
Michael H. Kay |
| Method Summary | |
| protected void | badUsage(String name, String message)
| | protected void | doMain(String args, String name)
Support method for main program. | | public void | execute(String initialTemplate, Templates sheet, File outputFile, ArrayList parameterList, String initialMode)
| | protected Configuration | getConfiguration()
Get the configuration. | | public static Object | loadDocuments(String sourceFileName, boolean useURLs, Configuration config, boolean useSAXSource)
Load a document, or all the documents in a directory, given a filename or URL
if sourceFileName represents a single source document, return a Source object representingthat document. | | public static void | main(String args)
Main program, can be used directly from the command line.
The format is:
java net.sf.saxon.Transform [options] source-file style-file >output-file
followed by any number of parameters in the form {keyword=value}... | | public List | preprocess(List sources)
Preprocess the list of sources. | | public void | processDirectory(List sources, Templates sheet, File outputDir, ArrayList parameterList, String initialMode)
| | public void | processDirectoryAssoc(List sources, File outputDir, ArrayList parameterList, String initialMode)
| | public void | processFile(Source source, Templates sheet, File outputFile, ArrayList parameterList, String initialMode)
| | public void | processFileAssoc(Source sourceInput, String localName, File outputFile, ArrayList parameterList, String initialMode)
| | protected static void | quit(String message, int code)
| | protected void | setFactoryConfiguration()
Set the configuration in the TransformerFactory. | | public void | setPOption(Configuration config)
|
| repeat | | protected int repeat(Code) | | |
| showTime | | protected boolean showTime(Code) | | |
| useURLs | | protected boolean useURLs(Code) | | |
| badUsage | | protected void badUsage(String name, String message)(Code) | | Report incorrect usage of the command line, with a list of the options and arguments that are available
Parameters:
name - The name of the command being executed (allows subclassing)
Parameters:
message - The error message |
| doMain | | protected void doMain(String args, String name)(Code) | | Support method for main program. This support method can also be invoked from subclasses
that support the same command line interface
Parameters:
args - the command-line arguments
Parameters:
name - name of the class, to be used in error messages |
| execute | | public void execute(String initialTemplate, Templates sheet, File outputFile, ArrayList parameterList, String initialMode) throws TransformerException(Code) | | Invoke a supplied stylesheet with no source document
Parameters:
initialTemplate - The entry point to the stylesheet
Parameters:
sheet - The Templates object identifying the stylesheet
Parameters:
outputFile - The output file to contain the results of thetransformation
Parameters:
parameterList - List of parameters to be supplied to thetransformation
Parameters:
initialMode - Initial mode for executing the transformation
throws:
net.sf.saxon.trans.XPathException - If the transformation fails |
| loadDocuments | | public static Object loadDocuments(String sourceFileName, boolean useURLs, Configuration config, boolean useSAXSource) throws TransformerException(Code) | | Load a document, or all the documents in a directory, given a filename or URL
if sourceFileName represents a single source document, return a Source object representingthat document. If sourceFileName represents a directory, return a List containing multiple Sourceobjects, one for each file in the directory. |
| main | | public static void main(String args) throws java.lang.Exception(Code) | | Main program, can be used directly from the command line.
The format is:
java net.sf.saxon.Transform [options] source-file style-file >output-file
followed by any number of parameters in the form {keyword=value}... which can be
referenced from within the stylesheet.
This program applies the XSL style sheet in style-file to the source XML document in source-file.
Parameters:
args - List of arguments supplied on operating system command line
throws:
java.lang.Exception - Indicates that a compile-time orrun-time error occurred |
| preprocess | | public List preprocess(List sources) throws XPathException(Code) | | Preprocess the list of sources. This method exists so that it can be
overridden in a subclass
|
| processDirectory | | public void processDirectory(List sources, Templates sheet, File outputDir, ArrayList parameterList, String initialMode) throws TransformerException(Code) | | Process each file in the source directory using the same supplied stylesheet
Parameters:
sources - The sources in the directory to be processed
Parameters:
sheet - The Templates object identifying the stylesheet
Parameters:
outputDir - The directory in which output files are to becreated
Parameters:
parameterList - List of parameters to be supplied to eachtransformation
Parameters:
initialMode - Initial mode for executing eachtransformation
throws:
XPathException - when any error occurs during atransformation |
| processDirectoryAssoc | | public void processDirectoryAssoc(List sources, File outputDir, ArrayList parameterList, String initialMode) throws Exception(Code) | | Process each file in the source directory using its own associated stylesheet
Parameters:
sources - The sources in the directory to be processed
Parameters:
outputDir - The directory in which output files are to becreated
Parameters:
parameterList - List of parameters to be supplied to eachtransformation
Parameters:
initialMode - Initial mode for executing eachtransformation
throws:
Exception - when any error occurs during a transformation |
| processFile | | public void processFile(Source source, Templates sheet, File outputFile, ArrayList parameterList, String initialMode) throws TransformerException(Code) | | Process a single file using a supplied stylesheet
Parameters:
source - The source XML document to be transformed
Parameters:
sheet - The Templates object identifying the stylesheet
Parameters:
outputFile - The output file to contain the results of thetransformation
Parameters:
parameterList - List of parameters to be supplied to thetransformation
Parameters:
initialMode - Initial mode for executing the transformation
throws:
net.sf.saxon.trans.XPathException - If the transformation fails |
| processFileAssoc | | public void processFileAssoc(Source sourceInput, String localName, File outputFile, ArrayList parameterList, String initialMode) throws TransformerException(Code) | | Process a single source file using its associated stylesheet(s)
Parameters:
sourceInput - Identifies the source file to be transformed
Parameters:
localName - The local name of the file within thedirectory, excluding the file type suffix
Parameters:
outputFile - The output file to contain the results of thetransformation
Parameters:
parameterList - List of parameters to be supplied to thetransformation
Parameters:
initialMode - Initial mode for executing the transformation
throws:
XPathException - If the transformation fails |
| quit | | protected static void quit(String message, int code)(Code) | | Exit with a message
Parameters:
message - The message to be output
Parameters:
code - The result code to be returned to the operatingsystem shell |
| setFactoryConfiguration | | protected void setFactoryConfiguration()(Code) | | Set the configuration in the TransformerFactory. This is designed to be
overridden in a subclass
|
|
|