SAXTransformerFactory

public abstract class SAXTransformerFactory
extends TransformerFactory

java.lang.Object
   ↳ javax.xml.transform.TransformerFactory
     ↳ javax.xml.transform.sax.SAXTransformerFactory


This class extends TransformerFactory to provide SAX-specific factory methods. It provides two types of ContentHandlers, one for creating Transformers, the other for creating Templates objects.

If an application wants to set the ErrorHandler or EntityResolver for an XMLReader used during a transformation, it should use a URIResolver to return the SAXSource which provides (with getXMLReader) a reference to the XMLReader.

Summary

Constants

String FEATURE

If TransformerFactory.getFeature(String) returns true when passed this value as an argument, the TransformerFactory returned from TransformerFactory.newInstance() may be safely cast to a SAXTransformerFactory.

String FEATURE_XMLFILTER

If TransformerFactory.getFeature(String) returns true when passed this value as an argument, the newXMLFilter(javax.xml.transform.Source) and newXMLFilter(javax.xml.transform.Templates) methods are supported.

Protected constructors

SAXTransformerFactory()

The default constructor is protected on purpose.

Public methods

abstract TemplatesHandler newTemplatesHandler()

Get a TemplatesHandler object that can process SAX ContentHandler events into a Templates object.

abstract TransformerHandler newTransformerHandler()

Get a TransformerHandler object that can process SAX ContentHandler events into a Result.

abstract TransformerHandler newTransformerHandler(Source src)

Get a TransformerHandler object that can process SAX ContentHandler events into a Result, based on the transformation instructions specified by the argument.

abstract TransformerHandler newTransformerHandler(Templates templates)

Get a TransformerHandler object that can process SAX ContentHandler events into a Result, based on the Templates argument.

abstract XMLFilter newXMLFilter(Source src)

Create an XMLFilter that uses the given Source as the transformation instructions.

abstract XMLFilter newXMLFilter(Templates templates)

Create an XMLFilter, based on the Templates argument..

Inherited methods

Constants

FEATURE

Added in API level 8
public static final String FEATURE

If TransformerFactory.getFeature(String) returns true when passed this value as an argument, the TransformerFactory returned from TransformerFactory.newInstance() may be safely cast to a SAXTransformerFactory.

Constant Value: "http://javax.xml.transform.sax.SAXTransformerFactory/feature"

FEATURE_XMLFILTER

Added in API level 8
public static final String FEATURE_XMLFILTER

If TransformerFactory.getFeature(String) returns true when passed this value as an argument, the newXMLFilter(javax.xml.transform.Source) and newXMLFilter(javax.xml.transform.Templates) methods are supported.

Constant Value: "http://javax.xml.transform.sax.SAXTransformerFactory/feature/xmlfilter"

Protected constructors

SAXTransformerFactory

Added in API level 8
protected SAXTransformerFactory ()

The default constructor is protected on purpose.

Public methods

newTemplatesHandler

Added in API level 8
public abstract TemplatesHandler newTemplatesHandler ()

Get a TemplatesHandler object that can process SAX ContentHandler events into a Templates object.

Returns
TemplatesHandler 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.

newTransformerHandler

Added in API level 8
public abstract TransformerHandler newTransformerHandler ()

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.

Returns
TransformerHandler 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.

newTransformerHandler

Added in API level 8
public abstract TransformerHandler newTransformerHandler (Source src)

Get a TransformerHandler object that can process SAX ContentHandler events into a Result, based on the transformation instructions specified by the argument.

Parameters
src Source: The Source of the transformation instructions.

Returns
TransformerHandler TransformerHandler ready to transform SAX events.

Throws
TransformerConfigurationException If for some reason the TransformerHandler can not be created.

newTransformerHandler

Added in API level 8
public abstract TransformerHandler newTransformerHandler (Templates templates)

Get a TransformerHandler object that can process SAX ContentHandler events into a Result, based on the Templates argument.

Parameters
templates Templates: The compiled transformation instructions.

Returns
TransformerHandler TransformerHandler ready to transform SAX events.

Throws
TransformerConfigurationException If for some reason the TransformerHandler can not be created.

newXMLFilter

Added in API level 8
public abstract XMLFilter newXMLFilter (Source src)

Create an XMLFilter that uses the given Source as the transformation instructions.

Parameters
src Source: The Source of the transformation instructions.

Returns
XMLFilter An XMLFilter object, or null if this feature is not supported.

Throws
TransformerConfigurationException If for some reason the TemplatesHandler cannot be created.

newXMLFilter

Added in API level 8
public abstract XMLFilter newXMLFilter (Templates templates)

Create an XMLFilter, based on the Templates argument..

Parameters
templates Templates: The compiled transformation instructions.

Returns
XMLFilter An XMLFilter object, or null if this feature is not supported.

Throws
TransformerConfigurationException If for some reason the TemplatesHandler cannot be created.