SAXTransformerFactory (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.xml.transform.sax
class SAXTransformerFactory

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

Most common ways to construct:

SAXTransformerFactory tf = (SAXTransformerFactory)TransformerFactory.newInstance();

Based on 26 examples

SAXTransformerFactory factory = (SAXTransformerFactory)SAXTransformerFactory.newInstance();

Based on 20 examples

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 String`	`FEATURE` If javax.xml.transform.TransformerFactory.getFeature returns true when passed this value as an argument, the TransformerFactory returned from javax.xml.transform.TransformerFactory.newInstance may be safely cast to a SAXTransformerFactory.
`static String`	`FEATURE_XMLFILTER` If javax.xml.transform.TransformerFactory.getFeature returns true when passed this value as an argument, the javax.xml.transform.sax.SAXTransformerFactory.newXMLFilter and javax.xml.transform.sax.SAXTransformerFactory.newXMLFilter methods are supported.

Constructor Summary
`protected`	`SAXTransformerFactory()` The default constructor is protected on purpose.

Method Summary
`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..

Methods inherited from class javax.xml.transform.TransformerFactory
`getAssociatedStylesheet, getAttribute, getErrorListener, getFeature, getURIResolver, newInstance, newInstance, newTemplates, newTransformer, newTransformer, setAttribute, setErrorListener, setFeature, setURIResolver`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

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()
                                              throws TransformerConfigurationException

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()
                                                  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.

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.

newTransformerHandler

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

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)
                                                  throws TransformerConfigurationException

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.

newXMLFilter

public abstract XMLFilter newXMLFilter(Source src)
                                throws TransformerConfigurationException

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)
                                throws TransformerConfigurationException

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.