Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.xml.transform

Class Transformer

Known Direct Subclasses:
GnomeTransformer
public abstract class Transformer
extends java.lang.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()

Method Summary

void
clearParameters()
Clears all parameter values.
ErrorListener
getErrorListener()
Returns the callback used to report errors during the transformation.
Properties
getOutputProperties()
Returns a copy of the output properties for the transformation.
String
getOutputProperty(String name)
Returns the value of an output property for the transformation.
Object
getParameter(String name)
Returns the specified parameter value.
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.
void
setErrorListener(ErrorListener listener)
Sets the callback used to report errors during the transformation.
void
setOutputProperties(Properties oformat)
Sets the output properties for the transformation, overriding any properties defined in the stylesheet.
void
setOutputProperty(String name, String value)
Sets an output property for the transformation, overriding any property of the same name defined in the stylesheet.
void
setParameter(String name, Object value)
Sets a parameter value for the transformation.
void
setURIResolver(URIResolver resolver)
Sets the callback used to resolve entities referenced by xsl:include, xsl:import, or the XPath document() function.
void
transform(Source xmlSource, Result outputTarget)
Transforms the source XML to a result tree.

Constructor Details

Transformer

protected Transformer()

Method Details

clearParameters

public void clearParameters()
Clears all parameter values.

getErrorListener

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

getOutputProperties

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

getParameter

public 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 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 void setErrorListener(ErrorListener listener)
            throws IllegalArgumentException
Sets the callback used to report errors during the transformation.

setOutputProperties

public 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(java.lang.String,java.lang.String) method.

Parameters:
oformat - a set of output properties, or null to reset all the properties to their default values

setOutputProperty

public 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

setParameter

public 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 void setURIResolver(URIResolver resolver)
Sets the callback used to resolve entities referenced by xsl:include, xsl:import, or the XPath document() function.

transform

public 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

Overview Package Tree Index Deprecated About