001 /*
002 * Copyright 2000-2005 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package javax.xml.transform.sax;
027
028 import javax.xml.transform.*;
029
030 import org.xml.sax.XMLFilter;
031
032 /**
033 * This class extends TransformerFactory to provide SAX-specific
034 * factory methods. It provides two types of ContentHandlers,
035 * one for creating Transformers, the other for creating Templates
036 * objects.
037 *
038 * <p>If an application wants to set the ErrorHandler or EntityResolver
039 * for an XMLReader used during a transformation, it should use a URIResolver
040 * to return the SAXSource which provides (with getXMLReader) a reference to
041 * the XMLReader.</p>
042 */
043 public abstract class SAXTransformerFactory extends TransformerFactory {
044
045 /** If {@link javax.xml.transform.TransformerFactory#getFeature}
046 * returns true when passed this value as an argument,
047 * the TransformerFactory returned from
048 * {@link javax.xml.transform.TransformerFactory#newInstance} may
049 * be safely cast to a SAXTransformerFactory.
050 */
051 public static final String FEATURE = "http://javax.xml.transform.sax.SAXTransformerFactory/feature";
052
053 /** If {@link javax.xml.transform.TransformerFactory#getFeature}
054 * returns true when passed this value as an argument,
055 * the {@link #newXMLFilter(Source src)}
056 * and {@link #newXMLFilter(Templates templates)} methods are supported.
057 */
058 public static final String FEATURE_XMLFILTER = "http://javax.xml.transform.sax.SAXTransformerFactory/feature/xmlfilter";
059
060 /**
061 * The default constructor is protected on purpose.
062 */
063 protected SAXTransformerFactory() {
064 }
065
066 /**
067 * Get a TransformerHandler object that can process SAX
068 * ContentHandler events into a Result, based on the transformation
069 * instructions specified by the argument.
070 *
071 * @param src The Source of the transformation instructions.
072 *
073 * @return TransformerHandler ready to transform SAX events.
074 *
075 * @throws TransformerConfigurationException If for some reason the
076 * TransformerHandler can not be created.
077 */
078 public abstract TransformerHandler newTransformerHandler(Source src)
079 throws TransformerConfigurationException;
080
081 /**
082 * Get a TransformerHandler object that can process SAX
083 * ContentHandler events into a Result, based on the Templates argument.
084 *
085 * @param templates The compiled transformation instructions.
086 *
087 * @return TransformerHandler ready to transform SAX events.
088 *
089 * @throws TransformerConfigurationException If for some reason the
090 * TransformerHandler can not be created.
091 */
092 public abstract TransformerHandler newTransformerHandler(
093 Templates templates)
094 throws TransformerConfigurationException;
095
096 /**
097 * Get a TransformerHandler object that can process SAX
098 * ContentHandler events into a Result. The transformation
099 * is defined as an identity (or copy) transformation, for example
100 * to copy a series of SAX parse events into a DOM tree.
101 *
102 * @return A non-null reference to a TransformerHandler, that may
103 * be used as a ContentHandler for SAX parse events.
104 *
105 * @throws TransformerConfigurationException If for some reason the
106 * TransformerHandler cannot be created.
107 */
108 public abstract TransformerHandler newTransformerHandler()
109 throws TransformerConfigurationException;
110
111 /**
112 * Get a TemplatesHandler object that can process SAX
113 * ContentHandler events into a Templates object.
114 *
115 * @return A non-null reference to a TransformerHandler, that may
116 * be used as a ContentHandler for SAX parse events.
117 *
118 * @throws TransformerConfigurationException If for some reason the
119 * TemplatesHandler cannot be created.
120 */
121 public abstract TemplatesHandler newTemplatesHandler()
122 throws TransformerConfigurationException;
123
124 /**
125 * Create an XMLFilter that uses the given Source as the
126 * transformation instructions.
127 *
128 * @param src The Source of the transformation instructions.
129 *
130 * @return An XMLFilter object, or null if this feature is not supported.
131 *
132 * @throws TransformerConfigurationException If for some reason the
133 * TemplatesHandler cannot be created.
134 */
135 public abstract XMLFilter newXMLFilter(Source src)
136 throws TransformerConfigurationException;
137
138 /**
139 * Create an XMLFilter, based on the Templates argument..
140 *
141 * @param templates The compiled transformation instructions.
142 *
143 * @return An XMLFilter object, or null if this feature is not supported.
144 *
145 * @throws TransformerConfigurationException If for some reason the
146 * TemplatesHandler cannot be created.
147 */
148 public abstract XMLFilter newXMLFilter(Templates templates)
149 throws TransformerConfigurationException;
150 }
|