org.apache.xalan.xsltc.trax

Class TransformerFactoryImpl

Implemented Interfaces:
ErrorListener, SourceLoader

public class TransformerFactoryImpl
extends SAXTransformerFactory
implements SourceLoader, ErrorListener

Implementation of a JAXP1.1 TransformerFactory for Translets.
Authors:
G. Todd Miller
Morten Jorgensen
Santiago Pericas-Geertsen

Field Summary

static String
AUTO_TRANSLET
static String
DEBUG
static String
DESTINATION_DIRECTORY
static String
ENABLE_INLINING
static String
GENERATE_TRANSLET
static String
INDENT_NUMBER
static String
JAR_NAME
static String
PACKAGE_NAME
static String
TRANSLET_NAME
static String
USE_CLASSPATH

Constructor Summary

TransformerFactoryImpl()
javax.xml.transform.sax.TransformerFactory implementation.

Method Summary

void
error(TransformerException e)
Receive notification of a recoverable error.
void
fatalError(TransformerException e)
Receive notification of a non-recoverable error.
Source
getAssociatedStylesheet(Source source, String media, String title, String charset)
javax.xml.transform.sax.TransformerFactory implementation.
Object
getAttribute(String name)
javax.xml.transform.sax.TransformerFactory implementation.
ErrorListener
getErrorListener()
javax.xml.transform.sax.TransformerFactory implementation.
boolean
getFeature(String name)
javax.xml.transform.sax.TransformerFactory implementation.
URIResolver
getURIResolver()
javax.xml.transform.sax.TransformerFactory implementation.
InputSource
loadSource(String href, String context, XSLTC xsltc)
This method implements XSLTC's SourceLoader interface.
Templates
newTemplates(Source source)
javax.xml.transform.sax.TransformerFactory implementation.
TemplatesHandler
newTemplatesHandler()
javax.xml.transform.sax.SAXTransformerFactory implementation.
Transformer
newTransformer()
javax.xml.transform.sax.TransformerFactory implementation.
Transformer
newTransformer(Source source)
javax.xml.transform.sax.TransformerFactory implementation.
TransformerHandler
newTransformerHandler()
javax.xml.transform.sax.SAXTransformerFactory implementation.
TransformerHandler
newTransformerHandler(Source src)
javax.xml.transform.sax.SAXTransformerFactory implementation.
TransformerHandler
newTransformerHandler(Templates templates)
javax.xml.transform.sax.SAXTransformerFactory implementation.
XMLFilter
newXMLFilter(Source src)
javax.xml.transform.sax.SAXTransformerFactory implementation.
XMLFilter
newXMLFilter(Templates templates)
javax.xml.transform.sax.SAXTransformerFactory implementation.
void
setAttribute(String name, Object value)
javax.xml.transform.sax.TransformerFactory implementation.
void
setErrorListener(ErrorListener listener)
javax.xml.transform.sax.TransformerFactory implementation.
void
setFeature(String name, boolean value)
Set a feature for this TransformerFactory and Transformers or Templates created by this factory.

Feature names are fully qualified java.net.URIs.

void
setURIResolver(URIResolver resolver)
javax.xml.transform.sax.TransformerFactory implementation.
void
warning(TransformerException e)
Receive notification of a warning.

Field Details

AUTO_TRANSLET

public static final String AUTO_TRANSLET

DEBUG

public static final String DEBUG

DESTINATION_DIRECTORY

public static final String DESTINATION_DIRECTORY

ENABLE_INLINING

public static final String ENABLE_INLINING

GENERATE_TRANSLET

public static final String GENERATE_TRANSLET

INDENT_NUMBER

public static final String INDENT_NUMBER

JAR_NAME

public static final String JAR_NAME

PACKAGE_NAME

public static final String PACKAGE_NAME

TRANSLET_NAME

public static final String TRANSLET_NAME

USE_CLASSPATH

public static final String USE_CLASSPATH

Constructor Details

TransformerFactoryImpl

public TransformerFactoryImpl()
javax.xml.transform.sax.TransformerFactory implementation.

Method Details

error

public void error(TransformerException e)
            throws TransformerException
Receive notification of a recoverable error. The transformer must continue to provide normal parsing events after invoking this method. It should still be possible for the application to process the document through to the end.
Parameters:
e - The warning information encapsulated in a transformer exception.

fatalError

public void fatalError(TransformerException e)
            throws TransformerException
Receive notification of a non-recoverable error. The application must assume that the transformation cannot continue after the Transformer has invoked this method, and should continue (if at all) only to collect addition error messages. In fact, Transformers are free to stop reporting events once this method has been invoked.
Parameters:
e - warning information encapsulated in a transformer exception.

getAssociatedStylesheet

public Source getAssociatedStylesheet(Source source,
                                      String media,
                                      String title,
                                      String charset)
            throws TransformerConfigurationException
javax.xml.transform.sax.TransformerFactory implementation. Get the stylesheet specification(s) associated via the xml-stylesheet processing instruction (see http://www.w3.org/TR/xml-stylesheet/) with the document document specified in the source parameter, and that match the given criteria.
Parameters:
source - The XML source document.
media - The media attribute to be matched. May be null, in which case the prefered templates will be used (i.e. alternate = no).
title - The value of the title attribute to match. May be null.
charset - The value of the charset attribute to match. May be null.
Returns:
A Source object suitable for passing to the TransformerFactory.

getAttribute

public Object getAttribute(String name)
            throws IllegalArgumentException
javax.xml.transform.sax.TransformerFactory implementation. Returns the value set for a TransformerFactory attribute
Parameters:
name - The attribute name
Returns:
An object representing the attribute value

getErrorListener

public ErrorListener getErrorListener()
javax.xml.transform.sax.TransformerFactory implementation. Get the error event handler for the TransformerFactory.
Returns:
The error listener used with the TransformerFactory

getFeature

public boolean getFeature(String name)
javax.xml.transform.sax.TransformerFactory implementation. Look up the value of a feature (to see if it is supported). This method must be updated as the various methods and features of this class are implemented.
Parameters:
name - The feature name
Returns:
'true' if feature is supported, 'false' if not

getURIResolver

public URIResolver getURIResolver()
javax.xml.transform.sax.TransformerFactory implementation. Get the object that is used by default during the transformation to resolve URIs used in document(), xsl:import, or xsl:include.
Returns:
The URLResolver used for this TransformerFactory and all Templates and Transformer objects created using this factory

loadSource

public InputSource loadSource(String href,
                              String context,
                              XSLTC xsltc)
This method implements XSLTC's SourceLoader interface. It is used to glue a TrAX URIResolver to the XSLTC compiler's Input and Import classes.
Specified by:
loadSource in interface SourceLoader
Parameters:
href - The URI of the document to load
context - The URI of the currently loaded document
xsltc - The compiler that resuests the document
Returns:
An InputSource with the loaded document

newTemplates

public Templates newTemplates(Source source)
            throws TransformerConfigurationException
javax.xml.transform.sax.TransformerFactory implementation. Process the Source into a Templates object, which is a a compiled representation of the source.
Parameters:
source - The input stylesheet - DOMSource not supported!!!
Returns:
A Templates object that can be used to create Transformers.

newTemplatesHandler

public TemplatesHandler newTemplatesHandler()
            throws TransformerConfigurationException
javax.xml.transform.sax.SAXTransformerFactory implementation. Get a TemplatesHandler object that can process SAX ContentHandler events into a Templates object.
Returns:
A TemplatesHandler object that can handle SAX events

newTransformer

public Transformer newTransformer()
            throws TransformerConfigurationException
javax.xml.transform.sax.TransformerFactory implementation. Create a Transformer object that copies the input document to the result.
Returns:
A Transformer object that simply copies the source to the result.

newTransformer

public Transformer newTransformer(Source source)
            throws TransformerConfigurationException
javax.xml.transform.sax.TransformerFactory implementation. Process the Source into a Templates object, which is a a compiled representation of the source. Note that this method should not be used with XSLTC, as the time-consuming compilation is done for each and every transformation.
Returns:
A Templates object that can be used to create Transformers.

newTransformerHandler

public TransformerHandler newTransformerHandler()
            throws TransformerConfigurationException
javax.xml.transform.sax.SAXTransformerFactory implementation. Get a TransformerHandler object that can process SAX ContentHandler events into a Result. This method will return a pure copy transformer.
Returns:
A TransformerHandler object that can handle SAX events

newTransformerHandler

public TransformerHandler newTransformerHandler(Source src)
            throws TransformerConfigurationException
javax.xml.transform.sax.SAXTransformerFactory implementation. Get a TransformerHandler object that can process SAX ContentHandler events into a Result, based on the transformation instructions specified by the argument.
Parameters:
src - The source of the transformation instructions.
Returns:
A TransformerHandler object that can handle SAX events

newTransformerHandler

public TransformerHandler newTransformerHandler(Templates templates)
            throws TransformerConfigurationException
javax.xml.transform.sax.SAXTransformerFactory implementation. Get a TransformerHandler object that can process SAX ContentHandler events into a Result, based on the transformation instructions specified by the argument.
Parameters:
templates - Represents a pre-processed stylesheet
Returns:
A TransformerHandler object that can handle SAX events

newXMLFilter

public XMLFilter newXMLFilter(Source src)
            throws TransformerConfigurationException
javax.xml.transform.sax.SAXTransformerFactory implementation. Create an XMLFilter that uses the given source as the transformation instructions.
Parameters:
src - The source of the transformation instructions.
Returns:
An XMLFilter object, or null if this feature is not supported.

newXMLFilter

public XMLFilter newXMLFilter(Templates templates)
            throws TransformerConfigurationException
javax.xml.transform.sax.SAXTransformerFactory implementation. Create an XMLFilter that uses the given source as the transformation instructions.
Parameters:
templates - The source of the transformation instructions.
Returns:
An XMLFilter object, or null if this feature is not supported.

setAttribute

public void setAttribute(String name,
                         Object value)
            throws IllegalArgumentException
javax.xml.transform.sax.TransformerFactory implementation. Sets the value for a TransformerFactory attribute.
Parameters:
name - The attribute name
value - An object representing the attribute value

setErrorListener

public void setErrorListener(ErrorListener listener)
            throws IllegalArgumentException
javax.xml.transform.sax.TransformerFactory implementation. 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 error listener to use with the TransformerFactory

setFeature

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

See javax.xml.transform.TransformerFactory for full documentation of specific features.

Parameters:
name - Feature name.
value - Is feature state true or false.

setURIResolver

public void setURIResolver(URIResolver resolver)
javax.xml.transform.sax.TransformerFactory implementation. Set the object that is used by default during the transformation to resolve URIs used in document(), xsl:import, or xsl:include. Note that this does not affect Templates and Transformers that are already created with this factory.
Parameters:
resolver - The URLResolver used for this TransformerFactory and all Templates and Transformer objects created using this factory

warning

public void warning(TransformerException e)
            throws TransformerException
Receive notification of a warning. Transformers can use this method to report conditions that are not errors or fatal errors. The default behaviour is to take no action. After invoking this method, the Transformer must continue with the transformation. It should still be possible for the application to process the document through to the end.
Parameters:
e - The warning information encapsulated in a transformer exception.

Copyright B) 2005 Apache XML Project. All Rights Reserved.