net.sf.saxon.s9api
Class XdmDestination

java.lang.Object
  net.sf.saxon.s9api.XdmDestination

All Implemented Interfaces:

Destination

public class XdmDestination
extends Object
implements Destination

An XdmDestination is a Destination in which an XdmNode is constructed to hold the output of a query or transformation: that is, a tree using Saxon's implementation of the XDM data model

No data needs to be supplied to the XdmDestination object. The query or transformation populates an XmlNode, which may then be retrieved using the getXdmNode method.

An XdmDestination can be reused to hold the results of a second transformation only if the reset() method is first called to reset its state.

Constructor Summary

XdmDestination()

Method Summary

Receiver	getReceiver(Configuration config) Return a Receiver.
XdmNode	getXdmNode() Return the node at the root of the tree, after it has been constructed.
void	reset() Allow the XdmDestination to be reused

Methods inherited from class java.lang.Object

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

Constructor Detail

XdmDestination

public XdmDestination()

Method Detail

getReceiver

public Receiver getReceiver(Configuration config)
                     throws SaxonApiException

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.

Specified by:

getReceiver in interface Destination

Parameters:

config - 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.

Returns:

the Receiver to which events are to be sent.

Throws:

SaxonApiException - if the Receiver cannot be created

getXdmNode

public XdmNode getXdmNode()

Return the node at the root of the tree, after it has been constructed.

This method should not be called while the tree is under construction.

Returns:

the root node of the tree (normally a document node). Returns null if the construction of the tree has not yet started. The result is undefined if tree construction has started but is not complete.

reset

public void reset()

Allow the XdmDestination to be reused