javax.xml.transform.sax

Class SAXTransformerFactory

public abstract class SAXTransformerFactory extends TransformerFactory

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.

Field Summary
static StringFEATURE
If {@link javax.xml.transform.TransformerFactory#getFeature} returns true when passed this value as an argument, the TransformerFactory returned from {@link javax.xml.transform.TransformerFactory#newInstance} may be safely cast to a SAXTransformerFactory.
static StringFEATURE_XMLFILTER
If {@link javax.xml.transform.TransformerFactory#getFeature} returns true when passed this value as an argument, the {@link #newXMLFilter(Source src)} and {@link #newXMLFilter(Templates templates)} methods are supported.
Constructor Summary
protected SAXTransformerFactory()
The default constructor is protected on purpose.
Method Summary
abstract TemplatesHandlernewTemplatesHandler()
Get a TemplatesHandler object that can process SAX ContentHandler events into a Templates object.
abstract TransformerHandlernewTransformerHandler(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 TransformerHandlernewTransformerHandler(Templates templates)
Get a TransformerHandler object that can process SAX ContentHandler events into a Result, based on the Templates argument.
abstract TransformerHandlernewTransformerHandler()
Get a TransformerHandler object that can process SAX ContentHandler events into a Result.
abstract XMLFilternewXMLFilter(Source src)
Create an XMLFilter that uses the given Source as the transformation instructions.
abstract XMLFilternewXMLFilter(Templates templates)
Create an XMLFilter, based on the Templates argument..

Field Detail

FEATURE

public static final String FEATURE
If {@link javax.xml.transform.TransformerFactory#getFeature} returns true when passed this value as an argument, the TransformerFactory returned from {@link javax.xml.transform.TransformerFactory#newInstance} may be safely cast to a SAXTransformerFactory.

FEATURE_XMLFILTER

public static final String FEATURE_XMLFILTER
If {@link javax.xml.transform.TransformerFactory#getFeature} returns true when passed this value as an argument, the {@link #newXMLFilter(Source src)} and {@link #newXMLFilter(Templates templates)} methods are supported.

Constructor Detail

SAXTransformerFactory

protected SAXTransformerFactory()
The default constructor is protected on purpose.

Method Detail

newTemplatesHandler

public abstract TemplatesHandler newTemplatesHandler()
Get a TemplatesHandler object that can process SAX ContentHandler events into a Templates object.

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.

newTransformerHandler

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 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 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 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 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: 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.

newXMLFilter

public abstract XMLFilter newXMLFilter(Source src)
Create an XMLFilter that uses the given Source as the transformation instructions.

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 TemplatesHandler cannot be created.

newXMLFilter

public abstract XMLFilter newXMLFilter(Templates templates)
Create an XMLFilter, based on the Templates argument..

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 TemplatesHandler cannot be created.