forked from willemdj/erlsom
/
erlsom.htm
4557 lines (3761 loc) · 250 KB
/
erlsom.htm
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
<html xmlns:v="urn:schemas-microsoft-com:vml"
xmlns:o="urn:schemas-microsoft-com:office:office"
xmlns:w="urn:schemas-microsoft-com:office:word"
xmlns:st1="urn:schemas-microsoft-com:office:smarttags"
xmlns="http://www.w3.org/TR/REC-html40">
<head>
<meta http-equiv=Content-Type content="text/html; charset=windows-1252">
<meta name=ProgId content=Word.Document>
<meta name=Generator content="Microsoft Word 11">
<meta name=Originator content="Microsoft Word 11">
<link rel=File-List href="erlsom_bestanden/filelist.xml">
<link rel=Edit-Time-Data href="erlsom_bestanden/editdata.mso">
<!--[if !mso]>
<style>
v\:* {behavior:url(#default#VML);}
o\:* {behavior:url(#default#VML);}
w\:* {behavior:url(#default#VML);}
.shape {behavior:url(#default#VML);}
</style>
<![endif]-->
<title>Erlsom</title>
<o:SmartTagType namespaceuri="urn:schemas-microsoft-com:office:smarttags"
name="City"/>
<o:SmartTagType namespaceuri="urn:schemas-microsoft-com:office:smarttags"
name="metricconverter"/>
<o:SmartTagType namespaceuri="urn:schemas-microsoft-com:office:smarttags"
name="place"/>
<o:SmartTagType namespaceuri="urn:schemas-microsoft-com:office:smarttags"
name="PlaceType"/>
<o:SmartTagType namespaceuri="urn:schemas-microsoft-com:office:smarttags"
name="PlaceName"/>
<o:SmartTagType namespaceuri="urn:schemas-microsoft-com:office:smarttags"
name="Street"/>
<o:SmartTagType namespaceuri="urn:schemas-microsoft-com:office:smarttags"
name="address"/>
<!--[if gte mso 9]><xml>
<w:WordDocument>
<w:View>Normal</w:View>
<w:DisplayBackgroundShape/>
<w:GrammarState>Clean</w:GrammarState>
<w:HyphenationZone>21</w:HyphenationZone>
<w:ValidateAgainstSchemas/>
<w:SaveIfXMLInvalid>false</w:SaveIfXMLInvalid>
<w:IgnoreMixedContent>false</w:IgnoreMixedContent>
<w:AlwaysShowPlaceholderText>false</w:AlwaysShowPlaceholderText>
<w:BrowserLevel>MicrosoftInternetExplorer4</w:BrowserLevel>
</w:WordDocument>
</xml><![endif]--><!--[if gte mso 9]><xml>
<w:LatentStyles DefLockedState="false" LatentStyleCount="156">
</w:LatentStyles>
</xml><![endif]--><!--[if !mso]><object
classid="clsid:38481807-CA0E-42D2-BF39-B33AF135CC4D" id=ieooui></object>
<style>
st1\:*{behavior:url(#ieooui) }
</style>
<![endif]-->
<style>
<!--
/* Style Definitions */
p.MsoNormal, li.MsoNormal, div.MsoNormal
{mso-style-parent:"";
margin:0cm;
margin-bottom:.0001pt;
mso-pagination:widow-orphan;
font-size:11.0pt;
font-family:Arial;
mso-fareast-font-family:"Times New Roman";}
h1
{margin-top:12.0pt;
margin-right:0cm;
margin-bottom:3.0pt;
margin-left:0cm;
mso-pagination:widow-orphan;
page-break-after:avoid;
mso-outline-level:1;
font-size:16.0pt;
font-family:Arial;}
h2
{margin-top:12.0pt;
margin-right:0cm;
margin-bottom:3.0pt;
margin-left:0cm;
mso-pagination:widow-orphan;
page-break-after:avoid;
mso-outline-level:2;
font-size:14.0pt;
font-family:Arial;
font-style:italic;}
p.MsoToc1, li.MsoToc1, div.MsoToc1
{margin:0cm;
margin-bottom:.0001pt;
mso-pagination:widow-orphan;
font-size:11.0pt;
font-family:Arial;
mso-fareast-font-family:"Times New Roman";}
p.MsoToc2, li.MsoToc2, div.MsoToc2
{margin-top:0cm;
margin-right:0cm;
margin-bottom:0cm;
margin-left:11.0pt;
margin-bottom:.0001pt;
mso-pagination:widow-orphan;
font-size:11.0pt;
font-family:Arial;
mso-fareast-font-family:"Times New Roman";}
p.MsoFootnoteText, li.MsoFootnoteText, div.MsoFootnoteText
{margin:0cm;
margin-bottom:.0001pt;
mso-pagination:widow-orphan;
font-size:10.0pt;
font-family:Arial;
mso-fareast-font-family:"Times New Roman";}
p.MsoCaption, li.MsoCaption, div.MsoCaption
{margin:0cm;
margin-bottom:.0001pt;
mso-pagination:widow-orphan;
font-size:10.0pt;
font-family:Arial;
mso-fareast-font-family:"Times New Roman";
font-weight:bold;}
span.MsoFootnoteReference
{vertical-align:super;}
p.MsoTitle, li.MsoTitle, div.MsoTitle
{margin-top:12.0pt;
margin-right:0cm;
margin-bottom:3.0pt;
margin-left:0cm;
text-align:center;
mso-pagination:widow-orphan;
font-size:16.0pt;
font-family:Arial;
mso-fareast-font-family:"Times New Roman";
font-weight:bold;}
a:link, span.MsoHyperlink
{color:#0000CC;
text-decoration:underline;
text-underline:single;}
a:visited, span.MsoHyperlinkFollowed
{color:purple;
text-decoration:underline;
text-underline:single;}
code
{font-family:"Courier New";
mso-ascii-font-family:"Courier New";
mso-fareast-font-family:"Times New Roman";
mso-hansi-font-family:"Courier New";
mso-bidi-font-family:"Courier New";}
p.copyright, li.copyright, div.copyright
{mso-style-name:copyright;
mso-margin-top-alt:auto;
margin-right:0cm;
mso-margin-bottom-alt:auto;
margin-left:0cm;
mso-pagination:widow-orphan;
font-size:11.0pt;
font-family:Arial;
mso-fareast-font-family:"Times New Roman";}
span.code
{mso-style-name:code;
font-family:"Courier New";
mso-ascii-font-family:"Courier New";
mso-hansi-font-family:"Courier New";
mso-bidi-font-family:"Courier New";}
span.GramE
{mso-style-name:"";
mso-gram-e:yes;}
@page Section1
{size:595.3pt 841.9pt;
margin:70.9pt 70.9pt 70.9pt 70.9pt;
mso-header-margin:35.4pt;
mso-footer-margin:35.4pt;
mso-paper-source:0;}
div.Section1
{page:Section1;}
/* List Definitions */
@list l0
{mso-list-id:1249509769;
mso-list-type:hybrid;
mso-list-template-ids:-466814868 1652719882 68354051 68354053 68354049 68354051 68354053 68354049 68354051 68354053;}
@list l0:level1
{mso-level-start-at:0;
mso-level-number-format:bullet;
mso-level-text:-;
mso-level-tab-stop:36.0pt;
mso-level-number-position:left;
text-indent:-18.0pt;
font-family:Arial;
mso-fareast-font-family:"Times New Roman";}
@list l0:level2
{mso-level-tab-stop:72.0pt;
mso-level-number-position:left;
text-indent:-18.0pt;}
@list l0:level3
{mso-level-tab-stop:108.0pt;
mso-level-number-position:left;
text-indent:-18.0pt;}
@list l0:level4
{mso-level-tab-stop:144.0pt;
mso-level-number-position:left;
text-indent:-18.0pt;}
@list l0:level5
{mso-level-tab-stop:180.0pt;
mso-level-number-position:left;
text-indent:-18.0pt;}
@list l0:level6
{mso-level-tab-stop:216.0pt;
mso-level-number-position:left;
text-indent:-18.0pt;}
@list l0:level7
{mso-level-tab-stop:252.0pt;
mso-level-number-position:left;
text-indent:-18.0pt;}
@list l0:level8
{mso-level-tab-stop:288.0pt;
mso-level-number-position:left;
text-indent:-18.0pt;}
@list l0:level9
{mso-level-tab-stop:324.0pt;
mso-level-number-position:left;
text-indent:-18.0pt;}
ol
{margin-bottom:0cm;}
ul
{margin-bottom:0cm;}
-->
</style>
<!--[if gte mso 10]>
<style>
/* Style Definitions */
table.MsoNormalTable
{mso-style-name:Standaardtabel;
mso-tstyle-rowband-size:0;
mso-tstyle-colband-size:0;
mso-style-noshow:yes;
mso-style-parent:"";
mso-padding-alt:0cm 5.4pt 0cm 5.4pt;
mso-para-margin:0cm;
mso-para-margin-bottom:.0001pt;
mso-pagination:widow-orphan;
font-size:10.0pt;
font-family:"Times New Roman";
mso-ansi-language:#0400;
mso-fareast-language:#0400;
mso-bidi-language:#0400;}
</style>
<![endif]--><!--[if gte mso 9]><xml>
<o:shapedefaults v:ext="edit" spidmax="2050"/>
</xml><![endif]--><!--[if gte mso 9]><xml>
<o:shapelayout v:ext="edit">
<o:idmap v:ext="edit" data="1"/>
</o:shapelayout></xml><![endif]-->
</head>
<body lang=NL link="#0000CC" vlink=purple style='tab-interval:35.4pt'>
<div class=Section1>
<p class=MsoTitle><span lang=EN-US style='mso-ansi-language:EN-US'>Erlsom</span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoTitle><span lang=EN-US style='mso-ansi-language:EN-US'> </span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoToc1><span class=MsoHyperlink><a href="#_Toc181008875"><span
lang=EN-US style='mso-ansi-language:EN-US'>Introduction</span><span lang=EN-GB
style='color:windowtext;display:none;mso-hide:all;mso-ansi-language:EN-GB;
text-decoration:none;text-underline:none'>. 1</span></a></span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoToc2><span class=MsoHyperlink><a href="#example_xml"><span
lang=EN-US style='mso-ansi-language:EN-US'>Example XML document</span><span
lang=EN-GB style='color:windowtext;display:none;mso-hide:all;mso-ansi-language:
EN-GB;text-decoration:none;text-underline:none'>. 8</span></a></span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoToc1><span class=MsoHyperlink><a href="#sax_mode"><span lang=EN-US
style='mso-ansi-language:EN-US'>SAX Mode</span><span lang=EN-GB
style='color:windowtext;display:none;mso-hide:all;mso-ansi-language:EN-GB;
text-decoration:none;text-underline:none'> 8</span></a></span><span lang=EN-GB
style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoToc2><span class=MsoHyperlink><a href="#sax_events"><span
lang=NO-BOK style='mso-ansi-language:NO-BOK'>SAX Events</span><span
lang=NO-BOK style='color:windowtext;display:none;mso-hide:all;mso-ansi-language:
NO-BOK;text-decoration:none;text-underline:none'>. 8</span></a></span><span
lang=NO-BOK style='mso-ansi-language:NO-BOK'><o:p></o:p></span></p>
<p class=MsoToc1><span class=MsoHyperlink><a href="#dom_mode"><span
lang=NO-BOK style='mso-ansi-language:NO-BOK'>Simple DOM Mode</span><span
lang=NO-BOK style='color:windowtext;display:none;mso-hide:all;mso-ansi-language:
NO-BOK;text-decoration:none;text-underline:none'> 8</span></a></span><span
lang=NO-BOK style='mso-ansi-language:NO-BOK'><o:p></o:p></span></p>
<p class=MsoToc1><span class=MsoHyperlink><a href="#data_binder_mode"><span
lang=NO-BOK style='mso-ansi-language:NO-BOK'>Data Binder Mode</span><span
lang=NO-BOK style='color:windowtext;display:none;mso-hide:all;mso-ansi-language:
NO-BOK;text-decoration:none;text-underline:none'> 8</span></a></span><span
lang=NO-BOK style='mso-ansi-language:NO-BOK'><o:p></o:p></span></p>
<p class=MsoToc1><span class=MsoHyperlink><a href="#_Toc181008877"><span
lang=EN-US style='mso-ansi-language:EN-US'>Installation</span><span lang=EN-GB
style='color:windowtext;display:none;mso-hide:all;mso-ansi-language:EN-GB;
text-decoration:none;text-underline:none'>. 7</span></a></span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoToc1><span class=MsoHyperlink><a href="#_Toc181008878"><span
lang=EN-US style='mso-ansi-language:EN-US'>Examples</span><span lang=EN-GB
style='color:windowtext;display:none;mso-hide:all;mso-ansi-language:EN-GB;
text-decoration:none;text-underline:none'>. 7</span></a></span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoToc1><span class=MsoHyperlink><a href="#_Toc181008881"><span
lang=EN-US style='mso-ansi-language:EN-US'>Character encoding</span><span
lang=EN-GB style='color:windowtext;display:none;mso-hide:all;mso-ansi-language:
EN-GB;text-decoration:none;text-underline:none'>. 9</span></a></span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoToc1><span class=MsoHyperlink><a href="#_Toc181008882"><span
lang=EN-US style='mso-ansi-language:EN-US'>Creation of atoms</span><span
lang=EN-GB style='color:windowtext;display:none;mso-hide:all;mso-ansi-language:
EN-GB;text-decoration:none;text-underline:none'>. 10</span></a></span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoToc1><span class=MsoHyperlink><a href="#_Toc181008883"><span
lang=EN-US style='mso-ansi-language:EN-US'>Limitations</span><span lang=EN-GB
style='color:windowtext;display:none;mso-hide:all;mso-ansi-language:EN-GB;
text-decoration:none;text-underline:none'>. 10</span></a></span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoToc2><span class=MsoHyperlink><a href="#_Toc181008884"><span
lang=EN-US style='mso-ansi-language:EN-US'>XML Schema elements</span><span
lang=EN-GB style='color:windowtext;display:none;mso-hide:all;mso-ansi-language:
EN-GB;text-decoration:none;text-underline:none'>. 10</span></a></span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoToc2><span class=MsoHyperlink><a href="#_Toc181008885"><span
lang=EN-US style='mso-ansi-language:EN-US'>XML Schema Attributes</span><span
lang=EN-GB style='color:windowtext;display:none;mso-hide:all;mso-ansi-language:
EN-GB;text-decoration:none;text-underline:none'>. 12</span></a></span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoToc1><span class=MsoHyperlink><a href="#_Toc181008886"><span
lang=EN-US style='mso-ansi-language:EN-US'>Reference</span><span lang=EN-GB
style='color:windowtext;display:none;mso-hide:all;mso-ansi-language:EN-GB;
text-decoration:none;text-underline:none'>. 12</span></a></span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoToc1><span class=MsoHyperlink><a href="#_Toc181008887"><span
lang=EN-US style='mso-ansi-language:EN-US'>Author</span><span lang=EN-GB
style='color:windowtext;display:none;mso-hide:all;mso-ansi-language:EN-GB;
text-decoration:none;text-underline:none'> 18</span></a></span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'> </span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<h1><a name="_Toc181008875"><span lang=EN-US style='mso-ansi-language:EN-US'>Introduction</span></a><span
style='mso-bookmark:_Toc181008875'></span><span lang=EN-GB style='mso-ansi-language:
EN-GB'><o:p></o:p></span></h1>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'>This is the
documentation for Erlsom v. 1.2.1. Erlsom is a set of functions to parse (and
generate) XML documents.<o:p></o:p></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'><o:p> </o:p></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'>Erlsom can
be used in a couple of very different modes:<o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:36.0pt;text-indent:-18.0pt;mso-list:l0 level1 lfo2;
tab-stops:list 36.0pt'><![if !supportLists]><span lang=EN-US style='mso-fareast-font-family:
Arial;mso-ansi-language:EN-US'><span style='mso-list:Ignore'>-<span
style='font:7.0pt "Times New Roman"'>
</span></span></span><![endif]><span lang=EN-US style='mso-ansi-language:EN-US'>as
a SAX parser. <br>
This is a more or less standardized model (see </span><a
href="http://www.saxproject.org/apidoc/org/xml/sax/ContentHandler.html"><span
lang=EN-GB style='mso-ansi-language:EN-GB'>http://www.saxproject.org/apidoc/org/xml/sax/ContentHandler.html</span></a><span
lang=EN-US style='mso-ansi-language:EN-US'>) for parsing XML. Every time the
parser has processed a meaningful part of the XML document (such as a start
tag)<span class=GramE>,</span> it will tell your application about this. The
application can process this information potentially in parallel while the
parser continues to parse the rest of the document. The SAX parser will allow
you to efficiently parse XML documents of arbitrary size, but it may take some
time to get used to it. If you invest some effort, you may find that it fits
very well with the Erlang programming model personally I have always been
very happy about my choice to use a SAX parser as the basis for the rest of
Erlsom. You will find a couple of examples how the SAX parser can be used
below.<o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:36.0pt;text-indent:-18.0pt;mso-list:l0 level1 lfo2;
tab-stops:list 36.0pt'><![if !supportLists]><span lang=EN-US style='mso-fareast-font-family:
Arial;mso-ansi-language:EN-US'><span style='mso-list:Ignore'>-<span
style='font:7.0pt "Times New Roman"'>
</span></span></span><![endif]><span lang=EN-US style='mso-ansi-language:EN-US'>As
a simple sort of DOM parser. <br>
Erlsom can translate your XML to the simple form that is used by Xmerl. This
is a form that is easy to understand, but you have to search your way through
the output to get to the information that you need. Section
provides an
example.<span style='mso-spacerun:yes'> </span>(Note: in the examples
directory you will also find an example that translates the XML to the more
complex output format that is produced by Xmerl. On this output you can use the
Xpath functions that come with Xmerl but I havent tested this extensively).<o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:36.0pt;text-indent:-18.0pt;mso-list:l0 level1 lfo2;
tab-stops:list 36.0pt'><![if !supportLists]><span lang=EN-US style='mso-fareast-font-family:
Arial;mso-ansi-language:EN-US'><span style='mso-list:Ignore'>-<span
style='font:7.0pt "Times New Roman"'>
</span></span></span><![endif]><span lang=EN-US style='mso-ansi-language:EN-US'>As
a data binder <br>
Erlsom can translate the XML document to an Erlang data structure that
corresponds to an XML Schema. It has the advantage over the SAX parser that it
validates the XML document, and that you know exactly what the layout of the
output will be. This makes it easy to access the elements that you need in a
very direct way. <span class=GramE>Section<span style='mso-spacerun:yes'>
</span>
</span> gives more information. (See <a
href="http://www.rpbourret.com/xml/XMLDataBinding.htm">http://www.rpbourret.com/xml/XMLDataBinding.htm</a>
for a general description of XML data binding.)<o:p></o:p></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'><o:p> </o:p></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'>For all
modes the following applies:<o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:36.0pt;text-indent:-18.0pt;mso-list:l0 level1 lfo2;
tab-stops:list 36.0pt'><![if !supportLists]><span lang=EN-US style='mso-fareast-font-family:
Arial;mso-ansi-language:EN-US'><span style='mso-list:Ignore'>-<span
style='font:7.0pt "Times New Roman"'>
</span></span></span><![endif]><span lang=EN-US style='mso-ansi-language:EN-US'>If
the document is too big to fit into memory, or if the document arrives in some
kind of data stream, it can be passed to the parser in blocks of arbitrary
size.<o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:36.0pt;text-indent:-18.0pt;mso-list:l0 level1 lfo2;
tab-stops:list 36.0pt'><![if !supportLists]><span lang=EN-US style='mso-fareast-font-family:
Arial;mso-ansi-language:EN-US'><span style='mso-list:Ignore'>-<span
style='font:7.0pt "Times New Roman"'>
</span></span></span><![endif]><span lang=EN-US style='mso-ansi-language:EN-US'>The
parser can work directly on binaries. There is no need to transform binaries to
lists before passing the data to Erlsom. Using binaries as input has a positive
effect on the memory usage and on the speed (provided that you are using Erlang
12B or later if you are using an older Erlang version the speed will be
better if you transform binaries to lists). The binaries can be latin-1, utf-8
or utf-16 encoded. <o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:36.0pt;text-indent:-18.0pt;mso-list:l0 level1 lfo2;
tab-stops:list 36.0pt'><![if !supportLists]><span lang=EN-US style='mso-fareast-font-family:
Arial;mso-ansi-language:EN-US'><span style='mso-list:Ignore'>-<span
style='font:7.0pt "Times New Roman"'>
</span></span></span><![endif]><span lang=EN-US style='mso-ansi-language:EN-US'>The
parser has an option to produce output in binary form (only the character data:
names of elements and attributes are always strings). This may be convenient if
you want to minimize the memory usage, and/or if you need the result in binary
format for further processing. Note that it will slow down the parser slightly.
If you select this option the encoding of the result will be utf-8
(irrespective of the encoding of the input document).<span
style='mso-spacerun:yes'> </span><o:p></o:p></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'><o:p> </o:p></span></p>
<h2><span lang=EN-US style='mso-ansi-language:EN-US'>Example XML document</span><a
name="#example_xml"></a><span lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></h2>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'>Unless
otherwise indicated, the examples in the next sections will use the following,
very simple XML document as input:<o:p></o:p></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'><o:p> </o:p></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'><foo
attr="baz"><bar>x</bar><bar>y</bar></foo></span></span><span
lang=EN-US style='mso-ansi-language:EN-US'><o:p></o:p></span></p>
<p class=MsoNormal style='tab-stops:229.5pt'><span lang=EN-US style='mso-ansi-language:
EN-US'><o:p> </o:p></span></p>
<p class=MsoNormal style='tab-stops:229.5pt'><span lang=EN-US style='mso-ansi-language:
EN-US'>This document is stored in a file called minimal.xml, and read into a
variable called Xml by the following commands in the shell:<o:p></o:p></span></p>
<p class=MsoNormal style='tab-stops:229.5pt'><span lang=EN-US style='mso-ansi-language:
EN-US'><o:p> </o:p></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'>1> {ok, Xml} = file:read_<span
class=GramE>file(</span>"minimal.xml").<o:p></o:p></span></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'>{ok<span class=GramE>,<</span><"<foo
attr=\"baz\"><bar>x</bar><bar>y</bar></foo>\r\n">>}<o:p></o:p></span></span></p>
<p class=MsoNormal style='tab-stops:229.5pt'><span lang=EN-US style='mso-ansi-language:
EN-US'><o:p> </o:p></span></p>
<p class=MsoNormal style='tab-stops:229.5pt'><span lang=EN-US style='mso-ansi-language:
EN-US'>The following, corresponding XSD (minimal.xsd) is used in the first
example for the data binder:<o:p></o:p></span></p>
<p class=MsoNormal style='tab-stops:229.5pt'><span lang=EN-US style='mso-ansi-language:
EN-US'><o:p> </o:p></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=GramE><span
class=code><span lang=DE style='mso-ansi-language:DE'><?xml</span></span></span><span
class=code><span lang=DE style='mso-ansi-language:DE'> version="1.0"
encoding="UTF-8"?><o:p></o:p></span></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span lang=DE
style='mso-ansi-language:DE'><xsd:schema
xmlns:xsd="http://www.w3.org/2001/XMLSchema"><o:p></o:p></span></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span lang=DE
style='mso-ansi-language:DE'><span style='mso-spacerun:yes'> </span></span></span><span
class=code><span lang=EN-GB style='mso-ansi-language:EN-GB'><xsd<span
class=GramE>:element</span> name="foo" type="foo_type"/><o:p></o:p></span></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'><span style='mso-spacerun:yes'>
</span><xsd<span class=GramE>:complexType</span>
name="foo_type"><o:p></o:p></span></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'><span
style='mso-spacerun:yes'> </span><xsd<span class=GramE>:sequence</span>><o:p></o:p></span></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'><span
style='mso-spacerun:yes'> </span><span style='mso-spacerun:yes'>
</span><xsd<span class=GramE>:element</span> name="bar" <o:p></o:p></span></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'><span
style='mso-spacerun:yes'> </span>type="xsd<span
class=GramE>:string</span>" maxOccurs="unbounded"/><o:p></o:p></span></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'><span
style='mso-spacerun:yes'> </span></xsd<span class=GramE>:sequence</span>><o:p></o:p></span></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'><span
style='mso-spacerun:yes'> </span><xsd<span class=GramE>:attribute</span>
name="attr" type="xsd:string"/><o:p></o:p></span></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'><span style='mso-spacerun:yes'>
</span></xsd<span class=GramE>:complexType</span>><o:p></o:p></span></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'></xsd<span class=GramE>:schema</span>><o:p></o:p></span></span></p>
<p class=MsoNormal style='tab-stops:229.5pt'><span lang=EN-GB style='mso-ansi-language:
EN-US'><span style='mso-spacerun:yes'> </span></span><span lang=EN-US
style='mso-ansi-language:EN-US'><o:p></o:p></span></p>
<h1><a name="sax_mode"><span lang=EN-US style='mso-ansi-language:EN-US'>SAX
Mode</span></a><span style='mso-bookmark:sax_mode'></span><span lang=EN-GB
style='mso-ansi-language:EN-GB'><o:p></o:p></span></h1>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'>The example
below shows how the example XML (see above) can be processed using the SAX
parser:<o:p></o:p></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'><o:p> </o:p></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'>2> erlsom<span class=GramE>:parse</span>_sax(Xml,
[], fun(Event, Acc) -> io:format("~p~n", [Event]), Acc end).<o:p></o:p></span></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'>startDocument<o:p></o:p></span></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'>{startElement<span class=GramE>,[</span>],"foo",[],[{attribute,"attr",[],[],"baz"}]}<o:p></o:p></span></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'>{startElement<span class=GramE>,[</span>],"bar",[],[]}<o:p></o:p></span></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'>{characters,"x"}<o:p></o:p></span></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'>{endElement<span class=GramE>,[</span>],"bar",[]}<o:p></o:p></span></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'>{startElement<span class=GramE>,[</span>],"bar",[],[]}<o:p></o:p></span></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'>{characters,"y"}<o:p></o:p></span></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'>{endElement<span class=GramE>,[</span>],"bar",[]}<o:p></o:p></span></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'>{endElement<span class=GramE>,[</span>],"foo",[]}<o:p></o:p></span></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'>endDocument<o:p></o:p></span></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'>{ok<span class=GramE>,[</span>],"\r\n"}<o:p></o:p></span></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'><o:p> </o:p></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'>The
function erlsom<span class=GramE>:parse</span>_sax takes as its arguments: the
XML document, an accumulator value and an event processing function. This
function will process the parts of the XML documents that have been parsed. In
this example, this function simply prints these events.<o:p></o:p></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'><o:p> </o:p></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'>The next
example does something slightly more meaningful: it counts the number of times
the bar element occurs in the XML document. Ok, maybe not very useful, but at
least this example will produce a result, not only side effects.<o:p></o:p></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'><o:p> </o:p></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'>3> CountBar = <span class=GramE>fun(</span>Event,
Acc) -> case Event of {startElement, _, "bar", _, _} -> Acc +
1; _ -> Acc end end.<o:p></o:p></span></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'>#Fun<erl_eval.12.113037538><o:p></o:p></span></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p> </o:p></span></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'>4> erlsom<span class=GramE>:parse</span>_sax(Xml,
0, CountBar).<span
style='mso-spacerun:yes'> </span><o:p></o:p></span></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'>{ok<span class=GramE>,2</span>,"\r\n"}<o:p></o:p></span></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'><o:p> </o:p></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'>To describe
it in a rather formal way: parse_<span class=GramE>sax(</span>Xml, Acc0, Fun)
calls Fun(Event, AccIn) on successive XML events that result from parsing
Xml, starting with AccIn == Acc0. Fun/2 must return a new accumulator which is
passed to the next call. The function returns {ok, AccOut, Tail}, where AccOut
is the final value of the accumulator and Tail the list of characters that
follow after the last tag of the XML document. In this example AccOut == 2,
since the tag occurs twice.<o:p></o:p></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'>(Notice how
similar this is to lists<span class=GramE>:foldl</span>(Fun, Acc0, Sax_events),
assuming that Sax_events is the list of Sax events I more or less copied this
description from the documentation of the lists module.)<o:p></o:p></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'><o:p> </o:p></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'>It may
still not be very clear to you how this SAX parser can be used to produce
useful results. There are some additional examples in the examples directory of
the Erlsom distribution. If you are still not convinced you can try to decipher
the source code for the data mapper mode (erlsom_parse.erl) this was also
built on top of the SAX parser.<o:p></o:p></span></p>
<p class=MsoNormal><span lang=EN-GB style='mso-ansi-language:EN-GB'><o:p> </o:p></span></p>
<h2><span lang=EN-US style='mso-ansi-language:EN-US'>SAX Events</span><a
name="#sax_events"></a><span lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></h2>
<p class=MsoNormal><i><span lang=EN-US style='mso-ansi-language:EN-US'>startDocument<o:p></o:p></span></i></p>
<p class=MsoNormal><i><span lang=EN-US style='mso-ansi-language:EN-US'><span
style='mso-tab-count:1'> </span></span></i><span lang=EN-US
style='mso-ansi-language:EN-US'> </span><span lang=EN-GB style='mso-ansi-language:
EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal><i><span lang=EN-US style='mso-ansi-language:EN-US'>endDocument
</span></i><span lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:35.4pt'><span lang=EN-US
style='mso-ansi-language:EN-US'>Will NOT be sent out in case of an error</span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'> </span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal><i><span lang=EN-US style='mso-ansi-language:EN-US'>{startPrefixMapping,
Prefix, URI}</span></i><span lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:35.4pt'><span lang=EN-US
style='mso-ansi-language:EN-US'>Begin the scope of a prefix - URI namespace
mapping</span><span lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:35.4pt'><span class=GramE><span
lang=EN-US style='mso-ansi-language:EN-US'>Will be sent immediately before the
corresponding startElement event.</span></span><span lang=EN-GB
style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'> </span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal><i><span lang=EN-US style='mso-ansi-language:EN-US'>{endPrefixMapping,
Prefix}</span></i><span lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:35.4pt'><span lang=EN-US
style='mso-ansi-language:EN-US'>End the scope of a prefix - URI namespace
mapping</span><span lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:35.4pt'><span class=GramE><span
lang=EN-US style='mso-ansi-language:EN-US'>Will be sent immediately before the
corresponding endElement event.</span></span><span lang=EN-GB style='mso-ansi-language:
EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'> </span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal><i><span lang=EN-US style='mso-ansi-language:EN-US'>{startElement,
Uri, LocalName, Prefix, [Attributes]}</span></i><span lang=EN-GB
style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:35.4pt'><span class=GramE><span
lang=EN-US style='mso-ansi-language:EN-US'>The beginning of an element.</span></span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:35.4pt'><span lang=EN-US
style='mso-ansi-language:EN-US'>There will be a corresponding endElement (even
when the element is</span><span lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:35.4pt'><span lang=EN-US
style='mso-ansi-language:EN-US'>empty).</span><span lang=EN-GB
style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:35.4pt'><span lang=EN-US
style='mso-ansi-language:EN-US'>All three name components will be provided.</span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'> </span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:35.4pt'><span lang=EN-US
style='mso-ansi-language:EN-US'>[Attributes] is a list of attribute records,
see sax.hrl.</span><span lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:35.4pt'><span lang=EN-US
style='mso-ansi-language:EN-US'>Namespace attributes (<span class=GramE>xmlns:</span>*)
will not be reported.</span><span lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:35.4pt'><span lang=EN-US
style='mso-ansi-language:EN-US'>There will be NO attribute values for defaulted
attributes!</span><span lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'> </span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:35.4pt'><span lang=EN-US
style='mso-ansi-language:EN-US'>Providing 'Prefix' in stead of 'Qualified name'
is probably not quite</span><span lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:35.4pt'><span lang=EN-US
style='mso-ansi-language:EN-US'>in line with the SAX spec, but it appears to be
more convenient.</span><span lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'> </span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal><i><span lang=EN-US style='mso-ansi-language:EN-US'>{endElement,
Uri, LocalName, Prefix}</span></i><span lang=EN-GB style='mso-ansi-language:
EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:35.4pt'><span class=GramE><span
lang=EN-US style='mso-ansi-language:EN-US'>The end of an element.</span></span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'> </span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal><i><span lang=EN-US style='mso-ansi-language:EN-US'>{characters,
Characters}</span></i><span lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:35.4pt'><span class=GramE><span
lang=EN-US style='mso-ansi-language:EN-US'>Character data.</span></span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:35.4pt'><span lang=EN-US
style='mso-ansi-language:EN-US'>All character data will be in one chunk, except
if there is a </span><span lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:35.4pt'><span class=GramE><span
lang=EN-US style='mso-ansi-language:EN-US'>CDATA section included inside a
character section.</span></span><span lang=EN-US style='mso-ansi-language:EN-US'>
In that case</span><span lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:35.4pt'><span lang=EN-US
style='mso-ansi-language:EN-US'>there will be separate events for the
characters before the CDATA, the</span><span lang=EN-GB style='mso-ansi-language:
EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:35.4pt'><span class=GramE><span
lang=EN-US style='mso-ansi-language:EN-US'>CDATA section and the characters
following it (if any, of course).</span></span><span lang=EN-GB
style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'> </span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal><i><span lang=EN-US style='mso-ansi-language:EN-US'>{ignorableWhitespace,
Characters}</span></i><span lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:35.4pt'><span lang=EN-US
style='mso-ansi-language:EN-US'>If a character data section (as it would be
reported by the 'characters'</span><span lang=EN-GB style='mso-ansi-language:
EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:35.4pt'><span lang=EN-US
style='mso-ansi-language:EN-US'>event, see above) consists ONLY of whitespace,
it will be </span><span lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:35.4pt'><span class=GramE><span
lang=EN-US style='mso-ansi-language:EN-US'>reported as ignorableWhitespace.</span></span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'> </span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal><i><span lang=EN-US style='mso-ansi-language:EN-US'>{processingInstruction,
Target, Data}</span></i><span lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'> </span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal><i><span lang=EN-US style='mso-ansi-language:EN-US'>{error,
Description}</span></i><span lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal><i><span lang=EN-US style='mso-ansi-language:EN-US'> </span></i><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal><i><span lang=EN-US style='mso-ansi-language:EN-US'>{internalError,
Description}</span></i><span lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'><o:p> </o:p></span></p>
<h1><span lang=EN-US style='mso-ansi-language:EN-US'>Simple DOM Mode</span><a
name="#dom_mode"></a><span lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></h1>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'>This mode
translates the XML document to a generic data structure. It doesnt really
follow the DOM standard, but in stead it provides a very simple format. In
fact, it is very similar to format that is defined as the simple-form in the
Xmerl documentation.<o:p></o:p></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'><o:p> </o:p></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'>An example
will probably be sufficient to explain it:<o:p></o:p></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'><o:p> </o:p></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'>erlsom<span class=GramE>:simple</span>_form(Xml).<span
style='mso-spacerun:yes'> </span><o:p></o:p></span></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'>{ok<span class=GramE>,{</span>"foo",<o:p></o:p></span></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'><span style='mso-spacerun:yes'>
</span>[{"attr","baz"}],<o:p></o:p></span></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'><span style='mso-spacerun:yes'>
</span>[{"bar"<span class=GramE>,[</span>],["x"]},{"bar",[],["y"]}]},<o:p></o:p></span></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'><span style='mso-spacerun:yes'>
</span>"\r\n"}<o:p></o:p></span></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'><o:p> </o:p></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'>Result =
{ok, Element, Tail}, where Element = {Tag, Attributes, Content}, Tag is a
string (there is an option that allows you to format Tag differently, see the
reference section below), Attributes = [{AttributeName, Value}], and Content is
a list of Elements and/or strings.<o:p></o:p></span></p>
<h1><span lang=EN-US style='mso-ansi-language:EN-US'>Data Binder Mode</span><a
name="#data_binder_mode"></a><span lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></h1>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'>In this
mode, Erlsom parses XML documents that are associated with an XSD (or Schema).
It checks whether the XML document conforms to the Schema, and it translates
the document to an Erlang structure that is based on the types defined in the
Schema. This section tries to explain the relation between the Schema and the
Erlang data structure that is produced by Erlsom.</span><span lang=EN-GB
style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal><span lang=EN-GB style='mso-ansi-language:EN-GB'><o:p> </o:p></span></p>
<p class=MsoNormal><span class=GramE><span lang=EN-GB style='mso-ansi-language:
EN-GB'>First a quick example using the same XML that was used for the other
modes.</span></span><span lang=EN-GB style='mso-ansi-language:EN-GB'> Before we
can parse the document we need to compile the XML Schema (similar to how you
might compile a regular expression). <o:p></o:p></span></p>
<p class=MsoNormal><span lang=EN-GB style='mso-ansi-language:EN-GB'><o:p> </o:p></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'>10> {ok, Model} = erlsom<span
class=GramE>:compile</span>_xsd_file("minimal.xsd").<o:p></o:p></span></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'>{ok<span class=GramE>,{</span>model,[{typ
<o:p></o:p></span></span></p>
<p class=MsoNormal><span lang=EN-GB style='mso-ansi-language:EN-GB'><o:p> </o:p></span></p>
<p class=MsoNormal><span lang=EN-GB style='mso-ansi-language:EN-GB'>Now you can
use this compiled model:<o:p></o:p></span></p>
<p class=MsoNormal><span lang=EN-GB style='mso-ansi-language:EN-GB'><o:p> </o:p></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'>11> {ok, Result, _} = erlsom<span
class=GramE>:scan</span>(Xml, Model).<o:p></o:p></span></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'>{ok<span class=GramE>,{</span>foo_type,[],"baz",["x","y"]},"\r\n"}<o:p></o:p></span></span></p>
<p class=MsoNormal><span lang=EN-GB style='mso-ansi-language:EN-GB'><o:p> </o:p></span></p>
<p class=MsoNormal><span lang=EN-GB style='mso-ansi-language:EN-GB'>Assuming
that you have defined a suitable record #foo_<span class=GramE>type{</span>}
(erlsom:write_xsd_hrl_file() can do it for you), you can use in your program
(wont work in the shell):<o:p></o:p></span></p>
<p class=MsoNormal><span lang=EN-GB style='mso-ansi-language:EN-GB'><o:p> </o:p></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'>BarValues = Result#foo_type.bar,<o:p></o:p></span></span></p>
<p class=MsoNormal style='background:#FFFF99'><span class=code><span
lang=EN-GB style='mso-ansi-language:EN-GB'>AttrValue = Result#foo_type.attr,</span></span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal><span lang=EN-GB style='mso-ansi-language:EN-GB'><o:p> </o:p></span></p>
<p class=MsoNormal><span lang=EN-GB style='mso-ansi-language:EN-GB'>Nice and
compact, as you see, but it may need more explanation. </span><span lang=EN-US
style='mso-ansi-language:EN-US'>I will use a more complex example from the XML
Schema<span class=GramE> Primer</span> (XML Schema Part 0: Primer Second
Edition) [Primer]. It can be found here:
http://www.w3.org/TR/2004/REC-xmlschema-0-20041028/<a name="_ftnref1"></a><a
href="#_ftn1" title=""><span style='mso-bookmark:_ftnref1'><span
class=MsoFootnoteReference>[1]</span></span><span style='mso-bookmark:_ftnref1'></span></a><span
style='mso-bookmark:_ftnref1'></span>. Sections that have been copied from this
document are contained in a blue box.</span><span lang=EN-GB style='mso-ansi-language:
EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal><span lang=EN-US style='mso-ansi-language:EN-US'> </span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:12.0pt;background:#D5DEE3'><span lang=DE
style='font-size:10.0pt;font-family:"Courier New";color:black;mso-ansi-language:
DE'><xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"></span><span
lang=DE style='mso-ansi-language:DE'><o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:12.0pt;background:#D5DEE3'><span lang=DE
style='font-size:10.0pt;font-family:"Courier New";color:black;mso-ansi-language:
DE'> </span><span lang=DE style='mso-ansi-language:DE'><o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:12.0pt;background:#D5DEE3'><span lang=DE
style='font-size:10.0pt;font-family:"Courier New";color:black;mso-ansi-language:
DE'> </span><span lang=EN style='font-size:10.0pt;font-family:"Courier New";
color:black;mso-ansi-language:EN'><xsd<span class=GramE>:annotation</span>></span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:12.0pt;background:#D5DEE3'><span lang=EN
style='font-size:10.0pt;font-family:"Courier New";color:black;mso-ansi-language:
EN'> <xsd<span class=GramE>:documentation</span>
xml:lang="en"></span><span lang=EN-GB style='mso-ansi-language:
EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:12.0pt;background:#D5DEE3'><span lang=EN
style='font-size:10.0pt;font-family:"Courier New";color:black;mso-ansi-language:
EN'> Purchase order schema for Example.com.</span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:12.0pt;background:#D5DEE3'><span lang=EN
style='font-size:10.0pt;font-family:"Courier New";color:black;mso-ansi-language:
EN'> Copyright 2000 Example.com. All rights reserved.</span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:12.0pt;background:#D5DEE3'><span lang=EN
style='font-size:10.0pt;font-family:"Courier New";color:black;mso-ansi-language:
EN'> </xsd<span class=GramE>:documentation</span>></span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>
<p class=MsoNormal style='margin-left:12.0pt;background:#D5DEE3'><span lang=EN
style='font-size:10.0pt;font-family:"Courier New";color:black;mso-ansi-language:
EN'> </xsd<span class=GramE>:annotation</span>></span><span
lang=EN-GB style='mso-ansi-language:EN-GB'><o:p></o:p></span></p>