Package net.sf.saxon.lib

Class StandardResultDocumentResolver

java.lang.Object

net.sf.saxon.lib.StandardResultDocumentResolver

All Implemented Interfaces:

ResultDocumentResolver

public class StandardResultDocumentResolver
extends Object
implements ResultDocumentResolver

This class defines the default ResultDocumentResolver. This is a counterpart to the JAXP URIResolver, but is used to map the URI of a secondary result document to a Receiver object which acts as the destination for the new document.

Constructor Summary

Constructors

Constructor	Description
StandardResultDocumentResolver()

Method Summary

Modifier and Type	Method	Description
void	close(Result result)	Signal completion of the result document.
protected StreamResult	createResult(URI absoluteURI)
static StandardResultDocumentResolver	getInstance()	Get a singular instance
static StreamResult	makeOutputFile(URI absoluteURI)	Create an output file (unless it already exists) and return a reference to it as a Result object
StreamResult	resolve(String href, String base)	Resolve an output URI
Receiver	resolve(XPathContext context, String href, String baseUri, SerializationProperties properties)	Saxon calls this method when an xsl:result-document instruction with an href attribute is evaluated.

Methods inherited from class java.lang.Object

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

Constructor Details

StandardResultDocumentResolver

public StandardResultDocumentResolver()

Method Details

getInstance

public static StandardResultDocumentResolver getInstance()

Get a singular instance

Returns:

the singleton instance of the class

resolve

public Receiver resolve(XPathContext context,
 String href,
 String baseUri,
 SerializationProperties properties)
                 throws XPathException

Description copied from interface: ResultDocumentResolver

Saxon calls this method when an xsl:result-document instruction with an href attribute is evaluated.

Note: it may be appropriate for the method to obtain a suitable Receiver by calling one of the static factory methods on the SerializerFactory class. A SerializerFactory can be obtained by calling context.getConfiguration().getSerializerFactory().

Specified by:

resolve in interface ResultDocumentResolver

Parameters:

context - the dynamic evaluation context

href - the effective value of the href attribute of xsl:result-document instruction. This will be a zero-length string if the attribute is omitted.

baseUri - the base output URI of the transformation (typically, the destination of the principal output destination). This may be null if no base output URI is known. The recommended action if it is null is to use the href value alone if it is absolute URI, otherwise to raise an error (SaxonErrorCode.SXRD0002, since there is no W3C-defined code for the condition).

properties - the serialization properties defined explicitly or implicitly on the xsl:result-document instruction, together with information about character maps in the stylesheet that might be referenced. Serialization parameters can be ignored if the result document is not being serialized. However, if the serialization parameters include a validation factory, then this must not be ignored: a validator must be inserted at a suitable point in the output pipeline.

Returns:

a new instance of the Receiver class, which Saxon will then call to open the output document, and subsequently to close it. This Receiver will receive a sequence of events representing the raw result of the xsl:result-document instruction, as a regular event sequence conforming to the rules defined in RegularSequenceChecker.

The implementation should set the systemId property of the returned Receiver to the result of resolving the supplied href against the supplied baseUri. On return from this method, Saxon will check that the systemId is non-null and that it satisfies the uniqueness conditions imposed by the XSLT specification. Specifically, it is not permitted for two calls on xsl:result-document to use the same URI, and this URI must not be read in a call on doc() or document(), either before or after executing the xsl:result-document instruction.

Throws:

XPathException - if a result document cannot be opened

resolve

public StreamResult resolve(String href,
 String base)
                     throws XPathException

Resolve an output URI

Parameters:

href - The relative URI of the output document. This corresponds to the href attribute of the xsl:result-document instruction.

base - The base URI that should be used. This is the base output URI, normally the URI of the principal output file.

Returns:

a Result object representing the destination for the XML document

Throws:

XPathException

createResult

protected StreamResult createResult(URI absoluteURI)
                             throws XPathException,
IOException

Throws:

XPathException

IOException

makeOutputFile

public static StreamResult makeOutputFile(URI absoluteURI)
                                   throws XPathException

Create an output file (unless it already exists) and return a reference to it as a Result object

Parameters:

absoluteURI - the URI of the output file (which should typically use the "file" scheme)

Returns:

a Result object referencing this output file

Throws:

XPathException - if the URI is not writable

close

public void close(Result result)
           throws XPathException

Signal completion of the result document. This method is called by the system when the result document has been successfully written. It allows the resolver to perform tidy-up actions such as closing output streams, or firing off processes that take this result tree as input. Note that the OutputURIResolver is stateless, so the original href is supplied to identify the document that has been completed.

Throws:

XPathException