summaryrefslogtreecommitdiff
path: root/external/jaxp/source/javax/xml/transform/TransformerFactory.java
blob: 4be4f030fa5884cd9a5a96f8bdee445be0f7a358 (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
/*
 * $Id: TransformerFactory.java,v 1.1.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;

// Imports
import java.io.IOException;
import java.io.InputStream;
import java.io.FileInputStream;
import java.io.File;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.util.Properties;

/**
 * Abstract class extended by implementations.
 *
 * @author	Andrew Selkirk, David Brownell
 * @version	1.0
 */
public abstract class TransformerFactory {

	/** Constructor, for use by subclasses. */
	protected TransformerFactory() {
	}


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

	/**
	 * Returns an object encapsulating the <?xml-stylesheet ?>
	 * processing instruction from the document that matches the
	 * specified criteria.
	 */
	public abstract Source getAssociatedStylesheet(Source source, 
		String media, String title, String charset) 
		throws TransformerConfigurationException;

	/** Returns an implementation-specific attribute */
	public abstract Object getAttribute(String name) 
		throws IllegalArgumentException;

	/** Returns the ErrorListener used when parsing stylesheets. */
	public abstract ErrorListener getErrorListener();

	/**
	 * Exposes capabilities of the underlying implementation.
	 * Examples include SAXSource.FEATURE and DOMResult.FEATURE.
	 */
	public abstract boolean getFeature(String name);

	/** Returns the URIResolver used when parsing stylesheets. */
	public abstract URIResolver getURIResolver();


	/**
	 * Returns a new TransformerFactory.  The name of this class
	 * is found by checking, in order:
	 * the <em>javax.xml.transform.TransformerFactory</em>
	 *	system property,
	 * <em>$JAVA_HOME/lib/jaxp.properties</em> for the key with
	 *	that same name,
	 * JAR files in the class path with a <em>META-INF/services</em>
	 *	file with that same name,
	 * else the compiled-in platform default.
	 */
	public static TransformerFactory newInstance() 
	throws TransformerFactoryConfigurationError
	{
	    try {
		return (TransformerFactory) ClassStuff.createFactory (
			"javax.xml.transform.TransformerFactory",
			"com.icl.saxon.TransformerFactoryImpl"
			// "gnu.xml.util.SAXNullTransformerFactory"
			// "org.apache.xalan.processor.TransformerFactoryImpl"
			);
	    } catch (ClassCastException e) {
		throw new TransformerFactoryConfigurationError(e);
	    }
	}


	/**
	 * Returns a pre-compiled stylesheet.
	 * @param stylesheet XSLT stylesheet specifying transform
	 */
	public abstract Templates newTemplates (Source stylesheet) 
		throws TransformerConfigurationException;

	/**
	 * Returns a transformer that performs the null transform.
	 */
	public abstract Transformer newTransformer() 
		throws TransformerConfigurationException;

	/**
	 * Returns a transformer making a specified transform.
	 * @param stylesheet XSLT stylesheet specifying transform
	 */
	public abstract Transformer newTransformer (Source stylesheet) 
		throws TransformerConfigurationException;


	/** Assigns an implementation-specific attribute */
	public abstract void setAttribute(String name, Object value)
		throws IllegalArgumentException;

	/** Assigns the ErrorListener used when parsing stylesheets. */
	public abstract void setErrorListener(ErrorListener listener) 
		throws IllegalArgumentException;

	/** Assigns the URIResolver used when parsing stylesheets. */
	public abstract void setURIResolver(URIResolver resolver);
}