com.bea.wli.sb.sources

Class XmlObjectSource

java.lang.Object

com.bea.wli.sb.sources.XmlObjectSource

All Implemented Interfaces:

Source

public class XmlObjectSource
extends Object
implements Source

Apache XBean Source Source content is represented as an Apache XBean. The XBean may be typed and so may be accompanied by a SchemaType object and an associated ClassLoader. However, both of these are entirely optional and the XBean may be untyped XML.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PRETTY_PRINT_OPTION
static String	TRACK_PAYLOAD_DETAILS
static String	UNSYNC_XML_OPTION

Fields inherited from interface com.bea.wli.sb.sources.Source

DEFAULT_CHARACTER_SET_ENCODING

Constructor Summary

Constructors

Constructor and Description
XmlObjectSource(XmlObject xml)
XmlObjectSource(XmlObject xml, SchemaType type, ClassLoader cl)
XmlObjectSource(XmlObject xml, String contentType)

Method Summary

Modifier and Type	Method and Description
static XmlOptions	createXmlOptions(TransformOptions options) Utility class that creates a set of XmlOptions from a set of TransformOptions.
ClassLoader	getClassLoader()
String	getContentType()
InputStream	getInputStream(TransformOptions options) Returns streaming byte-baseed representation of the Source's content.
static XmlObjectSource	getInstance(InputStream in, TransformOptions options) Utility method that creates a new XmlObjectSource from an InputStream containing marshalled XML.
static XmlObjectSource	getInstance(Node node, TransformOptions options) Utility method that creates a new XmlObjectSource from a DOM node.
static XmlObjectSource	getInstance(String xmlText, TransformOptions options) Utility method that creates a new XmlObjectSource from a piece of text containing stringified XML.
SchemaType	getSchemaType()
XmlObject	getXmlObject()
String	toString()
void	writeTo(OutputStream os, TransformOptions options) Serializes the Source's content to a byte-based stream.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

UNSYNC_XML_OPTION

public static final String UNSYNC_XML_OPTION

See Also:

Constant Field Values

TRACK_PAYLOAD_DETAILS

public static final String TRACK_PAYLOAD_DETAILS

See Also:

Constant Field Values

PRETTY_PRINT_OPTION

public static final String PRETTY_PRINT_OPTION

See Also:

Constant Field Values

Constructor Detail

XmlObjectSource

public XmlObjectSource(XmlObject xml)

XmlObjectSource

public XmlObjectSource(XmlObject xml,
                       String contentType)

XmlObjectSource

public XmlObjectSource(XmlObject xml,
                       SchemaType type,
                       ClassLoader cl)

Method Detail

getXmlObject

public XmlObject getXmlObject()

getContentType

public String getContentType()

getClassLoader

public ClassLoader getClassLoader()

getSchemaType

public SchemaType getSchemaType()

getInputStream

public InputStream getInputStream(TransformOptions options)

Description copied from interface: Source

Returns streaming byte-baseed representation of the Source's content. The representation of that serialization is entirely up to the Source. Note that this method may involve an internal transformation, although it should not in any way change the underlying content.

Specified by:

getInputStream in interface Source

Parameters:

options - Options used to affect the serialization

Returns:

an InputStream for retrieving the serialized content

writeTo

public void writeTo(OutputStream os,
                    TransformOptions options)
             throws IOException

Description copied from interface: Source

Serializes the Source's content to a byte-based stream. The representation of that serialization is entirely up to the Source. The Source is forbidden from closing the provided OutputStream, although it is allowed to flush it. However, flushing the stream should be left to the caller, if possible.

Note that this method may involve an internal transformation, although it should not in any way change the underlying content.

Specified by:

writeTo in interface Source

Parameters:

os - the OutputStream to which serialized content will be written

options - TransformOptions used to affect the serialization

Throws:

IOException

createXmlOptions

public static XmlOptions createXmlOptions(TransformOptions options)

Utility class that creates a set of XmlOptions from a set of TransformOptions. This method takes into account a base-set of default XmlOptions.

Parameters:

options -

Returns:

getInstance

public static XmlObjectSource getInstance(String xmlText,
                                          TransformOptions options)
                                   throws TransformException

Utility method that creates a new XmlObjectSource from a piece of text containing stringified XML.

Parameters:

xmlText -

options -

Returns:

Throws:

TransformException

getInstance

public static XmlObjectSource getInstance(Node node,
                                          TransformOptions options)
                                   throws TransformException

Utility method that creates a new XmlObjectSource from a DOM node.

Parameters:

node -

options -

Returns:

Throws:

TransformException

getInstance

public static XmlObjectSource getInstance(InputStream in,
                                          TransformOptions options)
                                   throws TransformException

Utility method that creates a new XmlObjectSource from an InputStream containing marshalled XML. This utility method will consume the provided InputStream.

Parameters:

in -

options -

Returns:

Throws:

TransformException

toString

public String toString()

Overrides:

toString in class Object