javax.xml.transform

Class Transformer

java.lang.Object

javax.xml.transform.Transformer

public abstract class Transformer
extends java.lang.Object

An XSL transformation. Instances of this class may be reused, but the same instance may not be used concurrently by different threads.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Transformer()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	clearParameters() Clears all parameter values.
abstract ErrorListener	getErrorListener() Returns the callback used to report errors during the transformation.
abstract java.util.Properties	getOutputProperties() Returns a copy of the output properties for the transformation.
abstract java.lang.String	getOutputProperty(java.lang.String name) Returns the value of an output property for the transformation.
abstract java.lang.Object	getParameter(java.lang.String name) Returns the specified parameter value.
abstract URIResolver	getURIResolver() Returns the callback used to resolve entities referenced by xsl:include, xsl:import, or the XPath document() function.
void	reset() Reset this Transformer to its original configuration.
abstract void	setErrorListener(ErrorListener listener) Sets the callback used to report errors during the transformation.
abstract void	setOutputProperties(java.util.Properties oformat) Sets the output properties for the transformation, overriding any properties defined in the stylesheet.
abstract void	setOutputProperty(java.lang.String name, java.lang.String value) Sets an output property for the transformation, overriding any property of the same name defined in the stylesheet.
abstract void	setParameter(java.lang.String name, java.lang.Object value) Sets a parameter value for the transformation.
abstract void	setURIResolver(URIResolver resolver) Sets the callback used to resolve entities referenced by xsl:include, xsl:import, or the XPath document() function.
abstract void	transform(Source xmlSource, Result outputTarget) Transforms the source XML to a result tree.

Methods inherited from class java.lang.Object

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

Constructor Detail

Transformer

protected Transformer()

Method Detail

transform

public abstract void transform(Source xmlSource,
             Result outputTarget)
                        throws TransformerException

Transforms the source XML to a result tree.

Parameters:

xmlSource - the XML source

outputTarget - the result of the transformation

Throws:

TransformerException

setParameter

public abstract void setParameter(java.lang.String name,
                java.lang.Object value)

Sets a parameter value for the transformation. Parameters may be referenced in the XSLT stylesheet.

Parameters:

name - the parameter name (an XML Name, or a namespace-prefixed XML Name of the form {namespaceURI}localName

value - the value to assign

getParameter

public abstract java.lang.Object getParameter(java.lang.String name)

Returns the specified parameter value.

Parameters:

name - the parameter name (an XML Name, or a namespace-prefixed XML Name of the form {namespaceURI}localName

clearParameters

public abstract void clearParameters()

Clears all parameter values.

setURIResolver

public abstract void setURIResolver(URIResolver resolver)

Sets the callback used to resolve entities referenced by xsl:include, xsl:import, or the XPath document() function.

getURIResolver

public abstract URIResolver getURIResolver()

Returns the callback used to resolve entities referenced by xsl:include, xsl:import, or the XPath document() function.

setOutputProperties

public abstract void setOutputProperties(java.util.Properties oformat)
                                  throws java.lang.IllegalArgumentException

Sets the output properties for the transformation, overriding any properties defined in the stylesheet. The format of property keys is as in the setOutputProperty(java.lang.String,java.lang.String) method.

Parameters:

oformat - a set of output properties, or null to reset all the properties to their default values

Throws:

java.lang.IllegalArgumentException

getOutputProperties

public abstract java.util.Properties getOutputProperties()

Returns a copy of the output properties for the transformation. Missing properties are defaulted according the XSLT Recommendation, section 16: getProperty(String) returns all properties including defaulted ones, and get(Object) returns only the properties explicitly set in the stylesheet.

setOutputProperty

public abstract void setOutputProperty(java.lang.String name,
                     java.lang.String value)
                                throws java.lang.IllegalArgumentException

Sets an output property for the transformation, overriding any property of the same name defined in the stylesheet.

Parameters:

name - the property name (an XML Name, or a namespace-prefixed XML Name of the form {namespaceURI}localName

value - the string value of the property

Throws:

java.lang.IllegalArgumentException - if the property is not supported

getOutputProperty

public abstract java.lang.String getOutputProperty(java.lang.String name)
                                            throws java.lang.IllegalArgumentException

Returns the value of an output property for the transformation. Only explicit properties set programmatically or defined in the stylesheet, not defaulted properties, are returned by this method.

Parameters:

name - the property name (an XML Name, or a namespace-prefixed XML Name of the form {namespaceURI}localName

Throws:

java.lang.IllegalArgumentException - if the property is not supported

setErrorListener

public abstract void setErrorListener(ErrorListener listener)
                               throws java.lang.IllegalArgumentException

Sets the callback used to report errors during the transformation.

Throws:

java.lang.IllegalArgumentException - if the listener is null

getErrorListener

public abstract ErrorListener getErrorListener()

Returns the callback used to report errors during the transformation.

reset

public void reset()

Reset this Transformer to its original configuration.

Since:

1.3