Package com.icl.saxon

Class TransformerFactoryImpl


public class TransformerFactoryImpl extends SAXTransformerFactory
A TransformerFactoryImpl instance can be used to create Transformer and Template objects.

The system property that determines which Factory implementation to create is named "javax.xml.transform.TransformerFactory". This property names a concrete subclass of the TransformerFactory abstract class. If the property is not defined, a platform default is be used.

This implementation class implements the abstract methods on both the javax.xml.transform.TransformerFactory and javax.xml.transform.sax.SAXTransformerFactory classes.

  • Constructor Details

    • TransformerFactoryImpl

      public TransformerFactoryImpl()
      Default constructor.
  • Method Details

    • newTransformer

      public Transformer newTransformer(Source source) throws 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 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:
      TransformerConfigurationException - May throw this during the parse when it is constructing the Templates object and fails.
    • newTransformer

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

      public Templates newTemplates(Source source) throws 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 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:
      TransformerConfigurationException - May throw this during the parse when it is constructing the Templates object and fails.
    • getSAXSource

      public SAXSource getSAXSource(Source source, boolean isStyleSheet)
      Convert a supplied Source to a SAXSource
      Parameters:
      source - The supplied input source
      isStyleSheet - true if the source is a stylesheet
      Returns:
      a SAXSource
    • getAssociatedStylesheet

      public Source getAssociatedStylesheet(Source source, String media, String title, String charset) throws TransformerConfigurationException
      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. Note that it is possible to return several stylesheets, in which case they are applied as if they were a list of imports or cascades.
      Specified by:
      getAssociatedStylesheet in class 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:
      TransformerConfigurationException
    • compositeStylesheet

      public Source compositeStylesheet(SAXSource[] sources) throws TransformerConfigurationException
      Process a series of stylesheet inputs, treating them in import or cascade order. This is mainly for support of the getAssociatedStylesheets method, but may be useful for other purposes.
      Parameters:
      sources - An array of SAX InputSource objects.
      Returns:
      A Source object representing a composite stylesheet.
      Throws:
      TransformerConfigurationException
    • setURIResolver

      public void setURIResolver(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 TransformerFactory
      Parameters:
      resolver - An object that implements the URIResolver interface, or null.
    • getURIResolver

      public 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 TransformerFactory
      Returns:
      The URIResolver that was set with setURIResolver.
    • setFeature

      public void setFeature(String name, boolean value) throws 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.

      All implementations are required to support the XMLConstants.FEATURE_SECURE_PROCESSING feature. When the feature is:

      The Saxon implementation does not support the secure processing feature.

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

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

      The feature name is any absolute URI.

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

      public void setAttribute(String name, Object value) throws 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 TransformerFactory
      Parameters:
      name - The name of the attribute. This must be one of the constants defined in class FeatureKeys.
      value - The value of the attribute.
      Throws:
      IllegalArgumentException - thrown if Saxon doesn't recognize the attribute.
    • getAttribute

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

      public void setErrorListener(ErrorListener listener) throws 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 TransformerFactory
      Parameters:
      listener - The new error listener.
      Throws:
      IllegalArgumentException - if listener is null.
    • getErrorListener

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

      public XMLReader getSourceParser() throws TransformerFactoryConfigurationError
      Get the parser for source documents
      Throws:
      TransformerFactoryConfigurationError
    • getStyleParser

      public XMLReader getStyleParser() throws TransformerFactoryConfigurationError
      Get the parser for stylesheet documents
      Throws:
      TransformerFactoryConfigurationError
    • makeParser

      public static XMLReader makeParser(String className) throws TransformerFactoryConfigurationError
      Create a new SAX XMLReader object using the class name provided.
      The named class must exist and must implement the org.xml.sax.XMLReader or Parser interface.
      This method returns an instance of the parser named.
      Parameters:
      className - A string containing the name of the SAX parser class, for example "com.microstar.sax.LarkDriver"
      Returns:
      an instance of the Parser class named, or null if it is not loadable or is not a Parser.
      Throws:
      TransformerFactoryConfigurationError
    • newTransformerHandler

      public TransformerHandler newTransformerHandler(Source src) throws 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 SAXTransformerFactory
      Parameters:
      src - The Source of the transformation instructions.
      Returns:
      TransformerHandler ready to transform SAX events.
      Throws:
      TransformerConfigurationException - If for some reason the TransformerHandler can not be created.
    • newTransformerHandler

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

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

      public TemplatesHandler newTemplatesHandler() throws TransformerConfigurationException
      Get a TemplatesHandler object that can process SAX ContentHandler events into a Templates object.
      Specified by:
      newTemplatesHandler in class SAXTransformerFactory
      Returns:
      A non-null reference to a TransformerHandler, that may be used as a ContentHandler for SAX parse events.
      Throws:
      TransformerConfigurationException - If for some reason the TemplatesHandler cannot be created.
    • newXMLFilter

      public XMLFilter newXMLFilter(Source src) throws TransformerConfigurationException
      Create an XMLFilter that uses the given Source as the transformation instructions.
      Specified by:
      newXMLFilter in class SAXTransformerFactory
      Parameters:
      src - The Source of the transformation instructions.
      Returns:
      An XMLFilter object, or null if this feature is not supported.
      Throws:
      TransformerConfigurationException - If for some reason the XMLFilter cannot be created.
    • newXMLFilter

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