javax.xml.transform
public abstract class TransformerFactory extends Object
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.
TransformerFactory
class is
NOT guaranteed to be thread safe. It is up to the user application
to make sure about the use of the TransformerFactory
from
more than one thread. Alternatively the application can have one instance
of the TransformerFactory
per thread.
An application can use the same instance of the factory to obtain one or
more instances of a Transformer
or Templates
provided the instance of the factory isn't being used in more than one
thread at a time.
Constructor Summary | |
---|---|
protected | TransformerFactory()
Default constructor is protected on purpose. |
Method Summary | |
---|---|
abstract 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. |
abstract Object | getAttribute(String name)
Allows the user to retrieve specific attributes on the underlying
implementation. |
abstract ErrorListener | getErrorListener()
Get the error event handler for the TransformerFactory.
|
abstract boolean | getFeature(String name)
Look up the value of a feature.
|
abstract URIResolver | getURIResolver()
Get the object that is used by default during the transformation
to resolve URIs used in document(), xsl:import, or xsl:include.
|
static TransformerFactory | newInstance()
Obtain a new instance of a TransformerFactory .
|
abstract Templates | newTemplates(Source source)
Process the Source into a Templates object, which is a
a compiled representation of the source. |
abstract Transformer | newTransformer(Source source)
Process the Source into a Transformer object. |
abstract Transformer | newTransformer()
Create a new Transformer object that performs a copy
of the source to the result.
|
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 | 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: 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.
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.
Returns: The current error handler, which should never be null.
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).
Returns: The URIResolver that was set with setURIResolver.
TransformerFactory
.
This static method creates a new factory instance
This method uses the following ordered lookup procedure to determine
the TransformerFactory
implementation class to
load:
javax.xml.transform.TransformerFactory
system
property.
java.util.Properties
format and contains the fully qualified name of the
implementation class with the key being the system property defined
above.
META-INF/services/javax.xml.transform.TransformerFactory
in jars available to the runtime.
TransformerFactory
instance.
TransformerFactory
it can use the factory to configure
and obtain parser instances.
Returns: new TransformerFactory instance, never null (unless an ErrorListener is registered with the TransformerFactory, in which case an exception error sends an error message to the ErrorListener and returns null).
Throws: TransformerFactoryConfigurationError if the implmentation is not available or cannot be instantiated.
Parameters: source An object that holds a URL, input stream, etc.
Returns: A Templates object capable of being used for transformation purposes, never null (unless an ErrorListener is registered with the TransformerFactory, in which case an exception error sends an error message to the ErrorListener and returns null).
Throws: TransformerConfigurationException May throw this during the parse when it is constructing the Templates object and fails.
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 (unless an ErrorListener is registered with the TransformerFactory, in which case an exception error sends an error message to the ErrorListener and returns null).
Throws: TransformerConfigurationException May throw this during the parse when it is constructing the Templates object and fails.
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 (unless an ErrorListener is registered with the TransformerFactory, in which case an exception error sends an error message to the ErrorListener and returns null).
Throws: TransformerConfigurationException May throw this during the parse when it is constructing the Templates object and fails.
Parameters: name The name of the attribute. value The value of the attribute.
Throws: IllegalArgumentException thrown if the underlying implementation doesn't recognize the attribute.
Parameters: listener The new error listener.
Throws: IllegalArgumentException if listener is null.
Parameters: resolver An object that implements the URIResolver interface, or null.