com.bea.wli.sb.sources
Class DOMSource

java.lang.Object
  extended by com.bea.wli.sb.sources.DOMSource
All Implemented Interfaces:
Source

public final class DOMSource
extends Object
implements Source

Document Object Model (DOM) Source

A Source whose content comes from a DOM node. The referenced node may be a full-fledged org.w3c.dom.Document, but it may also be an internal node in a larger document.

The serialization representation is XML text with a particular chracter set encoding. The encoding used can be specified via TransformOptions.


Field Summary
 
Fields inherited from interface com.bea.wli.sb.sources.Source
DEFAULT_CHARACTER_SET_ENCODING
 
Constructor Summary
DOMSource(Node node)
          Create a new Source from a DOM node.
DOMSource(Node node, String systemID)
          Create a new input source with a DOM node, and with the system ID also passed in as the base URI.
 
Method Summary
static weblogic.xml.domimpl.SaverOptions createSaverOptions(TransformOptions options)
          Utility class that creates a set of SaverOptions from a set of TransformOptions.
 InputStream getInputStream(TransformOptions options)
          Returns streaming byte-baseed representation of the Source's content.
 Node getNode()
          Get the underlying DOM node for this Source
 String getSystemId()
          Get the base ID (URL or system ID)
 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, toString, wait, wait, wait
 

Constructor Detail

DOMSource

public DOMSource(Node node)
Create a new Source from a DOM node.

Parameters:
node - The DOM node that will be this Source's content

DOMSource

public DOMSource(Node node,
                 String systemID)
Create a new input source with a DOM node, and with the system ID also passed in as the base URI.

Parameters:
node - The DOM node that will be this Source's content
systemID - Specifies the base URI associated with node.
Method Detail

getNode

public Node getNode()
Get the underlying DOM node for this Source


getSystemId

public String getSystemId()
Get the base ID (URL or system ID)

Returns:
Base URL for this DOM tree.

getInputStream

public InputStream getInputStream(TransformOptions options)
                           throws IOException,
                                  TransformException
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
Throws:
IOException
TransformException

writeTo

public void writeTo(OutputStream os,
                    TransformOptions options)
             throws IOException,
                    TransformException
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
TransformException

createSaverOptions

public static weblogic.xml.domimpl.SaverOptions createSaverOptions(TransformOptions options)
Utility class that creates a set of SaverOptions from a set of TransformOptions. This method takes into account a base-set of default SaverOptions.

Parameters:
options -
Returns: