Package net.sf.saxon.jaxp

Class StreamingTransformerImpl

  • public class StreamingTransformerImpl
extends IdentityTransformer
    Saxon implementation of the JAXP Transformer interface. This implementation of Transformer is used when the factory is a StreamingTransformerFactory, and the effect is that the transform(Source, Result) method accepts a StreamSource or SAXSource and processes it in streaming mode, assuming that the initial mode is labelled with streamable="yes". The global context item in such a transformation will be absent, so referring to "." within a global variable is an error.

    • Method Detail

      • transform

        public void transform​(javax.xml.transform.Source xmlSource,
                      javax.xml.transform.Result outputTarget)
               throws XPathException

        Transform the XML Source to a Result. Specific transformation behavior is determined by the settings of the TransformerFactory in effect when the Transformer was instantiated and any modifications made to the Transformer instance.

        An empty Source is represented as an empty document as constructed by DocumentBuilder.newDocument(). The result of transforming an empty Source depends on the transformation behavior; it is not always an empty Result.

        Overrides:
        transform in class IdentityTransformer
        Parameters:
        xmlSource - The XML input to transform.
        outputTarget - The Result of transforming the xmlSource.
        Throws:
        XPathException - If an unrecoverable error occurs during the course of the transformation.

      • setConvertedParameter

        protected void setConvertedParameter​(QName name,
                                     XdmValue value)

      • clearParameters

        public void clearParameters()
        Clear all parameters set with setParameter.

      • setURIResolver

        public void setURIResolver​(javax.xml.transform.URIResolver resolver)
        Set an object that will be used to resolve URIs used in document().

        If the resolver argument is null, the URIResolver value will be cleared and the transformer will no longer have a resolver.

        Overrides:
        setURIResolver in class IdentityTransformer
        Parameters:
        resolver - An object that implements the URIResolver interface, or null.

      • setErrorListener

        public void setErrorListener​(javax.xml.transform.ErrorListener listener)
                      throws java.lang.IllegalArgumentException
        Set the error event listener in effect for the transformation.
        Overrides:
        setErrorListener in class IdentityTransformer
        Parameters:
        listener - The new error listener.
        Throws:
        java.lang.IllegalArgumentException - if listener is null.

      • setInitialMode

        public void setInitialMode​(java.lang.String name)
                    throws java.lang.IllegalArgumentException
        Supply an initial mode for a transformation.

        This is a Saxon extension to the JAXP interface, needed for XSLT 2.0

        Parameters:
        name - the name of the initial mode, in Clark notation (either a local name, or "{uri}local")
        Throws:
        java.lang.IllegalArgumentException - if the argument is invalid, for example if the format of the name is incorrect or if there is no mode with this name

      • getUnderlyingXsltTransformer

        public Xslt30Transformer getUnderlyingXsltTransformer()
        Get the underlying s9api implementation class wrapped by this JAXP Transformer
        Returns:
        the underlying s9api XsltTransformer

      • getUnderlyingController

        public Controller getUnderlyingController()
        Get the internal Saxon Controller instance that implements this transformation. Note that the Controller interface will not necessarily remain stable in future releases
        Returns:
        the underlying Saxon Controller instance

      • newXMLFilter

        public org.xml.sax.XMLFilter newXMLFilter()
        Create a JAXP XMLFilter which allows this transformation to be added to a SAX pipeline
        Returns:
        the transformation in the form of an XMLFilter

      • newTransformerHandler

        public javax.xml.transform.sax.TransformerHandler newTransformerHandler()
                                                                 throws XPathException
        Get a TransformerHandler that can be used to run the transformation by feeding in SAX events
        Throws:
        XPathException

      • setParameter

        public void setParameter​(java.lang.String name,
                         java.lang.Object value)
        Add a parameter for the transformation.

        Pass a qualified name as a two-part string, the namespace URI enclosed in curly braces ({}), followed by the local name. If the name has a null URL, the String only contain the local name. An application can safely check for a non-null URI by testing to see if the first character of the name is a '{' character.

        For example, if a URI and local name were obtained from an element defined with <xyz:foo xmlns:xyz="http://xyz.foo.com/yada/baz.html"/>, then the qualified name would be "{http://xyz.foo.com/yada/baz.html}foo". Note that no prefix is used.

        Overrides:
        setParameter in class IdentityTransformer
        Parameters:
        name - The name of the parameter, which may begin with a namespace URI in curly braces ({}).
        value - The value object. This can be any valid Java object. It is up to the processor to provide the proper object coercion or to simply pass the object on for use in an extension.
        Throws:
        java.lang.NullPointerException - If value is null.
        java.lang.IllegalArgumentException - If the supplied value cannot be converted to the declared type of the corresponding stylesheet parameter

      • getParameter

        public java.lang.Object getParameter​(java.lang.String name)
        Get a parameter that was explicitly set with setParameter.

        This method does not return a default parameter value, which cannot be determined until the node context is evaluated during the transformation process.

        Overrides:
        getParameter in class IdentityTransformer
        Parameters:
        name - of Object to get
        Returns:
        A parameter that has been set with setParameter, or null if no parameter with this name has been set.

      • getStylesheetOutputProperties

        protected java.util.Properties getStylesheetOutputProperties()
        Get the output properties defined in the unnamed xsl:output declaration(s) within the stylesheet
        Overrides:
        getStylesheetOutputProperties in class IdentityTransformer
        Returns:
        the values of output properties set in the stylesheet

      • getUnderlyingXsltExecutable

        public XsltExecutable getUnderlyingXsltExecutable()
        Get the underlying s9api implementation class representing the compled stylesheet which this transformer is executing
        Returns:
        the underlying s9api XsltExecutable