File	Doc	Category	Size	Date	Package
TransformerFactory.java	API Doc	Java SE 5 API	13475	Fri Aug 26 14:58:24 BST 2005	javax.xml.transform

TransformerFactory

• java.lang.Object

Fields Summary

Constructors Summary
protected TransformerFactory() Default constructor is protected on purpose.

Methods Summary
public abstract javax.xml.transform.Source	getAssociatedStylesheet(javax.xml.transform.Source source, java.lang.String media, java.lang.String title, java.lang.String charset) Get the stylesheet specification(s) associated with the XML Source 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. param source The XML source document. param media The media attribute to be matched. May be null, in which case the prefered templates will be used (i.e. alternate = no). param title The value of the title attribute to match. May be null. param charset The value of the charset attribute to match. May be null. return A Source Object suitable for passing to the TransformerFactory. throws TransformerConfigurationException An Exception is thrown if an error occurings during parsing of the source. see Associating Style Sheets with XML documents Version 1.0
public abstract java.lang.Object	getAttribute(java.lang.String name) Allows the user to retrieve specific attributes on the underlying implementation. An IllegalArgumentException is thrown if the underlying implementation doesn't recognize the attribute. param name The name of the attribute. return value The value of the attribute.
public abstract javax.xml.transform.ErrorListener	getErrorListener() Get the error event handler for the TransformerFactory. return The current error handler, which should never be null.
public abstract boolean	getFeature(java.lang.String name) Look up the value of a feature. Feature names are fully qualified {@link java.net.URI}s. Implementations may define their own features. false is returned 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. param name Feature name. return The current state of the feature, true or false. throws NullPointerException If the name parameter is null.
public abstract javax.xml.transform.URIResolver	getURIResolver() Get the object that is used by default during the transformation to resolve URIs used in document(), xsl:import, or xsl:include. return The URIResolver that was set with setURIResolver.
public static javax.xml.transform.TransformerFactory	newInstance() Obtain a new instance of a 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: Use the javax.xml.transform.TransformerFactory system property. Use the properties file "lib/jaxp.properties" in the JRE directory. This configuration file is in standard java.util.Properties format and contains the fully qualified name of the implementation class with the key being the system property defined above. The jaxp.properties file is read only once by the JAXP implementation and it's values are then cached for future use. If the file does not exist when the first attempt is made to read from it, no further attempts are made to check for its existence. It is not possible to change the value of any property in jaxp.properties after it has been read for the first time. Use the Services API (as detailed in the JAR specification), if available, to determine the classname. The Services API will look for a classname in the file META-INF/services/javax.xml.transform.TransformerFactory in jars available to the runtime. Platform default TransformerFactory instance. Once an application has obtained a reference to a TransformerFactory it can use the factory to configure and obtain parser instances. return new TransformerFactory instance, never null. throws TransformerFactoryConfigurationError Thrown if the implementation is not available or cannot be instantiated. try { return (TransformerFactory) FactoryFinder.find( /* The default property name according to the JAXP spec */ "javax.xml.transform.TransformerFactory", /* The fallback implementation class name, XSLTC */ "com.sun.org.apache.xalan.internal.xsltc.trax.TransformerFactoryImpl"); } catch (FactoryFinder.ConfigurationError e) { throw new TransformerFactoryConfigurationError( e.getException(), e.getMessage()); }
public abstract javax.xml.transform.Templates	newTemplates(javax.xml.transform.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. param source An object that holds a URL, input stream, etc. return A Templates object capable of being used for transformation purposes, never null. exception TransformerConfigurationException May throw this during the parse when it is constructing the Templates object and fails.
public abstract javax.xml.transform.Transformer	newTransformer(javax.xml.transform.Source source) Process the Source into a Transformer Object. The Source is an XSLT document that conforms to XSL Transformations (XSLT) Version 1.0. Care must be taken not to use this Transformer in multiple Threads running concurrently. Different TransformerFactories can be used concurrently by different Threads. param source Source of XSLT document used to create Transformer. Examples of XML Sources include {@link javax.xml.transform.dom.DOMSource DOMSource}, {@link javax.xml.transform.sax.SAXSource SAXSource}, and {@link javax.xml.transform.stream.StreamSource StreamSource}. return A Transformer object that may be used to perform a transformation in a single Thread, never null. throws TransformerConfigurationException Thrown if there are errors when parsing the Source or it is not possible to create a Transformer instance. see XSL Transformations (XSLT) Version 1.0
public abstract javax.xml.transform.Transformer	newTransformer() Create a new Transformer that performs a copy of the Source to the Result. i.e. the "identity transform". return A Transformer object that may be used to perform a transformation in a single thread, never null. exception TransformerConfigurationException Thrown if it is not possible to create a Transformer instance.
public abstract void	setAttribute(java.lang.String name, java.lang.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. An IllegalArgumentException is thrown if the underlying implementation doesn't recognize the attribute. param name The name of the attribute. param value The value of the attribute.
public abstract void	setErrorListener(javax.xml.transform.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. An IllegalArgumentException is thrown if the ErrorListener listener is null. param listener The new error listener.
public abstract void	setFeature(java.lang.String name, boolean value) Set a feature for this TransformerFactory and Transformers or Templates created by this factory. Feature names are fully qualified {@link java.net.URI}s. Implementations may define their own features. An {@link 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 {@link javax.xml.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 registered {@link ErrorListener#fatalError(TransformerException exception)}. See {@link #setErrorListener(ErrorListener listener)}. false: the implementation will processing XML according to the XML specifications without regard to possible implementation limits. param name Feature name. param value Is feature state true or false. throws TransformerConfigurationException if this TransformerFactory or the Transformers or Templates it creates cannot support this feature. throws NullPointerException If the name parameter is null.
public abstract void	setURIResolver(javax.xml.transform.URIResolver resolver) Set an object that is used by default during the transformation to resolve URIs used in document(), xsl:import, or xsl:include. param resolver An object that implements the URIResolver interface, or null.