Google

: Class TransformerFactory


Class TransformerFactory


java.lang.Object

  |



public abstract class TransformerFactory
extends java.lang.Object

A TransformerFactory instance can be used to create Transformer and Template objects.

The system property that determines which Factory implementation property names a concrete subclass of the TransformerFactory abstract class. If the property is not defined, a platform default is be used.



          Default constructor is protected on purpose.
Constructor Summary
protected
 
          Allows the user to retrieve specific attributes on the underlying implementation.
          Look up the value of a feature. java.lang.Object value)
          Allows the user to set specific attributes on the underlying implementation.
          Set the error event listener for the TransformerFactory, which is used for the processing of transformation instructions, and not for the transformation itself.
          Set an object that is used by default during the transformation to resolve URIs used in xsl:import, or xsl:include.
Method Summary
java.lang.String media, java.lang.String title, java.lang.String charset)
          Get the stylesheet specification(s) associated document specified in the source parameter, and that match the given criteria.
abstract  java.lang.Object

          Get the error event handler for the TransformerFactory.
abstract  boolean

          Get the object that is used by default during the transformation to resolve URIs used in document(), xsl:import, or xsl:include.

          Obtain a new instance of a TransformerFactory.

          Process the Source into a Templates object, which is a a compiled representation of the source.

          Create a new Transformer object that performs a copy of the source to the result.

          Process the Source into a Transformer object.
abstract  void
abstract  void
abstract  void
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TransformerFactory


protected TransformerFactory()
Default constructor is protected on purpose.
Method Detail

newInstance



Obtain a new instance of a TransformerFactory. This static method creates a new factory instance This method uses the following ordered lookup procedure to determine the TransformerFactory implementation class to load:
  • property.
  • Use the JAVA_HOME(the parent directory where jdk is installed)/lib/jaxp.properties for a property file that contains the name of the implementation class keyed on the same value as the system property defined above.
  • Use the Services API (as detailed in the JAR specification), if available, to determine the classname. The Services API will look for a classname in the file in jars available to the runtime.
  • Platform default TransformerFactory instance.
Once an application has obtained a reference to a TransformerFactory it can use the factory to configure and obtain parser instances.

newTransformer


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.
Parameters:
source - An object that holds a URI, input stream, etc.
Returns:
A Transformer object that may be used to perform a transformation when it is constructing the Templates object and fails.

newTransformer



Create a new Transformer object that performs a copy of the source to the result.
Parameters:
source - An object that holds a URI, input stream, etc.
Returns:
A Transformer object that may be used to perform a transformation the parse when it is constructing the Templates object and fails.

newTemplates


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.
Parameters:
source - An object that holds a URL, input stream, etc.
Returns:
A Templates object capable of being used for transformation purposes, is constructing the Templates object and fails.

getAssociatedStylesheet

                                               java.lang.String media,
                                               java.lang.String title,
                                               java.lang.String charset)

Get the stylesheet specification(s) associated 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 in a single stylesheet.
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. -  

setURIResolver


Set an object that is used by default during the transformation to resolve URIs used in xsl:import, or xsl:include.
Parameters:
resolver - An object that implements the URIResolver interface, or null.

getURIResolver



Get the object that is used by default during the transformation to resolve URIs used in document(), xsl:import, or xsl:include.
Returns:
The URIResolver that was set with setURIResolver.

getFeature


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

The feature name is any absolute URI.

Parameters:
name - The feature name, which is an absolute URI.
Returns:
The current state of the feature (true or false).

setAttribute


public abstract 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.
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.

getAttribute


public abstract java.lang.Object getAttribute(java.lang.String name)
                                       throws java.lang.IllegalArgumentException
Allows the user to retrieve specific attributes on the underlying implementation.
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.

setErrorListener

                               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.
Parameters:
listener - The new error listener.
Throws:
java.lang.IllegalArgumentException - if listener is null.

getErrorListener



Get the error event handler for the TransformerFactory.
Returns:
The current error handler, which should never be null.