javax.xml.transform.Transformer
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
public abstract class Transformer
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.
| 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 java.util.Properties |
getOutputProperties()
Get a copy of the output properties for the transformation. |
abstract java.lang.String |
getOutputProperty(java.lang.String name)
Get an output property that is in effect for the transformer. |
abstract java.lang.Object |
getParameter(java.lang.String name)
Get a parameter that was explicitly set with setParameter. |
abstract URIResolver |
getURIResolver()
Get an object that will be used to resolve URIs used in document(). |
void |
reset()
Reset this Transformer to its original configuration. |
abstract void |
setErrorListener(ErrorListener listener)
Set the error event listener in effect for the transformation. |
abstract void |
setOutputProperties(java.util.Properties oformat)
Set the output properties for the transformation. |
abstract void |
setOutputProperty(java.lang.String name,
java.lang.String value)
Set an output property that will be in effect for the transformation. |
abstract void |
setParameter(java.lang.String name,
java.lang.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)
Transform the XML Source to a Result. |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Method Detail |
|---|
public void reset()
Reset this Transformer to its original configuration.
Transformer is reset to the same state as when it was created with
TransformerFactory.newTransformer(),
TransformerFactory.newTransformer(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.
public abstract void transform(Source xmlSource,
Result outputTarget)
throws TransformerException
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.
xmlSource - The XML input to transform.outputTarget - The Result of transforming the
xmlSource.
TransformerException - If an unrecoverable error occurs
during the course of the transformation.
public abstract void setParameter(java.lang.String name,
java.lang.Object value)
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.
java.lang.NullPointerException - If value is null.public abstract java.lang.Object getParameter(java.lang.String name)
This method does not return a default parameter value, which cannot be determined until the node context is evaluated during the transformation process.
name - of Object to get
public abstract void clearParameters()
public abstract void setURIResolver(URIResolver resolver)
If the resolver argument is null, the URIResolver value will be cleared and the transformer will no longer have a resolver.
resolver - An object that implements the URIResolver interface,
or null.public abstract URIResolver getURIResolver()
public abstract void setOutputProperties(java.util.Properties oformat)
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.
AnIllegalArgumentException is thrown if any of the
argument keys are not recognized and are not namespace qualified.
oformat - A set of output properties that will be
used to override any of the same properties in affect
for the transformation.OutputKeys,
Propertiespublic abstract java.util.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(java.lang.String, java.lang.String),
setOutputProperties(java.util.Properties), in the stylesheet, or the default
properties, while
getOutputProperties().get(String key) will only retrieve properties
that were explicitly set by setOutputProperty(java.lang.String, java.lang.String),
setOutputProperties(java.util.Properties), or in the stylesheet.
Note that mutation of the Properties object returned will not effect the properties that the transformer contains.
If any of the argument keys are not recognized and are not
namespace qualified, the property will be ignored and not returned.
In other words the behaviour is not orthogonal with
setOutputProperties.
OutputKeys,
Properties,
XSL Transformations (XSLT) Version 1.0
public abstract void setOutputProperty(java.lang.String name,
java.lang.String value)
throws java.lang.IllegalArgumentException
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(java.util.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.
java.lang.IllegalArgumentException - If the property is not supported, and is
not qualified with a namespace.OutputKeys
public abstract java.lang.String getOutputProperty(java.lang.String name)
throws java.lang.IllegalArgumentException
name - A non-null String that specifies an output
property name, which may be namespace qualified.
java.lang.IllegalArgumentException - If the property is not supported.OutputKeys
public abstract void setErrorListener(ErrorListener listener)
throws java.lang.IllegalArgumentException
listener - The new error listener.
java.lang.IllegalArgumentException - if listener is null.public abstract ErrorListener getErrorListener()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||