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: Transformer.java,v 1.1.1.1 2003-02-01 02:10:27 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.util.Properties;
/**
* Apply a transformation from a source, populating a result.
* Transformers may be reused, but not concurrently.
*
* @author Andrew Selkirk, David Brownell
* @version 1.0
*/
public abstract class Transformer {
//-------------------------------------------------------------
// Initialization ---------------------------------------------
//-------------------------------------------------------------
/** Default constructor, for use only by subclasses. */
protected Transformer() {
} // Transformer()
//-------------------------------------------------------------
// Methods ----------------------------------------------------
//-------------------------------------------------------------
/**
* Clears all parameter settings.
* @see #setParameter
*/
public abstract void clearParameters();
/** Returns the error handler used as documents are transformed. */
public abstract ErrorListener getErrorListener();
/**
* Returns a copy of the transformer's non-default output properties.
* That is, properties set in the stylesheet or through
* methods on this class are not set.
* @see OutputKeys
* @see #setOutputProperties
*/
public abstract Properties getOutputProperties();
/**
* Returns the value of a property applying to this transform.
* Values returned by this method are only those that have
* been set explicitly.
* @see OutputKeys
* @see #setOutputProperty
*/
public abstract String getOutputProperty(String name)
throws IllegalArgumentException;
/**
* Returns the value of a parameter passed to this transform.
* These are primarily for use access within transformations
* and extensions.
* @see #setParameter
*/
public abstract Object getParameter(String name);
/** Returns the resolver applied to documents being transformed. */
public abstract URIResolver getURIResolver();
/** Assigns the error handler used as documents are transformed. */
public abstract void setErrorListener(ErrorListener listener)
throws IllegalArgumentException;
/**
* Assigns a set of output properties, as if made by multiple
* calls to {@link #setOutputProperty}.
* @see OutputKeys
* @param outputformat set of properties, or null to reset all
* properties to their default values
*/
public abstract void setOutputProperties(Properties outputformat)
throws IllegalArgumentException;
/**
* Assigns the value of a transformation property, affecting
* generation of output (mostly text syntax). Parameters include
* those defined by the xslt:output element. Default settings may
* be explicitly overridden.
* @see OutputKeys
* @see #getOutputProperty
* @see #setOutputProperties
* @param name an XML name, or a namespace-scoped XML name
* encoded as <em>{uri}localName</em>.
* @param value associated with the name
*/
public abstract void setOutputProperty(String name, String value)
throws IllegalArgumentException;
/**
* Assigns the value of a parameter passed to this transform.
* These are primarily for use access within transformations
* and extensions.
* @see #getParameter
* @see #clearParameters
* @param name an XML name, or a namespace-scoped XML name
* encoded as <em>{uri}localName</em>.
* @param value associated with the name
*/
public abstract void setParameter(String name, Object value);
/** Assigns the resolver applied to documents being transformed. */
public abstract void setURIResolver(URIResolver resolver);
/** Apply the appropriate transformation */
public abstract void transform(Source source, Result result)
throws TransformerException;
} // Transformer
|
