File: xni-core.xml

package info (click to toggle)
libxerces2-java 2.12.1-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 12,596 kB
  • sloc: java: 127,777; xml: 13,728; sh: 39; makefile: 10
file content (1485 lines) | stat: -rw-r--r-- 44,979 bytes parent folder | download | duplicates (4)
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
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
<?xml version='1.0' encoding='UTF-8'?>
<!--
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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='XNI Core Interfaces'>
 <s2 title='Core Interfaces'>
  <p>
   The Xerces Native Interface core contains a series of
   interfaces and classes designed to communicate a document's
   "streaming" information set. This page documents the API
   available for receiving this information in the following
   sections:
  </p>
  <ul>
   <li><link anchor='document-information'>Document Information</link></li>
   <li><link anchor='dtd-information'>DTD Information</link></li>
  </ul>
  <p>
   A few examples are also included to illustrate the use of the
   streaming information set:
  </p>
  <ul>
   <li>
    <link anchor='pass-through-filter'>Pass-Through Document 
    Handler Filter</link>
   </li>
   <li><link anchor='upper-case-filter'>Upper-Case Filter</link></li>
  </ul>
  <p>
   For information regarding the parser configuration framework, 
   refer to the <link idref='xni-config'>Parser Configuration</link>
   documentation.
  </p>
  <note>
   The source code for the samples in this document are included
   in the downloaded packages for Xerces2.
  </note>
 </s2>
 <s2 title='Document Information'>
  <p>
   The document information is communicated using the
   <code>XMLDocumentHandler</code> interface. In addition, the
   <code>XMLDocumentFragmentHandler</code> interface is included
   to get information regarding document fragments. Programmers
   already familiar with the SAX programming interfaces should
   be immediately comfortable programming to the Xerces Native
   Interface. However, XNI does not depend on the SAX interfaces
   and classes.
  </p>
  <note>
   All of the interfaces and classes documented on this page
   are contained within the <code>org.apache.xerces.xni</code>
   package.
  </note>
  <anchor name='document-handler'/>
  <s3 title='Interface XMLDocumentHandler'>
   <p>
    Communicates document structure and content information. This
    is the most important handler interface in the Xerces Native
    Interface.
   </p>
<!-- REVISIT: this info is already available in http://xerces.apache.org/xerces2-j/api.html
   <table>
    <tr><th>Methods</th></tr>
    <tr>
     <td>
      <code>
       public void startDocument(
           <link anchor='locator'>XMLLocator</link> locator, 
           String encoding, Augmentations augs
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void xmlDecl(
           String version,
           String encoding,
	   String standalone, Augmentations augs
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void doctypeDecl(
           String rootElement,
	   String publicId,
           String systemId, Augmentations augs
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void comment(
           <link anchor='string'>XMLString</link> text, Augmentations augs
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void processingInstruction(
           String target,
           <link anchor='string'>XMLString</link> data, Augmentations augs
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void startPrefixMapping(
           String prefix,
	   String uri, Augmentations augs
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void endPrefixMapping(
           String prefix, Augmentations augs
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void startElement(
           <link anchor='qname'>QName</link> element,
	   <link anchor='attributes'>XMLAttributes</link> attributes,
       Augmentations augs
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void emptyElement(
           <link anchor='qname'>QName</link> element,
	   <link anchor='attributes'>XMLAttributes</link> attributes,
       Augmentations augs
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void endElement(
           <link anchor='qname'>QName</link> element,
           Augmentations augs
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void startGeneralEntity(
           String name,
           XMLResourceIdentifier identifier,
	   String encoding, Augmentations augs
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void textDecl(
           String version,
	   String encoding, Augmentations augs
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void endGeneralEntity(
           String name, Augmentations augs
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void characters(
           <link anchor='string'>XMLString</link> text,
           Augmentations augs
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void ignorableWhitespace(
           <link anchor='string'>XMLString</link> text,
           Augmentations augs
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void startCDATA(Augmentations augs) 
           throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void endCDATA(Augmentations augs) 
           throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void endDocument(Augmentations augs) 
           throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
   </table>
-->

  </s3>
  <anchor name='document-fragment-handler'/>
  <s3 title='Interface XMLDocumentFragmentHandler'>
   <p>
    Communicates information about a document fragment. This
    interface is provided for convenience in defining a document
    fragment but is not required to be used by a compliant XNI
    parser component or configuration.
   </p>

<!-- REVISIT: see http://xerces.apache.org/xerces2-j/api.html
   <table>
    <tr><th>Methods</th></tr>
    <tr>
     <td>
      <code>
       public void startDocumentFragment(
           <link anchor='locator'>XMLLocator</link> locator,
           <link anchor='namespace-context'>NamespaceContext</link>
           ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void startEntity(
           String name,
	   String publicId,
	   String systemId,
	   String baseSystemId,
	   String encoding
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void textDecl(
           String version,
	   String encoding
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void endEntity(
           String name
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void comment(
           <link anchor='string'>XMLString</link> text
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void processingInstruction(
           String target,
           <link anchor='string'>XMLString</link> data
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void startPrefixMapping(
           String prefix,
	   String uri
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void endPrefixMapping(
           String prefix
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void startElement(
           <link anchor='qname'>QName</link> element,
	   <link anchor='attributes'>XMLAttributes</link> attributes
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void emptyElement(
           <link anchor='qname'>QName</link> element,
	   <link anchor='attributes'>XMLAttributes</link> attributes
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void endElement(
           <link anchor='qname'>QName</link> element
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void characters(
           <link anchor='string'>XMLString</link> text
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void ignorableWhitespace(
           <link anchor='string'>XMLString</link> text
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void startCDATA() 
           throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void endCDATA() 
           throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void endDocumentFragment() 
           throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
   </table>
-->
  </s3>
  <p>
   Besides the handler interfaces there are several related 
   interfaces and classes. All of these are described below.
  </p>
  <anchor name='exception'/>
  <s3 title='Class XNIException'>
   <p>Represents a generic Xerces Native Interface exception.</p>
   <p>
    <strong>Note:</strong> 
    This exception extends <code>java.lang.RuntimeException</code>. 
    Therefore, even though all of the handler interface methods can 
    throw this type of exception, it is not explicitly required to 
    be caught. Since XNI is intended to be an internal set of 
    interfaces, it is expected that XNI implementations will provide 
    a catch block for this exception at the top level so that XNI 
    exceptions do not "leak" out to the application code.
   </p>

<!-- REVISIT: http://xerces.apache.org/xerces2-j/api.html

   <table>
    <tr><th>Constructors</th></tr>
    <tr><td><code>public XNIException(String message);</code></td></tr>
    <tr>
     <td><code>public XNIException(Exception exception);</code></td>
    </tr>
    <tr>
     <td>
      <code>
       public XNIException(String message, Exception exception);
      </code>
     </td>
    </tr>
    <tr><th>Methods</th></tr>
    <tr><td><code>public Exception getException();</code></td></tr>
   </table>

-->
  </s3>
  <anchor name='augs'/>
  <s3 title='Interface Augmentations'>
    <p> This interface enables arbitrary information to be passed
    through the pipeline on various calls from one component to
    another.  XNI tries to model, as close as is feasible, the
    information made available by the W3C&apos;s InfoSet
    specification.  The <link anchor="augs">Augmentations</link>
    interface is intended to permit components to augment the infoset
    for some document at almost any given point.  Many other XNI
    interfaces besides the DocumentHandler support Augmentations
    parameters.</p>
    <p> One kind of particularly useful Infoset augmentation is
    provided through the Post-Schema validation Infoset.  For
    information about Xerces2&apos;s support of the PSVI, and how
    Augmentations are used in a well-defined way to permit this
    support, see the <link idref="samples-xni">documentation</link> for the PSVI Writer and 
    PSVI Configuration samples.</p>
  </s3>
  <anchor name='resource'/>
  <s3 title='Interface XMLResourceIdentifier'>
  <p>
    This interface serves to gather together information relevant to 
    any kind of XML resource (external entity, notation, schema 
    grammar, etc.).  There are five fields in this interface:</p>
    <ul>
      <li>baseSystemId:  The URI against which the literal systemId 
        in the entity (or the URI to be resolved in the 
        <code>schemaLocation</code> attribute as the case may be) 
        should be resolved relative to.  
      </li>
      <li> literalSystemId:  The &quot;real&quot; (unexpanded) value
        of the systemId (or <code>schemaLocation</code>) of the entity
        which this object relates to.  
      </li>
      <li> expandedSystemId:  The value of the systemId (or
        <code>schemaLocation</code>) after being subjects to relative
        URI expansion.  SAX programmers will be familiar with this
        concept from the SAX Locator interface, for example; this
        property maps to the <code>systemId</code> property of that
        interface.
      </li>
      <li> publicId:  the publicId of the entity. 
      </li>
      <li> namespace:  the namespace of the entity. This is useful
        when the resource is some kind of namespace-aware grammar
        (an XML Schema, for example).
      </li>
      </ul>
      <p> As in the case of other XNI objects, XMLResourceIdentifiers
      cannot be depended upon to retain their values between calls;
      hence, callees should extract whatever information they need
      from them (or clone the object) before returning control back to
      the parser. </p>
  </s3> 
  <anchor name='locator'/>
  <s3 title='Interface XMLLocator'>
   <p>
    This interface is used to communicate the document location to
    the various handler interfaces. The application can use the
    methods on this interface to query the public, literal system, and expanded system
    base system identifier as well as the line number, column number 
    and the encoding of the entity currently being parsed.
   </p>
   <p>
    A locator is passed as a parameter in the first method called
    by the <code>XMLDocumentHandler</code>,
    <code>XMLDocumentFragmentHandler</code>, and
    <code>XMLDTDHandler</code> interfaces. 
   </p>
   <p>
    <strong>Note:</strong> 
    Parser components that emit document information are not required
    to provide a locator object. However, the Xerces2 reference 
    implementation <em>does</em> provide a locator to registered
    handlers.
   </p>
   
<!-- REVISIT: http://xerces.apache.org/xerces2-j/api.html
<table>
    <tr><th>Methods</th></tr>
    <tr><td><code>public String getPublicId();</code></td></tr>
    <tr><td><code>public String getSystemId();</code></td></tr>
    <tr><td><code>public String getBaseSystemId();</code></td></tr>
    <tr><td><code>public int getLineNumber();</code></td></tr>
    <tr><td><code>public int getColumnNumber();</code></td></tr>
   </table>
-->
  </s3>
  <anchor name='qname'/>
  <s3 title='Class QName'>
   <p>The QName object is a structure of qualified name information.</p>
   <p>
    <strong>Note:</strong>
    The fields of this object have public visibility but should be
    considered to be <em>read-only</em> to all methods that are
    passed this object. The caller that creates and passes the QName
    object "owns" the data. Therefore, callees should 
    <strong>not</strong> retain a reference to the passed object and
    are required to copy the references contained in the object if
    the data is to be used beyond the scope of the method call.
   </p>

<!-- REVISIT: http://xerces.apache.org/xerces2-j/api.html
   <table>
    <tr><th>Fields</th></tr>
    <tr><td><code>public String prefix;</code></td></tr>
    <tr><td><code>public String localpart;</code></td></tr>
    <tr><td><code>public String rawname;</code></td></tr>
    <tr><td><code>public String uri;</code></td></tr>
    <tr><th>Constructors</th></tr>
    <tr><td><code>public QName();</code></td></tr>
    <tr>
     <td>
      <code>
       public QName(String prefix, String localpart,
                    String rawname, String uri);
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public QName(<link anchor='qname'>QName</link> qname);
      </code>
     </td>
    </tr>
    <tr><th>Convenience Methods</th></tr>
    <tr>
     <td>
      <code>
       public void setValues(String prefix, String localpart,
                             String rawname, String uri);
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void setValues(<link anchor='qname'>QName</link> qname);
      </code>
     </td>
    </tr>
    <tr><td><code>public void clear();</code></td></tr>
   </table>
-->
  </s3>
  <anchor name='attributes'/>
  <s3 title='Interface XMLAttributes'>
   <p>
    This interface represents the collection of attributes that is
    passed to the <code>startElement</code> and <code>emptyElement</code>
    methods of the <code>XMLDocumentHandler</code> and
    <code>XMLDocumentFragmentHandler</code> interfaces. This
    collection of attributes contains all of the information about
    the attributes of an element (except order) and is editable.
   </p>
   <p>
    This interface is also capable of storing information about
    entities appearing in the attribute value. However, it should
    be noted that if entity information is set for an attribute,
    then the non-normalized value of the attribute <strong>must</strong>
    also be stored because the offsets and lengths of entities in
    the attribute have no meaning for the normalized value.
   </p>

<!-- REVISIT: http://xerces.apache.org/xerces2-j/api.html
   <table>
    <tr><th>Methods</th></tr>
    <tr>
     <td>
      <code>
       public void addAttribute(
           <link anchor='qname'>QName</link> attrName,
	   String attrType, 
	   String attrValue
           );
      </code>
     </td>
    </tr>
    <tr><td><code>public void removeAllAttributes();</code></td></tr>
    <tr>
     <td><code>public void removeAttributeAt(int attrIndex);</code></td>
    </tr>
    <tr>
     <td>
      <code>
       public void addAttributeEntity(
           int attrIndex,
	   String entityName,
	   int entityOffset,
	   int entityLength
           );
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>public void removeAllEntitiesFor(int attrIndex);</code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void removeEntityAt(int attrIndex, int entityIndex);
      </code>
     </td>
    </tr>
    <tr><td><code>public int getLength();</code></td></tr>
    <tr><td><code>public int getIndex(String qName);</code></td></tr>
    <tr>
     <td>
      <code>public int getIndex(String uri, String localName);</code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void setName(
           int attrIndex,
           <link anchor='qname'>QName</link> attrName
           );
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void getName(
           int attrIndex,
           <link anchor='qname'>QName</link> attrName
           );
      </code>
     </td>
    </tr>
    <tr><td><code>public String getURI(int attrIndex);</code></td></tr>
    <tr>
     <td><code>public String getLocalName(int attrIndex);</code></td>
    </tr>
    <tr><td><code>public String getQName(int attrIndex);</code></td></tr>
    <tr>
     <td>
      <code>public void setType(int attrIndex, String attrType);</code>
     </td>
    </tr>
    <tr><td><code>public String getType(int attrIndex);</code></td></tr>
    <tr><td><code>public String getType(String qName);</code></td></tr>
    <tr>
     <td>
      <code>public String getType(String uri, String localName);</code>
     </td>
    </tr>
    <tr>
     <td>
      <code>public void setValue(int attrIndex, String attrValue);</code>
     </td>
    </tr>
    <tr><td><code>public String getValue(int attrIndex);</code></td></tr>
    <tr><td><code>public String getValue(String qName);</code></td></tr>
    <tr>
     <td>
      <code>public String getValue(String uri, String localName);</code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void setNonNormalizedValue(int attrIndex, String attrValue);
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>public String getNonNormalizedValue(int attrIndex);</code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void setSpecified(int attrIndex, boolean specified);
      </code>
     </td>
    </tr>
    <tr>
     <td><code>public boolean isSpecified(int attrIndex);</code></td>
    </tr>
    <tr>
     <td><code>public int getEntityCount(int attrIndex);</code></td>
    </tr>
    <tr>
     <td>
      <code>
       public void setEntityName(
           int attrIndex, 
	   int entityIndex,
	   String entityName
           );
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public String getEntityName(
           int attrIndex, 
	   int entityIndex
           );
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void setEntityOffset(
           int attrIndex, 
	   int entityIndex,
	   int entityOffset
           );
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public int getEntityOffset(
           int attrIndex, 
	   int entityIndex
           );
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void setEntityLength(
           int attrIndex, 
	   int entityIndex,
	   int entityLength
           );
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public int getEntityLength(
           int attrIndex, 
	   int entityIndex
	   );
      </code>
     </td>
    </tr>
   </table>

-->

  </s3>
  <anchor name='string'/>
  <s3 title='Class XMLString'>
   <p>
    The XMLString object is a structure for holding text information.
    This object allows the underlying implementation to pass text
    information by using its own internal character buffer without
    creating new String objects or copying the data.
   </p>
   <p>
    <strong>Note:</strong>
    The fields of this object have public visibility but should be
    considered to be <em>read-only</em> to all methods that are
    passed this object. The caller that creates and passes the 
    XMLString object "owns" the data. Therefore, callees should 
    <strong>not</strong> retain a reference to the passed object and
    are required to copy the information contained in the object if
    the data is to be used beyond the scope of the method call. Also,
    callees should <strong>never</strong> modify the contents of the
    character array directly as that could adversely affect the
    operation of the caller.
   </p>

<!-- REVISIT: http://xerces.apache.org/xerces2-j/api.html
   <table>
    <tr><th>Fields</th></tr>
    <tr><td><code>public char[] ch;</code></td></tr>
    <tr><td><code>public int offset;</code></td></tr>
    <tr><td><code>public int length;</code></td></tr>
    <tr><th>Constructors</th></tr>
    <tr><td><code>public XMLString();</code></td></tr>
    <tr>
     <td>
      <code>
       public XMLString(char[] ch, int offset, int length);
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public XMLString(<link anchor='string'>XMLString</link> string);
      </code>
     </td>
    </tr>
    <tr><th>Convenience Methods</th></tr>
    <tr>
     <td>
      <code>
       public void setValues(char[] ch, int offset, int length);
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void setValues(<link anchor='string'>XMLString</link> string);
      </code>
     </td>
    </tr>
    <tr><td><code>public void clear();</code></td></tr>
   </table>
-->
  </s3>
  <anchor name='namespace-context'/>
  <s3 title='Interface NamespaceContext'>
   <p>
    Namespace context information for document fragments. This 
    object is passed to the first method of the
    <code>XMLDocumentFragmentHandler</code> interface.
   </p>

<!-- REVISIT: http://xerces.apache.org/xerces2-j/api.html   
<table>
    <tr><th>Constants</th></tr>
    <tr><td><code>public static final String XMLNS;</code></td></tr>
    <tr><td><code>public String getURI(String prefix);</code></td></tr>
    <tr><td><code>public int getDeclaredPrefixCount();</code></td></tr>
    <tr>
     <td><code>public String getDeclaredPrefixAt(int index);</code></td>
    </tr>
    <tr>
     <td>
      <code>
       public <link anchor='namespace-context'>NamespaceContext</link>
       getParentContext();
      </code>
     </td>
    </tr>
   </table>
-->

  </s3>
 </s2>
 <s2 title='DTD Information'>
  <p>
   The DTD information is communicated through two interfaces:
   <code>XMLDTDHandler</code> and <code>XMLDTDContentModelHandler</code>.
   The first handler interface passes the basic DTD information
   whereas the second handler interface breaks down each element
   declaration content model into separate callbacks.
  </p>
  <anchor name="dtd-handler"/>
  <s3 title='Interface XMLDTDHandler'>
   <p>
    Communicates basic DTD information such as element and attribute
    declarations. The implementor of this interface can also be
    informed of characters within an ignored conditional section.
   </p>

<!-- REVISIT: http://xerces.apache.org/xerces2-j/api.html
   <table>
    <tr><th>Constants</th></tr>
    <tr>
     <td><code>public static final short CONDITIONAL_INCLUDE;</code></td>
    </tr>
    <tr>
     <td><code>public static final short CONDITIONAL_IGNORE;</code></td>
    </tr>
    <tr><th>Methods</th></tr>
    <tr>
     <td>
      <code>
       public void startDTD(
           <link anchor='locator'>XMLLocator</link> locator
           ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void startEntity(
           String name,
	   String publicId,
	   String systemId,
	   String baseSystemId,
	   String encoding
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void textDecl(
           String version,
	   String encoding
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void endEntity(
           String name
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void comment(
           <link anchor='string'>XMLString</link> text
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void processingInstruction(
           String target,
           <link anchor='string'>XMLString</link> data
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void elementDecl(
           String name,
	   String contentModel
           ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void startAttlist(
           String elementName
           ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void attributeDecl(
           String elementName,
	   String attributeName,
	   String type,
	   String[] enumeration,
	   String defaultType,
	   <link anchor='string'>XMLString</link> defaultValue
           ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void endAttlist() throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void internalEntityDecl(
           String name,
	   <link anchor='string'>XMLString</link> text
           ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void externalEntityDecl(
           String name,
	   String publicId,
	   String systemId,
	   String baseSystemId
           ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void unparsedEntityDecl(
           String name,
	   String publicId,
	   String systemId,
	   String notation
           ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void notationDecl(
           String name,
	   String publicId,
	   String systemId
           ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void startConditional(
           short type
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void characters(
           <link anchor='string'>XMLString</link> text
	   ) throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void endConditional() throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void endDTD() throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
   </table>
-->

  </s3>
  <anchor name="dtd-content-model-handler"/>
  <s3 title='Interface XMLDTDContentModelHandler'>
   <p>
    Breaks down each element declaration's content model into 
    a set of separate methods so that handlers don't have to 
    reparse the content model string given in the 
    <code>XMLDTDHandler#elementDecl(String,String)</code> method. 
    This separation also helps those applications that want to 
    know boundaries of entities when used as part of an element's 
    content model.
   </p>

<!-- REVISIT: http://xerces.apache.org/xerces2-j/api.html
   <table>
    <tr><th>Constants</th></tr>
    <tr>
     <td>
      <code>public static final short SEPARATOR_CHOICE;</code>
     </td>
    </tr>
    <tr>
     <td>
      <code>public static final short SEPARATOR_SEQUENCE;</code>
     </td>
    </tr>
    <tr>
     <td>
      <code>public static final short OCCURS_ZERO_OR_ONE;</code>
     </td>
    </tr>
    <tr>
     <td>
      <code>public static final short OCCURS_ZERO_OR_MORE;</code>
     </td>
    </tr>
    <tr>
     <td>
      <code>public static final short OCCURS_ONE_OR_MORE;</code>
     </td>
    </tr>
    <tr><th>Methods</th></tr>
    <tr>
     <td>
      <code>
       public void startContentModel()
           throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void any()
           throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void empty()
           throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void startGroup()
           throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void pcdata()
           throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void element(String elementName)
           throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void separator(short type)
           throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void occurrence(short type)
           throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void endGroup()
           throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
    <tr>
     <td>
      <code>
       public void endContentModel()
           throws <link anchor='exception'>XNIException</link>;
      </code>
     </td>
    </tr>
   </table>

-->

  </s3>
 </s2>
 <s2 title='Examples'>
  <p>
   The following examples demonstrate the basic use of the various
   XNI handler interfaces.
  </p>
  <anchor name='pass-through-filter'/>
  <s3 title='Pass-Through Document Handler Filter'>
   <p>
    The following example demonstrates a basic pass-through 
    document handler filter. This filter receives document handler
    events and passes them through to the next document handler.
   </p>
   <source>import org.apache.xerces.xni.<link anchor='qname'>QName</link>;
import org.apache.xerces.xni.<link anchor='attributes'>XMLAttributes</link>;
import org.apache.xerces.xni.<link anchor='document-handler'>XMLDocumentHandler</link>;
import org.apache.xerces.xni.<link anchor='locator'>XMLLocator</link>;
import org.apache.xerces.xni.<link anchor='string'>XMLString</link>;
import org.apache.xerces.xni.<link anchor='exception'>XNIException</link>;
import org.apache.xerces.xni.<link anchor='resource'>XMLResourceIdentifier</link>;
import org.apache.xerces.xni.<link anchor='augs'>Augmentations</link>;

public class PassThroughFilter
    implements <link anchor='document-handler'>XMLDocumentHandler</link> {
    
    // Data
    
    protected <link anchor='document-handler'>XMLDocumentHandler</link> fDocumentHandler;
    protected <link anchor='document-source'>XMLDocumentSource</link> fDocumentSource;
    
    // Public methods
   
    public void setDocumentHandler(<link anchor='document-handler'>XMLDocumentHandler</link> handler) {
        fDocumentHandler = handler;
    }
    
    // XMLDocumentHandler methods
    
    public void startDocument(<link anchor='locator'>XMLLocator</link>
    locator, String encoding, <link anchor='namespaceContext'>NamespaceContext</link> namespaceContext, <link anchor="augs">Augmentations</link> augs)
        throws <link anchor='exception'>XNIException</link> {
        if (fDocumentHandler != null) {
            fDocumentHandler.startDocument(locator, encoding, namespaceContext, augs);
        }
    }
    
    public void xmlDecl(String version, String encoding, 
                        String standalone, <link
                        anchor="augs">Augmentations</link> augs) throws <link anchor='exception'>XNIException</link> {
        if (fDocumentHandler != null) {
            fDocumentHandler.xmlDecl(version, encoding, standalone,
                augs);
        }
    }
    
    public void doctypeDecl(String rootElement, String publicId, 
                            String systemId, <link
                            anchor="augs">Augmentations</link> augs) throws <link anchor='exception'>XNIException</link> {
        if (fDocumentHandler != null) {
            fDocumentHandler.doctypeDecl(rootElement, publicId,
                    systemId, augs);
        }
    }
    
    public void comment(<link anchor='string'>XMLString</link> text,
        <link anchor="augs">Augmentations</link> augs)
        throws <link anchor='exception'>XNIException</link> {
        if (fDocumentHandler != null) {
            fDocumentHandler.comment(text, augs);
        }
    }
    
    public void processingInstruction(String target, <link
    anchor='string'>XMLString</link> data, <link
        anchor="augs">Augmentations</link> augs)
        throws <link anchor='exception'>XNIException</link> {
        if (fDocumentHandler != null) {
            fDocumentHandler.processingInstruction(target, data, augs);
        }
    }

    public void startElement(<link anchor='qname'>QName</link>
    element, <link anchor='attributes'>XMLAttributes</link>
        attributes, <link anchor="augs">Augmentations</link> augs)
        throws <link anchor='exception'>XNIException</link> {
        if (fDocumentHandler != null) {
            fDocumentHandler.startElement(element, attributes, augs);
        }
    }
    
    public void emptyElement(<link anchor='qname'>QName</link>
    element, <link anchor='attributes'>XMLAttributes</link>
        attributes, <link anchor="augs">Augmentations</link> augs)
        throws <link anchor='exception'>XNIException</link> {
        if (fDocumentHandler != null) {
            fDocumentHandler.emptyElement(element, attributes, augs);
        }
    }
    
    public void endElement(<link anchor='qname'>QName</link> element,
        <link anchor="augs">augmentations</link> augs)
        throws <link anchor='exception'>XNIException</link> {
        if (fDocumentHandler != null) {
            fDocumentHandler.endElement(element, augs);
        }
    }
    
    public void startGeneralEntity(String name, 
            <link anchor="resource">XMLResourceIdentifier</link> resId,
            String encoding, <link anchor="augs">Augmentations</link> augs) 
        throws <link anchor='exception'>XNIException</link> {
        if (fDocumentHandler != null) {
            fDocumentHandler.startEntity(name, 
                                         resId, encoding, augs);
        }
    }
    
    public void textDecl(String version, String encoding, <link
        anchor="augs">Augmentations</link> augs)
        throws <link anchor='exception'>XNIException</link> {
        if (fDocumentHandler != null) {
            fDocumentHandler.textDecl(version, encoding, augs);
        }
    }
    
    public void endGeneralEntity(String name, <link
        anchor="augs">Augmentations</link> augs)
        throws <link anchor='exception'>XNIException</link> {
        if (fDocumentHandler != null) {
            fDocumentHandler.endEntity(name, augs);
        }
    }
    
    public void characters(<link anchor='string'>XMLString</link> text,
        <link anchor="augs">Augmentations</link> augs)
        throws <link anchor='exception'>XNIException</link> {
        if (fDocumentHandler != null) {
            fDocumentHandler.characters(text, augs);
        }
    }
    
    public void ignorableWhitespace(<link
        anchor='string'>XMLString</link> text ,
        <link anchor="augs">Augmentations</link> augs)
        throws <link anchor='exception'>XNIException</link> {
        if (fDocumentHandler != null) {
            fDocumentHandler.ignorableWhitespace(text, augs);
        }
    }
    
    public void startCDATA(<link anchor="augs">Augmentations</link>
        augs)
        throws <link anchor='exception'>XNIException</link> {
        if (fDocumentHandler != null) {
            fDocumentHandler.startCDATA(augs);
        }
    }
    
    public void endCDATA(<link anchor="augs">Augmentations</link> augs)
        throws <link anchor='exception'>XNIException</link> {
        if (fDocumentHandler != null) {
            fDocumentHandler.endCDATA(augs);
        }
    }
    
    public void endDocument(<link anchor="augs">Augmentations</link>
            augs)
        throws <link anchor='exception'>XNIException</link> {
        if (fDocumentHandler != null) {
            fDocumentHandler.endDocument(augs);
        }
    }

    public void setDocumentSource(<link anchor='document-source'>XMLDocumentSource</link> source) {
        fDocumentSource = source;
    }
    
    public XMLDocumentSource getDocumentSource(<link anchor='document-source'>XMLDocumentSource</link> source) {
        return fDocumentSource;
    }
    
    
} // class PassThroughFilter</source>
  </s3>
  <anchor name='upper-case-filter'/>
  <s3 title='Upper-Case Filter'>
   <p>
    The following code extends the pass-through document handler
    filter to upper-case all of the element names.
   </p>
   <source>import org.apache.xerces.xni.<link anchor='qname'>QName</link>;
import org.apache.xerces.xni.<link anchor='attributes'>XMLAttributes</link>;
import org.apache.xerces.xni.<link anchor='string'>XNIException</link>;
import org.apache.xerces.xni.<link anchor='augs'>Augmentations</link>; 
public class UpperCaseFilter
    extends PassThroughFilter {
    
    // Data
    
    private final <link anchor='qname'>QName</link> fQName = new QName();

    // XMLDocumentHandler methods
    
    public void startElement(<link anchor='qname'>QName</link> element, <link anchor='attributes'>XMLAttributes</link> attributes,
        <link anchor="augs">Augmentations</link> augs)
        throws <link anchor='exception'>XNIException</link> {
        super.startElement(toUpperCase(element), attributes, augs);
    }
    
    public void emptyElement(<link anchor='qname'>QName</link>
    element, <link anchor='attributes'>XMLAttributes</link>
        attributes, <link anchor="augs">Augmentations</link> augs)
        throws <link anchor='exception'>XNIException</link> {
        super.emptyElement(toUpperCase(element), attributes, augs);
    }
    
    public void endElement(<link anchor='qname'>QName</link> element,
        <link anchor="augs">Augmentations</link> augs)
        throws <link anchor='exception'>XNIException</link> {
        super.endElement(toUpperCase(element), augs);
    }
    
    // Protected methods
    
    protected QName toUpperCase(<link anchor='qname'>QName</link> qname) {
        String prefix = qname.prefix != null
                      ? qname.prefix.toUpperCase() : null;
        String localpart = qname.localpart != null
                         ? qname.localpart.toUpperCase() : null;
        String rawname = qname.rawname != null
                       ? qname.rawname.toUpperCase() : null;
        String uri = qname.uri;
        fQName.setValues(prefix, localpart, rawname, uri);
        return fQName;
    }

} // class UpperCaseFilter</source>
  </s3>
 </s2>
</s1>