org.apache.excalibur.xml.xslt

Class XSLTProcessorImpl

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.excalibur.xml.xslt.XSLTProcessorImpl

All Implemented Interfaces:

javax.xml.transform.URIResolver, org.apache.avalon.excalibur.pool.Poolable, org.apache.avalon.excalibur.pool.Recyclable, org.apache.avalon.framework.activity.Disposable, org.apache.avalon.framework.activity.Initializable, org.apache.avalon.framework.component.Component, org.apache.avalon.framework.logger.LogEnabled, org.apache.avalon.framework.parameters.Parameterizable, org.apache.avalon.framework.service.Serviceable, XSLTProcessor

public class XSLTProcessorImpl
extends org.apache.avalon.framework.logger.AbstractLogEnabled
implements XSLTProcessor, org.apache.avalon.framework.service.Serviceable, org.apache.avalon.framework.activity.Initializable, org.apache.avalon.framework.activity.Disposable, org.apache.avalon.framework.parameters.Parameterizable, org.apache.avalon.excalibur.pool.Recyclable, javax.xml.transform.URIResolver, org.apache.avalon.framework.component.Component

This class defines the implementation of the XSLTProcessor component. The <use-store> configuration forces the transformer to put the Templates generated from the XSLT stylesheet into the Store. This property is false by default.

The <transformer-factory> configuration tells the transformer to use a particular implementation of javax.xml.transform.TransformerFactory. This allows to force the use of a given TRAX implementation (e.g. xalan or saxon) if several are available in the classpath. If this property is not set, the transformer uses the standard TRAX mechanism (TransformerFactory.newInstance()).

Since:

July 11, 2001

Version:

CVS $Id: XSLTProcessorImpl.java,v 1.6 2004/04/02 09:02:37 cziegeler Exp $, 1.0

Author:

Avalon Development Team

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.excalibur.xml.xslt.XSLTProcessor

XSLTProcessor.TransformerHandlerAndValidity

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	m_checkIncludes Check included stylesheets
protected javax.xml.transform.sax.SAXTransformerFactory	m_defaultFactory The default TransformerFactory used by this component
protected TraxErrorHandler	m_errorHandler The error handler for the transformer
protected javax.xml.transform.sax.SAXTransformerFactory	m_factory The trax TransformerFactory this component uses
private java.lang.String	m_id Hold the System ID of the main/base stylesheet
protected java.util.Map	m_includesMap Map of pairs of System ID's / validities of the included stylesheets
protected boolean	m_incrementalProcessing Is incremental processing turned on? (default for Xalan: no)
protected org.apache.avalon.framework.service.ServiceManager	m_manager The ServiceManager
protected org.apache.excalibur.source.SourceResolver	m_resolver Resolver used to resolve XSLT document() calls, imports and includes
protected org.apache.excalibur.store.Store	m_store The store service instance
protected java.lang.String	m_transformerFactory The configured transformer factory to use
protected boolean	m_useStore Is the store turned on? (default is off)
protected XMLizer	m_xmlizer

Fields inherited from interface org.apache.excalibur.xml.xslt.XSLTProcessor

ROLE

Constructor Summary

Constructors

Constructor and Description
XSLTProcessorImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	dispose() Disposable
private static org.xml.sax.InputSource	getInputSource(org.apache.excalibur.source.Source source) Return a new InputSource object that uses the InputStream and the system ID of the Source object.
private XSLTProcessor.TransformerHandlerAndValidity	getTemplates(org.apache.excalibur.source.Source stylesheet, java.lang.String id)
private javax.xml.transform.sax.SAXTransformerFactory	getTransformerFactory(java.lang.String factoryName) Get the TransformerFactory associated with the given classname.
javax.xml.transform.sax.TransformerHandler	getTransformerHandler(org.apache.excalibur.source.Source stylesheet) Same as XSLTProcessor.getTransformerHandler(Source,XMLFilter), with filter set to null.
javax.xml.transform.sax.TransformerHandler	getTransformerHandler(org.apache.excalibur.source.Source stylesheet, org.xml.sax.XMLFilter filter) Return a TransformerHandler for a given stylesheet Source.
XSLTProcessor.TransformerHandlerAndValidity	getTransformerHandlerAndValidity(org.apache.excalibur.source.Source stylesheet) Same as XSLTProcessor.getTransformerHandlerAndValidity(Source,XMLFilter), with filter set to null.
XSLTProcessor.TransformerHandlerAndValidity	getTransformerHandlerAndValidity(org.apache.excalibur.source.Source stylesheet, org.xml.sax.XMLFilter filter) Return a TransformerHandler and SourceValidity for a given stylesheet Source.
void	initialize() Initialize
void	parameterize(org.apache.avalon.framework.parameters.Parameters params) Configure the component
private void	putTemplates(javax.xml.transform.Templates templates, org.apache.excalibur.source.Source stylesheet, java.lang.String id)
void	recycle() Recycle the component
javax.xml.transform.Source	resolve(java.lang.String href, java.lang.String base) Called by the processor when it encounters an xsl:include, xsl:import, or document() function.
void	service(org.apache.avalon.framework.service.ServiceManager manager) Compose.
void	setTransformerFactory(java.lang.String classname) Set the transformer factory used by this component
private void	sourceToSAX(org.apache.excalibur.source.Source source, org.xml.sax.ContentHandler handler)
void	transform(org.apache.excalibur.source.Source source, org.apache.excalibur.source.Source stylesheet, org.apache.avalon.framework.parameters.Parameters params, javax.xml.transform.Result result) Applies an XSLT stylesheet to an XML document.

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_store

protected org.apache.excalibur.store.Store m_store

The store service instance

m_transformerFactory

protected java.lang.String m_transformerFactory

The configured transformer factory to use

m_factory

protected javax.xml.transform.sax.SAXTransformerFactory m_factory

The trax TransformerFactory this component uses

m_defaultFactory

protected javax.xml.transform.sax.SAXTransformerFactory m_defaultFactory

The default TransformerFactory used by this component

m_useStore

protected boolean m_useStore

Is the store turned on? (default is off)

m_incrementalProcessing

protected boolean m_incrementalProcessing

Is incremental processing turned on? (default for Xalan: no)

m_resolver

protected org.apache.excalibur.source.SourceResolver m_resolver

Resolver used to resolve XSLT document() calls, imports and includes

m_errorHandler

protected TraxErrorHandler m_errorHandler

The error handler for the transformer

m_checkIncludes

protected boolean m_checkIncludes

Check included stylesheets

m_includesMap

protected java.util.Map m_includesMap

Map of pairs of System ID's / validities of the included stylesheets

m_xmlizer

protected XMLizer m_xmlizer

m_manager

protected org.apache.avalon.framework.service.ServiceManager m_manager

The ServiceManager

m_id

private java.lang.String m_id

Hold the System ID of the main/base stylesheet

Constructor Detail

XSLTProcessorImpl

public XSLTProcessorImpl()

Method Detail

service

public void service(org.apache.avalon.framework.service.ServiceManager manager)
             throws org.apache.avalon.framework.service.ServiceException

Compose. Try to get the store

Specified by:

service in interface org.apache.avalon.framework.service.Serviceable

Throws:

org.apache.avalon.framework.service.ServiceException

initialize

public void initialize()
                throws java.lang.Exception

Initialize

Specified by:

initialize in interface org.apache.avalon.framework.activity.Initializable

Throws:

java.lang.Exception

dispose

public void dispose()

Disposable

Specified by:

dispose in interface org.apache.avalon.framework.activity.Disposable

parameterize

public void parameterize(org.apache.avalon.framework.parameters.Parameters params)
                  throws org.apache.avalon.framework.parameters.ParameterException

Configure the component

Specified by:

parameterize in interface org.apache.avalon.framework.parameters.Parameterizable

Throws:

org.apache.avalon.framework.parameters.ParameterException

setTransformerFactory

public void setTransformerFactory(java.lang.String classname)

Set the transformer factory used by this component

Specified by:

setTransformerFactory in interface XSLTProcessor

Parameters:

classname - the name of the class implementing TransformerFactory value. If an error is found or the indicated class doesn't implement the required interface the original factory of the component is maintained.

getTransformerHandler

public javax.xml.transform.sax.TransformerHandler getTransformerHandler(org.apache.excalibur.source.Source stylesheet)
                                                                 throws XSLTProcessorException

Description copied from interface: XSLTProcessor

Same as XSLTProcessor.getTransformerHandler(Source,XMLFilter), with filter set to null.

Specified by:

getTransformerHandler in interface XSLTProcessor

Parameters:

stylesheet - a Source value

Returns:

a TransformerHandler value

Throws:

XSLTProcessorException - if an error occurs

See Also:

XSLTProcessor.getTransformerHandler(org.apache.excalibur.source.Source)

getTransformerHandler

public javax.xml.transform.sax.TransformerHandler getTransformerHandler(org.apache.excalibur.source.Source stylesheet,
                                                               org.xml.sax.XMLFilter filter)
                                                                 throws XSLTProcessorException

Description copied from interface: XSLTProcessor

Return a TransformerHandler for a given stylesheet Source. This can be used in a pipeline to handle the transformation of a stream of SAX events. See org.apache.cocoon.transformation.TraxTransformer#setConsumer for an example of how to use this method.

The additional filter argument, if it's not null, is inserted in the chain SAX events as an XML filter during the parsing or the source document.

This method caches the Templates object with meta information (modification time and list of included stylesheets) and performs a reparsing only if this changes.

Specified by:

getTransformerHandler in interface XSLTProcessor

Parameters:

stylesheet - a Source value

filter - a XMLFilter value

Returns:

a TransformerHandler value

Throws:

XSLTProcessorException - if an error occurs

See Also:

XSLTProcessor.getTransformerHandler(org.apache.excalibur.source.Source, org.xml.sax.XMLFilter)

getTransformerHandlerAndValidity

public XSLTProcessor.TransformerHandlerAndValidity getTransformerHandlerAndValidity(org.apache.excalibur.source.Source stylesheet)
                                                                             throws XSLTProcessorException

Description copied from interface: XSLTProcessor

Same as XSLTProcessor.getTransformerHandlerAndValidity(Source,XMLFilter), with filter set to null.

Specified by:

getTransformerHandlerAndValidity in interface XSLTProcessor

Parameters:

stylesheet - a Source value

Returns:

a XSLTProcessor.TransformerHandlerAndValidity value

Throws:

XSLTProcessorException - if an error occurs

getTransformerHandlerAndValidity

public XSLTProcessor.TransformerHandlerAndValidity getTransformerHandlerAndValidity(org.apache.excalibur.source.Source stylesheet,
                                                                           org.xml.sax.XMLFilter filter)
                                                                             throws XSLTProcessorException

Description copied from interface: XSLTProcessor

Return a TransformerHandler and SourceValidity for a given stylesheet Source. This can be used in a pipeline to handle the transformation of a stream of SAX events. See org.apache.cocoon.transformation.TraxTransformer#setConsumer for an example of how to use this method.

The additional filter argument, if it's not null, is inserted in the chain SAX events as an XML filter during the parsing or the source document.

This method caches the Templates object with meta information (modification time and list of included stylesheets) and performs a reparsing only if this changes.

Specified by:

getTransformerHandlerAndValidity in interface XSLTProcessor

Parameters:

stylesheet - a Source value

filter - a XMLFilter value

Returns:

a TransformerHandlerAndValidity value

Throws:

XSLTProcessorException - if an error occurs

sourceToSAX

private void sourceToSAX(org.apache.excalibur.source.Source source,
               org.xml.sax.ContentHandler handler)
                  throws org.xml.sax.SAXException,
                         java.io.IOException,
                         org.apache.excalibur.source.SourceException

Throws:

org.xml.sax.SAXException

java.io.IOException

org.apache.excalibur.source.SourceException

transform

public void transform(org.apache.excalibur.source.Source source,
             org.apache.excalibur.source.Source stylesheet,
             org.apache.avalon.framework.parameters.Parameters params,
             javax.xml.transform.Result result)
               throws XSLTProcessorException

Description copied from interface: XSLTProcessor

Applies an XSLT stylesheet to an XML document. The source and stylesheet documents are specified as Source objects. The result of the transformation is placed in Result, which should be properly initialized before invoking this method. Any additional parameters passed in params will become arguments to the stylesheet.

Specified by:

transform in interface XSLTProcessor

Parameters:

source - a Source value

stylesheet - a Source value

params - a Parameters value

result - a Result value

Throws:

XSLTProcessorException - if an error occurs

getTransformerFactory

private javax.xml.transform.sax.SAXTransformerFactory getTransformerFactory(java.lang.String factoryName)

Get the TransformerFactory associated with the given classname. If the class can't be found or the given class doesn't implement the required interface, the default factory is returned.

getTemplates

private XSLTProcessor.TransformerHandlerAndValidity getTemplates(org.apache.excalibur.source.Source stylesheet,
                                                       java.lang.String id)
                                                          throws java.io.IOException,
                                                                 org.apache.excalibur.source.SourceException,
                                                                 javax.xml.transform.TransformerException

Throws:

java.io.IOException

org.apache.excalibur.source.SourceException

javax.xml.transform.TransformerException

putTemplates

private void putTemplates(javax.xml.transform.Templates templates,
                org.apache.excalibur.source.Source stylesheet,
                java.lang.String id)
                   throws java.io.IOException

Throws:

java.io.IOException

resolve

public javax.xml.transform.Source resolve(java.lang.String href,
                                 java.lang.String base)
                                   throws javax.xml.transform.TransformerException

Called by the processor when it encounters an xsl:include, xsl:import, or document() function.

Specified by:

resolve in interface javax.xml.transform.URIResolver

Parameters:

href - An href attribute, which may be relative or absolute.

base - The base URI in effect when the href attribute was encountered.

Returns:

A Source object, or null if the href cannot be resolved, and the processor should try to resolve the URI itself.

Throws:

javax.xml.transform.TransformerException - if an error occurs when trying to resolve the URI.

getInputSource

private static org.xml.sax.InputSource getInputSource(org.apache.excalibur.source.Source source)
                                               throws java.io.IOException,
                                                      org.apache.excalibur.source.SourceException

Return a new InputSource object that uses the InputStream and the system ID of the Source object.

Throws:

java.io.IOException - if I/O error occured.

org.apache.excalibur.source.SourceException

recycle

public void recycle()

Recycle the component

Specified by:

recycle in interface org.apache.avalon.excalibur.pool.Recyclable