summaryrefslogtreecommitdiff
path: root/external/jaxp/source/javax/xml/transform/sax/SAXTransformerFactory.java
blob: 615f8c05707cc0b981e262cd076e8c9cb9fa2338 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
/*
 * $Id: SAXTransformerFactory.java,v 1.1 2003-02-01 02:10:28 cbj Exp $
 * Copyright (C) 2001 Andrew Selkirk
 * Copyright (C) 2001 David Brownell
 * 
 * This file is part of GNU JAXP, a library.
 *
 * GNU JAXP 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 of the License, or
 * (at your option) any later version.
 * 
 * GNU JAXP 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 this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * As a special exception, if you link this library with other files to
 * produce an executable, this library does not by itself cause the
 * resulting executable to be covered by the GNU General Public License.
 * This exception does not however invalidate any other reasons why the
 * executable file might be covered by the GNU General Public License. 
 */
package javax.xml.transform.sax;

// Imports
import org.xml.sax.InputSource;
import org.xml.sax.XMLFilter;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.Result;
import javax.xml.transform.Source;
import javax.xml.transform.Templates;
import javax.xml.transform.TransformerConfigurationException;

/**
 * A TransformerFactory that supports several separate modes for
 * working with SAX inputs and outputs.  Those modes include: <ul>
 *
 * <li> Pipeline Stage, pushing events through {@link TransformerHandler}
 *	objects used as SAX handlers, and passing the transformed data
 *	through a {@link SAXResult} encapsulating SAX ContentHandler and
 *	LexicalHandler objects;
 * <li> Pipeline Termination, like a normal pipeline stage but using some
 *	other kind of {@link Result} to store transformed data rather than
 *	passing it to another stage;
 * <li> Event producer, an {@link XMLFilter} object taking data from a URI
 *	or from a SAX {@link InputSource} input object and delivering it
 *	to a SAX ContentHandler;
 * <li>	Transformer objects produced by this factory will usually be able
 *	to accept {@link SAXSource} objects as inputs, and the XMLReader
 *	object in such a source could be an XMLFilter.
 * </ul>
 *
 * <p>Transformer objects produced by this factory will of course be
 * able to perform {@link Transformer#transform Transformer.transform()}
 * operations to map XML text into other text.
 *
 * <p>The factory also supports creating Templates objects.
 * 
 * @author	Andrew Selkirk, David Brownell
 * @version	1.0
 */
public abstract class SAXTransformerFactory extends TransformerFactory
{
	/**
	 * Used with <em>TransformerFactory.getFeature()</em> to determine
	 * whether the transformers it produces extend this class.
	 */
	public static final String FEATURE =
		"http://javax.xml.transform.sax.SAXTransformerFactory/feature";

	/**
	 * Used with <em>TransformerFactory.getFeature()</em> to determine
	 * whether <em>newXMLFilter()</em> methods are supported.
	 */
	public static final String FEATURE_XMLFILTER =
		"http://javax.xml.transform.sax.SAXTransformerFactory/feature/xmlfilter";


	//-------------------------------------------------------------
	// Initialization ---------------------------------------------
	//-------------------------------------------------------------

	/** Constructor, for use with subclasses */
	protected SAXTransformerFactory() {
	}


	//-------------------------------------------------------------
	// Methods ----------------------------------------------------
	//-------------------------------------------------------------

	/**
	 * Returns a SAX event consumer sending its inputs to some Result
	 * after transforming them according to a stylesheet.
	 */
	public abstract TransformerHandler
	newTransformerHandler (Source stylesheet)
		throws TransformerConfigurationException;

	/**
	 * Returns a SAX event consumer sending its inputs to some Result
	 * after transforming them according to a pre-parsed stylesheet.
	 */
	public abstract TransformerHandler
	newTransformerHandler (Templates stylesheet)
		throws TransformerConfigurationException;

	/**
	 * Returns a SAX event consumer sending its inputs to some Result
	 * without transforming them (null transformation).
	 */
	public abstract TransformerHandler newTransformerHandler()
		throws TransformerConfigurationException;

	/**
	 * Returns a SAX parser that transforms XML data according 
	 * to a stylesheet before reporting SAX events.
	 */
	public abstract XMLFilter newXMLFilter (Source stylesheet)
		throws TransformerConfigurationException;

	/**
	 * Returns a SAX parser that transforms XML data according 
	 * to a pre-parsed stylesheet before reporting SAX events.
	 */
	public abstract XMLFilter newXMLFilter (Templates stylesheet)
		throws TransformerConfigurationException;

	/**
	 * Returns a SAX event consumer collecting its inputs into
	 * a pre-parsed stylesheet.
	 */
	public abstract TemplatesHandler newTemplatesHandler()
		throws TransformerConfigurationException;

}