Class StandardOutputResolver

  • All Implemented Interfaces:
    OutputURIResolver

    public class StandardOutputResolver
    extends java.lang.Object
    implements OutputURIResolver
    This class defines the default OutputURIResolver. This is a counterpart to the JAXP URIResolver, but is used to map the URI of a secondary result document to a Result object which acts as the destination for the new document.
    Author:
    Michael H. Kay
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close​(javax.xml.transform.Result result)
      Signal completion of the result document.
      static StandardOutputResolver getInstance()
      Get a singular instance
      static javax.xml.transform.Result makeOutputFile​(java.net.URI absoluteURI)
      Create an output file (unless it already exists) and return a reference to it as a Result object
      javax.xml.transform.Result resolve​(java.lang.String href, java.lang.String base)
      Resolve an output URI
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • StandardOutputResolver

        public StandardOutputResolver()
    • Method Detail

      • getInstance

        public static StandardOutputResolver getInstance()
        Get a singular instance
        Returns:
        the singleton instance of the class
      • resolve

        public javax.xml.transform.Result resolve​(java.lang.String href,
                                                  java.lang.String base)
                                           throws XPathException
        Resolve an output URI
        Specified by:
        resolve in interface OutputURIResolver
        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
      • makeOutputFile

        public static javax.xml.transform.Result makeOutputFile​(java.net.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 use the "file" scheme
        Returns:
        a Result object referencing this output file
        Throws:
        XPathException
      • close

        public void close​(javax.xml.transform.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.
        Specified by:
        close in interface OutputURIResolver
        Parameters:
        result - The result object returned by the previous call of resolve()
        Throws:
        XPathException