Home » xml-commons-external-1.4.01-src » javax » xml » transform » [javadoc | source]
javax.xml.transform
abstract public class: Transformer [javadoc | source]
java.lang.Object
   javax.xml.transform.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.

Constructor:
 protected Transformer() 
Method from javax.xml.transform.Transformer Summary:
clearParameters,   getErrorListener,   getOutputProperties,   getOutputProperty,   getParameter,   getURIResolver,   reset,   setErrorListener,   setOutputProperties,   setOutputProperty,   setParameter,   setURIResolver,   transform
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.xml.transform.Transformer Detail:
 abstract public  void clearParameters()
    Clear all parameters set with setParameter.
 abstract public ErrorListener getErrorListener()
    Get the error event handler in effect for the transformation. Implementations must provide a default error listener.
 abstract 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 , #setOutputProperties , in the stylesheet, or the default properties, while getOutputProperties().get(String key) will only retrieve properties that were explicitly set by #setOutputProperty , #setOutputProperties , 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 .

 abstract public String getOutputProperty(String name) throws IllegalArgumentException
    Get an output property that is in effect for the transformer. The property specified may be a property that was set with setOutputProperty, or it may be a property specified in the stylesheet.
 abstract public Object getParameter(String name)
    Get a parameter that was explicitly set with setParameter.

    This method does not return a default parameter value, which cannot be determined until the node context is evaluated during the transformation process.

 abstract public URIResolver getURIResolver()
    Get an object that will be used to resolve URIs used in document().
 public  void reset() 
 abstract public  void setErrorListener(ErrorListener listener) throws IllegalArgumentException
    Set the error event listener in effect for the transformation.
 abstract public  void setOutputProperties(Properties oformat)
    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.

    An IllegalArgumentException is thrown if any of the argument keys are not recognized and are not namespace qualified.
 abstract 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 won't be effected by calling this method.

 abstract 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.

 abstract 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.

 abstract public  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 javax.xml.parsers.DocumentBuilder#newDocument() . The result of transforming an empty Source depends on the transformation behavior; it is not always an empty Result.