net.sf.saxon.s9api

Class DOMDestination

java.lang.Object

net.sf.saxon.s9api.AbstractDestination

net.sf.saxon.s9api.DOMDestination

All Implemented Interfaces:

Destination

public class DOMDestination
extends AbstractDestination

This class represents a Destination (for example, the destination of the output of a transformation) in which the results are written to a newly constructed DOM tree in memory. The caller must supply a Document node, which will be used as the root of the constructed tree

Field Summary

Fields inherited from class net.sf.saxon.s9api.AbstractDestination

helper

Constructor Summary

Constructors

Constructor and Description
DOMDestination(org.w3c.dom.Node root) Create a DOMDestination, supplying a node in a DOM document to which the content of the result tree will be attached.

Method Summary

Modifier and Type	Method and Description
void	close() Close the destination, allowing resources to be released.
Receiver	getReceiver(PipelineConfiguration pipe, SerializationProperties params) Return a Receiver.

Methods inherited from class net.sf.saxon.s9api.AbstractDestination

closeAndNotify, getDestinationBaseURI, onClose, setDestinationBaseURI

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DOMDestination

public DOMDestination(org.w3c.dom.Node root)

Create a DOMDestination, supplying a node in a DOM document to which the content of the result tree will be attached.

Parameters:

root - the root node for the new tree. This must be a document or element node.

Method Detail

getReceiver

public Receiver getReceiver(PipelineConfiguration pipe,
                            SerializationProperties params)

Return a Receiver. Saxon calls this method to obtain a Receiver, to which it then sends a sequence of events representing the content of an XML document.

Parameters:

pipe - The Saxon configuration. This is supplied so that the destination can use information from the configuration (for example, a reference to the name pool) to construct or configure the returned Receiver.

params -

Returns:

the Receiver to which events are to be sent.

close

public void close()
           throws SaxonApiException

Close the destination, allowing resources to be released. Saxon calls this method when it has finished writing to the destination.

Throws:

SaxonApiException - if any failure occurs