com.icl.saxon

Class TransformerFactoryImpl

public class TransformerFactoryImpl extends SAXTransformerFactory

A TransformerFactoryImpl instance can be used to create Transformer and Template objects.

The system property that determines which Factory implementation to create is named "javax.xml.transform.TransformerFactory". This property names a concrete subclass of the TransformerFactory abstract class. If the property is not defined, a platform default is be used.

This implementation class implements the abstract methods on both the javax.xml.transform.TransformerFactory and javax.xml.transform.sax.SAXTransformerFactory classes.

Constructor Summary
TransformerFactoryImpl()
Default constructor.
Method Summary
SourcecompositeStylesheet(SAXSource[] sources)
Process a series of stylesheet inputs, treating them in import or cascade order.
SourcegetAssociatedStylesheet(Source source, String media, String title, String charset)
Get the stylesheet specification(s) associated via the xml-stylesheet processing instruction (see http://www.w3.org/TR/xml-stylesheet/) with the document document specified in the source parameter, and that match the given criteria.
ObjectgetAttribute(String name)
Allows the user to retrieve specific attributes on the underlying implementation.
ErrorListenergetErrorListener()
Get the error event handler for the TransformerFactory.
booleangetFeature(String name)
Look up the value of a feature.
SAXSourcegetSAXSource(Source source, boolean isStyleSheet)
Convert a supplied Source to a SAXSource
XMLReadergetSourceParser()
Get the parser for source documents
XMLReadergetStyleParser()
Get the parser for stylesheet documents
URIResolvergetURIResolver()
Get the object that is used by default during the transformation to resolve URIs used in document(), xsl:import, or xsl:include.
static XMLReadermakeParser(String className)
Create a new SAX XMLReader object using the class name provided.
The named class must exist and must implement the org.xml.sax.XMLReader or Parser interface.
This method returns an instance of the parser named.
TemplatesnewTemplates(Source source)
Process the Source into a Templates object, which is a a compiled representation of the source.
TemplatesHandlernewTemplatesHandler()
Get a TemplatesHandler object that can process SAX ContentHandler events into a Templates object.
TransformernewTransformer(Source source)
Process the Source into a Transformer object.
TransformernewTransformer()
Create a new Transformer object that performs a copy of the source to the result.
TransformerHandlernewTransformerHandler(Source src)
Get a TransformerHandler object that can process SAX ContentHandler events into a Result, based on the transformation instructions specified by the argument.
TransformerHandlernewTransformerHandler(Templates templates)
Get a TransformerHandler object that can process SAX ContentHandler events into a Result, based on the Templates argument.
TransformerHandlernewTransformerHandler()
Get a TransformerHandler object that can process SAX ContentHandler events into a Result.
XMLFilternewXMLFilter(Source src)
Create an XMLFilter that uses the given Source as the transformation instructions.
XMLFilternewXMLFilter(Templates templates)
Create an XMLFilter, based on the Templates argument..
voidsetAttribute(String name, Object value)
Allows the user to set specific attributes on the underlying implementation.
voidsetErrorListener(ErrorListener listener)
Set the error event listener for the TransformerFactory, which is used for the processing of transformation instructions, and not for the transformation itself.
voidsetFeature(String name, boolean value)

Set a feature for this TransformerFactory and Transformers or Templates created by this factory.

Feature names are fully qualified java.net.URIs.

voidsetURIResolver(URIResolver resolver)
Set an object that is used by default during the transformation to resolve URIs used in xsl:import, or xsl:include.

Constructor Detail

TransformerFactoryImpl

public TransformerFactoryImpl()
Default constructor.

Method Detail

compositeStylesheet

public Source compositeStylesheet(SAXSource[] sources)
Process a series of stylesheet inputs, treating them in import or cascade order. This is mainly for support of the getAssociatedStylesheets method, but may be useful for other purposes.

Parameters: sources An array of SAX InputSource objects.

Returns: A Source object representing a composite stylesheet.

getAssociatedStylesheet

public Source getAssociatedStylesheet(Source source, String media, String title, String charset)
Get the stylesheet specification(s) associated via the xml-stylesheet processing instruction (see http://www.w3.org/TR/xml-stylesheet/) with the document document specified in the source parameter, and that match the given criteria. Note that it is possible to return several stylesheets, in which case they are applied as if they were a list of imports or cascades.

Parameters: source The XML source document. media The media attribute to be matched. May be null, in which case the prefered templates will be used (i.e. alternate = no). title The value of the title attribute to match. May be null. charset The value of the charset attribute to match. May be null.

Returns: A Source object suitable for passing to the TransformerFactory.

Throws: TransformerConfigurationException

getAttribute

public Object getAttribute(String name)
Allows the user to retrieve specific attributes on the underlying implementation.

Parameters: name The name of the attribute.

Returns: value The value of the attribute.

Throws: IllegalArgumentException thrown if the underlying implementation doesn't recognize the attribute.

getErrorListener

public ErrorListener getErrorListener()
Get the error event handler for the TransformerFactory.

Returns: The current error handler, which should never be null.

getFeature

public boolean getFeature(String name)
Look up the value of a feature.

The feature name is any absolute URI.

Parameters: name The feature name, which is an absolute URI.

Returns: The current state of the feature (true or false).

getSAXSource

public SAXSource getSAXSource(Source source, boolean isStyleSheet)
Convert a supplied Source to a SAXSource

Parameters: source The supplied input source isStyleSheet true if the source is a stylesheet

Returns: a SAXSource

getSourceParser

public XMLReader getSourceParser()
Get the parser for source documents

getStyleParser

public XMLReader getStyleParser()
Get the parser for stylesheet documents

getURIResolver

public URIResolver getURIResolver()
Get the object that is used by default during the transformation to resolve URIs used in document(), xsl:import, or xsl:include.

Returns: The URIResolver that was set with setURIResolver.

makeParser

public static XMLReader makeParser(String className)
Create a new SAX XMLReader object using the class name provided.
The named class must exist and must implement the org.xml.sax.XMLReader or Parser interface.
This method returns an instance of the parser named.

Parameters: className A string containing the name of the SAX parser class, for example "com.microstar.sax.LarkDriver"

Returns: an instance of the Parser class named, or null if it is not loadable or is not a Parser.

newTemplates

public Templates newTemplates(Source source)
Process the Source into a Templates object, which is a a compiled representation of the source. This Templates object may then be used concurrently across multiple threads. Creating a Templates object allows the TransformerFactory to do detailed performance optimization of transformation instructions, without penalizing runtime transformation.

Parameters: source An object that holds a URL, input stream, etc.

Returns: A Templates object capable of being used for transformation purposes, never null.

Throws: TransformerConfigurationException May throw this during the parse when it is constructing the Templates object and fails.

newTemplatesHandler

public TemplatesHandler newTemplatesHandler()
Get a TemplatesHandler object that can process SAX ContentHandler events into a Templates object.

Returns: A non-null reference to a TransformerHandler, that may be used as a ContentHandler for SAX parse events.

Throws: TransformerConfigurationException If for some reason the TemplatesHandler cannot be created.

newTransformer

public Transformer newTransformer(Source source)
Process the Source into a Transformer object. Care must be given not to use this object in multiple threads running concurrently. Different TransformerFactories can be used concurrently by different threads.

Parameters: source An object that holds a URI, input stream, etc.

Returns: A Transformer object that may be used to perform a transformation in a single thread, never null.

Throws: TransformerConfigurationException May throw this during the parse when it is constructing the Templates object and fails.

newTransformer

public Transformer newTransformer()
Create a new Transformer object that performs a copy of the source to the result.

Returns: A Transformer object that may be used to perform a transformation in a single thread, never null.

Throws: TransformerConfigurationException May throw this during the parse when it is constructing the Templates object and fails.

newTransformerHandler

public TransformerHandler newTransformerHandler(Source src)
Get a TransformerHandler object that can process SAX ContentHandler events into a Result, based on the transformation instructions specified by the argument.

Parameters: src The Source of the transformation instructions.

Returns: TransformerHandler ready to transform SAX events.

Throws: TransformerConfigurationException If for some reason the TransformerHandler can not be created.

newTransformerHandler

public TransformerHandler newTransformerHandler(Templates templates)
Get a TransformerHandler object that can process SAX ContentHandler events into a Result, based on the Templates argument.

Parameters: templates The compiled transformation instructions.

Returns: TransformerHandler ready to transform SAX events.

Throws: TransformerConfigurationException If for some reason the TransformerHandler can not be created.

newTransformerHandler

public TransformerHandler newTransformerHandler()
Get a TransformerHandler object that can process SAX ContentHandler events into a Result. The transformation is defined as an identity (or copy) transformation, for example to copy a series of SAX parse events into a DOM tree.

Returns: A non-null reference to a TransformerHandler, that may be used as a ContentHandler for SAX parse events.

Throws: TransformerConfigurationException If for some reason the TransformerHandler cannot be created.

newXMLFilter

public XMLFilter newXMLFilter(Source src)
Create an XMLFilter that uses the given Source as the transformation instructions.

Parameters: src The Source of the transformation instructions.

Returns: An XMLFilter object, or null if this feature is not supported.

Throws: TransformerConfigurationException If for some reason the XMLFilter cannot be created.

newXMLFilter

public XMLFilter newXMLFilter(Templates templates)
Create an XMLFilter, based on the Templates argument..

Parameters: templates The compiled transformation instructions.

Returns: An XMLFilter object, or null if this feature is not supported.

Throws: TransformerConfigurationException If for some reason the XMLFilter cannot be created.

setAttribute

public void setAttribute(String name, Object value)
Allows the user to set specific attributes on the underlying implementation. An attribute in this context is defined to be an option that the implementation provides.

Parameters: name The name of the attribute. This must be one of the constants defined in class FeatureKeys. value The value of the attribute.

Throws: IllegalArgumentException thrown if Saxon doesn't recognize the attribute.

setErrorListener

public void setErrorListener(ErrorListener listener)
Set the error event listener for the TransformerFactory, which is used for the processing of transformation instructions, and not for the transformation itself.

Parameters: listener The new error listener.

Throws: IllegalArgumentException if listener is null.

setFeature

public void setFeature(String name, boolean value)

Set a feature for this TransformerFactory and Transformers or Templates created by this factory.

Feature names are fully qualified java.net.URIs. Implementations may define their own features. An javax.xml.transform.TransformerConfigurationException is thrown if this TransformerFactory or the Transformers or Templates it creates cannot support the feature. It is possible for an TransformerFactory to expose a feature value but be unable to change its state.

All implementations are required to support the javax.xml.XMLConstants#FEATURE_SECURE_PROCESSING feature. When the feature is:

The Saxon implementation does not support the secure processing feature.

Parameters: name Feature name. value Is feature state true or false.

Throws: javax.xml.transform.TransformerConfigurationException if this TransformerFactory or the Transformers or Templates it creates cannot support this feature. NullPointerException If the name parameter is null.

setURIResolver

public void setURIResolver(URIResolver resolver)
Set an object that is used by default during the transformation to resolve URIs used in xsl:import, or xsl:include.

Parameters: resolver An object that implements the URIResolver interface, or null.