Package org.custommonkey.xmlunit

Class Transform

java.lang.Object

org.custommonkey.xmlunit.Transform

public class Transform
extends Object

Handy wrapper for an XSLT transformation performed using JAXP/Trax. Note that transformation is not actually performed until a call to getResultXXX method, and Templates are not used.

Constructor Summary

Constructors

Constructor	Description
Transform(String input, File stylesheet)	Create a transformation using String input XML and stylesheet in a File
Transform(String input, String stylesheet)	Create a transformation using String input XML and String stylesheet
Transform(Source inputSource, Source stylesheetSource)	Create a transformation using Source input XML and Source stylesheet
Transform(Node sourceNode)	Create a transformation that allows us to serialize a DOM Node
Transform(Node sourceNode, File stylesheet)	Create a transformation from an input Node and stylesheet in a File
Transform(Node sourceNode, String stylesheet)	Create a transformation from an input Node and stylesheet in a String
Transform(InputSource input, File stylesheet)	Create a transformation using InputSource input XML and stylesheet in a File
Transform(InputSource input, InputSource stylesheet)	Create a transformation using InputSource input XML and InputSource stylesheet

Method Summary

Modifier and Type	Method	Description
void	clearParameters()	Clear parameters used for the transformation
Object	getParameter(String name)	See a parameter used for the transformation
Document	getResultDocument()	Perform the XSLT transformation specified in the constructor
String	getResultString()	Perform the XSLT transformation specified in the constructor
void	setErrorListener(ErrorListener errorListener)	Set the ErrorListener for the transformation
void	setOutputProperties(Properties outputProperties)	Override output properties specified in the transformation stylesheet
void	setOutputProperty(String name, String value)	Override an output property specified in the transformation stylesheet
void	setParameter(String name, Object value)	Add a parameter for the transformation
void	setURIResolver(URIResolver uriResolver)	Set the URIResolver for the transformation
protected void	transformTo(Result result)	Perform the actual transformation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Transform

public Transform(String input,
 String stylesheet)

Create a transformation using String input XML and String stylesheet

Parameters:

input - document to transform

stylesheet - stylesheet to use for transformation

Transform

public Transform(String input,
 File stylesheet)

Create a transformation using String input XML and stylesheet in a File

Parameters:

input - document to transform

stylesheet - stylesheet to use for transformation

Transform

public Transform(InputSource input,
 InputSource stylesheet)

Create a transformation using InputSource input XML and InputSource stylesheet

Parameters:

input - document to transform

stylesheet - stylesheet to use for transformation

Transform

public Transform(InputSource input,
 File stylesheet)

Create a transformation using InputSource input XML and stylesheet in a File

Parameters:

input - document to transform

stylesheet - stylesheet to use for transformation

Transform

public Transform(Node sourceNode)

Create a transformation that allows us to serialize a DOM Node

Parameters:

sourceNode - document to transform

Transform

public Transform(Node sourceNode,
 String stylesheet)

Create a transformation from an input Node and stylesheet in a String

Parameters:

sourceNode - document to transform

stylesheet - stylesheet to use for transformation

Transform

public Transform(Node sourceNode,
 File stylesheet)

Create a transformation from an input Node and stylesheet in a File

Parameters:

sourceNode - document to transform

stylesheet - stylesheet to use for transformation

Transform

public Transform(Source inputSource,
 Source stylesheetSource)

Create a transformation using Source input XML and Source stylesheet

Parameters:

inputSource - document to transform

stylesheetSource - stylesheet to use for transformation

Method Details

transformTo

protected void transformTo(Result result)
                    throws TransformerException

Perform the actual transformation

Parameters:

result - result to output transformation result to

Throws:

TransformerException - if transformation fails

getResultString

public String getResultString()
                       throws TransformerException

Perform the XSLT transformation specified in the constructor

Returns:

the result as a String

Throws:

TransformerException - if transformation fails

getResultDocument

public Document getResultDocument()
                           throws TransformerException

Perform the XSLT transformation specified in the constructor

Returns:

the result as a DOM Document

Throws:

TransformerException - if transformation fails

setOutputProperty

public void setOutputProperty(String name,
 String value)

Override an output property specified in the transformation stylesheet

Parameters:

name - name of the property

value - value of the property

setOutputProperties

public void setOutputProperties(Properties outputProperties)

Override output properties specified in the transformation stylesheet

Parameters:

outputProperties - output properties

See Also:

• Transformer.setOutputProperties(java.util.Properties)

setParameter

public void setParameter(String name,
 Object value)

Add a parameter for the transformation

Parameters:

name - name of the parameter

value - value of the parameter

See Also:

• Transformer.setParameter(java.lang.String, java.lang.Object)

getParameter

public Object getParameter(String name)

See a parameter used for the transformation

Parameters:

name - name of the parameter

Returns:

the parameter value

See Also:

• Transformer.getParameter(java.lang.String)

clearParameters

public void clearParameters()

Clear parameters used for the transformation

See Also:

• Transformer.clearParameters()

setURIResolver

public void setURIResolver(URIResolver uriResolver)

Set the URIResolver for the transformation

Parameters:

uriResolver - resolver to use

See Also:

• Transformer.setURIResolver(javax.xml.transform.URIResolver)

setErrorListener

public void setErrorListener(ErrorListener errorListener)

Set the ErrorListener for the transformation

Parameters:

errorListener - error listener to use

See Also:

• Transformer.setErrorListener(javax.xml.transform.ErrorListener)