Package net.sf.saxon
Class TransformerFactoryImpl
java.lang.Object
javax.xml.transform.TransformerFactory
javax.xml.transform.sax.SAXTransformerFactory
net.sf.saxon.TransformerFactoryImpl
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.
-
Field Summary
Fields inherited from class javax.xml.transform.sax.SAXTransformerFactory
FEATURE, FEATURE_XMLFILTER
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.TransformerFactoryImpl
(Configuration config) Construct a TransformerFactory using an existing Configuration. -
Method Summary
Modifier and TypeMethodDescriptiongetAssociatedStylesheet
(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.getAttribute
(String name) Allows the user to retrieve specific attributes on the underlying implementation.Get the configuration (en bloc)Get the error event handler for the TransformerFactory.boolean
getFeature
(String name) Look up the value of a feature.Get the object that is used by default during the transformation to resolve URIs used in document(), xsl:import, or xsl:include.newTemplates
(Source source) Process the Source into a Templates object, which is a a compiled representation of the source.newTemplates
(Source source, CompilerInfo info) Process the Source into a Templates object, which is a a compiled representation of the source.Get a TemplatesHandler object that can process SAX ContentHandler events into a Templates object.Create a new Transformer object that performs a copy of the source to the result.newTransformer
(Source source) Process the Source into a Transformer object.Get a TransformerHandler object that can process SAX ContentHandler events into a Result.Get a TransformerHandler object that can process SAX ContentHandler events into a Result, based on the transformation instructions specified by the argument.newTransformerHandler
(Templates templates) Get a TransformerHandler object that can process SAX ContentHandler events into a Result, based on the Templates argument.newXMLFilter
(Source src) Create an XMLFilter that uses the given Source as the transformation instructions.newXMLFilter
(Templates templates) Create an XMLFilter, based on the Templates argument..void
setAttribute
(String name, Object value) Allows the user to set specific attributes on the underlying implementation.void
setConfiguration
(Configuration config) Set the configuration (en bloc)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.void
setFeature
(String name, boolean value) Set a feature for thisTransformerFactory
andTransformer
s orTemplate
s created by this factory.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.Methods inherited from class javax.xml.transform.TransformerFactory
newDefaultInstance, newInstance, newInstance
-
Constructor Details
-
TransformerFactoryImpl
public TransformerFactoryImpl()Default constructor. -
TransformerFactoryImpl
Construct a TransformerFactory using an existing Configuration.
-
-
Method Details
-
setConfiguration
Set the configuration (en bloc) -
getConfiguration
Get the configuration (en bloc) -
newTransformer
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.- Specified by:
newTransformer
in classTransformerFactory
- 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
Create a new Transformer object that performs a copy of the source to the result.- Specified by:
newTransformer
in classTransformerFactory
- 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.
-
newTemplates
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.- Specified by:
newTemplates
in classTransformerFactory
- 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.
-
newTemplates
public Templates newTemplates(Source source, CompilerInfo info) throws TransformerConfigurationException 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.
-
getAssociatedStylesheet
public Source getAssociatedStylesheet(Source source, String media, String title, String charset) throws TransformerConfigurationException 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.- Specified by:
getAssociatedStylesheet
in classTransformerFactory
- 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
- if any problems occur
-
setURIResolver
Set an object that is used by default during the transformation to resolve URIs used in xsl:import, or xsl:include.- Specified by:
setURIResolver
in classTransformerFactory
- Parameters:
resolver
- An object that implements the URIResolver interface, or null.
-
getURIResolver
Get the object that is used by default during the transformation to resolve URIs used in document(), xsl:import, or xsl:include.- Specified by:
getURIResolver
in classTransformerFactory
- Returns:
- The URIResolver that was set with setURIResolver.
-
getFeature
Look up the value of a feature.The feature name is any absolute URI.
- Specified by:
getFeature
in classTransformerFactory
- Parameters:
name
- The feature name, which is an absolute URI.- Returns:
- The current state of the feature (true or false).
-
setAttribute
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.- Specified by:
setAttribute
in classTransformerFactory
- Parameters:
name
- The name of the attribute. This must be one of the constants defined in classFeatureKeys
.value
- The value of the attribute.- Throws:
IllegalArgumentException
- thrown if Saxon doesn't recognize the attribute.- See Also:
-
getAttribute
Allows the user to retrieve specific attributes on the underlying implementation.- Specified by:
getAttribute
in classTransformerFactory
- 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.
-
setErrorListener
Set the error event listener for the TransformerFactory, which is used for the processing of transformation instructions, and not for the transformation itself.- Specified by:
setErrorListener
in classTransformerFactory
- Parameters:
listener
- The new error listener.- Throws:
IllegalArgumentException
- if listener is null.
-
getErrorListener
Get the error event handler for the TransformerFactory.- Specified by:
getErrorListener
in classTransformerFactory
- Returns:
- The current error listener, which should never be null.
-
newTransformerHandler
public TransformerHandler newTransformerHandler(Source src) throws TransformerConfigurationException Get a TransformerHandler object that can process SAX ContentHandler events into a Result, based on the transformation instructions specified by the argument.- Specified by:
newTransformerHandler
in classSAXTransformerFactory
- 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) throws TransformerConfigurationException Get a TransformerHandler object that can process SAX ContentHandler events into a Result, based on the Templates argument.- Specified by:
newTransformerHandler
in classSAXTransformerFactory
- 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
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.- Specified by:
newTransformerHandler
in classSAXTransformerFactory
- 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.
-
newTemplatesHandler
Get a TemplatesHandler object that can process SAX ContentHandler events into a Templates object.- Specified by:
newTemplatesHandler
in classSAXTransformerFactory
- 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.
-
newXMLFilter
Create an XMLFilter that uses the given Source as the transformation instructions.- Specified by:
newXMLFilter
in classSAXTransformerFactory
- 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
Create an XMLFilter, based on the Templates argument..- Specified by:
newXMLFilter
in classSAXTransformerFactory
- 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.
-
setFeature
Set a feature for this
Feature names are fully qualifiedTransformerFactory
andTransformer
s orTemplate
s created by this factory.URI
s. Implementations may define their own features. AnTransformerConfigurationException
is thrown if thisTransformerFactory
or theTransformer
s orTemplate
s it creates cannot support the feature. It is possible for anTransformerFactory
to expose a feature value but be unable to change its state.All implementations are required to support the FEATURE_SECURE_PROCESSING feature. When the feature is:
-
true
: the implementation will limit XML processing to conform to implementation limits and behave in a secure fashion as defined by the implementation. Examples include resolving user defined style sheets and functions. If XML processing is limited for security reasons, it will be reported via a call to the registeredErrorListener.fatalError(javax.xml.transform.TransformerException exception)
. SeesetErrorListener(javax.xml.transform.ErrorListener listener)
. In the Saxon implementation, this option causes calls on extension functions and extensions instructions to be disabled, and also disables the use of xsl:result-document to write to secondary output destinations. -
false
: the implementation will processing XML according to the XML specifications without regard to possible implementation limits.
- Specified by:
setFeature
in classTransformerFactory
- Parameters:
name
- Feature name.value
- Is feature statetrue
orfalse
.- Throws:
TransformerConfigurationException
- if thisTransformerFactory
or theTransformer
s orTemplate
s it creates cannot support this feature.NullPointerException
- If thename
parameter is null.
-
-