Package org.apache.xalan.xsltc.trax

Class TransformerFactoryImpl

  • All Implemented Interfaces:
    javax.xml.transform.ErrorListener, SourceLoader
    public class TransformerFactoryImpl
extends javax.xml.transform.sax.SAXTransformerFactory
implements SourceLoader, javax.xml.transform.ErrorListener
    Implementation of a JAXP1.1 TransformerFactory for Translets.
    Author:
    G. Todd Miller, Morten Jorgensen, Santiago Pericas-Geertsen

    • Constructor Summary

      Constructors 
      Constructor Description
      TransformerFactoryImpl()
      javax.xml.transform.sax.TransformerFactory implementation.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void error​(javax.xml.transform.TransformerException e)
      Receive notification of a recoverable error.
      void fatalError​(javax.xml.transform.TransformerException e)
      Receive notification of a non-recoverable error.
      javax.xml.transform.Source getAssociatedStylesheet​(javax.xml.transform.Source source, java.lang.String media, java.lang.String title, java.lang.String charset)
      javax.xml.transform.sax.TransformerFactory implementation.
      java.lang.Object getAttribute​(java.lang.String name)
      javax.xml.transform.sax.TransformerFactory implementation.
      javax.xml.transform.ErrorListener getErrorListener()
      javax.xml.transform.sax.TransformerFactory implementation.
      boolean getFeature​(java.lang.String name)
      javax.xml.transform.sax.TransformerFactory implementation.
      javax.xml.transform.URIResolver getURIResolver()
      javax.xml.transform.sax.TransformerFactory implementation.
      org.xml.sax.InputSource loadSource​(java.lang.String href, java.lang.String context, XSLTC xsltc)
      This method implements XSLTC's SourceLoader interface.
      javax.xml.transform.Templates newTemplates​(javax.xml.transform.Source source)
      javax.xml.transform.sax.TransformerFactory implementation.
      javax.xml.transform.sax.TemplatesHandler newTemplatesHandler()
      javax.xml.transform.sax.SAXTransformerFactory implementation.
      javax.xml.transform.Transformer newTransformer()
      javax.xml.transform.sax.TransformerFactory implementation.
      javax.xml.transform.Transformer newTransformer​(javax.xml.transform.Source source)
      javax.xml.transform.sax.TransformerFactory implementation.
      javax.xml.transform.sax.TransformerHandler newTransformerHandler()
      javax.xml.transform.sax.SAXTransformerFactory implementation.
      javax.xml.transform.sax.TransformerHandler newTransformerHandler​(javax.xml.transform.Source src)
      javax.xml.transform.sax.SAXTransformerFactory implementation.
      javax.xml.transform.sax.TransformerHandler newTransformerHandler​(javax.xml.transform.Templates templates)
      javax.xml.transform.sax.SAXTransformerFactory implementation.
      org.xml.sax.XMLFilter newXMLFilter​(javax.xml.transform.Source src)
      javax.xml.transform.sax.SAXTransformerFactory implementation.
      org.xml.sax.XMLFilter newXMLFilter​(javax.xml.transform.Templates templates)
      javax.xml.transform.sax.SAXTransformerFactory implementation.
      void setAttribute​(java.lang.String name, java.lang.Object value)
      javax.xml.transform.sax.TransformerFactory implementation.
      void setErrorListener​(javax.xml.transform.ErrorListener listener)
      javax.xml.transform.sax.TransformerFactory implementation.
      void setFeature​(java.lang.String name, boolean value)
      Set a feature for this TransformerFactory and Transformers or Templates created by this factory.
      void setURIResolver​(javax.xml.transform.URIResolver resolver)
      javax.xml.transform.sax.TransformerFactory implementation.
      void warning​(javax.xml.transform.TransformerException e)
      Receive notification of a warning.

      • Methods inherited from class javax.xml.transform.TransformerFactory

        newDefaultInstance, newInstance, newInstance

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • TransformerFactoryImpl

        public TransformerFactoryImpl()
        javax.xml.transform.sax.TransformerFactory implementation.

    • Method Detail

      • setErrorListener

        public void setErrorListener​(javax.xml.transform.ErrorListener listener)
                      throws java.lang.IllegalArgumentException
        javax.xml.transform.sax.TransformerFactory implementation. Set the error event listener for the TransformerFactory, which is used for the processing of transformation instructions, and not for the transformation itself.
        Specified by:
        setErrorListener in class javax.xml.transform.TransformerFactory
        Parameters:
        listener - The error listener to use with the TransformerFactory
        Throws:
        java.lang.IllegalArgumentException

      • getErrorListener

        public javax.xml.transform.ErrorListener getErrorListener()
        javax.xml.transform.sax.TransformerFactory implementation. Get the error event handler for the TransformerFactory.
        Specified by:
        getErrorListener in class javax.xml.transform.TransformerFactory
        Returns:
        The error listener used with the TransformerFactory

      • getAttribute

        public java.lang.Object getAttribute​(java.lang.String name)
                              throws java.lang.IllegalArgumentException
        javax.xml.transform.sax.TransformerFactory implementation. Returns the value set for a TransformerFactory attribute
        Specified by:
        getAttribute in class javax.xml.transform.TransformerFactory
        Parameters:
        name - The attribute name
        Returns:
        An object representing the attribute value
        Throws:
        java.lang.IllegalArgumentException

      • setAttribute

        public void setAttribute​(java.lang.String name,
                         java.lang.Object value)
                  throws java.lang.IllegalArgumentException
        javax.xml.transform.sax.TransformerFactory implementation. Sets the value for a TransformerFactory attribute.
        Specified by:
        setAttribute in class javax.xml.transform.TransformerFactory
        Parameters:
        name - The attribute name
        value - An object representing the attribute value
        Throws:
        java.lang.IllegalArgumentException

      • setFeature

        public void setFeature​(java.lang.String name,
                       boolean value)
                throws javax.xml.transform.TransformerConfigurationException

        Set a feature for this TransformerFactory and Transformers or Templates created by this factory.

        Feature names are fully qualified URIs. Implementations may define their own features. An TransformerConfigurationException is thrown if this TransformerFactory or the Transformers or Templates it creates cannot support the feature. It is possible for an TransformerFactory to expose a feature value but be unable to change its state.

        See TransformerFactory for full documentation of specific features.

        Specified by:
        setFeature in class javax.xml.transform.TransformerFactory
        Parameters:
        name - Feature name.
        value - Is feature state true or false.
        Throws:
        javax.xml.transform.TransformerConfigurationException - if this TransformerFactory or the Transformers or Templates it creates cannot support this feature.
        java.lang.NullPointerException - If the name parameter is null.

      • getFeature

        public boolean getFeature​(java.lang.String name)
        javax.xml.transform.sax.TransformerFactory implementation. Look up the value of a feature (to see if it is supported). This method must be updated as the various methods and features of this class are implemented.
        Specified by:
        getFeature in class javax.xml.transform.TransformerFactory
        Parameters:
        name - The feature name
        Returns:
        'true' if feature is supported, 'false' if not

      • getURIResolver

        public javax.xml.transform.URIResolver getURIResolver()
        javax.xml.transform.sax.TransformerFactory implementation. Get the object that is used by default during the transformation to resolve URIs used in document(), xsl:import, or xsl:include.
        Specified by:
        getURIResolver in class javax.xml.transform.TransformerFactory
        Returns:
        The URLResolver used for this TransformerFactory and all Templates and Transformer objects created using this factory

      • setURIResolver

        public void setURIResolver​(javax.xml.transform.URIResolver resolver)
        javax.xml.transform.sax.TransformerFactory implementation. Set the object that is used by default during the transformation to resolve URIs used in document(), xsl:import, or xsl:include. Note that this does not affect Templates and Transformers that are already created with this factory.
        Specified by:
        setURIResolver in class javax.xml.transform.TransformerFactory
        Parameters:
        resolver - The URLResolver used for this TransformerFactory and all Templates and Transformer objects created using this factory

      • getAssociatedStylesheet

        public javax.xml.transform.Source getAssociatedStylesheet​(javax.xml.transform.Source source,
                                                          java.lang.String media,
                                                          java.lang.String title,
                                                          java.lang.String charset)
                                                   throws javax.xml.transform.TransformerConfigurationException
        javax.xml.transform.sax.TransformerFactory implementation. Get the stylesheet specification(s) associated via the xml-stylesheet processing instruction (see http://www.w3.org/TR/xml-stylesheet/) with the document document specified in the source parameter, and that match the given criteria.
        Specified by:
        getAssociatedStylesheet in class javax.xml.transform.TransformerFactory
        Parameters:
        source - The XML source document.
        media - The media attribute to be matched. May be null, in which case the prefered templates will be used (i.e. alternate = no).
        title - The value of the title attribute to match. May be null.
        charset - The value of the charset attribute to match. May be null.
        Returns:
        A Source object suitable for passing to the TransformerFactory.
        Throws:
        javax.xml.transform.TransformerConfigurationException

      • newTransformer

        public javax.xml.transform.Transformer newTransformer()
                                               throws javax.xml.transform.TransformerConfigurationException
        javax.xml.transform.sax.TransformerFactory implementation. Create a Transformer object that copies the input document to the result.
        Specified by:
        newTransformer in class javax.xml.transform.TransformerFactory
        Returns:
        A Transformer object that simply copies the source to the result.
        Throws:
        javax.xml.transform.TransformerConfigurationException

      • newTransformer

        public javax.xml.transform.Transformer newTransformer​(javax.xml.transform.Source source)
                                               throws javax.xml.transform.TransformerConfigurationException
        javax.xml.transform.sax.TransformerFactory implementation. Process the Source into a Templates object, which is a a compiled representation of the source. Note that this method should not be used with XSLTC, as the time-consuming compilation is done for each and every transformation.
        Specified by:
        newTransformer in class javax.xml.transform.TransformerFactory
        Returns:
        A Templates object that can be used to create Transformers.
        Throws:
        javax.xml.transform.TransformerConfigurationException

      • newTemplates

        public javax.xml.transform.Templates newTemplates​(javax.xml.transform.Source source)
                                           throws javax.xml.transform.TransformerConfigurationException
        javax.xml.transform.sax.TransformerFactory implementation. Process the Source into a Templates object, which is a a compiled representation of the source.
        Specified by:
        newTemplates in class javax.xml.transform.TransformerFactory
        Parameters:
        source - The input stylesheet - DOMSource not supported!!!
        Returns:
        A Templates object that can be used to create Transformers.
        Throws:
        javax.xml.transform.TransformerConfigurationException

      • newTemplatesHandler

        public javax.xml.transform.sax.TemplatesHandler newTemplatesHandler()
                                                             throws javax.xml.transform.TransformerConfigurationException
        javax.xml.transform.sax.SAXTransformerFactory implementation. Get a TemplatesHandler object that can process SAX ContentHandler events into a Templates object.
        Specified by:
        newTemplatesHandler in class javax.xml.transform.sax.SAXTransformerFactory
        Returns:
        A TemplatesHandler object that can handle SAX events
        Throws:
        javax.xml.transform.TransformerConfigurationException

      • newTransformerHandler

        public javax.xml.transform.sax.TransformerHandler newTransformerHandler()
                                                                 throws javax.xml.transform.TransformerConfigurationException
        javax.xml.transform.sax.SAXTransformerFactory implementation. Get a TransformerHandler object that can process SAX ContentHandler events into a Result. This method will return a pure copy transformer.
        Specified by:
        newTransformerHandler in class javax.xml.transform.sax.SAXTransformerFactory
        Returns:
        A TransformerHandler object that can handle SAX events
        Throws:
        javax.xml.transform.TransformerConfigurationException

      • newTransformerHandler

        public javax.xml.transform.sax.TransformerHandler newTransformerHandler​(javax.xml.transform.Source src)
                                                                 throws javax.xml.transform.TransformerConfigurationException
        javax.xml.transform.sax.SAXTransformerFactory implementation. Get a TransformerHandler object that can process SAX ContentHandler events into a Result, based on the transformation instructions specified by the argument.
        Specified by:
        newTransformerHandler in class javax.xml.transform.sax.SAXTransformerFactory
        Parameters:
        src - The source of the transformation instructions.
        Returns:
        A TransformerHandler object that can handle SAX events
        Throws:
        javax.xml.transform.TransformerConfigurationException

      • newTransformerHandler

        public javax.xml.transform.sax.TransformerHandler newTransformerHandler​(javax.xml.transform.Templates templates)
                                                                 throws javax.xml.transform.TransformerConfigurationException
        javax.xml.transform.sax.SAXTransformerFactory implementation. Get a TransformerHandler object that can process SAX ContentHandler events into a Result, based on the transformation instructions specified by the argument.
        Specified by:
        newTransformerHandler in class javax.xml.transform.sax.SAXTransformerFactory
        Parameters:
        templates - Represents a pre-processed stylesheet
        Returns:
        A TransformerHandler object that can handle SAX events
        Throws:
        javax.xml.transform.TransformerConfigurationException

      • newXMLFilter

        public org.xml.sax.XMLFilter newXMLFilter​(javax.xml.transform.Source src)
                                   throws javax.xml.transform.TransformerConfigurationException
        javax.xml.transform.sax.SAXTransformerFactory implementation. Create an XMLFilter that uses the given source as the transformation instructions.
        Specified by:
        newXMLFilter in class javax.xml.transform.sax.SAXTransformerFactory
        Parameters:
        src - The source of the transformation instructions.
        Returns:
        An XMLFilter object, or null if this feature is not supported.
        Throws:
        javax.xml.transform.TransformerConfigurationException

      • newXMLFilter

        public org.xml.sax.XMLFilter newXMLFilter​(javax.xml.transform.Templates templates)
                                   throws javax.xml.transform.TransformerConfigurationException
        javax.xml.transform.sax.SAXTransformerFactory implementation. Create an XMLFilter that uses the given source as the transformation instructions.
        Specified by:
        newXMLFilter in class javax.xml.transform.sax.SAXTransformerFactory
        Parameters:
        templates - The source of the transformation instructions.
        Returns:
        An XMLFilter object, or null if this feature is not supported.
        Throws:
        javax.xml.transform.TransformerConfigurationException

      • error

        public void error​(javax.xml.transform.TransformerException e)
           throws javax.xml.transform.TransformerException
        Receive notification of a recoverable error. The transformer must continue to provide normal parsing events after invoking this method. It should still be possible for the application to process the document through to the end.
        Specified by:
        error in interface javax.xml.transform.ErrorListener
        Parameters:
        e - The warning information encapsulated in a transformer exception.
        Throws:
        javax.xml.transform.TransformerException - if the application chooses to discontinue the transformation (always does in our case).

      • fatalError

        public void fatalError​(javax.xml.transform.TransformerException e)
                throws javax.xml.transform.TransformerException
        Receive notification of a non-recoverable error. The application must assume that the transformation cannot continue after the Transformer has invoked this method, and should continue (if at all) only to collect addition error messages. In fact, Transformers are free to stop reporting events once this method has been invoked.
        Specified by:
        fatalError in interface javax.xml.transform.ErrorListener
        Parameters:
        e - warning information encapsulated in a transformer exception.
        Throws:
        javax.xml.transform.TransformerException - if the application chooses to discontinue the transformation (always does in our case).

      • warning

        public void warning​(javax.xml.transform.TransformerException e)
             throws javax.xml.transform.TransformerException
        Receive notification of a warning. Transformers can use this method to report conditions that are not errors or fatal errors. The default behaviour is to take no action. After invoking this method, the Transformer must continue with the transformation. It should still be possible for the application to process the document through to the end.
        Specified by:
        warning in interface javax.xml.transform.ErrorListener
        Parameters:
        e - The warning information encapsulated in a transformer exception.
        Throws:
        javax.xml.transform.TransformerException - if the application chooses to discontinue the transformation (never does in our case).

      • loadSource

        public org.xml.sax.InputSource loadSource​(java.lang.String href,
                                          java.lang.String context,
                                          XSLTC xsltc)
        This method implements XSLTC's SourceLoader interface. It is used to glue a TrAX URIResolver to the XSLTC compiler's Input and Import classes.
        Specified by:
        loadSource in interface SourceLoader
        Parameters:
        href - The URI of the document to load
        context - The URI of the currently loaded document
        xsltc - The compiler that resuests the document
        Returns:
        An InputSource with the loaded document