Class TransformerFactoryImpl


  • public class TransformerFactoryImpl
    extends javax.xml.transform.sax.SAXTransformerFactory
    An implementation of JAXP 1.1 TransfomerFactory. Please see the JAXP 1.1 documentation for more information on how this class should be used.
    Version:
    $Revision: 3955 $ $Date: 2003-10-07 10:37:35 +0200 (Tue, 07 Oct 2003) $
    Author:
    Keith Visco
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String[] SUPPORTED_FEATURES
      The list of supported features
      • Fields inherited from class javax.xml.transform.sax.SAXTransformerFactory

        FEATURE, FEATURE_XMLFILTER
    • Constructor Summary

      Constructors 
      Constructor Description
      TransformerFactoryImpl()
      Creates a new TransformerFactoryImpl
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      javax.xml.transform.Source getAssociatedStylesheet​(javax.xml.transform.Source source, java.lang.String media, java.lang.String title, java.lang.String charset)
      Returns the associated stylesheet with the given source document.
      java.lang.Object getAttribute​(java.lang.String name)
      Allows the user to retrieve specific attributes on the underlying implementation.
      javax.xml.transform.ErrorListener getErrorListener()
      Get the error event handler for the TransformerFactory.
      boolean getFeature​(java.lang.String name)
      Look up the value of a feature.
      javax.xml.transform.URIResolver getURIResolver()
      Get the object that is used by default during the transformation to resolve URIs used in document(), xsl:import, or xsl:include.
      javax.xml.transform.Templates newTemplates​(javax.xml.transform.Source source)
      Process the Source into a Templates object, which is a a compiled representation of the source.
      javax.xml.transform.sax.TemplatesHandler newTemplatesHandler()
      Get a TemplatesHandler object that can process SAX ContentHandler events into a Templates object.
      javax.xml.transform.Transformer newTransformer()
      Create a new Transformer object that performs a copy of the source to the result.
      javax.xml.transform.Transformer newTransformer​(javax.xml.transform.Source source)
      Process the Source into a Transformer object.
      javax.xml.transform.sax.TransformerHandler newTransformerHandler()
      Get a TransformerHandler object that can process SAX ContentHandler events into a Result.
      javax.xml.transform.sax.TransformerHandler newTransformerHandler​(javax.xml.transform.Source source)
      Get a TransformerHandler object that can process SAX ContentHandler events into a Result, based on the transformation instructions specified by the argument.
      javax.xml.transform.sax.TransformerHandler newTransformerHandler​(javax.xml.transform.Templates templates)
      Get a TransformerHandler object that can process SAX ContentHandler events into a Result, based on the Templates argument.
      org.xml.sax.XMLFilter newXMLFilter​(javax.xml.transform.Source source)
      Create an XMLFilter that uses the given Source as the transformation instructions.
      org.xml.sax.XMLFilter newXMLFilter​(javax.xml.transform.Templates templates)
      Create an XMLFilter, based on the Templates argument..
      void setAttribute​(java.lang.String name, java.lang.Object value)
      Allows the user to set specific attributes on the underlying implementation.
      void setErrorListener​(javax.xml.transform.ErrorListener listener)
      Set the error event listener for the TransformerFactory, which is used for the processing of transformation instructions, and not for the transformation itself.
      void setFeature​(java.lang.String name, boolean value)  
      void setURIResolver​(javax.xml.transform.URIResolver resolver)
      Set an object that is used by default during the transformation to resolve URIs used in xsl:import, or xsl:include.
      • 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
    • Field Detail

      • SUPPORTED_FEATURES

        public static final java.lang.String[] SUPPORTED_FEATURES
        The list of supported features
    • Constructor Detail

      • TransformerFactoryImpl

        public TransformerFactoryImpl()
        Creates a new TransformerFactoryImpl
    • Method Detail

      • 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
        Returns the associated stylesheet with the given source document.

        Refer to the JAXP 1.1 TransformerFactory documentation for more information

        Note: This method is not yet supported.

        Specified by:
        getAssociatedStylesheet in class javax.xml.transform.TransformerFactory
        Throws:
        javax.xml.transform.TransformerConfigurationException
      • getAttribute

        public java.lang.Object getAttribute​(java.lang.String name)
                                      throws java.lang.IllegalArgumentException
        Allows the user to retrieve specific attributes on the underlying implementation.
        Specified by:
        getAttribute in class javax.xml.transform.TransformerFactory
        Parameters:
        name - The name of the attribute.
        Returns:
        value The value of the attribute.
        Throws:
        java.lang.IllegalArgumentException - thrown if the underlying implementation doesn't recognize the attribute.
      • getErrorListener

        public javax.xml.transform.ErrorListener getErrorListener()
        Get the error event handler for the TransformerFactory.
        Specified by:
        getErrorListener in class javax.xml.transform.TransformerFactory
        Returns:
        The current error handler, which should never be null.
      • getFeature

        public boolean getFeature​(java.lang.String name)
        Look up the value of a feature.

        The feature name is any absolute URI.

        Specified by:
        getFeature in class javax.xml.transform.TransformerFactory
        Parameters:
        name - The feature name, which is an absolute URI.
        Returns:
        The current state of the feature (true or false).
      • getURIResolver

        public javax.xml.transform.URIResolver getURIResolver()
        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 URIResolver that was set with setURIResolver.
      • newTemplates

        public javax.xml.transform.Templates newTemplates​(javax.xml.transform.Source source)
                                                   throws javax.xml.transform.TransformerConfigurationException
        Process the Source into a Templates object, which is a a compiled representation of the source. This Templates object may then be used concurrently across multiple threads. Creating a Templates object allows the TransformerFactory to do detailed performance optimization of transformation instructions, without penalizing runtime transformation.
        Specified by:
        newTemplates in class javax.xml.transform.TransformerFactory
        Parameters:
        source - An object that holds a URL, input stream, etc.
        Returns:
        A Templates object capable of being used for transformation purposes, never null.
        Throws:
        javax.xml.transform.TransformerConfigurationException - May throw this during the parse when it is constructing the Templates object and fails.
      • newTransformer

        public javax.xml.transform.Transformer newTransformer​(javax.xml.transform.Source source)
                                                       throws javax.xml.transform.TransformerConfigurationException
        Process the Source into a Transformer object. Care must be given not to use this object in multiple threads running concurrently. Different TransformerFactories can be used concurrently by different threads.
        Specified by:
        newTransformer in class javax.xml.transform.TransformerFactory
        Parameters:
        source - An object that holds a URI, input stream, etc.
        Returns:
        A Transformer object that may be used to perform a transformation in a single thread, never null.
        Throws:
        javax.xml.transform.TransformerConfigurationException - May throw this during the parse when it is constructing the Templates object and fails.
      • newTransformer

        public javax.xml.transform.Transformer newTransformer()
                                                       throws javax.xml.transform.TransformerConfigurationException
        Create a new Transformer object that performs a copy of the source to the result.
        Specified by:
        newTransformer in class javax.xml.transform.TransformerFactory
        Parameters:
        source - An object that holds a URI, input stream, etc.
        Returns:
        A Transformer object that may be used to perform a transformation in a single thread, never null.
        Throws:
        javax.xml.transform.TransformerConfigurationException - May throw this during the parse when it is constructing the Templates object and fails.
      • setAttribute

        public void setAttribute​(java.lang.String name,
                                 java.lang.Object value)
                          throws java.lang.IllegalArgumentException
        Allows the user to set specific attributes on the underlying implementation. An attribute in this context is defined to be an option that the implementation provides.
        Specified by:
        setAttribute in class javax.xml.transform.TransformerFactory
        Parameters:
        name - The name of the attribute.
        value - The value of the attribute.
        Throws:
        java.lang.IllegalArgumentException - thrown if the underlying implementation doesn't recognize the attribute.
      • setErrorListener

        public void setErrorListener​(javax.xml.transform.ErrorListener listener)
                              throws java.lang.IllegalArgumentException
        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 new error listener.
        Throws:
        java.lang.IllegalArgumentException - if listener is null.
      • setURIResolver

        public void setURIResolver​(javax.xml.transform.URIResolver resolver)
        Set an object that is used by default during the transformation to resolve URIs used in xsl:import, or xsl:include.
        Specified by:
        setURIResolver in class javax.xml.transform.TransformerFactory
        Parameters:
        resolver - An object that implements the URIResolver interface, or null.
      • newTransformerHandler

        public javax.xml.transform.sax.TransformerHandler newTransformerHandler​(javax.xml.transform.Source source)
                                                                         throws javax.xml.transform.TransformerConfigurationException
        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:
        TransformerHandler ready to transform SAX events.
        Throws:
        javax.xml.transform.TransformerConfigurationException - If for some reason the TransformerHandler can not be created.
      • newTransformerHandler

        public javax.xml.transform.sax.TransformerHandler newTransformerHandler​(javax.xml.transform.Templates templates)
                                                                         throws javax.xml.transform.TransformerConfigurationException
        Get a TransformerHandler object that can process SAX ContentHandler events into a Result, based on the Templates argument.
        Specified by:
        newTransformerHandler in class javax.xml.transform.sax.SAXTransformerFactory
        Parameters:
        templates - The compiled transformation instructions.
        Returns:
        TransformerHandler ready to transform SAX events.
        Throws:
        javax.xml.transform.TransformerConfigurationException - If for some reason the TransformerHandler can not be created.
      • newTransformerHandler

        public javax.xml.transform.sax.TransformerHandler newTransformerHandler()
                                                                         throws javax.xml.transform.TransformerConfigurationException
        Get a TransformerHandler object that can process SAX ContentHandler events into a Result. The transformation is defined as an identity (or copy) transformation, for example to copy a series of SAX parse events into a DOM tree.
        Specified by:
        newTransformerHandler in class javax.xml.transform.sax.SAXTransformerFactory
        Returns:
        A non-null reference to a TransformerHandler, that may be used as a ContentHandler for SAX parse events.
        Throws:
        javax.xml.transform.TransformerConfigurationException - If for some reason the TransformerHandler cannot be created.
      • newTemplatesHandler

        public javax.xml.transform.sax.TemplatesHandler newTemplatesHandler()
                                                                     throws javax.xml.transform.TransformerConfigurationException
        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 non-null reference to a TransformerHandler, that may be used as a ContentHandler for SAX parse events.
        Throws:
        javax.xml.transform.TransformerConfigurationException - If for some reason the TemplatesHandler cannot be created.
      • newXMLFilter

        public org.xml.sax.XMLFilter newXMLFilter​(javax.xml.transform.Source source)
                                           throws javax.xml.transform.TransformerConfigurationException
        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 - If for some reason the TemplatesHandler cannot be created.
      • newXMLFilter

        public org.xml.sax.XMLFilter newXMLFilter​(javax.xml.transform.Templates templates)
                                           throws javax.xml.transform.TransformerConfigurationException
        Create an XMLFilter, based on the Templates argument..
        Specified by:
        newXMLFilter in class javax.xml.transform.sax.SAXTransformerFactory
        Parameters:
        templates - The compiled transformation instructions.
        Returns:
        An XMLFilter object, or null if this feature is not supported.
        Throws:
        javax.xml.transform.TransformerConfigurationException - If for some reason the TemplatesHandler cannot be created.
      • setFeature

        public void setFeature​(java.lang.String name,
                               boolean value)
                        throws javax.xml.transform.TransformerConfigurationException
        Specified by:
        setFeature in class javax.xml.transform.TransformerFactory
        Throws:
        javax.xml.transform.TransformerConfigurationException