net.sf.saxon.jaxp

Class TransformerImpl

java.lang.Object

javax.xml.transform.Transformer

net.sf.saxon.jaxp.IdentityTransformer

net.sf.saxon.jaxp.AbstractTransformerImpl

net.sf.saxon.jaxp.TransformerImpl

public class TransformerImpl
extends AbstractTransformerImpl

Saxon implementation of the JAXP Transformer interface.

Since Saxon 9.6, JAXP interfaces are implemented as a layer above the s9api interface

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TransformerImpl(XsltExecutable e, XsltTransformer t)

Method Summary

Modifier and Type	Method and Description
void	clearParameters() Clear all parameters set with setParameter.
XsltController	getUnderlyingController() Get the internal Saxon Controller instance that implements this transformation.
XsltTransformer	getUnderlyingXsltTransformer() Get the underlying s9api implementation class wrapped by this JAXP Transformer
TransformerHandler	newTransformerHandler() Create a JAXP TransformerHandler to perform the transformation
XMLFilter	newXMLFilter() Create a JAXP XMLFilter which allows this transformation to be added to a SAX pipeline
void	reset() Reset this Transformer to its original configuration.
protected void	setConvertedParameter(QName name, XdmValue value)
void	setErrorListener(ErrorListener listener) Set the error event listener in effect for the transformation.
void	setInitialMode(String name) Supply an initial mode for a transformation.
void	setInitialTemplate(String name) Supply an initial template for a transformation.
void	setURIResolver(URIResolver resolver) Set an object that will be used to resolve URIs used in document().
void	transform(Source xmlSource, Result outputTarget) Transform the XML Source to a Result.

Methods inherited from class net.sf.saxon.jaxp.AbstractTransformerImpl

getParameter, getStylesheetOutputProperties, getUnderlyingXsltExecutable, makeDestination, setParameter

Methods inherited from class net.sf.saxon.jaxp.IdentityTransformer

getConfiguration, getErrorListener, getLocalOutputProperties, getOutputProperties, getOutputProperty, getURIResolver, reportFatalError, setOutputProperties, setOutputProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

TransformerImpl

protected TransformerImpl(XsltExecutable e,
                          XsltTransformer t)

Method Detail

transform

public void transform(Source xmlSource,
                      Result outputTarget)
               throws XPathException

Transform the XML Source to a Result. Specific transformation behavior is determined by the settings of the TransformerFactory in effect when the Transformer was instantiated and any modifications made to the Transformer instance.

An empty Source is represented as an empty document as constructed by DocumentBuilder.newDocument(). The result of transforming an empty Source depends on the transformation behavior; it is not always an empty Result.

Overrides:

transform in class IdentityTransformer

Parameters:

xmlSource - The XML input to transform.

outputTarget - The Result of transforming the xmlSource.

Throws:

XPathException - If an unrecoverable error occurs during the course of the transformation.

setConvertedParameter

protected void setConvertedParameter(QName name,
                                     XdmValue value)

Specified by:

setConvertedParameter in class AbstractTransformerImpl

clearParameters

public void clearParameters()

Clear all parameters set with setParameter.

Overrides:

clearParameters in class AbstractTransformerImpl

setURIResolver

public void setURIResolver(URIResolver resolver)

Set an object that will be used to resolve URIs used in document().

If the resolver argument is null, the URIResolver value will be cleared and the transformer will no longer have a resolver.

Overrides:

setURIResolver in class IdentityTransformer

Parameters:

resolver - An object that implements the URIResolver interface, or null.

setErrorListener

public void setErrorListener(ErrorListener listener)
                      throws IllegalArgumentException

Set the error event listener in effect for the transformation.

Overrides:

setErrorListener in class IdentityTransformer

Parameters:

listener - The new error listener.

Throws:

IllegalArgumentException - if listener is null.

setInitialTemplate

public void setInitialTemplate(String name)

Supply an initial template for a transformation.

This is a Saxon extension to the JAXP interface, needed for XSLT 2.0

Changed in 9.9 so it no longer validates the supplied name; an incorrect name will lead to an error later.

Parameters:

name - the name of the initial template, in Clark notation (either a local name, or "{uri}local")

setInitialMode

public void setInitialMode(String name)
                    throws IllegalArgumentException

Supply an initial mode for a transformation.

This is a Saxon extension to the JAXP interface, needed for XSLT 2.0

Parameters:

name - the name of the initial mode, in Clark notation (either a local name, or "{uri}local")

Throws:

IllegalArgumentException - if the argument is invalid, for example if the format of the name is incorrect or if there is no mode with this name

getUnderlyingXsltTransformer

public XsltTransformer getUnderlyingXsltTransformer()

Get the underlying s9api implementation class wrapped by this JAXP Transformer

Returns:

the underlying s9api XsltTransformer

getUnderlyingController

public XsltController getUnderlyingController()

Get the internal Saxon Controller instance that implements this transformation. Note that the Controller interface will not necessarily remain stable in future releases

Specified by:

getUnderlyingController in class AbstractTransformerImpl

Returns:

the underlying Saxon Controller instance

newTransformerHandler

public TransformerHandler newTransformerHandler()

Create a JAXP TransformerHandler to perform the transformation

Returns:

a JAXP TransformerHandler, which allows the transformation to be performed in "push" mode on a SAX pipeline.

newXMLFilter

public XMLFilter newXMLFilter()

Create a JAXP XMLFilter which allows this transformation to be added to a SAX pipeline

Specified by:

newXMLFilter in class AbstractTransformerImpl

Returns:

the transformation in the form of an XMLFilter

reset

public void reset()

Description copied from class: IdentityTransformer

Reset this Transformer to its original configuration.

Transformer is reset to the same state as when it was created with TransformerFactory.newTransformer(), TransformerFactory.newTransformer(javax.xml.transform.Source source) or Templates.newTransformer(). reset() is designed to allow the reuse of existing Transformers thus saving resources associated with the creation of new Transformers.

The reset Transformer is not guaranteed to have the same URIResolver or ErrorListener Objects, e.g. Object.equals(Object obj). It is guaranteed to have a functionally equal URIResolver and ErrorListener.

Overrides:

reset in class IdentityTransformer