Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.xml.transform

Class TransformerFactory

Known Direct Subclasses:
GnomeTransformerFactory, SAXTransformerFactory, TransformerFactoryImpl
public abstract class TransformerFactory
extends java.lang.Object
Factory for obtaining transformation contexts.

Constructor Summary

TransformerFactory()

Method Summary

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.
Object
getAttribute(String name)
Retrieve the specified named attribute value.
ErrorListener
getErrorListener()
Returns the callback to be used by transformers obtained from this factory to report transformation errors.
boolean
getFeature(String name)
Returns the state of a feature in the factory implementation.
URIResolver
getURIResolver()
Returns the resolver callback to be used by transformers obtained from this factory.
static TransformerFactory
newInstance()
Creates a new factory instance.
Templates
newTemplates(Source source)
Creates a new compiled transformation using the specified stylesheet.
Transformer
newTransformer()
Creates a new transformer that applies the identity transform.
Transformer
newTransformer(Source source)
Creates a new transformer using the specified stylesheet.
void
setAttribute(String name, Object value)
Set a named attribute on the underlying implementation.
void
setErrorListener(ErrorListener listener)
Sets the callback to be used by transformers obtained from this factory to report transformation errors.
void
setFeature(String name, boolean value)
Sets a feature of transformers and templates obtained from this factory.
void
setURIResolver(URIResolver resolver)
Set the resolver callback to be used by transformers obtained from this factory.

Constructor Details

TransformerFactory

protected TransformerFactory()

Method Details

getAssociatedStylesheet

public 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

getAttribute

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

Parameters:
name - the attribute name

getErrorListener

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

getFeature

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

getURIResolver

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

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

newTemplates

public 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

newTransformer

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

newTransformer

public 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

setAttribute

public 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

setErrorListener

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

setFeature

public 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

setURIResolver

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

Overview Package Tree Index Deprecated About