net.sf.saxon

Class Transform

Known Direct Subclasses:
DOMTransform, JDOMTransform

public class Transform
extends java.lang.Object

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

Field Summary

protected Configuration
config
protected TransformerFactoryImpl
factory
protected int
repeat
protected boolean
showTime
protected boolean
useURLs

Method Summary

protected void
badUsage(String name, String message)
Report incorrect usage of the command line, with a list of the options and arguments that are available
void
doTransform(args[] , String command)
Support method for main program.
protected Configuration
getConfiguration()
Get the configuration.
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
static void
main(args[] )
Main program, can be used directly from the command line.
static long
now()
Get current time in milliseconds
List
preprocess(List sources)
Preprocess the list of sources.
void
processDirectory(List sources, Templates sheet, File outputDir, ArrayList parameterList, String initialTemplate, String initialMode)
Process each file in the source directory using the same supplied stylesheet
void
processDirectoryAssoc(List sources, File outputDir, ArrayList parameterList, String initialMode)
Process each file in the source directory using its own associated stylesheet
void
processFile(Source source, Templates sheet, File outputFile, ArrayList parameterList, String initialTemplate, String initialMode)
Process a single file using a supplied stylesheet
void
processFileAssoc(Source sourceInput, String localName, File outputFile, ArrayList parameterList, String initialMode)
Process a single source file using its associated stylesheet(s)
protected static void
quit(String message, int code)
Exit with a message
void
setFactoryConfiguration(boolean schemaAware, String className)
Set the configuration in the TransformerFactory.

Field Details

config

protected Configuration config

factory

protected TransformerFactoryImpl factory

repeat

protected int repeat

showTime

protected boolean showTime

useURLs

protected boolean useURLs

Method Details

badUsage

protected void badUsage(String name,
                        String message)
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)
message - The error message

doTransform

public void doTransform(args[] ,
                        String command)
Support method for main program. This support method can also be invoked from subclasses that support the same command line interface
Parameters:
command - the form of the command as written by the user, to be used in error messages

getConfiguration

protected Configuration getConfiguration()
Get the configuration.
Returns:
the Saxon configuration

loadDocuments

public static Object loadDocuments(String sourceFileName,
                                   boolean useURLs,
                                   Configuration config,
                                   boolean useSAXSource)
            throws TransformerException
Load a document, or all the documents in a directory, given a filename or URL
Parameters:
sourceFileName - the name of the source file or directory
useURLs - true if the filename argument is to be treated as a URI
config - the Saxon configuration
useSAXSource - true if the method should use a SAXSource rather than a StreamSource
Returns:
if sourceFileName represents a single source document, return a Source object representing that document. If sourceFileName represents a directory, return a List containing multiple Source objects, one for each file in the directory.

main

public static void main(args[] )
            throws java.lang.Exception
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:

now

public static long now()
Get current time in milliseconds
Returns:
the current time in milliseconds since 1970

preprocess

public List preprocess(List sources)
            throws XPathException
Preprocess the list of sources. This method exists so that it can be overridden in a subclass
Parameters:
sources - the list of Source objects
Returns:
a revised list of Source objects

processDirectory

public void processDirectory(List sources,
                             Templates sheet,
                             File outputDir,
                             ArrayList parameterList,
                             String initialTemplate,
                             String initialMode)
            throws TransformerException
Process each file in the source directory using the same supplied stylesheet
Parameters:
sources - The sources in the directory to be processed
sheet - The Templates object identifying the stylesheet
outputDir - The directory in which output files are to be created
parameterList - List of parameters to be supplied to each transformation
initialTemplate - Initial template for executing each transformation
initialMode - Initial mode for executing each transformation

processDirectoryAssoc

public void processDirectoryAssoc(List sources,
                                  File outputDir,
                                  ArrayList parameterList,
                                  String initialMode)
            throws Exception
Process each file in the source directory using its own associated stylesheet
Parameters:
sources - The sources in the directory to be processed
outputDir - The directory in which output files are to be created
parameterList - List of parameters to be supplied to each transformation
initialMode - Initial mode for executing each transformation

processFile

public void processFile(Source source,
                        Templates sheet,
                        File outputFile,
                        ArrayList parameterList,
                        String initialTemplate,
                        String initialMode)
            throws TransformerException
Process a single file using a supplied stylesheet
Parameters:
source - The source XML document to be transformed (maybe null if an initial template is specified)
sheet - The Templates object identifying the stylesheet
outputFile - The output file to contain the results of the transformation
parameterList - List of parameters to be supplied to the transformation
initialTemplate - Initial template for executing each transformation
initialMode - Initial mode for executing the transformation

processFileAssoc

public void processFileAssoc(Source sourceInput,
                             String localName,
                             File outputFile,
                             ArrayList parameterList,
                             String initialMode)
            throws TransformerException
Process a single source file using its associated stylesheet(s)
Parameters:
sourceInput - Identifies the source file to be transformed
localName - The local name of the file within the directory, excluding the file type suffix
outputFile - The output file to contain the results of the transformation
parameterList - List of parameters to be supplied to the transformation
initialMode - Initial mode for executing the transformation

quit

protected static void quit(String message,
                           int code)
Exit with a message
Parameters:
message - The message to be output
code - The result code to be returned to the operating system shell

setFactoryConfiguration

public void setFactoryConfiguration(boolean schemaAware,
                                    String className)
            throws RuntimeException
Set the configuration in the TransformerFactory. This is designed to be overridden in a subclass
Parameters:
schemaAware - True if the transformation is to be schema-aware
className - Name of the schema-aware Configuration class to be loaded. Designed for use by .NET; can normally be null.