javax.xml.transform

Class TransformerFactory

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(Source source) Creates a new transformer using the specified stylesheet.
abstract Transformer	newTransformer() Creates a new transformer that applies the identity transform.
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.

Method Detail

getAssociatedStylesheet

public 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. 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

getAttribute

public abstract Object getAttribute(String name)

Retrieve the specified named attribute value.

Parameters: name the attribute name

Throws: IllegalArgumentException if the attribute is not supported

getErrorListener

public abstract ErrorListener getErrorListener()

Returns the callback to be used by transformers obtained from this factory to report transformation errors.

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 {@link javax.xml.XMLConstants} and

{@link javax.xml.transform.dom.DOMSource#FEATURE}
{@link javax.xml.transform.dom.DOMResult#FEATURE}
{@link javax.xml.transform.sax.SAXSource#FEATURE}
{@link javax.xml.transform.sax.SAXResult#FEATURE}
{@link javax.xml.transform.sax.SAXTransformerFactory#FEATURE}
{@link javax.xml.transform.sax.SAXTransformerFactory#FEATURE_XMLFILTER}
{@link javax.xml.transform.stream.StreamSource#FEATURE}
{@link javax.xml.transform.stream.StreamResult#FEATURE}

The latter expose various capabilities of the factory implementation.

getURIResolver

public abstract URIResolver getURIResolver()

Returns the resolver callback to be used by transformers obtained from this factory.

newInstance

public static TransformerFactory newInstance()

Creates a new factory instance. The implementation class to load is the first found in the following locations:

the javax.xml.transform.TransformerFactory system property
the above named property value in the $JAVA_HOME/lib/jaxp.properties file
the class name specified in the META-INF/services/javax.xml.parsers.DocumentBuilderFactory system resource
the default factory class

newTemplates

public abstract Templates newTemplates(Source source)

Creates a new compiled transformation using the specified stylesheet.

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

newTransformer

public abstract Transformer newTransformer(Source source)

Creates a new transformer using the specified stylesheet.

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

newTransformer

public abstract Transformer newTransformer()

Creates a new transformer that applies the identity transform.

setAttribute

public abstract void setAttribute(String name, Object value)

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

setErrorListener

public abstract void setErrorListener(ErrorListener listener)

Sets the callback to be used by transformers obtained from this factory to report transformation errors.

setFeature

public abstract void setFeature(String name, boolean value)

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

setURIResolver

public abstract void setURIResolver(URIResolver resolver)

Set the resolver callback to be used by transformers obtained from this factory.