- Direct Known Subclasses:
SAXTransformerFactory
A TransformerFactory instance can be used to create
Transformer
and
Templates
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.
- Since:
- 1.5
-
Constructor Summary
ModifierConstructorDescriptionprotected
Default constructor is protected on purpose. -
Method Summary
Modifier and TypeMethodDescriptionabstract Source
getAssociatedStylesheet
(Source source, String media, String title, String charset) Get the stylesheet specification(s) associated with the XMLSource
document via the xml-stylesheet processing instruction that match the given criteria.abstract Object
getAttribute
(String name) Allows the user to retrieve specific attributes on the underlying implementation.abstract ErrorListener
Get the error event handler for the TransformerFactory.abstract boolean
getFeature
(String name) Look up the value of a feature.abstract URIResolver
Get the object that is used by default during the transformation to resolve URIs used in document(), xsl:import, or xsl:include.static TransformerFactory
Creates a new instance of theTransformerFactory
builtin system-default implementation.static TransformerFactory
Obtains a new instance of aTransformerFactory
.static TransformerFactory
newInstance
(String factoryClassName, ClassLoader classLoader) Obtain a new instance of aTransformerFactory
from factory class name.abstract Templates
newTemplates
(Source source) Process the Source into a Templates object, which is a a compiled representation of the source.abstract Transformer
Create a newTransformer
that performs a copy of theSource
to theResult
, i.e. the "identity transform".abstract Transformer
newTransformer
(Source source) Process theSource
into aTransformer
Object
.abstract void
setAttribute
(String name, Object value) Allows the user to set specific attributes on the underlying implementation.abstract 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.abstract void
setFeature
(String name, boolean value) Set a feature for thisTransformerFactory
andTransformer
s orTemplate
s created by this factory.abstract void
setURIResolver
(URIResolver resolver) Set an object that is used by default during the transformation to resolve URIs used in document(), xsl:import, or xsl:include.
-
Constructor Details
-
TransformerFactory
protected TransformerFactory()Default constructor is protected on purpose.
-
-
Method Details
-
newDefaultInstance
Creates a new instance of theTransformerFactory
builtin system-default implementation.- Returns:
- A new instance of the
TransformerFactory
builtin system-default implementation. - Since:
- 9
-
newInstance
Obtains a new instance of aTransformerFactory
. This method uses the JAXP Lookup Mechanism to determine theTransformerFactory
implementation class to load.Once an application has obtained a reference to a
TransformerFactory
, it can use the factory to configure and obtain transformer instances.- Returns:
- new TransformerFactory instance, never null.
- Throws:
TransformerFactoryConfigurationError
- Thrown in case of service configuration error or if the implementation is not available or cannot be instantiated.
-
newInstance
public static TransformerFactory newInstance(String factoryClassName, ClassLoader classLoader) throws TransformerFactoryConfigurationError Obtain a new instance of aTransformerFactory
from factory class name. This function is useful when there are multiple providers in the classpath. It gives more control to the application as it can specify which provider should be loaded.Once an application has obtained a reference to a
TransformerFactory
it can use the factory to configure and obtain transformer instances.Tip for Trouble-shooting
Setting the
jaxp.debug
system property will cause this method to print a lot of debug messages toSystem.err
about what it is doing and where it is looking at.If you have problems try:
java -Djaxp.debug=1 YourProgram ....
- Parameters:
factoryClassName
- fully qualified factory class name that provides implementation ofjavax.xml.transform.TransformerFactory
.classLoader
-ClassLoader
used to load the factory class. Ifnull
currentThread
's context classLoader is used to load the factory class.- Returns:
- new TransformerFactory instance, never null.
- Throws:
TransformerFactoryConfigurationError
- iffactoryClassName
isnull
, or the factory class cannot be loaded, instantiated.- Since:
- 1.6
- See Also:
-
newTransformer
Process theSource
into aTransformer
Object
. TheSource
is an XSLT document that conforms to XSL Transformations (XSLT) Version 1.0. Care must be taken not to use thisTransformer
in multipleThread
s running concurrently. DifferentTransformerFactories
can be used concurrently by differentThread
s.- Parameters:
source
-Source
of XSLT document used to createTransformer
. Examples of XMLSource
s includeDOMSource
,SAXSource
, andStreamSource
.- Returns:
- A
Transformer
object that may be used to perform a transformation in a singleThread
, nevernull
. - Throws:
TransformerConfigurationException
- Thrown if there are errors when parsing theSource
or it is not possible to create aTransformer
instance.- See Also:
-
newTransformer
Create a newTransformer
that performs a copy of theSource
to theResult
, i.e. the "identity transform".- Returns:
- A Transformer object that may be used to perform a transformation in a single thread, never null.
- Throws:
TransformerConfigurationException
- When it is not possible to create aTransformer
instance.
-
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.- 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
- When parsing to construct the Templates object fails.
-
getAssociatedStylesheet
public abstract Source getAssociatedStylesheet(Source source, String media, String title, String charset) throws TransformerConfigurationException Get the stylesheet specification(s) associated with the XMLSource
document via the xml-stylesheet processing instruction 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 in a single stylesheet.- Parameters:
source
- The XML source document.media
- The media attribute to be matched. May be null, in which case the preferred 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 theTransformerFactory
. - Throws:
TransformerConfigurationException
- AnException
is thrown if an error occurings during parsing of thesource
.- See Also:
-
setURIResolver
Set an object that is used by default during the transformation to resolve URIs used in document(), xsl:import, or xsl:include.- 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.- Returns:
- The URIResolver that was set with setURIResolver.
-
setFeature
public abstract void setFeature(String name, boolean value) throws TransformerConfigurationException Set a feature for this
TransformerFactory
andTransformer
s orTemplate
s created by this factory.Feature names are fully qualified
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
XMLConstants.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(TransformerException exception)
. SeesetErrorListener(ErrorListener listener)
. -
false
: the implementation will processing XML according to the XML specifications without regard to possible implementation limits.
- 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.
-
-
getFeature
Look up the value of a feature.Feature names are fully qualified
URI
s. Implementations may define their own features.false
is returned 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.- Parameters:
name
- Feature name.- Returns:
- The current state of the feature,
true
orfalse
. - Throws:
NullPointerException
- If thename
parameter is null.
-
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. AnIllegalArgumentException
is thrown if the underlying implementation doesn't recognize the attribute.All implementations that implement JAXP 1.5 or newer are required to support the
XMLConstants.ACCESS_EXTERNAL_DTD
andXMLConstants.ACCESS_EXTERNAL_STYLESHEET
properties.-
Access to external DTDs in the source file is restricted to the protocols specified by the
XMLConstants.ACCESS_EXTERNAL_DTD
property. If access is denied during transformation due to the restriction of this property,TransformerException
will be thrown byTransformer.transform(Source, Result)
.Access to external DTDs in the stylesheet is restricted to the protocols specified by the
XMLConstants.ACCESS_EXTERNAL_DTD
property. If access is denied during the creation of a new transformer due to the restriction of this property,TransformerConfigurationException
will be thrown by thenewTransformer(Source)
method.Access to external reference set by the stylesheet processing instruction, Import and Include element is restricted to the protocols specified by the
XMLConstants.ACCESS_EXTERNAL_STYLESHEET
property. If access is denied during the creation of a new transformer due to the restriction of this property,TransformerConfigurationException
will be thrown by thenewTransformer(Source)
method.Access to external document through XSLT document function is restricted to the protocols specified by the property. If access is denied during the transformation due to the restriction of this property,
TransformerException
will be thrown by theTransformer.transform(Source, Result)
method.
- Parameters:
name
- The name of the attribute.value
- The value of the attribute.- Throws:
IllegalArgumentException
- When implementation does not recognize the attribute.
-
-
getAttribute
Allows the user to retrieve specific attributes on the underlying implementation. AnIllegalArgumentException
is thrown if the underlying implementation doesn't recognize the attribute.- Parameters:
name
- The name of the attribute.- Returns:
- value The value of the attribute.
- Throws:
IllegalArgumentException
- When implementation does not 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. AnIllegalArgumentException
is thrown if theErrorListener
listener isnull
.- Parameters:
listener
- The new error listener.- Throws:
IllegalArgumentException
- Whenlistener
isnull
-
getErrorListener
Get the error event handler for the TransformerFactory.- Returns:
- The current error handler, which should never be null.
-