org.jdom.transform

Class JDOMResult


public class JDOMResult
extends SAXResult

Acts as a holder for a transformation result tree, in the form of a JDOM Document.

This class shall be used to get the result of XSL Transformation as a JDOM Document.

The following example shows how to apply an XSL Transformation to a JDOM document and get the transformation result in the form of another JDOM Document:

   public static Document transform(Document in, String stylesheet)
                                      throws JDOMException {
     try {
       Transformer transformer = TransformerFactory.newInstance()
                             .newTransformer(new StreamSource(stylesheet));
       JDOMResult out = new JDOMResult();
       transformer.transform(new JDOMSource(in), out);
       return out.getDocument();
     }
     catch (TransformerException e) {
       throw new JDOMException("XSLT Trandformation failed", e);
     }
   }
 

Version:
$Revision: 1.5 $, $Date: 2002/01/08 09:17:10 $

Authors:
Laurent Bihanic
Jason Hunter

See Also:
JDOMSource

Field Summary

static String
JDOM_FEATURE
If javax.xml.transform.TransformerFactory.getFeature returns true when passed this value as an argument, the Transformer natively supports JDOM.

Constructor Summary

JDOMResult()
Default empty constructor.

Method Summary

Document
getDocument()
Returns the document produced as result of an XSL Transformation.
JDOMFactory
getFactory()
Returns the custom JDOMFactory used to build the result document.
void
setDocument(Document document)
Sets the document produced as result of an XSL Transformation.
void
setFactory(JDOMFactory factory)
Sets a custom JDOMFactory to use when building the result document.
void
setHandler(ContentHandler handler)
Sets the target to be a SAX2 ContentHandler.
void
setLexicalHandler(LexicalHandler handler)
Sets the SAX2 LexicalHandler for the output.

Field Details

JDOM_FEATURE

public static final String JDOM_FEATURE
If javax.xml.transform.TransformerFactory.getFeature returns true when passed this value as an argument, the Transformer natively supports JDOM.

Note: This implementation does not override the SAXResult.FEATURE value defined by its superclass to be considered as a SAXResult by Transformer implementations not natively supporting JDOM.

Constructor Details

JDOMResult

public JDOMResult()
Default empty constructor.

Method Details

getDocument

public Document getDocument()
Returns the document produced as result of an XSL Transformation.

Returns:
the transformation result as a JDOM document.


getFactory

public JDOMFactory getFactory()
Returns the custom JDOMFactory used to build the result document.

Returns:
the custom JDOMFactory used to build the result document or null if the default JDOM classes are being used.

See Also:
setFactory(JDOMFactory)


setDocument

public void setDocument(Document document)
Sets the document produced as result of an XSL Transformation.

Note: This method shall be used by the javax.xml.transform.Transformer implementations that natively support JDOM to directly set the transformation result rather than considering this object as a SAXResult. Applications should not use this method.

Parameters:
document - the JDOM document result of a transformation.

See Also:
getDocument()


setFactory

public void setFactory(JDOMFactory factory)
Sets a custom JDOMFactory to use when building the result document. Use a custom factory to build the tree with your own subclasses of the JDOM classes.

Parameters:
factory - the custom JDOMFactory to use or null to use the default JDOM classes.

See Also:
getFactory()


setHandler

public void setHandler(ContentHandler handler)
Sets the target to be a SAX2 ContentHandler.

Parameters:
handler - Must be a non-null ContentHandler reference.


setLexicalHandler

public void setLexicalHandler(LexicalHandler handler)
Sets the SAX2 LexicalHandler for the output.

This is needed to handle XML comments and the like. If the lexical handler is not set, an attempt should be made by the transformer to cast the ContentHandler to a LexicalHandler.

Parameters:
handler - A non-null LexicalHandler for handling lexical parse events.


Copyright B) 2002 Jason Hunter, Brett McLaughlin. All Rights Reserved.