Project

General

Profile

1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
2
<!--NewPage-->
3
<html>
4
<head>
5
<!-- Generated by javadoc on Fri Sep 24 03:23:03 CEST 1999 -->
6
<title>
7
  Class de.tudarmstadt.ito.schemas.dtd.DTD
8
</title>
9
</head>
10
<body>
11
<a name="_top_"></a>
12
<pre>
13
<a href="packages.html">All Packages</a>  <a href="tree.html">Class Hierarchy</a>  <a href="Package-de.tudarmstadt.ito.schemas.dtd.html">This Package</a>  <a href="de.tudarmstadt.ito.schemas.dtd.Attribute.html#_top_">Previous</a>  <a href="de.tudarmstadt.ito.schemas.dtd.DTDConst.html#_top_">Next</a>  <a href="AllNames.html">Index</a></pre>
14
<hr>
15
<h1>
16
  Class de.tudarmstadt.ito.schemas.dtd.DTD
17
</h1>
18
<pre>
19
java.lang.Object
20
   |
21
   +----de.tudarmstadt.ito.schemas.dtd.DTD
22
</pre>
23
<hr>
24
<dl>
25
  <dt> public class <b>DTD</b>
26
  <dt> extends Object
27
</dl>
28
Class representing a DTD.
29
<p>
30
<hr>
31
<a name="index"></a>
32
<h2>
33
  <img src="images/variable-index.gif" width=207 height=38 alt="Variable Index">
34
</h2>
35
<dl>
36
  <dt> <img src="images/magenta-ball-small.gif" width=6 height=6 alt=" o ">
37
	<a href="#elementTypes"><b>elementTypes</b></a>
38
  <dd>  A Hashtable of ElementTypes defined in the DTD, keyed by the qualified
39
 element type name (ElementType.name.qualified).
40
  <dt> <img src="images/magenta-ball-small.gif" width=6 height=6 alt=" o ">
41
	<a href="#notations"><b>notations</b></a>
42
  <dd>  A Hashtable of Notations defined in the DTD, keyed by the notation name.
43
  <dt> <img src="images/magenta-ball-small.gif" width=6 height=6 alt=" o ">
44
	<a href="#parameterEntities"><b>parameterEntities</b></a>
45
  <dd>  A Hashtable of ParameterEntities defined in the DTD, keyed by the
46
 entity name.
47
  <dt> <img src="images/magenta-ball-small.gif" width=6 height=6 alt=" o ">
48
	<a href="#parsedGeneralEntities"><b>parsedGeneralEntities</b></a>
49
  <dd>  A Hashtable of ParsedGeneralEntities defined in the DTD, keyed by the
50
 entity name.
51
  <dt> <img src="images/magenta-ball-small.gif" width=6 height=6 alt=" o ">
52
	<a href="#unparsedEntities"><b>unparsedEntities</b></a>
53
  <dd>  A Hashtable of UnparsedEntities defined in the DTD, keyed by the
54
 entity name.
55
</dl>
56
<h2>
57
  <img src="images/constructor-index.gif" width=275 height=38 alt="Constructor Index">
58
</h2>
59
<dl>
60
  <dt> <img src="images/yellow-ball-small.gif" width=6 height=6 alt=" o ">
61
	<a href="#DTD()"><b>DTD</b></a>()
62
  <dd> Construct a new DTD.
63
</dl>
64
<h2>
65
  <img src="images/method-index.gif" width=207 height=38 alt="Method Index">
66
</h2>
67
<dl>
68
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
69
	<a href="#addElementType(de.tudarmstadt.ito.utils.NSName)"><b>addElementType</b></a>(NSName)
70
  <dd>  Add a new ElementType.
71
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
72
	<a href="#addElementType(java.lang.String, java.lang.String, java.lang.String)"><b>addElementType</b></a>(String, String, String)
73
  <dd>  Same as addElementType(NSName) except that the local name, prefix, and
74
 namespace URI are specified.
75
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
76
	<a href="#checkElementTypeReferences()"><b>checkElementTypeReferences</b></a>()
77
  <dd>  Checks that all element types referred to in the content models of
78
 ElementTypes have been added to the DTD through addElementType.
79
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
80
	<a href="#checkNotationReferences()"><b>checkNotationReferences</b></a>()
81
  <dd>  Checks that all notations referred to Attributes have been defined.
82
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
83
	<a href="#elementTypeDefined(de.tudarmstadt.ito.utils.NSName)"><b>elementTypeDefined</b></a>(NSName)
84
  <dd>  Checks if an element type has been defined -- that is, added with
85
 addElementType.
86
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
87
	<a href="#getElementType(de.tudarmstadt.ito.utils.NSName)"><b>getElementType</b></a>(NSName)
88
  <dd>  Get an ElementType.
89
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
90
	<a href="#getElementType(java.lang.String, java.lang.String, java.lang.String)"><b>getElementType</b></a>(String, String, String)
91
  <dd>  Same as getElementType(NSName) except that the local name, prefix, and
92
 namespace URI are specified.
93
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
94
	<a href="#serialize(java.io.OutputStream, boolean)"><b>serialize</b></a>(OutputStream, boolean)
95
  <dd>  Serialize a DTD to an OutputStream.
96
  <dt> <img src="images/red-ball-small.gif" width=6 height=6 alt=" o ">
97
	<a href="#updateANYParents()"><b>updateANYParents</b></a>()
98
  <dd>  For element types with a content model of ANY, constructs the parent
99
 and children Hashtables in the ElementType objects in the DTD.
100
</dl>
101
<a name="variables"></a>
102
<h2>
103
  <img src="images/variables.gif" width=153 height=38 alt="Variables">
104
</h2>
105
<a name="elementTypes"><img src="images/magenta-ball.gif" width=12 height=12 alt=" o "></a>
106
<b>elementTypes</b>
107
<pre>
108
 public Hashtable elementTypes
109
</pre>
110
<dl>
111
  <dd> A Hashtable of ElementTypes defined in the DTD, keyed by the qualified
112
 element type name (ElementType.name.qualified).<p>
113
</dl>
114
<a name="notations"><img src="images/magenta-ball.gif" width=12 height=12 alt=" o "></a>
115
<b>notations</b>
116
<pre>
117
 public Hashtable notations
118
</pre>
119
<dl>
120
  <dd> A Hashtable of Notations defined in the DTD, keyed by the notation name.<p>
121
</dl>
122
<a name="parsedGeneralEntities"><img src="images/magenta-ball.gif" width=12 height=12 alt=" o "></a>
123
<b>parsedGeneralEntities</b>
124
<pre>
125
 public Hashtable parsedGeneralEntities
126
</pre>
127
<dl>
128
  <dd> A Hashtable of ParsedGeneralEntities defined in the DTD, keyed by the
129
 entity name.<p>
130
</dl>
131
<a name="parameterEntities"><img src="images/magenta-ball.gif" width=12 height=12 alt=" o "></a>
132
<b>parameterEntities</b>
133
<pre>
134
 public Hashtable parameterEntities
135
</pre>
136
<dl>
137
  <dd> A Hashtable of ParameterEntities defined in the DTD, keyed by the
138
 entity name.<p>
139
</dl>
140
<a name="unparsedEntities"><img src="images/magenta-ball.gif" width=12 height=12 alt=" o "></a>
141
<b>unparsedEntities</b>
142
<pre>
143
 public Hashtable unparsedEntities
144
</pre>
145
<dl>
146
  <dd> A Hashtable of UnparsedEntities defined in the DTD, keyed by the
147
 entity name.<p>
148
</dl>
149
<a name="constructors"></a>
150
<h2>
151
  <img src="images/constructors.gif" width=231 height=38 alt="Constructors">
152
</h2>
153
<a name="DTD"></a>
154
<a name="DTD()"><img src="images/yellow-ball.gif" width=12 height=12 alt=" o "></a>
155
<b>DTD</b>
156
<pre>
157
 public DTD()
158
</pre>
159
<dl>
160
  <dd> Construct a new DTD.
161
<p>
162
</dl>
163
<a name="methods"></a>
164
<h2>
165
  <img src="images/methods.gif" width=151 height=38 alt="Methods">
166
</h2>
167
<a name="addElementType(de.tudarmstadt.ito.utils.NSName)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
168
<a name="addElementType"><b>addElementType</b></a>
169
<pre>
170
 public <a href="de.tudarmstadt.ito.schemas.dtd.ElementType.html#_top_">ElementType</a> addElementType(<a href="de.tudarmstadt.ito.utils.NSName.html#_top_">NSName</a> name) throws <a href="de.tudarmstadt.ito.schemas.dtd.DTDException.html#_top_">DTDException</a>
171
</pre>
172
<dl>
173
  <dd> Add a new ElementType. This method checks that the element type has
174
 not been added before.
175
<p>
176
  <dd><dl>
177
    <dt> <b>Parameters:</b>
178
    <dd> name - The NSName of the element type.
179
    <dt> <b>Throws:</b> <a href="de.tudarmstadt.ito.schemas.dtd.DTDException.html#_top_">DTDException</a>
180
    <dd> Thrown if addElementType has already been called
181
 for the element type.
182
  </dl></dd>
183
</dl>
184
<a name="getElementType(de.tudarmstadt.ito.utils.NSName)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
185
<a name="getElementType"><b>getElementType</b></a>
186
<pre>
187
 public <a href="de.tudarmstadt.ito.schemas.dtd.ElementType.html#_top_">ElementType</a> getElementType(<a href="de.tudarmstadt.ito.utils.NSName.html#_top_">NSName</a> name)
188
</pre>
189
<dl>
190
  <dd> Get an ElementType. If the ElementType does not exist, a new ElementType
191
 is created. Note that addElementType can still be called for ElementTypes
192
 created in this manner.
193
<p>
194
  <dd><dl>
195
    <dt> <b>Parameters:</b>
196
    <dd> name - The NSName of the element type.
197
  </dl></dd>
198
</dl>
199
<a name="addElementType(java.lang.String, java.lang.String, java.lang.String)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
200
<a name="addElementType"><b>addElementType</b></a>
201
<pre>
202
 public <a href="de.tudarmstadt.ito.schemas.dtd.ElementType.html#_top_">ElementType</a> addElementType(String local,
203
                                   String prefix,
204
                                   String uri) throws <a href="de.tudarmstadt.ito.schemas.dtd.DTDException.html#_top_">DTDException</a>
205
</pre>
206
<dl>
207
  <dd> Same as addElementType(NSName) except that the local name, prefix, and
208
 namespace URI are specified.
209
<p>
210
  <dd><dl>
211
    <dt> <b>Parameters:</b>
212
    <dd> local - The local name of the element type.
213
    <dd> prefix - The namespace prefix. May be null.
214
    <dd> uri - The namespace URI. May be null.
215
    <dt> <b>Throws:</b> <a href="de.tudarmstadt.ito.schemas.dtd.DTDException.html#_top_">DTDException</a>
216
    <dd> Thrown if addElementType has already been called
217
 for the element type.
218
  </dl></dd>
219
</dl>
220
<a name="getElementType(java.lang.String, java.lang.String, java.lang.String)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
221
<a name="getElementType"><b>getElementType</b></a>
222
<pre>
223
 public <a href="de.tudarmstadt.ito.schemas.dtd.ElementType.html#_top_">ElementType</a> getElementType(String local,
224
                                   String prefix,
225
                                   String uri)
226
</pre>
227
<dl>
228
  <dd> Same as getElementType(NSName) except that the local name, prefix, and
229
 namespace URI are specified.
230
<p>
231
  <dd><dl>
232
    <dt> <b>Parameters:</b>
233
    <dd> local - The local name of the element type.
234
    <dd> prefix - The namespace prefix. May be null.
235
    <dd> uri - The namespace URI. May be null.
236
  </dl></dd>
237
</dl>
238
<a name="updateANYParents()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
239
<a name="updateANYParents"><b>updateANYParents</b></a>
240
<pre>
241
 public void updateANYParents()
242
</pre>
243
<dl>
244
  <dd> For element types with a content model of ANY, constructs the parent
245
 and children Hashtables in the ElementType objects in the DTD. Note that
246
 operation cannot successfully be performed until after all ElementTypes
247
 have been added to the DTD.
248
<p>
249
</dl>
250
<a name="checkElementTypeReferences()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
251
<a name="checkElementTypeReferences"><b>checkElementTypeReferences</b></a>
252
<pre>
253
 public void checkElementTypeReferences() throws <a href="de.tudarmstadt.ito.schemas.dtd.DTDException.html#_top_">DTDException</a>
254
</pre>
255
<dl>
256
  <dd> Checks that all element types referred to in the content models of
257
 ElementTypes have been added to the DTD through addElementType.
258
<p>
259
  <dd><dl>
260
    <dt> <b>Throws:</b> <a href="de.tudarmstadt.ito.schemas.dtd.DTDException.html#_top_">DTDException</a>
261
    <dd> Thrown if an element type has been referred
262
  to but not added.
263
  </dl></dd>
264
</dl>
265
<a name="checkNotationReferences()"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
266
<a name="checkNotationReferences"><b>checkNotationReferences</b></a>
267
<pre>
268
 public void checkNotationReferences() throws <a href="de.tudarmstadt.ito.schemas.dtd.DTDException.html#_top_">DTDException</a>
269
</pre>
270
<dl>
271
  <dd> Checks that all notations referred to Attributes have been defined.
272
<p>
273
  <dd><dl>
274
    <dt> <b>Throws:</b> <a href="de.tudarmstadt.ito.schemas.dtd.DTDException.html#_top_">DTDException</a>
275
    <dd> Thrown if notation has been referred
276
  to but not defined.
277
  </dl></dd>
278
</dl>
279
<a name="elementTypeDefined(de.tudarmstadt.ito.utils.NSName)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
280
<a name="elementTypeDefined"><b>elementTypeDefined</b></a>
281
<pre>
282
 public boolean elementTypeDefined(<a href="de.tudarmstadt.ito.utils.NSName.html#_top_">NSName</a> name)
283
</pre>
284
<dl>
285
  <dd> Checks if an element type has been defined -- that is, added with
286
 addElementType.
287
<p>
288
  <dd><dl>
289
    <dt> <b>Parameters:</b>
290
    <dd> name - The NSName of the element type.
291
  </dl></dd>
292
</dl>
293
<a name="serialize(java.io.OutputStream, boolean)"><img src="images/red-ball.gif" width=12 height=12 alt=" o "></a>
294
<a name="serialize"><b>serialize</b></a>
295
<pre>
296
 public void serialize(OutputStream out,
297
                       boolean pretty) throws IOException
298
</pre>
299
<dl>
300
  <dd> Serialize a DTD to an OutputStream.
301
<p>
302
  <dd><dl>
303
    <dt> <b>Parameters:</b>
304
    <dd> out - The OutputStream.
305
    <dd> pretty - Whether to pretty-print the DTD.
306
  </dl></dd>
307
</dl>
308
<hr>
309
<pre>
310
<a href="packages.html">All Packages</a>  <a href="tree.html">Class Hierarchy</a>  <a href="Package-de.tudarmstadt.ito.schemas.dtd.html">This Package</a>  <a href="de.tudarmstadt.ito.schemas.dtd.Attribute.html#_top_">Previous</a>  <a href="de.tudarmstadt.ito.schemas.dtd.DTDConst.html#_top_">Next</a>  <a href="AllNames.html">Index</a></pre>
311
</body>
312
</html>
(34-34/72)