org.jdom.transform
public class JDOMResult extends SAXResult
The following example shows how to apply an XSL Transformation to a JDOM document and get the transformation result in the form of a list of JDOM nodes:
public static List transform(Document doc, String stylesheet)
throws JDOMException {
try {
Transformer transformer = TransformerFactory.newInstance()
.newTransformer(new StreamSource(stylesheet));
JDOMSource in = new JDOMSource(doc);
JDOMResult out = new JDOMResult();
transformer.transform(in, out);
return out.getResult();
}
catch (TransformerException e) {
throw new JDOMException("XSLT Transformation failed", e);
}
}
Version: $Revision: 1.24 $, $Date: 2007/11/10 05:29:02 $
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()
Public default constructor. |
Method Summary | |
---|---|
Document | getDocument()
Returns the result of an XSL Transformation as a JDOM document.
|
JDOMFactory | getFactory()
Returns the custom JDOMFactory used to build the transformation
result.
|
List | getResult()
Returns the result of an XSL Transformation as a list of JDOM
nodes.
|
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
transformation result. |
void | setHandler(ContentHandler handler)
Sets the target to be a SAX2 ContentHandler.
|
void | setLexicalHandler(LexicalHandler handler)
Sets the SAX2 LexicalHandler for the output.
|
void | setResult(List result)
Sets the object(s) produced as result of an XSL Transformation.
|
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.
If the result of the transformation is a list of nodes, this method attempts to convert it into a JDOM document. If successful, any subsequent call to JDOMResult will return an empty list.
Warning: The XSLT 1.0 specification states that
the output of an XSL transformation is not a well-formed XML
document but a list of nodes. Applications should thus use
JDOMResult instead of this method or at least expect
null
documents to be returned.
Returns: the transformation result as a JDOM document or
null
if the result of the transformation
can not be converted into a well-formed document.
See Also: JDOMResult
Returns: the custom JDOMFactory
used to build the
transformation result or null
if the
default JDOM classes are being used.
See Also: JDOMResult
If the result of the transformation is a JDOM document,
this method converts it into a list of JDOM nodes; any
subsequent call to JDOMResult will return
null
.
Returns: the transformation result as a (possibly empty) list of JDOM nodes (Elements, Texts, Comments, PIs...).
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: JDOMResult JDOMResult
Parameters: factory the custom JDOMFactory
to use or
null
to use the default JDOM
classes.
See Also: JDOMResult
Parameters: handler Must be a non-null ContentHandler reference.
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.
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: result the result of a transformation as a
java.util.List list
of JDOM nodes
(Elements, Texts, Comments, PIs...).
See Also: JDOMResult