Class TraxSource
- All Implemented Interfaces:
Source
JAXP TrAX Source
that enables using XStream object serialization as
direct input for XSLT processors without resorting to an intermediate representation such as
text XML, DOM or DOM4J.
The following example shows how to apply an XSL Transformation
to a set of Java objects gathered into a List (source
):
public static String transform(List source, String stylesheet) {
try {
Transformer transformer = TransformerFactory.newInstance().newTransformer(
new StreamSource(stylesheet));
TraxSource in = new TraxSource(source);
Writer out = new StringWriter();
transformer.transform(in, new StreamResult(out));
return out.toString();
} catch (TransformerException e) {
throw new RuntimeException("XSLT Transformation failed", e);
}
}
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate List
The list of Java objects to be serialized.private XMLReader
The XMLReader object associated to this source ornull
if no XMLReader has yet been requested.private XStream
The configured XStream facade to use for serializing objects.static final String
IfTransformerFactory.getFeature(java.lang.String)
returnstrue
when passed this value as an argument, the Transformer natively supports XStream. -
Constructor Summary
ConstructorsConstructorDescriptionCreates a XStream TrAX source.TraxSource
(Object source) Creates a XStream TrAX source, specifying the object to marshal.TraxSource
(Object source, XStream xstream) Creates a XStream TrAX source, specifying the object to marshal and a configured (with aliases) XStream facade.TraxSource
(List source) Creates a XStream TrAX source, setting the objects to marshal.TraxSource
(List source, XStream xstream) Creates a XStream TrAX source, setting the objects to marshal and a configured (with aliases) XStream facade. -
Method Summary
Modifier and TypeMethodDescriptionprivate void
private void
createXMLReader
(XMLReader filterChain) Returns the XMLReader to be used for the Source.void
setInputSource
(InputSource inputSource) Sets the SAX InputSource to be used for the Source.void
Sets the object to marshal.void
setSourceAsList
(List list) Sets the list of objects to marshal.void
setXMLReader
(XMLReader reader) Set the XMLReader to be used for the Source.void
setXStream
(XStream xstream) Sets the XStream facade to use when marshalling objects.Methods inherited from class javax.xml.transform.sax.SAXSource
getInputSource, getSystemId, isEmpty, setSystemId, sourceToInputSource
-
Field Details
-
XSTREAM_FEATURE
IfTransformerFactory.getFeature(java.lang.String)
returnstrue
when passed this value as an argument, the Transformer natively supports XStream.Note: This implementation does not override the
SAXSource.FEATURE
value defined by its superclass to be considered as a SAXSource by Transformer implementations not natively supporting this XStream-specific source- See Also:
-
xmlReader
The XMLReader object associated to this source ornull
if no XMLReader has yet been requested.- See Also:
-
xstream
The configured XStream facade to use for serializing objects. -
source
The list of Java objects to be serialized.
-
-
Constructor Details
-
TraxSource
public TraxSource()Creates a XStream TrAX source. -
TraxSource
Creates a XStream TrAX source, specifying the object to marshal.- Parameters:
source
- the object to marshal.- Throws:
IllegalArgumentException
- ifsource
isnull
.- See Also:
-
TraxSource
Creates a XStream TrAX source, specifying the object to marshal and a configured (with aliases) XStream facade.- Parameters:
source
- the object to marshal.xstream
- a configured XStream facade.- Throws:
IllegalArgumentException
- ifsource
orxstream
isnull
.- See Also:
-
TraxSource
Creates a XStream TrAX source, setting the objects to marshal.- Parameters:
source
- the list of objects to marshal.- Throws:
IllegalArgumentException
- ifsource
isnull
or empty.- See Also:
-
TraxSource
Creates a XStream TrAX source, setting the objects to marshal and a configured (with aliases) XStream facade.- Parameters:
source
- the list of objects to marshal.xstream
- a configured XStream facade.- Throws:
IllegalArgumentException
- ifsource
orxstream
isnull
orsource
is empty.- See Also:
-
-
Method Details
-
setInputSource
Sets the SAX InputSource to be used for the Source.As this implementation only supports object lists as data source, this method always throws an
UnsupportedOperationException
.- Overrides:
setInputSource
in classSAXSource
- Parameters:
inputSource
- a valid InputSource reference.- Throws:
UnsupportedOperationException
- always!
-
setXMLReader
Set the XMLReader to be used for the Source.As this implementation only supports object lists as data source, this method throws an
UnsupportedOperationException
if the provided reader object does not implement the SAXXMLFilter
interface. Otherwise, aSaxWriter
instance will be attached as parent of the filter chain.- Overrides:
setXMLReader
in classSAXSource
- Parameters:
reader
- a valid XMLReader or XMLFilter reference.- Throws:
UnsupportedOperationException
- ifreader
is not a SAXXMLFilter
.- See Also:
-
getXMLReader
Returns the XMLReader to be used for the Source.This implementation returns a specific XMLReader (
SaxWriter
) generating the XML from a list of input objects.- Overrides:
getXMLReader
in classSAXSource
- Returns:
- an XMLReader generating the XML from a list of input objects.
-
setXStream
Sets the XStream facade to use when marshalling objects.- Parameters:
xstream
- a configured XStream facade.- Throws:
IllegalArgumentException
- ifxstream
isnull
.
-
setSource
Sets the object to marshal.- Parameters:
obj
- the object to marshal.- Throws:
IllegalArgumentException
- ifsource
isnull
.
-
setSourceAsList
Sets the list of objects to marshal.When dealing with non-text input (such as SAX or DOM), XSLT processors support multiple root node children for the source tree (see section 3.1 of the "XSL Transformations (XSLT) Version 1.0" specification. Using a list of objects as source makes use of this feature and allows creating XML documents merging the XML serialization of several Java objects.
- Parameters:
list
- the list of objects to marshal.- Throws:
IllegalArgumentException
- ifsource
isnull
or empty.
-
createXMLReader
-
configureXMLReader
private void configureXMLReader()
-