-
Notifications
You must be signed in to change notification settings - Fork 117
/
SAXOutputter.java
1468 lines (1333 loc) · 51.3 KB
/
SAXOutputter.java
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
/*--
$Id: SAXOutputter.java,v 1.40 2007/11/10 05:29:01 jhunter Exp $
Copyright (C) 2000-2007 Jason Hunter & Brett McLaughlin.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions, and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions, and the disclaimer that follows
these conditions in the documentation and/or other materials
provided with the distribution.
3. The name "JDOM" must not be used to endorse or promote products
derived from this software without prior written permission. For
written permission, please contact <request_AT_jdom_DOT_org>.
4. Products derived from this software may not be called "JDOM", nor
may "JDOM" appear in their name, without prior written permission
from the JDOM Project Management <request_AT_jdom_DOT_org>.
In addition, we request (but do not require) that you include in the
end-user documentation provided with the redistribution and/or in the
software itself an acknowledgement equivalent to the following:
"This product includes software developed by the
JDOM Project (http://www.jdom.org/)."
Alternatively, the acknowledgment may be graphical using the logos
available at http://www.jdom.org/images/logos.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE JDOM AUTHORS OR THE PROJECT
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
This software consists of voluntary contributions made by many
individuals on behalf of the JDOM Project and was originally
created by Jason Hunter <jhunter_AT_jdom_DOT_org> and
Brett McLaughlin <brett_AT_jdom_DOT_org>. For more information
on the JDOM Project, please see <http://www.jdom.org/>.
*/
package org.jdom.output;
import java.io.*;
import java.lang.reflect.*;
import java.util.*;
import org.jdom.*;
import org.xml.sax.*;
import org.xml.sax.ext.*;
import org.xml.sax.helpers.*;
/**
* Outputs a JDOM document as a stream of SAX2 events.
* <p>
* Most ContentHandler callbacks are supported. Both
* <code>ignorableWhitespace()</code> and <code>skippedEntity()</code> have not
* been implemented. The <code>{@link JDOMLocator}</code> class returned by
* <code>{@link #getLocator}</code> exposes the current node being operated
* upon.
* <p>
* At this time, it is not possible to access notations and unparsed entity
* references in a DTD from JDOM. Therefore, <code>DTDHandler</code> callbacks
* have not been implemented yet.
* <p>
* The <code>ErrorHandler</code> callbacks have not been implemented, since
* these are supposed to be invoked when the document is parsed and at this
* point the document exists in memory and is known to have no errors. </p>
*
* @version $Revision: 1.40 $, $Date: 2007/11/10 05:29:01 $
* @author Brett McLaughlin
* @author Jason Hunter
* @author Fred Trimble
* @author Bradley S. Huffman
*/
public class SAXOutputter {
private static final String CVS_ID =
"@(#) $RCSfile: SAXOutputter.java,v $ $Revision: 1.40 $ $Date: 2007/11/10 05:29:01 $ $Name: $";
/** Shortcut for SAX namespaces core feature */
private static final String NAMESPACES_SAX_FEATURE =
"http://xml.org/sax/features/namespaces";
/** Shortcut for SAX namespace-prefixes core feature */
private static final String NS_PREFIXES_SAX_FEATURE =
"http://xml.org/sax/features/namespace-prefixes";
/** Shortcut for SAX validation core feature */
private static final String VALIDATION_SAX_FEATURE =
"http://xml.org/sax/features/validation";
/** Shortcut for SAX-ext. lexical handler property */
private static final String LEXICAL_HANDLER_SAX_PROPERTY =
"http://xml.org/sax/properties/lexical-handler";
/** Shortcut for SAX-ext. declaration handler property */
private static final String DECL_HANDLER_SAX_PROPERTY =
"http://xml.org/sax/properties/declaration-handler";
/**
* Shortcut for SAX-ext. lexical handler alternate property.
* Although this property URI is not the one defined by the SAX
* "standard", some parsers use it instead of the official one.
*/
private static final String LEXICAL_HANDLER_ALT_PROPERTY =
"http://xml.org/sax/handlers/LexicalHandler";
/** Shortcut for SAX-ext. declaration handler alternate property */
private static final String DECL_HANDLER_ALT_PROPERTY =
"http://xml.org/sax/handlers/DeclHandler";
/**
* Array to map JDOM attribute type (as entry index) to SAX
* attribute type names.
*/
private static final String[] attrTypeToNameMap = new String[] {
"CDATA", // Attribute.UNDEFINED_ATTRIBUTE, as per SAX 2.0 spec.
"CDATA", // Attribute.CDATA_TYPE
"ID", // Attribute.ID_TYPE
"IDREF", // Attribute.IDREF_TYPE
"IDREFS", // Attribute.IDREFS_TYPE
"ENTITY", // Attribute.ENTITY_TYPE
"ENTITIES", // Attribute.ENTITIES_TYPE
"NMTOKEN", // Attribute.NMTOKEN_TYPE
"NMTOKENS", // Attribute.NMTOKENS_TYPE
"NOTATION", // Attribute.NOTATION_TYPE
"NMTOKEN", // Attribute.ENUMERATED_TYPE, as per SAX 2.0 spec.
};
/** registered <code>ContentHandler</code> */
private ContentHandler contentHandler;
/** registered <code>ErrorHandler</code> */
private ErrorHandler errorHandler;
/** registered <code>DTDHandler</code> */
private DTDHandler dtdHandler;
/** registered <code>EntityResolver</code> */
private EntityResolver entityResolver;
/** registered <code>LexicalHandler</code> */
private LexicalHandler lexicalHandler;
/** registered <code>DeclHandler</code> */
private DeclHandler declHandler;
/**
* Whether to report attribute namespace declarations as xmlns attributes.
* Defaults to <code>false</code> as per SAX specifications.
*
* @see <a href="http://www.megginson.com/SAX/Java/namespaces.html">
* SAX namespace specifications</a>
*/
private boolean declareNamespaces = false;
/**
* Whether to report DTD events to DeclHandlers and LexicalHandlers.
* Defaults to <code>true</code>.
*/
private boolean reportDtdEvents = true;
/**
* A SAX Locator that points at the JDOM node currently being
* outputted.
*/
private JDOMLocator locator = null;
/**
* This will create a <code>SAXOutputter</code> without any
* registered handler. The application is then responsible for
* registering them using the <code>setXxxHandler()</code> methods.
*/
public SAXOutputter() {
}
/**
* This will create a <code>SAXOutputter</code> with the
* specified <code>ContentHandler</code>.
*
* @param contentHandler contains <code>ContentHandler</code>
* callback methods
*/
public SAXOutputter(ContentHandler contentHandler) {
this(contentHandler, null, null, null, null);
}
/**
* This will create a <code>SAXOutputter</code> with the
* specified SAX2 handlers. At this time, only <code>ContentHandler</code>
* and <code>EntityResolver</code> are supported.
*
* @param contentHandler contains <code>ContentHandler</code>
* callback methods
* @param errorHandler contains <code>ErrorHandler</code> callback methods
* @param dtdHandler contains <code>DTDHandler</code> callback methods
* @param entityResolver contains <code>EntityResolver</code>
* callback methods
*/
public SAXOutputter(ContentHandler contentHandler,
ErrorHandler errorHandler,
DTDHandler dtdHandler,
EntityResolver entityResolver) {
this(contentHandler, errorHandler, dtdHandler, entityResolver, null);
}
/**
* This will create a <code>SAXOutputter</code> with the
* specified SAX2 handlers. At this time, only <code>ContentHandler</code>
* and <code>EntityResolver</code> are supported.
*
* @param contentHandler contains <code>ContentHandler</code>
* callback methods
* @param errorHandler contains <code>ErrorHandler</code> callback methods
* @param dtdHandler contains <code>DTDHandler</code> callback methods
* @param entityResolver contains <code>EntityResolver</code>
* callback methods
* @param lexicalHandler contains <code>LexicalHandler</code> callbacks.
*/
public SAXOutputter(ContentHandler contentHandler,
ErrorHandler errorHandler,
DTDHandler dtdHandler,
EntityResolver entityResolver,
LexicalHandler lexicalHandler) {
this.contentHandler = contentHandler;
this.errorHandler = errorHandler;
this.dtdHandler = dtdHandler;
this.entityResolver = entityResolver;
this.lexicalHandler = lexicalHandler;
}
/**
* This will set the <code>ContentHandler</code>.
*
* @param contentHandler contains <code>ContentHandler</code>
* callback methods.
*/
public void setContentHandler(ContentHandler contentHandler) {
this.contentHandler = contentHandler;
}
/**
* Returns the registered <code>ContentHandler</code>.
*
* @return the current <code>ContentHandler</code> or
* <code>null</code> if none was registered.
*/
public ContentHandler getContentHandler() {
return this.contentHandler;
}
/**
* This will set the <code>ErrorHandler</code>.
*
* @param errorHandler contains <code>ErrorHandler</code> callback methods.
*/
public void setErrorHandler(ErrorHandler errorHandler) {
this.errorHandler = errorHandler;
}
/**
* Return the registered <code>ErrorHandler</code>.
*
* @return the current <code>ErrorHandler</code> or
* <code>null</code> if none was registered.
*/
public ErrorHandler getErrorHandler() {
return this.errorHandler;
}
/**
* This will set the <code>DTDHandler</code>.
*
* @param dtdHandler contains <code>DTDHandler</code> callback methods.
*/
public void setDTDHandler(DTDHandler dtdHandler) {
this.dtdHandler = dtdHandler;
}
/**
* Return the registered <code>DTDHandler</code>.
*
* @return the current <code>DTDHandler</code> or
* <code>null</code> if none was registered.
*/
public DTDHandler getDTDHandler() {
return this.dtdHandler;
}
/**
* This will set the <code>EntityResolver</code>.
*
* @param entityResolver contains EntityResolver callback methods.
*/
public void setEntityResolver(EntityResolver entityResolver) {
this.entityResolver = entityResolver;
}
/**
* Return the registered <code>EntityResolver</code>.
*
* @return the current <code>EntityResolver</code> or
* <code>null</code> if none was registered.
*/
public EntityResolver getEntityResolver() {
return this.entityResolver;
}
/**
* This will set the <code>LexicalHandler</code>.
*
* @param lexicalHandler contains lexical callback methods.
*/
public void setLexicalHandler(LexicalHandler lexicalHandler) {
this.lexicalHandler = lexicalHandler;
}
/**
* Return the registered <code>LexicalHandler</code>.
*
* @return the current <code>LexicalHandler</code> or
* <code>null</code> if none was registered.
*/
public LexicalHandler getLexicalHandler() {
return this.lexicalHandler;
}
/**
* This will set the <code>DeclHandler</code>.
*
* @param declHandler contains declaration callback methods.
*/
public void setDeclHandler(DeclHandler declHandler) {
this.declHandler = declHandler;
}
/**
* Return the registered <code>DeclHandler</code>.
*
* @return the current <code>DeclHandler</code> or
* <code>null</code> if none was registered.
*/
public DeclHandler getDeclHandler() {
return this.declHandler;
}
/**
* Returns whether attribute namespace declarations shall be reported as
* "xmlns" attributes.
*
* @return whether attribute namespace declarations shall be reported as
* "xmlns" attributes.
*/
public boolean getReportNamespaceDeclarations() {
return declareNamespaces;
}
/**
* This will define whether attribute namespace declarations shall be
* reported as "xmlns" attributes. This flag defaults to <code>false</code>
* and behaves as the "namespace-prefixes" SAX core feature.
*
* @param declareNamespaces whether attribute namespace declarations
* shall be reported as "xmlns" attributes.
*/
public void setReportNamespaceDeclarations(boolean declareNamespaces) {
this.declareNamespaces = declareNamespaces;
}
/**
* Returns whether DTD events will be reported.
*
* @return whether DTD events will be reported
*/
public boolean getReportDTDEvents() {
return reportDtdEvents;
}
/**
* This will define whether to report DTD events to SAX DeclHandlers
* and LexicalHandlers if these handlers are registered and the
* document to output includes a DocType declaration.
*
* @param reportDtdEvents whether to notify DTD events.
*/
public void setReportDTDEvents(boolean reportDtdEvents) {
this.reportDtdEvents = reportDtdEvents;
}
/**
* This will set the state of a SAX feature.
* <p>
* All XMLReaders are required to support setting to true and to false.
* </p>
* <p>
* SAXOutputter currently supports the following SAX core features:
* <dl>
* <dt><code>http://xml.org/sax/features/namespaces</code></dt>
* <dd><strong>description:</strong> <code>true</code> indicates
* namespace URIs and unprefixed local names for element and
* attribute names will be available</dd>
* <dd><strong>access:</strong> read/write, but always
* <code>true</code>!</dd>
* <dt><code>http://xml.org/sax/features/namespace-prefixes</code></dt>
* <dd><strong>description:</strong> <code>true</code> indicates
* XML 1.0 names (with prefixes) and attributes (including xmlns*
* attributes) will be available</dd>
* <dd><strong>access:</strong> read/write</dd>
* <dt><code>http://xml.org/sax/features/validation</code></dt>
* <dd><strong>description:</strong> controls whether SAXOutputter
* is reporting DTD-related events; if <code>true</code>, the
* DocType internal subset will be parsed to fire DTD events</dd>
* <dd><strong>access:</strong> read/write, defaults to
* <code>true</code></dd>
* </dl>
* </p>
*
* @param name <code>String</code> the feature name, which is a
* fully-qualified URI.
* @param value <code>boolean</code> the requested state of the
* feature (true or false).
*
* @throws SAXNotRecognizedException when SAXOutputter does not
* recognize the feature name.
* @throws SAXNotSupportedException when SAXOutputter recognizes
* the feature name but cannot set the requested value.
*/
public void setFeature(String name, boolean value)
throws SAXNotRecognizedException, SAXNotSupportedException {
if (NS_PREFIXES_SAX_FEATURE.equals(name)) {
// Namespace prefix declarations.
this.setReportNamespaceDeclarations(value);
}
else {
if (NAMESPACES_SAX_FEATURE.equals(name)) {
if (value != true) {
// Namespaces feature always supported by SAXOutputter.
throw new SAXNotSupportedException(name);
}
// Else: true is OK!
}
else {
if (VALIDATION_SAX_FEATURE.equals(name)) {
// Report DTD events.
this.setReportDTDEvents(value);
}
else {
// Not a supported feature.
throw new SAXNotRecognizedException(name);
}
}
}
}
/**
* This will look up the value of a SAX feature.
*
* @param name <code>String</code> the feature name, which is a
* fully-qualified URI.
* @return <code>boolean</code> the current state of the feature
* (true or false).
*
* @throws SAXNotRecognizedException when SAXOutputter does not
* recognize the feature name.
* @throws SAXNotSupportedException when SAXOutputter recognizes
* the feature name but determine its value at this time.
*/
public boolean getFeature(String name)
throws SAXNotRecognizedException, SAXNotSupportedException {
if (NS_PREFIXES_SAX_FEATURE.equals(name)) {
// Namespace prefix declarations.
return (this.declareNamespaces);
}
else {
if (NAMESPACES_SAX_FEATURE.equals(name)) {
// Namespaces feature always supported by SAXOutputter.
return (true);
}
else {
if (VALIDATION_SAX_FEATURE.equals(name)) {
// Report DTD events.
return (this.reportDtdEvents);
}
else {
// Not a supported feature.
throw new SAXNotRecognizedException(name);
}
}
}
}
/**
* This will set the value of a SAX property.
* This method is also the standard mechanism for setting extended
* handlers.
* <p>
* SAXOutputter currently supports the following SAX properties:
* <dl>
* <dt><code>http://xml.org/sax/properties/lexical-handler</code></dt>
* <dd><strong>data type:</strong>
* <code>org.xml.sax.ext.LexicalHandler</code></dd>
* <dd><strong>description:</strong> An optional extension handler for
* lexical events like comments.</dd>
* <dd><strong>access:</strong> read/write</dd>
* <dt><code>http://xml.org/sax/properties/declaration-handler</code></dt>
* <dd><strong>data type:</strong>
* <code>org.xml.sax.ext.DeclHandler</code></dd>
* <dd><strong>description:</strong> An optional extension handler for
* DTD-related events other than notations and unparsed entities.</dd>
* <dd><strong>access:</strong> read/write</dd>
* </dl>
* </p>
*
* @param name <code>String</code> the property name, which is a
* fully-qualified URI.
* @param value <code>Object</code> the requested value for the property.
*
* @throws SAXNotRecognizedException when SAXOutputter does not recognize
* the property name.
* @throws SAXNotSupportedException when SAXOutputter recognizes the
* property name but cannot set the requested value.
*/
public void setProperty(String name, Object value)
throws SAXNotRecognizedException, SAXNotSupportedException {
if ((LEXICAL_HANDLER_SAX_PROPERTY.equals(name)) ||
(LEXICAL_HANDLER_ALT_PROPERTY.equals(name))) {
this.setLexicalHandler((LexicalHandler)value);
}
else {
if ((DECL_HANDLER_SAX_PROPERTY.equals(name)) ||
(DECL_HANDLER_ALT_PROPERTY.equals(name))) {
this.setDeclHandler((DeclHandler)value);
}
else {
throw new SAXNotRecognizedException(name);
}
}
}
/**
* This will look up the value of a SAX property.
*
* @param name <code>String</code> the property name, which is a
* fully-qualified URI.
* @return <code>Object</code> the current value of the property.
*
* @throws SAXNotRecognizedException when SAXOutputter does not recognize
* the property name.
* @throws SAXNotSupportedException when SAXOutputter recognizes the
* property name but cannot determine its value at this time.
*/
public Object getProperty(String name)
throws SAXNotRecognizedException, SAXNotSupportedException {
if ((LEXICAL_HANDLER_SAX_PROPERTY.equals(name)) ||
(LEXICAL_HANDLER_ALT_PROPERTY.equals(name))) {
return this.getLexicalHandler();
}
else {
if ((DECL_HANDLER_SAX_PROPERTY.equals(name)) ||
(DECL_HANDLER_ALT_PROPERTY.equals(name))) {
return this.getDeclHandler();
}
else {
throw new SAXNotRecognizedException(name);
}
}
}
/**
* This will output the <code>JDOM Document</code>, firing off the
* SAX events that have been registered.
*
* @param document <code>JDOM Document</code> to output.
*
* @throws JDOMException if any error occurred.
*/
public void output(Document document) throws JDOMException {
if (document == null) {
return;
}
// contentHandler.setDocumentLocator()
documentLocator(document);
// contentHandler.startDocument()
startDocument();
// Fire DTD events
if (this.reportDtdEvents) {
dtdEvents(document);
}
// Handle root element, as well as any root level
// processing instructions and comments
Iterator i = document.getContent().iterator();
while (i.hasNext()) {
Object obj = i.next();
// update locator
locator.setNode(obj);
if (obj instanceof Element) {
// process root element and its content
element(document.getRootElement(), new NamespaceStack());
}
else if (obj instanceof ProcessingInstruction) {
// contentHandler.processingInstruction()
processingInstruction((ProcessingInstruction) obj);
}
else if (obj instanceof Comment) {
// lexicalHandler.comment()
comment(((Comment) obj).getText());
}
}
// contentHandler.endDocument()
endDocument();
}
/**
* This will output a list of JDOM nodes as a document, firing
* off the SAX events that have been registered.
* <p>
* <strong>Warning</strong>: This method may output ill-formed XML
* documents if the list contains top-level objects that are not
* legal at the document level (e.g. Text or CDATA nodes, multiple
* Element nodes, etc.). Thus, it should only be used to output
* document portions towards ContentHandlers capable of accepting
* such ill-formed documents (such as XSLT processors).</p>
*
* @param nodes <code>List</code> of JDOM nodes to output.
*
* @throws JDOMException if any error occurred.
*
* @see #output(org.jdom.Document)
*/
public void output(List nodes) throws JDOMException {
if ((nodes == null) || (nodes.size() == 0)) {
return;
}
// contentHandler.setDocumentLocator()
documentLocator(null);
// contentHandler.startDocument()
startDocument();
// Process node list.
elementContent(nodes, new NamespaceStack());
// contentHandler.endDocument()
endDocument();
}
/**
* This will output a single JDOM element as a document, firing
* off the SAX events that have been registered.
*
* @param node the <code>Element</code> node to output.
*
* @throws JDOMException if any error occurred.
*/
public void output(Element node) throws JDOMException {
if (node == null) {
return;
}
// contentHandler.setDocumentLocator()
documentLocator(null);
// contentHandler.startDocument()
startDocument();
// Output node.
elementContent(node, new NamespaceStack());
// contentHandler.endDocument()
endDocument();
}
/**
* This will output a list of JDOM nodes as a fragment of an XML
* document, firing off the SAX events that have been registered.
* <p>
* <strong>Warning</strong>: This method does not call the
* {@link ContentHandler#setDocumentLocator},
* {@link ContentHandler#startDocument} and
* {@link ContentHandler#endDocument} callbacks on the
* {@link #setContentHandler ContentHandler}. The user shall
* invoke these methods directly prior/after outputting the
* document fragments.</p>
*
* @param nodes <code>List</code> of JDOM nodes to output.
*
* @throws JDOMException if any error occurred.
*
* @see #outputFragment(org.jdom.Content)
*/
public void outputFragment(List nodes) throws JDOMException {
if ((nodes == null) || (nodes.size() == 0)) {
return;
}
// Output node list as a document fragment.
elementContent(nodes, new NamespaceStack());
}
/**
* This will output a single JDOM nodes as a fragment of an XML
* document, firing off the SAX events that have been registered.
* <p>
* <strong>Warning</strong>: This method does not call the
* {@link ContentHandler#setDocumentLocator},
* {@link ContentHandler#startDocument} and
* {@link ContentHandler#endDocument} callbacks on the
* {@link #setContentHandler ContentHandler}. The user shall
* invoke these methods directly prior/after outputting the
* document fragments.</p>
*
* @param node the <code>Content</code> node to output.
*
* @throws JDOMException if any error occurred.
*
* @see #outputFragment(java.util.List)
*/
public void outputFragment(Content node) throws JDOMException {
if (node == null) {
return;
}
// Output single node as a document fragment.
elementContent(node, new NamespaceStack());
}
/**
* This parses a DTD declaration to fire the related events towards
* the registered handlers.
*
* @param document <code>JDOM Document</code> the DocType is to
* process.
*/
private void dtdEvents(Document document) throws JDOMException {
DocType docType = document.getDocType();
// Fire DTD-related events only if handlers have been registered.
if ((docType != null) &&
((dtdHandler != null) || (declHandler != null))) {
// Build a dummy XML document that only references the DTD...
String dtdDoc = new XMLOutputter().outputString(docType);
try {
// And parse it to fire DTD events.
createDTDParser().parse(new InputSource(
new StringReader(dtdDoc)));
// We should never reach this point as the document is
// ill-formed; it does not have any root element.
}
catch (SAXParseException e) {
// Expected exception: There's no root element in document.
}
catch (SAXException e) {
throw new JDOMException("DTD parsing error", e);
}
catch (IOException e) {
throw new JDOMException("DTD parsing error", e);
}
}
}
/**
* <p>
* This method tells you the line of the XML file being parsed.
* For an in-memory document, it's meaningless. The location
* is only valid for the current parsing lifecycle, but
* the document has already been parsed. Therefore, it returns
* -1 for both line and column numbers.
* </p>
*
* @param document JDOM <code>Document</code>.
*/
private void documentLocator(Document document) {
locator = new JDOMLocator();
String publicID = null;
String systemID = null;
if (document != null) {
DocType docType = document.getDocType();
if (docType != null) {
publicID = docType.getPublicID();
systemID = docType.getSystemID();
}
}
locator.setPublicId(publicID);
locator.setSystemId(systemID);
locator.setLineNumber(-1);
locator.setColumnNumber(-1);
contentHandler.setDocumentLocator(locator);
}
/**
* <p>
* This method is always the second method of all callbacks in
* all handlers to be invoked (setDocumentLocator is always first).
* </p>
*/
private void startDocument() throws JDOMException {
try {
contentHandler.startDocument();
}
catch (SAXException se) {
throw new JDOMException("Exception in startDocument", se);
}
}
/**
* <p>
* Always the last method of all callbacks in all handlers
* to be invoked.
* </p>
*/
private void endDocument() throws JDOMException {
try {
contentHandler.endDocument();
// reset locator
locator = null;
}
catch (SAXException se) {
throw new JDOMException("Exception in endDocument", se);
}
}
/**
* <p>
* This will invoke the <code>ContentHandler.processingInstruction</code>
* callback when a processing instruction is encountered.
* </p>
*
* @param pi <code>ProcessingInstruction</code> containing target and data.
*/
private void processingInstruction(ProcessingInstruction pi)
throws JDOMException {
if (pi != null) {
String target = pi.getTarget();
String data = pi.getData();
try {
contentHandler.processingInstruction(target, data);
}
catch (SAXException se) {
throw new JDOMException(
"Exception in processingInstruction", se);
}
}
}
/**
* <p>
* This will recursively invoke all of the callbacks for a particular
* element.
* </p>
*
* @param element <code>Element</code> used in callbacks.
* @param namespaces <code>List</code> stack of Namespaces in scope.
*/
private void element(Element element, NamespaceStack namespaces)
throws JDOMException {
// used to check endPrefixMapping
int previouslyDeclaredNamespaces = namespaces.size();
// contentHandler.startPrefixMapping()
Attributes nsAtts = startPrefixMapping(element, namespaces);
// contentHandler.startElement()
startElement(element, nsAtts);
// handle content in the element
elementContent(element.getContent(), namespaces);
// update locator
if (locator != null) {
locator.setNode(element);
}
// contentHandler.endElement()
endElement(element);
// contentHandler.endPrefixMapping()
endPrefixMapping(namespaces, previouslyDeclaredNamespaces);
}
/**
* <p>
* This will invoke the <code>ContentHandler.startPrefixMapping</code>
* callback
* when a new namespace is encountered in the <code>Document</code>.
* </p>
*
* @param element <code>Element</code> used in callbacks.
* @param namespaces <code>List</code> stack of Namespaces in scope.
*
* @return <code>Attributes</code> declaring the namespaces local to
* <code>element</code> or <code>null</code>.
*/
private Attributes startPrefixMapping(Element element,
NamespaceStack namespaces)
throws JDOMException {
AttributesImpl nsAtts = null; // The namespaces as xmlns attributes
Namespace ns = element.getNamespace();
if (ns != Namespace.XML_NAMESPACE) {
String prefix = ns.getPrefix();
String uri = namespaces.getURI(prefix);
if (!ns.getURI().equals(uri)) {
namespaces.push(ns);
nsAtts = this.addNsAttribute(nsAtts, ns);
try {
contentHandler.startPrefixMapping(prefix, ns.getURI());
}
catch (SAXException se) {
throw new JDOMException(
"Exception in startPrefixMapping", se);
}
}
}
// Fire additional namespace declarations
List additionalNamespaces = element.getAdditionalNamespaces();
if (additionalNamespaces != null) {
Iterator itr = additionalNamespaces.iterator();
while (itr.hasNext()) {
ns = (Namespace)itr.next();
String prefix = ns.getPrefix();
String uri = namespaces.getURI(prefix);
if (!ns.getURI().equals(uri)) {
namespaces.push(ns);
nsAtts = this.addNsAttribute(nsAtts, ns);
try {
contentHandler.startPrefixMapping(prefix, ns.getURI());
}
catch (SAXException se) {
throw new JDOMException(
"Exception in startPrefixMapping", se);
}
}
}
}
// Fire any namespace on Attributes that were not explicity added as additionals.
List attributes = element.getAttributes();
if (attributes != null) {
Iterator itr = attributes.iterator();
while (itr.hasNext()) {
Attribute att = (Attribute)itr.next();
ns = att.getNamespace();
if (ns == Namespace.NO_NAMESPACE) {
// Issue #60
// no-prefix attributes are always in the NO_NAMESPACE
// namespace. This prefix mapping is implied for Attributes.
continue;
}
String prefix = ns.getPrefix();
String uri = namespaces.getURI(prefix);
if (!ns.getURI().equals(uri)) {
namespaces.push(ns);
nsAtts = this.addNsAttribute(nsAtts, ns);
try {
contentHandler.startPrefixMapping(prefix, ns.getURI());
}
catch (SAXException se) {
throw new JDOMException(
"Exception in startPrefixMapping", se);
}
}
}
}
return nsAtts;
}
/**
* <p>