javax.xml.transform
Class Transformer
java.lang.Object
javax.xml.transform.Transformer
public abstract class Transformer
extends java.lang.Object
An instance of this abstract class can transform a
source tree into a result tree.
An instance of this class can be obtained with the
TransformerFactory.newTransformer
method. This instance may then be used to process XML from a
variety of sources and write the transformation output to a
variety of sinks.
An object of this class may not be used in multiple threads
running concurrently. Different Transformers may be used
concurrently by different threads.
A
Transformer
may be used multiple times. Parameters and
output properties are preserved across transformations.
Transformer() - Default constructor is protected on purpose.
|
Transformer
protected Transformer()
Default constructor is protected on purpose.
clearParameters
public void clearParameters()
Clear all parameters set with setParameter.
getErrorListener
public ErrorListener getErrorListener()
Get the error event handler in effect for the transformation.
- The current error handler, which should never be null.
getOutputProperties
public Properties getOutputProperties()
Get a copy of the output properties for the transformation.
The properties returned should contain properties set by the user,
and properties set by the stylesheet, and these properties
are "defaulted" by default properties specified by
section 16 of the
XSL Transformations (XSLT) W3C Recommendation. The properties that
were specifically set by the user or the stylesheet should be in the base
Properties list, while the XSLT default properties that were not
specifically set should be the default Properties list. Thus,
getOutputProperties().getProperty(String key) will obtain any
property in that was set by
setOutputProperty(String,String)
,
setOutputProperties(Properties)
, in the stylesheet,
or the default
properties, while
getOutputProperties().get(String key) will only retrieve properties
that were explicitly set by
setOutputProperty(String,String)
,
setOutputProperties(Properties)
, or in the stylesheet.
Note that mutation of the Properties object returned will not
effect the properties that the transformation contains.
If any of the argument keys are not recognized and are not
namespace qualified, the property will be ignored. In other words the
behaviour is not orthogonal with setOutputProperties.
OutputKeys
, java.util.Properties
getOutputProperty
public String getOutputProperty(String name)
throws IllegalArgumentException
Get an output property that is in effect for the
transformation. The property specified may be a property
that was set with setOutputProperty, or it may be a
property specified in the stylesheet.
name
- A non-null String that specifies an output
property name, which may be namespace qualified.
- The string value of the output property, or null
if no property was found.
OutputKeys
getParameter
public Object getParameter(String name)
Get a parameter that was explicitly set with setParameter
or setParameters.
This method does not return a default parameter value, which
cannot be determined until the node context is evaluated during
the transformation process.
- A parameter that has been set with setParameter.
getURIResolver
public URIResolver getURIResolver()
Get an object that will be used to resolve URIs used in
document(), etc.
- 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.
listener
- The new error listener.
setOutputProperties
public void setOutputProperties(Properties oformat)
throws IllegalArgumentException
Set the output properties for the transformation. These
properties will override properties set in the Templates
with xsl:output.
If argument to this function is null, any properties
previously set are removed, and the value will revert to the value
defined in the templates object.
Pass a qualified property key name as a two-part string, the namespace URI
enclosed in curly braces ({}), followed by the local name. If the
name has a null URL, the String only contain the local name. An
application can safely check for a non-null URI by testing to see if the first
character of the name is a '{' character.
For example, if a URI and local name were obtained from an element
defined with <xyz:foo xmlns:xyz="http://xyz.foo.com/yada/baz.html"/>,
then the qualified name would be "{http://xyz.foo.com/yada/baz.html}foo". Note that
no prefix is used.
oformat
- A set of output properties that will be
used to override any of the same properties in affect
for the transformation.
OutputKeys
, java.util.Properties
setOutputProperty
public void setOutputProperty(String name,
String value)
throws IllegalArgumentException
Set an output property that will be in effect for the
transformation.
Pass a qualified property name as a two-part string, the namespace URI
enclosed in curly braces ({}), followed by the local name. If the
name has a null URL, the String only contain the local name. An
application can safely check for a non-null URI by testing to see if the first
character of the name is a '{' character.
For example, if a URI and local name were obtained from an element
defined with <xyz:foo xmlns:xyz="http://xyz.foo.com/yada/baz.html"/>,
then the qualified name would be "{http://xyz.foo.com/yada/baz.html}foo". Note that
no prefix is used.
The Properties object that was passed to
setOutputProperties(Properties)
won't
be effected by calling this method.
name
- A non-null String that specifies an output
property name, which may be namespace qualified.value
- The non-null string value of the output property.
OutputKeys
setParameter
public void setParameter(String name,
Object value)
Add a parameter for the transformation.
Pass a qualified name as a two-part string, the namespace URI
enclosed in curly braces ({}), followed by the local name. If the
name has a null URL, the String only contain the local name. An
application can safely check for a non-null URI by testing to see if the first
character of the name is a '{' character.
For example, if a URI and local name were obtained from an element
defined with <xyz:foo xmlns:xyz="http://xyz.foo.com/yada/baz.html"/>,
then the qualified name would be "{http://xyz.foo.com/yada/baz.html}foo". Note that
no prefix is used.
name
- The name of the parameter, which may begin with a namespace URI
in curly braces ({}).value
- The value object. This can be any valid Java object. It is
up to the processor to provide the proper object coersion or to simply
pass the object on for use in an extension.
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 default behavior will be used.
resolver
- An object that implements the URIResolver interface,
or null.
transform
public void transform(Source xmlSource,
Result outputTarget)
throws TransformerException
Process the source tree to the output result.
xmlSource
- The input for the source tree.outputTarget
- The output target.
TransformerException
- If an unrecoverable error occurs
during the course of the transformation.