javax.xml.transform

Class Transformer

Known Direct Subclasses:
GnomeTransformer

public abstract class Transformer
extends 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

Transformer()
The basic constructor.

Method Summary

abstract void
clearParameters()
Clears all parameter values.
abstract ErrorListener
getErrorListener()
Returns the callback used to report errors during the transformation.
abstract Properties
getOutputProperties()
Returns a copy of the output properties for the transformation.
abstract String
getOutputProperty(String name)
Returns the value of an output property for the transformation.
abstract Object
getParameter(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(Properties oformat)
Sets the output properties for the transformation, overriding any properties defined in the stylesheet.
abstract void
setOutputProperty(String name, String value)
Sets an output property for the transformation, overriding any property of the same name defined in the stylesheet.
abstract void
setParameter(String name, 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, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Transformer

protected Transformer()
The basic constructor. Object is special, because it has no superclass, so there is no call to super().

Method Details

clearParameters

public abstract void clearParameters()
Clears all parameter values.

getErrorListener

public abstract ErrorListener getErrorListener()
Returns the callback used to report errors during the transformation.

getOutputProperties

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

getOutputProperty

public abstract String getOutputProperty(String name)
            throws 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:
IllegalArgumentException - if the property is not supported

getParameter

public abstract Object getParameter(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

getURIResolver

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

reset

public void reset()
Reset this Transformer to its original configuration.
Since:
1.3

setErrorListener

public abstract void setErrorListener(ErrorListener listener)
            throws IllegalArgumentException
Sets the callback used to report errors during the transformation.
Throws:
IllegalArgumentException - if the listener is null

setOutputProperties

public abstract void setOutputProperties(Properties oformat)
            throws 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(String,String) method.
Parameters:
oformat - a set of output properties, or null to reset all the properties to their default values

setOutputProperty

public abstract void setOutputProperty(String name,
                                       String value)
            throws 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:
IllegalArgumentException - if the property is not supported

setParameter

public abstract void setParameter(String name,
                                  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

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.

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

Transformer.java -- Copyright (C) 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.