javax.xml.transform

Class TransformerFactory

Known Direct Subclasses:
GnomeTransformerFactory, SAXTransformerFactory

public abstract class TransformerFactory
extends Object

Factory for obtaining transformation contexts.

Constructor Summary

TransformerFactory()
The basic constructor.

Method Summary

abstract Source
getAssociatedStylesheet(Source source, String media, String title, String charset)
Returns a source object representing the XML resource specified by the xml-stylesheet processing instruction and matching the given criteria.
abstract Object
getAttribute(String name)
Retrieve the specified named attribute value.
abstract ErrorListener
getErrorListener()
Returns the callback to be used by transformers obtained from this factory to report transformation errors.
abstract boolean
getFeature(String name)
Returns the state of a feature in the factory implementation.
abstract URIResolver
getURIResolver()
Returns the resolver callback to be used by transformers obtained from this factory.
static TransformerFactory
newInstance()
Creates a new factory instance.
abstract Templates
newTemplates(Source source)
Creates a new compiled transformation using the specified stylesheet.
abstract Transformer
newTransformer()
Creates a new transformer that applies the identity transform.
abstract Transformer
newTransformer(Source source)
Creates a new transformer using the specified stylesheet.
abstract void
setAttribute(String name, Object value)
Set a named attribute on the underlying implementation.
abstract void
setErrorListener(ErrorListener listener)
Sets the callback to be used by transformers obtained from this factory to report transformation errors.
abstract void
setFeature(String name, boolean value)
Sets a feature of transformers and templates obtained from this factory.
abstract void
setURIResolver(URIResolver resolver)
Set the resolver callback to be used by transformers obtained from this factory.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TransformerFactory

protected TransformerFactory()
The basic constructor. Object is special, because it has no superclass, so there is no call to super().

Method Details

getAssociatedStylesheet

public abstract Source getAssociatedStylesheet(Source source,
                                               String media,
                                               String title,
                                               String charset)
            throws TransformerConfigurationException
Returns a source object representing the XML resource specified by the xml-stylesheet processing instruction and matching the given criteria. Note that if multiple stylesheets are selected, the source represents a stylesheet composed of a list of imports.
Parameters:
source - the source XML document
media - the media attribute to match, or null to match the preferred templates
title - the title attribute to match, or null to match any
charset - the charset attribute to match, or null to match any

getAttribute

public abstract Object getAttribute(String name)
            throws IllegalArgumentException
Retrieve the specified named attribute value.
Parameters:
name - the attribute name
Throws:
IllegalArgumentException - if the attribute is not supported

getErrorListener

public abstract ErrorListener getErrorListener()
Returns the callback to be used by transformers obtained from this factory to report transformation errors.

getFeature

public abstract boolean getFeature(String name)
Returns the state of a feature in the factory implementation. Feature names are fully qualified URIs, and may depend on the factory implementation. JAXP also predefines several features, including the constants in XMLConstants and The latter expose various capabilities of the factory implementation.

getURIResolver

public abstract URIResolver getURIResolver()
Returns the resolver callback to be used by transformers obtained from this factory.

newInstance

public static TransformerFactory newInstance()
            throws TransformerFactoryConfigurationError
Creates a new factory instance. The implementation class to load is the first found in the following locations:
  1. the javax.xml.transform.TransformerFactory system property
  2. the above named property value in the $JAVA_HOME/lib/jaxp.properties file
  3. the class name specified in the META-INF/services/javax.xml.parsers.DocumentBuilderFactory system resource
  4. the default factory class

newTemplates

public abstract Templates newTemplates(Source source)
            throws TransformerConfigurationException
Creates a new compiled transformation using the specified stylesheet.
Parameters:
source - the source of an XSLT stylesheet specifying the transformation to apply

newTransformer

public abstract Transformer newTransformer()
            throws TransformerConfigurationException
Creates a new transformer that applies the identity transform.

newTransformer

public abstract Transformer newTransformer(Source source)
            throws TransformerConfigurationException
Creates a new transformer using the specified stylesheet.
Parameters:
source - the source of an XSLT stylesheet specifying the transformation to apply

setAttribute

public abstract void setAttribute(String name,
                                  Object value)
            throws IllegalArgumentException
Set a named attribute on the underlying implementation.
Parameters:
name - the attribute name
value - the value to assign
Throws:
IllegalArgumentException - if the attribute is not supported

setErrorListener

public abstract void setErrorListener(ErrorListener listener)
            throws IllegalArgumentException
Sets the callback to be used by transformers obtained from this factory to report transformation errors.

setFeature

public abstract void setFeature(String name,
                                boolean value)
            throws TransformerConfigurationException
Sets a feature of transformers and templates obtained from this factory. Feature names are fully qualified URIs, and may depend on the factory implementation.
Parameters:
name - the name of the feature
value - the feature state
Throws:
TransformerConfigurationException - if the feature is unsupported

setURIResolver

public abstract void setURIResolver(URIResolver resolver)
Set the resolver callback to be used by transformers obtained from this factory.

TransformerFactory.java -- Copyright (C) 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.