javax.xml.transform
public abstract class Transformer extends Object
An instance of this class can be obtained with the
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.TransformerFactory.newTransformer
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.
Constructor Summary | |
---|---|
protected | Transformer()
Default constructor is protected on purpose. |
Method Summary | |
---|---|
abstract void | clearParameters()
Clear all parameters set with setParameter. |
abstract ErrorListener | getErrorListener()
Get the error event handler in effect for the transformation.
|
abstract Properties | getOutputProperties()
Get a copy of the output properties for the transformation.
|
abstract String | getOutputProperty(String name)
Get an output property that is in effect for the
transformation. |
abstract Object | getParameter(String name)
Get a parameter that was explicitly set with setParameter
or setParameters.
|
abstract URIResolver | getURIResolver()
Get an object that will be used to resolve URIs used in
document(), etc.
|
abstract void | setErrorListener(ErrorListener listener)
Set the error event listener in effect for the transformation.
|
abstract void | setOutputProperties(Properties oformat)
Set the output properties for the transformation. |
abstract void | setOutputProperty(String name, String value)
Set an output property that will be in effect for the
transformation.
|
abstract void | setParameter(String name, Object value)
Add a parameter for the transformation.
|
abstract void | setURIResolver(URIResolver resolver)
Set an object that will be used to resolve URIs used in
document().
|
abstract void | transform(Source xmlSource, Result outputTarget)
Process the source tree to the output result. |
Returns: The current error handler, which should never be null.
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 Transformer, Transformer, in the stylesheet, or the default properties, while getOutputProperties().get(String key) will only retrieve properties that were explicitly set by Transformer, Transformer, 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.
See Also: OutputKeys java.util.Properties
UNKNOWN: A copy of the set of output properties in effect for the next transformation.
Parameters: name A non-null String that specifies an output property name, which may be namespace qualified.
Returns: The string value of the output property, or null if no property was found.
Throws: IllegalArgumentException If the property is not supported.
See Also: OutputKeys
This method does not return a default parameter value, which cannot be determined until the node context is evaluated during the transformation process.
Returns: A parameter that has been set with setParameter.
Returns: An object that implements the URIResolver interface, or null.
Parameters: listener The new error listener.
Throws: IllegalArgumentException if listener is null.
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.
Parameters: oformat A set of output properties that will be used to override any of the same properties in affect for the transformation.
Throws: IllegalArgumentException if any of the argument keys are not recognized and are not namespace qualified.
See Also: OutputKeys java.util.Properties
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 Transformer won't be effected by calling this method.
Parameters: 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.
Throws: IllegalArgumentException If the property is not supported, and is not qualified with a namespace.
See Also: OutputKeys
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.
Parameters: 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.
If the resolver argument is null, the URIResolver value will be cleared, and the default behavior will be used.
Parameters: resolver An object that implements the URIResolver interface, or null.
Parameters: xmlSource The input for the source tree. outputTarget The output target.
Throws: TransformerException If an unrecoverable error occurs during the course of the transformation.