Main Page   Packages   Namespace List   Class Hierarchy   Compound List   Compound Members  

JDOMResult Class Reference

List of all members.

Public Methods

 JDOMResult ()
void setDocument (Document document)
Document getDocument ()
void setFactory (JDOMFactory factory)
JDOMFactory getFactory ()
void setHandler (ContentHandler handler)
void setLexicalHandler (LexicalHandler handler)

Static Public Attributes

final String JDOM_FEATURE

Detailed Description

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);
     }
   }
 

See also:
org.jdom.transform.JDOMSource
Author:
Laurent Bihanic , Jason Hunter
Version:
Revision:
1.5
,
Date:
2002/01/08 09:17:10


Constructor & Destructor Documentation

JDOMResult::JDOMResult   [inline]
 

Default empty constructor.


Member Function Documentation

Document JDOMResult::getDocument   [inline]
 

Returns the document produced as result of an XSL Transformation.

Returns:
the transformation result as a JDOM document.

JDOMFactory JDOMResult::getFactory   [inline]
 

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

void JDOMResult::setDocument Document    document [inline]
 

Sets the document produced as result of an XSL Transformation.

Note: This method shall be used by the 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

void JDOMResult::setFactory JDOMFactory    factory [inline]
 

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

void JDOMResult::setHandler ContentHandler    handler [inline]
 

Sets the target to be a SAX2 ContentHandler.

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

void JDOMResult::setLexicalHandler LexicalHandler    handler [inline]
 

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.


Member Data Documentation

final String JDOMResult::JDOM_FEATURE [static]
 

Initial value:

                      "http://org.jdom.transform.JDOMResult/feature"
If returns true when passed this value as an argument, the Transformer natively supports JDOM.

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


The documentation for this class was generated from the following file:
Generated on Sat Mar 30 18:53:03 2002 for JDOM by doxygen1.2.12 written by Dimitri van Heesch, © 1997-2001