Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
SAXTransformerFactory
com.icl.saxon.TransformerFactoryImpl
public class TransformerFactoryImpl
extends SAXTransformerFactory
Constructor Summary | |
|
Method Summary | |
Source |
|
Source |
|
Object |
|
ErrorListener |
|
boolean |
|
SAXSource |
|
XMLReader |
|
XMLReader |
|
URIResolver |
|
static XMLReader |
|
Templates |
|
TemplatesHandler |
|
Transformer |
|
Transformer |
|
TransformerHandler |
|
TransformerHandler |
|
TransformerHandler |
|
XMLFilter |
|
XMLFilter |
|
void |
|
void |
|
void |
|
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.
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.
- 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.
public Object getAttribute(String name) throws 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.
public ErrorListener getErrorListener()
Get the error event handler for the TransformerFactory.
- Returns:
- The current error handler, which should never be null.
public boolean getFeature(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).
public SAXSource getSAXSource(Source source, boolean isStyleSheet)
Convert a supplied Source to a SAXSource
- Parameters:
source
- The supplied input sourceisStyleSheet
- true if the source is a stylesheet
- Returns:
- a SAXSource
public XMLReader getSourceParser() throws TransformerFactoryConfigurationError
Get the parser for source documents
public XMLReader getStyleParser() throws TransformerFactoryConfigurationError
Get the parser for stylesheet documents
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.
- Returns:
- The URIResolver that was set with setURIResolver.
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.
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.
- Parameters:
source
- An object that holds a URL, input stream, etc.
- Returns:
- A Templates object capable of being used for transformation purposes, never null.
public 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.
public Transformer newTransformer() throws TransformerConfigurationException
Create a new Transformer object that performs a copy of the source to the result.
- Returns:
- A Transformer object that may be used to perform a transformation in a single thread, never null.
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.
- 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.
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.
- Returns:
- A non-null reference to a TransformerHandler, that may be used as a ContentHandler for SAX parse events.
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.
- Parameters:
src
- The Source of the transformation instructions.
- Returns:
- TransformerHandler ready to transform SAX events.
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.
- Parameters:
templates
- The compiled transformation instructions.
- Returns:
- TransformerHandler ready to transform SAX events.
public 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.
public 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.
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.
- Parameters:
name
- The name of the attribute. This must be one of the constants defined in class FeatureKeys.value
- The value of the attribute.
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.
- Parameters:
listener
- The new error listener.
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.
- Parameters:
resolver
- An object that implements the URIResolver interface, or null.