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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
|
<?xml version='1.0' encoding='UTF-8'?>
<!--
* Copyright 2001-2005 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
-->
<!DOCTYPE s1 SYSTEM 'dtd/document.dtd'>
<s1 title='DOM Samples'>
<s2 title='Overview'>
<p>
This page documents the various Document Object Model (DOM)
samples included with Xerces. Besides being useful programs,
they can be used as DOM programming examples to learn how to
program using the DOM API.
</p>
<p>Basic DOM samples:</p>
<ul>
<li><link anchor='Counter'>dom.Counter</link></li>
<!--
- Should the following samples be removed? rewritten? revamped?
<li><link anchor='DOMGenerate'>dom.DOMGenerate</link></li>
-->
<li><link anchor='GetElementsByTagName'>dom.GetElementsByTagName</link></li>
<li><link anchor='Writer'>dom.Writer</link></li>
<!-- <li><link anchor='ASBuilder'>dom.ASBuilder</link></li> -->
<li><link anchor='DOM3'>dom.DOM3</link></li>
<li><link anchor='DOMAddLines'>dom.DOMAddLines</link></li>
</ul>
<!--
- These samples should be redone.
<p>DOM Traversal samples:</p>
<ul>
<li><link anchor='IteratorView'>dom.traversal.IteratorView</link></li>
<li><link anchor='NameNodeFilter'>dom.traversal.NameNodeFilter</link></li>
<li><link anchor='TreeWalkerView'>dom.traversal.TreeWalkerView</link></li>
</ul>
-->
<p>
Most of the DOM parser samples have a command line option that
allows the user to specify a different DOM parser to use. In
order to supply another DOM parser besides the default Xerces
<code>DOMParser</code>, a DOM parser wrapper class must be written.
This class must implement the <code>dom.ParserWrapper</code>
interface.
</p>
<note>
JAXP could be used instead of the special DOM parser wrapper
class. However, that feature is not implemented at this time.
Using JAXP would require the user to specify the
<code>-Djavax.xml.parsers.DocumentBuilderFactory=...</code>
option to the virtual machine in order to use a different
document builder factory.
</note>
</s2>
<anchor name='Counter'/>
<s2 title='Sample dom.Counter'>
<p>
A sample DOM counter. This sample program illustrates how to
traverse a DOM tree in order to get information about the document.
The output of this program shows the time and count of elements,
attributes, ignorable whitespaces, and characters appearing in
the document. Three times are shown: the parse time, the first
traversal of the document, and the second traversal of the tree.
</p>
<p>
This class is useful as a "poor-man's" performance tester to
compare the speed and accuracy of various DOM parsers. However,
it is important to note that the first parse time of a parser
will include both VM class load time and parser initialization
that would not be present in subsequent parses with the same
file.
</p>
<note>
The results produced by this program should never be accepted as
true performance measurements.
</note>
<s3 title='usage'>
<source>java dom.Counter (options) uri ...</source>
</s3>
<s3 title='options'>
<table>
<tr><th>Option</th><th>Description</th></tr>
<tr><td>-p name</td><td>Select parser wrapper by name.</td></tr>
<tr><td>-x number</td><td>Select number of repetitions.</td></tr>
<tr><td>-n | -N</td><td>Turn on/off namespace processing.</td></tr>
<tr><td>-v | -V</td><td>Turn on/off validation.</td></tr>
<tr>
<td>-s | -S</td>
<td>
Turn on/off Schema validation support.<br/>
<strong>NOTE:</strong> Not supported by all parsers.
</td>
</tr>
<tr>
<td>-f | -F</td>
<td>
Turn on/off Schema full checking.<br/>
<strong>NOTE:</strong> Requires use of -s and not supported by all parsers.
</td>
</tr>
<tr>
<td>-hs | -HS</td>
<td>
Turn on/off honouring of all schema locations.<br/>
<strong>NOTE:</strong> Requires use of -s and not supported by all parsers.
</td>
</tr>
<tr>
<td>-va | -VA</td>
<td>
Turn on/off validation of schema annotations.<br/>
<strong>NOTE:</strong> Requires use of -s and not supported by all parsers.
</td>
</tr>
<tr>
<td>-dv | -DV</td>
<td>
Turn on/off dynamic validation.<br/>
<strong>NOTE:</strong> Not supported by all parsers.
</td>
</tr>
<tr>
<td>-xi | -XI</td>
<td>
Turn on/off XInclude processing.<br/>
<strong>NOTE:</strong> Not supported by all parsers.
</td>
</tr>
<tr>
<td>-xb | -XB</td>
<td>
Turn on/off base URI fixup during XInclude processing.<br/>
<strong>NOTE:</strong> Requires use of -xi and not supported by all parsers.
</td>
</tr>
<tr>
<td>-xl | -XL</td>
<td>
Turn on/off language fixup during XInclude processing.<br/>
<strong>NOTE:</strong> Requires use of -xi and not supported by all parsers.
</td>
</tr>
<tr><td>-h</td><td>Display help screen.</td></tr>
</table>
</s3>
</s2>
<!--
- Should the following samples be removed? rewritten? revamped?
<anchor name='DOMGenerate'/>
<s2 title='Sample dom.DOMGenerate'>
<p>TODO</p>
</s2>
-->
<anchor name='GetElementsByTagName'/>
<s2 title='Sample dom.GetElementsByTagName'>
<p>
A sample DOM filter. This sample program illustrates how to
use the <code>Document#getElementsByTagName()</code> method
to quickly and easily locate elements by name.
</p>
<s3 title='usage'>
<source>java dom.GetElementsByTagName (options) uri ...</source>
</s3>
<s3 title='options'>
<table>
<tr><th>Option</th><th>Description</th></tr>
<tr><td>-p name</td><td>Select parser wrapper by name.</td></tr>
<tr><td>-e name</td><td>Specify element name for search.</td></tr>
<tr><td>-a name</td><td>Specify attribute name for specified elements.</td></tr>
<tr><td>-n | -N</td><td>Turn on/off namespace processing.</td></tr>
<tr><td>-v | -V</td><td>Turn on/off validation.</td></tr>
<tr>
<td>-s | -S</td>
<td>
Turn on/off Schema validation support.<br/>
<strong>NOTE:</strong> Not supported by all parsers.
</td>
</tr>
<tr>
<td>-f | -F</td>
<td>
Turn on/off Schema full checking.<br/>
<strong>NOTE:</strong> Requires use of -s and not supported by all parsers.
</td>
</tr>
<tr>
<td>-hs | -HS</td>
<td>
Turn on/off honouring of all schema locations.<br/>
<strong>NOTE:</strong> Requires use of -s and not supported by all parsers.
</td>
</tr>
<tr>
<td>-va | -VA</td>
<td>
Turn on/off validation of schema annotations.<br/>
<strong>NOTE:</strong> Requires use of -s and not supported by all parsers.
</td>
</tr>
<tr>
<td>-dv | -DV</td>
<td>
Turn on/off dynamic validation.<br/>
<strong>NOTE:</strong> Not supported by all parsers.
</td>
</tr>
<tr>
<td>-xi | -XI</td>
<td>
Turn on/off XInclude processing.<br/>
<strong>NOTE:</strong> Not supported by all parsers.
</td>
</tr>
<tr>
<td>-xb | -XB</td>
<td>
Turn on/off base URI fixup during XInclude processing.<br/>
<strong>NOTE:</strong> Requires use of -xi and not supported by all parsers.
</td>
</tr>
<tr>
<td>-xl | -XL</td>
<td>
Turn on/off language fixup during XInclude processing.<br/>
<strong>NOTE:</strong> Requires use of -xi and not supported by all parsers.
</td>
</tr>
<tr><td>-h</td><td>Display help screen.</td></tr>
</table>
</s3>
</s2>
<anchor name='Writer'/>
<s2 title='Sample dom.Writer'>
<p>
A sample DOM writer. This sample program illustrates how to
traverse a DOM tree in order to print a document that is parsed.
</p>
<s3 title='usage'>
<source>java dom.Writer (options) uri ...</source>
</s3>
<s3 title='options'>
<table>
<tr><td>-p name</td><td>Select parser wrapper by name.</td></tr>
<tr><td>-n | -N</td><td>Turn on/off namespace processing.</td></tr>
<tr><td>-v | -V</td><td>Turn on/off validation.</td></tr>
<tr>
<td>-xd | -XD</td>
<td>
Turn on/off loading of external DTDs.<br/>
<strong>NOTE:</strong> Always on when -v in use and not supported by all parsers.
</td>
</tr>
<tr>
<td>-s | -S</td>
<td>
Turn on/off Schema validation support.<br/>
<strong>NOTE:</strong> Not supported by all parsers.
</td>
</tr>
<tr>
<td>-f | -F</td>
<td>
Turn on/off Schema full checking.<br/>
<strong>NOTE:</strong> Requires use of -s and not supported by all parsers.
</td>
</tr>
<tr>
<td>-hs | -HS</td>
<td>
Turn on/off honouring of all schema locations.<br/>
<strong>NOTE:</strong> Requires use of -s and not supported by all parsers.
</td>
</tr>
<tr>
<td>-va | -VA</td>
<td>
Turn on/off validation of schema annotations.<br/>
<strong>NOTE:</strong> Requires use of -s and not supported by all parsers.
</td>
</tr>
<tr>
<td>-ga | -GA</td>
<td>
Turn on/off generation of synthetic schema annotations.<br/>
<strong>NOTE:</strong> Requires use of -s and not supported by all parsers.
</td>
</tr>
<tr>
<td>-dv | -DV</td>
<td>
Turn on/off dynamic validation.<br/>
<strong>NOTE:</strong> Not supported by all parsers.
</td>
</tr>
<tr>
<td>-xi | -XI</td>
<td>
Turn on/off XInclude processing.<br/>
<strong>NOTE:</strong> Not supported by all parsers.
</td>
</tr>
<tr>
<td>-xb | -XB</td>
<td>
Turn on/off base URI fixup during XInclude processing.<br/>
<strong>NOTE:</strong> Requires use of -xi and not supported by all parsers.
</td>
</tr>
<tr>
<td>-xl | -XL</td>
<td>
Turn on/off language fixup during XInclude processing.<br/>
<strong>NOTE:</strong> Requires use of -xi and not supported by all parsers.
</td>
</tr>
<tr>
<td>-c | -C</td>
<td>
Turn on/off Canonical XML output.<br/>
<strong>NOTE:</strong> This is not W3C canonical output.
</td>
</tr>
<tr><td>-h</td><td>Display help screen.</td></tr>
</table>
</s3>
</s2>
<!--
<anchor name='ASBuilder'/>
<s2 title='Sample dom.ASBuilder'>
<p>
This sample program illustrates how to preparse xml schema
documents and how to validate instance documents against
preparsed schema grammars.
</p>
<note>The Abstract Schema module implementation is <code>deprecated</code>. You should use
Xerces Grammar caching functionality to pre-parse schemas.</note>
<s3 title='usage'>
<source>java dom.ASBuilder [-f|-F] -a uri ... [-i uri ...]</source>
</s3>
<s3 title='options'>
<table>
<tr><td>-f | -F</td><td>Turn on/off schema full checking.</td></tr>
<tr><td>-a uri ...</td><td>Provide a list of schema documents.</td></tr>
<tr><td>-i uri ...</td><td>Provide a list of instance documents to validate.</td></tr>
</table>
</s3>
</s2> -->
<anchor name='DOM3'/>
<s2 title='Sample dom.DOM3'>
<p>This sample program illustrates how to use the DOM Level 3 API.</p>
<s3 title='usage'>
<source>java dom.DOM3 uri</source>
</s3>
</s2>
<anchor name='DOMAddLines'/>
<s2 title='Sample dom.DOMAddLines'>
<p>
A sample of Adding lines to the DOM Node. This sample program illustrates:
</p>
<ul>
<li>How to override methods from DocumentHandler ( XMLDocumentHandler)</li>
<li>How to turn off ignorable white spaces by overriding ignorableWhiteSpace</li>
<li>How to use the SAX Locator to return row position (line number of DOM element)</li>
<li>How to attach user defined Objects to Nodes using the DOM Level 3 setUserData method.</li>
</ul>
<s3 title='usage'>
<source>java dom.DOMAddLines (options) uri ...</source>
</s3>
<s3 title='options'>
<table>
<tr><th>Option</th><th>Description</th></tr>
<tr><td>-h</td><td>Display help screen.</td></tr>
<tr><td>-i</td><td>Don't print ignorable white spaces.</td></tr>
</table>
</s3>
</s2>
<!--
These samples should be redone.
<anchor name='IteratorView'/>
<s2 title='Sample dom.traversal.IteratorView'>
<p>TODO</p>
</s2>
<anchor name='NameNodeFilter'/>
<s2 title='Sample dom.traversal.NameNodeFilter'>
<p>TODO</p>
</s2>
<anchor name='TreeWalkerView'/>
<s2 title='Sample dom.traversal.TreeWalkerView'>
<p>TODO</p>
</s2>
-->
</s1>
|
