org.exolab.adaptx.jaxp.transform

Class TransformerFactoryImpl


public class TransformerFactoryImpl
extends SAXTransformerFactory

An implementation of JAXP 1.1 TransfomerFactory. Please see the JAXP 1.1 documentation for more information on how this class should be used.
Version:
$Revision: 3955 $ $Date: 2003-10-07 04:37:35 -0400 (Tue, 07 Oct 2003) $
Author:
Keith Visco

Field Summary

static String[]
SUPPORTED_FEATURES
The list of supported features

Constructor Summary

TransformerFactoryImpl()
Creates a new TransformerFactoryImpl

Method Summary

Source
getAssociatedStylesheet(Source source, String media, String title, String charset)
Returns the associated stylesheet with the given source document.
Object
getAttribute(String name)
Allows the user to retrieve specific attributes on the underlying implementation.
ErrorListener
getErrorListener()
Get the error event handler for the TransformerFactory.
boolean
getFeature(String name)
Look up the value of a feature.
URIResolver
getURIResolver()
Get the object that is used by default during the transformation to resolve URIs used in document(), xsl:import, or xsl:include.
Templates
newTemplates(Source source)
Process the Source into a Templates object, which is a a compiled representation of the source.
TemplatesHandler
newTemplatesHandler()
Get a TemplatesHandler object that can process SAX ContentHandler events into a Templates object.
Transformer
newTransformer()
Create a new Transformer object that performs a copy of the source to the result.
Transformer
newTransformer(Source source)
Process the Source into a Transformer object.
TransformerHandler
newTransformerHandler()
Get a TransformerHandler object that can process SAX ContentHandler events into a Result.
TransformerHandler
newTransformerHandler(Source source)
Get a TransformerHandler object that can process SAX ContentHandler events into a Result, based on the transformation instructions specified by the argument.
TransformerHandler
newTransformerHandler(Templates templates)
Get a TransformerHandler object that can process SAX ContentHandler events into a Result, based on the Templates argument.
XMLFilter
newXMLFilter(Source source)
Create an XMLFilter that uses the given Source as the transformation instructions.
XMLFilter
newXMLFilter(Templates templates)
Create an XMLFilter, based on the Templates argument..
void
setAttribute(String name, Object value)
Allows the user to set specific attributes on the underlying implementation.
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.
void
setFeature(String name, boolean value)
void
setURIResolver(URIResolver resolver)
Set an object that is used by default during the transformation to resolve URIs used in xsl:import, or xsl:include.

Field Details

SUPPORTED_FEATURES

public static final String[] SUPPORTED_FEATURES
The list of supported features

Constructor Details

TransformerFactoryImpl

public TransformerFactoryImpl()
Creates a new TransformerFactoryImpl

Method Details

getAssociatedStylesheet

public Source getAssociatedStylesheet(Source source,
                                      String media,
                                      String title,
                                      String charset)
            throws TransformerConfigurationException
Returns the associated stylesheet with the given source document.

Refer to the JAXP 1.1 TransformerFactory documentation for more information

Note: This method is not yet supported.


getAttribute

public Object getAttribute(String name)
            throws IllegalArgumentException
Allows the user to retrieve specific attributes on the underlying implementation.
Parameters:
name - The name of the attribute.
Returns:
value The value of the attribute.

getErrorListener

public ErrorListener getErrorListener()
Get the error event handler for the TransformerFactory.
Returns:
The current error handler, which should never be null.

getFeature

public boolean getFeature(String name)
Look up the value of a feature.

The feature name is any absolute URI.

Parameters:
name - The feature name, which is an absolute URI.
Returns:
The current state of the feature (true or false).

getURIResolver

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.
Returns:
The URIResolver that was set with setURIResolver.

newTemplates

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.
Parameters:
source - An object that holds a URL, input stream, etc.
Returns:
A Templates object capable of being used for transformation purposes, never null.

newTemplatesHandler

public TemplatesHandler newTemplatesHandler()
            throws TransformerConfigurationException
Get a TemplatesHandler object that can process SAX ContentHandler events into a Templates object.
Returns:
A non-null reference to a TransformerHandler, that may be used as a ContentHandler for SAX parse events.

newTransformer

public Transformer newTransformer()
            throws TransformerConfigurationException
Create a new Transformer object that performs a copy of the source to the result.
Parameters:
Returns:
A Transformer object that may be used to perform a transformation in a single thread, never null.

newTransformer

public Transformer newTransformer(Source source)
            throws TransformerConfigurationException
Process the Source into a Transformer object. Care must be given not to use this object in multiple threads running concurrently. Different TransformerFactories can be used concurrently by different threads.
Parameters:
source - An object that holds a URI, input stream, etc.
Returns:
A Transformer object that may be used to perform a transformation in a single thread, never null.

newTransformerHandler

public TransformerHandler newTransformerHandler()
            throws TransformerConfigurationException
Get a TransformerHandler object that can process SAX ContentHandler events into a Result. The transformation is defined as an identity (or copy) transformation, for example to copy a series of SAX parse events into a DOM tree.
Returns:
A non-null reference to a TransformerHandler, that may be used as a ContentHandler for SAX parse events.

newTransformerHandler

public TransformerHandler newTransformerHandler(Source source)
            throws TransformerConfigurationException
Get a TransformerHandler object that can process SAX ContentHandler events into a Result, based on the transformation instructions specified by the argument.
Parameters:
Returns:
TransformerHandler ready to transform SAX events.

newTransformerHandler

public TransformerHandler newTransformerHandler(Templates templates)
            throws TransformerConfigurationException
Get a TransformerHandler object that can process SAX ContentHandler events into a Result, based on the Templates argument.
Parameters:
templates - The compiled transformation instructions.
Returns:
TransformerHandler ready to transform SAX events.

newXMLFilter

public XMLFilter newXMLFilter(Source source)
            throws TransformerConfigurationException
Create an XMLFilter that uses the given Source as the transformation instructions.
Parameters:
Returns:
An XMLFilter object, or null if this feature is not supported.

newXMLFilter

public XMLFilter newXMLFilter(Templates templates)
            throws TransformerConfigurationException
Create an XMLFilter, based on the Templates argument..
Parameters:
templates - The compiled transformation instructions.
Returns:
An XMLFilter object, or null if this feature is not supported.

setAttribute

public void setAttribute(String name,
                         Object value)
            throws IllegalArgumentException
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.
Parameters:
name - The name of the attribute.
value - The value of the attribute.

setErrorListener

public void setErrorListener(ErrorListener listener)
            throws IllegalArgumentException
Set the error event listener for the TransformerFactory, which is used for the processing of transformation instructions, and not for the transformation itself.
Parameters:
listener - The new error listener.

setFeature

public void setFeature(String name,
                       boolean value)
            throws TransformerConfigurationException

setURIResolver

public void setURIResolver(URIResolver resolver)
Set an object that is used by default during the transformation to resolve URIs used in xsl:import, or xsl:include.
Parameters:
resolver - An object that implements the URIResolver interface, or null.