javax.xml.transform
Class TransformerFactory

java.lang.Object
  extended by javax.xml.transform.TransformerFactory
Direct Known Subclasses:
SAXTransformerFactory

public abstract class TransformerFactory
extends Object

Factory for obtaining transformation contexts.


Constructor Summary
protected TransformerFactory()
           
 
Method Summary
abstract  Source getAssociatedStylesheet(Source source, String media, String title, String charset)
          Returns a source object representing the XML resource specified by the xml-stylesheet processing instruction and matching the given criteria.
abstract  Object getAttribute(String name)
          Retrieve the specified named attribute value.
abstract  ErrorListener getErrorListener()
          Returns the callback to be used by transformers obtained from this factory to report transformation errors.
abstract  boolean getFeature(String name)
          Returns the state of a feature in the factory implementation.
abstract  URIResolver getURIResolver()
          Returns the resolver callback to be used by transformers obtained from this factory.
static TransformerFactory newInstance()
          Creates a new factory instance.
abstract  Templates newTemplates(Source source)
          Creates a new compiled transformation using the specified stylesheet.
abstract  Transformer newTransformer()
          Creates a new transformer that applies the identity transform.
abstract  Transformer newTransformer(Source source)
          Creates a new transformer using the specified stylesheet.
abstract  void setAttribute(String name, Object value)
          Set a named attribute on the underlying implementation.
abstract  void setErrorListener(ErrorListener listener)
          Sets the callback to be used by transformers obtained from this factory to report transformation errors.
abstract  void setFeature(String name, boolean value)
          Sets a feature of transformers and templates obtained from this factory.
abstract  void setURIResolver(URIResolver resolver)
          Set the resolver callback to be used by transformers obtained from this factory.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TransformerFactory

protected TransformerFactory()
Method Detail

newInstance

public static TransformerFactory newInstance()
                                      throws TransformerFactoryConfigurationError
Creates a new factory instance. The implementation class to load is the first found in the following locations:
  1. the javax.xml.transform.TransformerFactory system property
  2. the above named property value in the $JAVA_HOME/lib/jaxp.properties file
  3. the class name specified in the META-INF/services/javax.xml.parsers.DocumentBuilderFactory system resource
  4. the default factory class

Throws:
TransformerFactoryConfigurationError

newTransformer

public abstract Transformer newTransformer(Source source)
                                    throws TransformerConfigurationException
Creates a new transformer using the specified stylesheet.

Parameters:
source - the source of an XSLT stylesheet specifying the transformation to apply
Throws:
TransformerConfigurationException

newTransformer

public abstract Transformer newTransformer()
                                    throws TransformerConfigurationException
Creates a new transformer that applies the identity transform.

Throws:
TransformerConfigurationException

newTemplates

public abstract Templates newTemplates(Source source)
                                throws TransformerConfigurationException
Creates a new compiled transformation using the specified stylesheet.

Parameters:
source - the source of an XSLT stylesheet specifying the transformation to apply
Throws:
TransformerConfigurationException

getAssociatedStylesheet

public abstract Source getAssociatedStylesheet(Source source,
                                               String media,
                                               String title,
                                               String charset)
                                        throws TransformerConfigurationException
Returns a source object representing the XML resource specified by the xml-stylesheet processing instruction and matching the given criteria. Note that if multiple stylesheets are selected, the source represents a stylesheet composed of a list of imports.

Parameters:
source - the source XML document
media - the media attribute to match, or null to match the preferred templates
title - the title attribute to match, or null to match any
charset - the charset attribute to match, or null to match any
Throws:
TransformerConfigurationException

setURIResolver

public abstract void setURIResolver(URIResolver resolver)
Set the resolver callback to be used by transformers obtained from this factory.


getURIResolver

public abstract URIResolver getURIResolver()
Returns the resolver callback to be used by transformers obtained from this factory.


setFeature

public abstract void setFeature(String name,
                                boolean value)
                         throws TransformerConfigurationException
Sets a feature of transformers and templates obtained from this factory. Feature names are fully qualified URIs, and may depend on the factory implementation.

Parameters:
name - the name of the feature
value - the feature state
Throws:
TransformerConfigurationException - if the feature is unsupported

getFeature

public abstract boolean getFeature(String name)
Returns the state of a feature in the factory implementation. Feature names are fully qualified URIs, and may depend on the factory implementation. JAXP also predefines several features, including the constants in XMLConstants and The latter expose various capabilities of the factory implementation.


setAttribute

public abstract void setAttribute(String name,
                                  Object value)
                           throws IllegalArgumentException
Set a named attribute on the underlying implementation.

Parameters:
name - the attribute name
value - the value to assign
Throws:
IllegalArgumentException - if the attribute is not supported

getAttribute

public abstract Object getAttribute(String name)
                             throws IllegalArgumentException
Retrieve the specified named attribute value.

Parameters:
name - the attribute name
Throws:
IllegalArgumentException - if the attribute is not supported

setErrorListener

public abstract void setErrorListener(ErrorListener listener)
                               throws IllegalArgumentException
Sets the callback to be used by transformers obtained from this factory to report transformation errors.

Throws:
IllegalArgumentException

getErrorListener

public abstract ErrorListener getErrorListener()
Returns the callback to be used by transformers obtained from this factory to report transformation errors.