Home » xml-commons-external-1.4.01-src » javax » xml » transform » [javadoc | source]
javax.xml.transform
abstract public class: TransformerFactory [javadoc | source]
java.lang.Object
   javax.xml.transform.TransformerFactory

Direct Known Subclasses:
    SAXTransformerFactory

A TransformerFactory instance can be used to create javax.xml.transform.Transformer and javax.xml.transform.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.

Constructor:
 protected TransformerFactory() 
Method from javax.xml.transform.TransformerFactory Summary:
getAssociatedStylesheet,   getAttribute,   getErrorListener,   getFeature,   getURIResolver,   newInstance,   newInstance,   newTemplates,   newTransformer,   newTransformer,   setAttribute,   setErrorListener,   setFeature,   setURIResolver
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.xml.transform.TransformerFactory Detail:
 abstract public Source getAssociatedStylesheet(Source source,
    String media,
    String title,
    String charset) throws TransformerConfigurationException

    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.

 abstract public Object getAttribute(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.
 abstract public ErrorListener getErrorListener()
    Get the error event handler for the TransformerFactory.
 abstract public boolean getFeature(String name)
    Look up the value of a feature.

    Feature names are fully qualified 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.

 abstract 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.
 public static TransformerFactory newInstance() throws TransformerFactoryConfigurationError 
    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.
 public static TransformerFactory newInstance(String factoryClassName,
    ClassLoader classLoader) throws TransformerFactoryConfigurationError 
 abstract public Templates newTemplates(Source source) 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.
 abstract public Transformer newTransformer() throws TransformerConfigurationException

    Create a new Transformer that performs a copy of the Source to the Result. i.e. the "identity transform".

 abstract public Transformer newTransformer(Source source) throws TransformerConfigurationException

    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.

 abstract 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. An IllegalArgumentException is thrown if the underlying implementation doesn't recognize the attribute.
 abstract 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. An IllegalArgumentException is thrown if the ErrorListener listener is null.
 abstract public  void setFeature(String name,
    boolean value) throws TransformerConfigurationException

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

    Feature names are fully qualified java.net.URI s. Implementations may define their own features. An 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:

    • 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 ErrorListener#fatalError(TransformerException exception) . See #setErrorListener(ErrorListener listener) .
    • false: the implementation will processing XML according to the XML specifications without regard to possible implementation limits.
 abstract public  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.