-
-
Notifications
You must be signed in to change notification settings - Fork 15
/
eml-physical.xsd
1348 lines (1340 loc) · 76.4 KB
/
eml-physical.xsd
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
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:res="eml://ecoinformatics.org/resource-2.1.1" xmlns:cit="eml://ecoinformatics.org/literature-2.1.1" xmlns:doc="eml://ecoinformatics.org/documentation-2.1.1" xmlns:acc="eml://ecoinformatics.org/access-2.1.1" xmlns="eml://ecoinformatics.org/physical-2.1.1" xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="eml://ecoinformatics.org/physical-2.1.1">
<xs:import namespace="eml://ecoinformatics.org/documentation-2.1.1" schemaLocation="eml-documentation.xsd"/>
<xs:import namespace="eml://ecoinformatics.org/literature-2.1.1" schemaLocation="eml-literature.xsd"/>
<xs:import namespace="eml://ecoinformatics.org/resource-2.1.1" schemaLocation="eml-resource.xsd"/>
<xs:import namespace="eml://ecoinformatics.org/access-2.1.1" schemaLocation="eml-access.xsd"/>
<xs:annotation>
<xs:documentation>
'$RCSfile: eml-physical.xsd,v $'
Copyright: 1997-2002 Regents of the University of California,
University of New Mexico, and
Arizona State University
Sponsors: National Center for Ecological Analysis and Synthesis and
Partnership for Interdisciplinary Studies of Coastal Oceans,
University of California Santa Barbara
Long-Term Ecological Research Network Office,
University of New Mexico
Center for Environmental Studies, Arizona State University
Other funding: National Science Foundation (see README for details)
The David and Lucile Packard Foundation
For Details: http://knb.ecoinformatics.org/
'$Author: obrien $'
'$Date: 2009-03-05 22:33:04 $'
'$Revision: 1.82 $'
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
</xs:documentation>
<xs:appinfo>
<doc:moduleDocs>
<doc:moduleName>eml-physical</doc:moduleName>
<doc:moduleDescription>
<section xmlns="">
<title>The eml-physical module - Physical file format</title>
<para>
The eml-physical module describes the external
and internal physical characteristics of a data object as well as the
information required for its distribution. Examples of the external
physical characteristics of a data object would be the filename,
size, compression, encoding methods, and authentication of a file
or byte stream. Internal physical characteristics describe the
format of the data object being described. Both named binary or
otherwise proprietary formats can be cited (e.g., Microsoft Access
2000), or text formats can be precisely described (e.g., ASCII text
delimited with commas). For these text formats, it also includes the
information needed to parse the data object to extract the entity
and its attributes from the data object. Distribution information
describes how to retrieve the data object. The retrieval information
can be either online (e.g., a URL or other connection information)
or offline (e.g., a data object residing on an archival tape).
</para>
<para>
The eml-physical module, like other modules, may be
"referenced" via the <references> tag. This
allows a physical document to be described once, and then
used as a reference in other locations within the EML document
via its ID.
</para>
</section>
</doc:moduleDescription>
<doc:recommendedUsage>Any data object that is being described by EML
needs this information so the entities and attributes that reside
with in the data object can be extracted. </doc:recommendedUsage>
<doc:standAlone>yes</doc:standAlone>
</doc:moduleDocs>
</xs:appinfo>
</xs:annotation>
<xs:element name="physical" type="PhysicalType">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Physical structure</doc:tooltip>
<doc:summary>Physical structure of an entity or entities.</doc:summary>
<doc:description>The content model for physical is a CHOICE between
"references" and all of the elements that let you describe the
internal/external characteristics and distribution of a data object
(e.g., dataObject, dataFormat, distribution.) A physical element can
contain a reference to an physical element defined elsewhere. Using
a reference means that the referenced physical is identical, not just
in name but identical in its complete description. </doc:description>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:complexType name="PhysicalType">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Physical structure</doc:tooltip>
<doc:summary>Physical structure of an entity or entities.</doc:summary>
<doc:description>
<section xmlns="">
<para>The eml-physical module describes the physical characteristics of a
data object
and the information required for its distribution. External physical characteristics
include the filename, size, compression, encoding methods, and authentication
of a file or byte stream. Internal physical characteristics describe the format of
the data object. Proprietary formats can be cited (e.g., Microsoft Access 2000),
or text formats can be precisely described (e.g., ASCII text delimited with commas).
The module includes the information needed to parse the text data object to extract
the entity and its attributes. Distribution information describes how to retrieve the
data object, either as online (a URL or connection definition), offline (e.g., a data
object residing on an archival tape), or inline (i.e., the data are included with the
metadata).</para>
<para>Like many other EML elements, a physical Type can
contain a reference to another physical element defined elsewhere in the document
instead of a description of the resource. Using
a reference means that the referenced physical is identical, not just
in name but identical in its complete description. </para>
</section>
</doc:description>
</xs:appinfo>
</xs:annotation>
<xs:choice>
<xs:sequence>
<xs:element name="objectName" type="res:NonEmptyStringType">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Data object name</doc:tooltip>
<doc:summary>The name of the data object.
</doc:summary>
<doc:description>The name of the data object. This is
possibly distinct from the entity name in that one physical
object can contain multiple entities, even though that is not
a recommended practice. The objectName often is the filename
of a file in a file system or that is accessible on the network.
</doc:description>
<doc:example>rainfall-sev-2002-10.txt</doc:example>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="size" minOccurs="0">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Data object size</doc:tooltip>
<doc:summary>Describes the physical size of the
data object.</doc:summary>
<doc:description>This element contains information of the
physical size of the entity, by default represented in
bytes unless the unit attribute is provided to change
the units.</doc:description>
<doc:example>134</doc:example>
</xs:appinfo>
</xs:annotation>
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="unit" use="optional" default="byte">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Unit of measurement</doc:tooltip>
<doc:summary>Unit of measurement for the entity
size, by default byte</doc:summary>
<doc:description>This element gives the unit of
measurement for the size of the entity, and is
by default a byte.</doc:description>
<doc:example>byte</doc:example>
</xs:appinfo>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:element name="authentication" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Authentication value</doc:tooltip>
<doc:summary>A value, typically a checksum, used to
authenticate that the bitstream delivered to the user is
identical to the original.</doc:summary>
<doc:description>This element describes authentication
procedures or techniques, typically by giving a checksum
value for the object. The method used to compute the
authentication value (e.g., MD5) is listed in the method
attribute.</doc:description>
<doc:example>f5b2177ea03aea73de12da81f896fe40</doc:example>
</xs:appinfo>
</xs:annotation>
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="method" type="xs:string" use="optional">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Authentication method</doc:tooltip>
<doc:summary>The method used to calculate an
authentication checksum.</doc:summary>
<doc:description>This element names the method used
to calculate and authentication checksum that can
be used to validate a bytestream. Typical checksum
methods include MD5 and CRC.</doc:description>
<doc:example>MD5</doc:example>
</xs:appinfo>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="compressionMethod" type="res:NonEmptyStringType">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Compression Method</doc:tooltip>
<doc:summary>Name of a compression method applied
</doc:summary>
<doc:description>This element lists a compression method used
to compress the object, such as zip, compress, etc. Compression
and encoding methods must be listed in the order in which they
were applied, so that decompression and decoding should
occur in the reverse order of the listing. For example,
if a file is compressed using zip and then encoded using
MIME base64, the compression method would be listed first
and the encoding method second.</doc:description>
<doc:example>zip</doc:example>
<doc:example>gzip</doc:example>
<doc:example>compress</doc:example>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="encodingMethod" type="res:NonEmptyStringType">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Encoding Method</doc:tooltip>
<doc:summary>Name of a encoding method applied
</doc:summary>
<doc:description>This element lists a encoding method used
to encode the object, such as base64, BinHex, etc. Compression
and encoding methods must be listed in the order in which they
were applied, so that decompression and decoding should
occur in the reverse order of the listing. For example,
if a file is compressed using zip and then encoded using
MIME base64, the compression method would be listed first
and the encoding method second.</doc:description>
<doc:example>base64</doc:example>
<doc:example>uuencode</doc:example>
<doc:example>binhex</doc:example>
</xs:appinfo>
</xs:annotation>
</xs:element>
</xs:choice>
<xs:element name="characterEncoding" type="res:NonEmptyStringType" minOccurs="0">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Character Encoding</doc:tooltip>
<doc:summary>Contains the name of the character encoding
used for the data.</doc:summary>
<doc:description>This element contains the name of the
character encoding. This is typically ASCII or UTF-8, or
one of the other common encodings.</doc:description>
<doc:example>UTF-8</doc:example>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="dataFormat">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Data format</doc:tooltip>
<doc:summary>Describes the internal physical format
of a data object.</doc:summary>
<doc:description>This element is the parent which is a CHOICE
between four possible internal physical formats
which describe the internal
physical characteristics of the data object. Using this
information the user should be able parse physical object to
extract the entity and its attributes. Note that this is
the format of the physical object itself.</doc:description>
</xs:appinfo>
</xs:annotation>
<xs:complexType>
<xs:choice>
<xs:element name="textFormat">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Text Format</doc:tooltip>
<doc:summary>Description of a text formatted object
</doc:summary>
<doc:description>Description of a text formatted object.
The description includes detailed parsing instructions for
extracting attributes from the bytestream for simple
delimited file formats (e.g., CSV), fixed format files
that use fixed columns for attribute locations, and
mixtures of the two. It also supports records that
span multiple lines.</doc:description>
</xs:appinfo>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="numHeaderLines" type="xs:int" minOccurs="0">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Number of header lines</doc:tooltip>
<doc:summary>Number of header lines preceding
data.</doc:summary>
<doc:description>Number of header lines preceding
data. Lines are determined by the
physicalLineDelimiter, or if it is absent, by the
recordDelimiter. This value indicated the
number of header lines that should be skipped
before starting to parse the data.
</doc:description>
<doc:example>4</doc:example>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="numFooterLines" type="xs:int" minOccurs="0">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Number of footer lines</doc:tooltip>
<doc:summary>Number of footer lines following
data.</doc:summary>
<doc:description>Number of footer lines following
data. Lines are determined by the
physicalLineDelimiter, or if it is absent, by the
recordDelimiter. This value indicated the
number of footer lines that should be skipped
after parsing the data. If this value is omitted,
parsers should assume the data continues to the end
of the data stream.</doc:description>
<doc:example>4</doc:example>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="recordDelimiter" type="xs:string" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Record delimiter character</doc:tooltip>
<doc:summary>Character used to delimit
records.</doc:summary>
<doc:description>This element specifies the record
delimiter character when the format is text. The
record delimiter is usually a linefeed (\n) on UNIX, a
carriage return (\r) on MacOS, or both (\r\n) on
Windows/DOS. Multiline records are usually delimited
with two line ending characters, for example on UNIX
it would be two linefeed characters (\n\n). As record
delimiters are often non-printing characters, one can
use either the special value "\n" to represent a
linefeed (ASCII 0x0a) and "\r" to represent a carriage
return (ASCII 0x0d). Alternatively, one can use the
hex value to represent character values (e.g., 0x0a).
</doc:description>
<doc:example>\n\r</doc:example>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="physicalLineDelimiter" type="xs:string" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Physical line delimiter character
</doc:tooltip>
<doc:summary>Character used to delimit
physical lines.</doc:summary>
<doc:description>This element specifies the physical
line delimiter character when the format is text. The
line delimiter is usually a linefeed (\n) on UNIX, a
carriage return (\r) on MacOS, or both (\r\n) on
Windows/DOS. Multiline records are usually delimited
with two line ending characters, for example on UNIX
it would be two linefeed characters (\n\n). As line
delimiters are often non-printing characters, one can
use either the special value "\n" to represent a
linefeed (ASCII 0x0a) and "\r" to represent a carriage
return (ASCII 0x0d). Alternatively, one can use the
hex value to represent character values (e.g., 0x0a).
If this value is not provided, processors should
assume that the physical line delimiter is the same
as the record delimiter.
</doc:description>
<doc:example>\n\r</doc:example>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="numPhysicalLinesPerRecord" type="xs:unsignedInt" minOccurs="0">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Physical lines per record</doc:tooltip>
<doc:summary>The number of physical lines in the file
spanned by a single logical data record.</doc:summary>
<doc:description>A single logical data record may be
written over several physical lines in a file, with
no special marker to indicate the end of a record. In
such cases, it is necessary to know the number of
lines per record in order to correctly read
them. If this value is not provided, processors should
assume that records are wholly contained on one
physical line. If the value is greater than 1, then
processors should examine the lineNumber field for
each attribute to determine which line of the
record contains the information.</doc:description>
<doc:example>3</doc:example>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="maxRecordLength" type="xs:unsignedLong" minOccurs="0">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Maximum record length</doc:tooltip>
<doc:summary>The maximum number of characters in any
record in the physical file.
</doc:summary>
<doc:description>The maximum number of characters
in any record in the physical file. For delimited
files, the record length varies and this is not
particularly useful. However, for fixed format files
that do not contain record delimiters, this field is
critical to tell processors when one record stops
and another begins.</doc:description>
<doc:example>597</doc:example>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="attributeOrientation">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Orientation of attributes</doc:tooltip>
<doc:summary>Orientation of attributes.</doc:summary>
<doc:description> Specifies whether the attributes
described in the physical stream are found in
columns or rows. The valid values are column or row.
If set to 'column', then the attributes are in
columns. If set to 'row', then the attributes
are in rows. Row orientation is rare, but some
systems such as SPlus and R utilize it.
For example, some data with column orientation:
DATE PLOT SPECIES
2002-01-15 hfr5 acer rubrum
2002-01-15 hfr5 acer xxxx
The same data in a rowMajor table:
DATE 2002-01-15
PLOT hfr5
SPECIES acer rubrum acer xxxx
</doc:description>
<doc:example>column</doc:example>
<doc:example>row</doc:example>
</xs:appinfo>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="column"/>
<xs:enumeration value="row"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:choice>
<xs:element name="simpleDelimited">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Simple delimited format
</doc:tooltip>
<doc:summary>A simple delimited format.
</doc:summary>
<doc:description>A simple delimited format that
uses one of a series of delimiters to indicate
the ends of fields in the data stream. More
complex formats such as fixed format or mixed
delimited and fixed formats can be described using
the "complex" element.
</doc:description>
</xs:appinfo>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="fieldDelimiter" type="xs:string" maxOccurs="unbounded">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Field Delimiter character
</doc:tooltip>
<doc:summary>Character used to delimit the
end of an attribute</doc:summary>
<doc:description>This element specifies
a character to be used in the object for
indicating the ending column for an attribute.
The delimiter character itself is not part
of the attribute value, but rather is present
in the column following the last character
of the value. Typical delimiter characters
include commas, tabs, spaces, and semicolons.
The only time the fieldDelimiter character is
not interpreted as a delimiter is if it
is contained in a quoted string
(see quoteCharacter) or is immediately
preceded by a literalCharacter.
Non-printable quote characters can be
provided as their hex values, and for tab
characters by its ASCII string "\t".
Processors should assume that the field
starts in the column following the previous
field if the previous field was fixed,
or in the column following the delimiter
from the previous field if the previous
field was delimited.
</doc:description>
<doc:example>,</doc:example>
<doc:example>\t</doc:example>
<doc:example>0x09</doc:example>
<doc:example>0x20</doc:example>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="collapseDelimiters" minOccurs="0">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Treat consecutive delimiters
as one</doc:tooltip>
<doc:summary>Specification of how to
handle consecutive delimiters while
parsing</doc:summary>
<doc:description>
The collapseDelimiters element
specifies whether sequential delimiters
should be treated as a single delimiter or
multiple delimiters. An example is when
a space delimiter is used; often there may
be several repeated spaces that should be
treated as a single delimiter, but not
always. The valid values are yes or no.
If it is set to yes, then consecutive
delimiters will be collapsed to one. If set
to no or absent, then consecutive delimiters
will be treated as separate delimiters.
Default behaviour is no; hence, consecutive
delimiters will be treated as separate
delimiters, by default.
</doc:description>
<doc:example>yes</doc:example>
<doc:example>no</doc:example>
</xs:appinfo>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="yes"/>
<xs:enumeration value="no"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="quoteCharacter" type="res:NonEmptyStringType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Quote character</doc:tooltip>
<doc:summary>Character used to quote values
for delimiter escaping</doc:summary>
<doc:description>This element specifies
a character to be used in the object for
quoting values so that field delimiters can
be used within the value. This basically
allows delimiter "escaping". The quoteChacter
is typically a " or '. When a processor
encounters a quote character, it should
not interpret any following characters as
a delimiter until a matching quote character
has been encountered (i.e., quotes come in
pairs). It is an error to not provide a
closing quote before the record ends.
Non-printable quote characters can be
provided as their hex values.
</doc:description>
<doc:example>"</doc:example>
<doc:example>'</doc:example>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="literalCharacter" type="res:NonEmptyStringType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Literal character</doc:tooltip>
<doc:summary>Character used to escape other
special characters</doc:summary>
<doc:description>This element specifies
a character to be used for escaping
special character values so that they
are treated as literal values.
This allows "escaping" for special
characters like quotes, commas, and spaces
when they are intended to be used in an
attribute value rather than being intended
as a delimiter. The literalCharacter is
typically a \.</doc:description>
<doc:example>\</doc:example>
</xs:appinfo>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="complex">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Complex text format
</doc:tooltip>
<doc:summary>A complex text format.
</doc:summary>
<doc:description>A complex text format that
can describe delimited fields, fixed width
fields, and mixtures of the two. This supports
multiline records (where one record is distributed
across multiple physical lines). When using the
complex format, the number of textFixed and
textDelimited elements should exactly equal the
number of attributes that have been described
for the entity, and the order of the textFixed
and textDelimited elements should correspond to
the order of the attributes as described in the
entity. Thus, for a delimited file with fourteen
attributes, one should provide exactly fourteen
textDelimited elements.
</doc:description>
</xs:appinfo>
</xs:annotation>
<xs:complexType>
<xs:choice maxOccurs="unbounded">
<xs:element name="textFixed">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Fixed format text
</doc:tooltip>
<doc:summary>Describes the physical format
of data sequences that use a fixed
number of characters in a specified position
in the stream to locate attribute values.
</doc:summary>
<doc:description>Describes the physical
format of data sequences that use a fixed
number of characters in a specified position
in the stream to locate attribute values.
This method is common in sensor-derived
data and in legacy database systems. To
parse it, one must know the number
of characters for each attribute and the
starting column and line to begin reading
the value.
</doc:description>
</xs:appinfo>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="fieldWidth" type="xs:unsignedLong">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Field width</doc:tooltip>
<doc:summary>Field width in
characters for fixed field
length.</doc:summary>
<doc:description>Fixed width fields
have a set length, thus the end of
the field can always be determined by
adding the fieldWidth to the starting
column number.</doc:description>
<doc:example>7</doc:example>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="lineNumber" type="xs:unsignedLong" minOccurs="0">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Physical Line Number
</doc:tooltip>
<doc:summary>The line on which
the data field is found, when
the data record is written over
more than one physical line in
the file.</doc:summary>
<doc:description>A single logical
data record may be written over
several physical lines in a file,
with no special marker to indicate
the end of a record. In such
cases, the relative location of
a data field must be indicated
by both relative row and column
number. The lineNumber should never
greater that the number of physical
lines per record.
</doc:description>
<doc:example>3</doc:example>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="fieldStartColumn" type="xs:long" minOccurs="0">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Start column
</doc:tooltip>
<doc:summary>The starting
column number for a fixed format
attribute.</doc:summary>
<doc:description>Fixed width fields
have a set length, thus the end of
the field can always be determined by
adding the fieldWidth to the starting
column number. If the starting
column is not provided, processors
should assume that the field starts
in the column following the previous
field if the previous field was fixed,
or in the column following the
delimiter from the previous field if
the previous field was delimited.
</doc:description>
<doc:example>58</doc:example>
</xs:appinfo>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="textDelimited">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Delimited format text
</doc:tooltip>
<doc:summary>Describes the physical format
of data sequences that use delimiters
in the stream to locate attribute values.
</doc:summary>
<doc:description>Describes the physical
format of data sequences that use delimiters
in the stream to locate attribute values.
This method is common in data exported from
spreadsheets and database systems,
To parse it, one must know the character
that indicates the end of each attribute
and the line to begin reading the value.
</doc:description>
</xs:appinfo>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="fieldDelimiter" type="xs:string">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Field Delimiter character
</doc:tooltip>
<doc:summary>Character used
to delimit the end of a particular
attribute</doc:summary>
<doc:description>This element
specifies a character to be used
in the object for indicating the
ending column for an attribute.
The delimiter character itself is
not part of the attribute value,
but rather is present in the column
following the last character of the
value. Typical delimiter characters
include commas, tabs, spaces,
and semicolons. The only time the
fieldDelimiter character is not
interpreted as a delimiter is if it
is contained in a quoted string (see
quoteCharacter) or is immediately
preceded by a literalCharacter.
Non-printable quote characters can
be provided as their hex values,
and for tab characters by its ASCII
string "\t". Processors should
assume that the field starts in the
column following the previous field
if the previous field was fixed,
or in the column following the
delimiter from the previous field
if the previous field was delimited.
</doc:description>
<doc:example>,</doc:example>
<doc:example>\t</doc:example>
<doc:example>0x09</doc:example>
<doc:example>0x20</doc:example>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="collapseDelimiters" minOccurs="0">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Treat consecutive
delimiters as single</doc:tooltip>
<doc:summary>Specification of how
to handle consecutive delimiters
while parsing </doc:summary>
<doc:description>
The collapseDelimiters element
specifies whether sequential delimiters
should be treated as a single delimiter
or multiple delimiters. An example
is when a space delimiter is used;
often there may be several repeated
spaces that should be treated as a
single delimiter, but not always. The
valid values are yes or no. If it
is set to yes, then consecutive
delimiters will be collapsed
to one. If set to no or absent,
then consecutive delimiters will
be treated as separate delimiters.
Default behaviour is no; hence,
consecutive delimiters will be treated
as separate delimiters, by default.
</doc:description>
<doc:example>yes</doc:example>
<doc:example>no</doc:example>
</xs:appinfo>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="yes"/>
<xs:enumeration value="no"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="lineNumber" type="xs:unsignedLong" minOccurs="0">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Physical Line Number
</doc:tooltip>
<doc:summary>The line on which
the data field is found, when
the data record is written over
more than one physical line in
the file.</doc:summary>
<doc:description>A single logical
data record may be written over
several physical lines in a file,
with no special marker to indicate
the end of a record. In such
cases, the relative location of
a data field must be indicated
by both relative row and column
number.
The lineNumber should never be
greater that the number of physical
lines per record. When parsing the
first field on a physical line as
a delimited field, they should assume
that the field data starts in the
first column. Otherwise, follow the
rules indicated under fieldDelimiter.
</doc:description>
<doc:example>3</doc:example>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="quoteCharacter" type="res:NonEmptyStringType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Quote character
</doc:tooltip>
<doc:summary>Character used
to quote values for delimiter
escaping</doc:summary>
<doc:description>This element
specifies a character to be used in
the object for quoting values so
that field delimiters can be used
within the value. This basically
allows delimiter "escaping". The
quoteChacter is typically a " or
'. When a processor encounters
a quote character, it should not
interpret any following characters
as a delimiter until a matching
quote character has been encountered
(i.e., quotes come in pairs). It is
an error to not provide a closing
quote before the record ends.
Non-printable quote characters
can be provided as their hex
values.</doc:description>
<doc:example>"</doc:example>
<doc:example>'</doc:example>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="literalCharacter" type="res:NonEmptyStringType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Literal character
</doc:tooltip>
<doc:summary>Character used
to escape other special
characters</doc:summary>
<doc:description>This element
specifies a character to be used
for escaping special character
values so that they are treated
as literal values. This allows
"escaping" for special characters
like quotes, commas, and spaces
when they are intended to be used
in an attribute value rather than
being intended as a delimiter.
The literalCharacter is typically
a \.</doc:description>
<doc:example>\</doc:example>
</xs:appinfo>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="externallyDefinedFormat">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Externally Defined Format</doc:tooltip>
<doc:summary>Information about a non-text or proprietary
formatted object.
</doc:summary>
<doc:description>Information about a non-text or
proprietary formatted object.
The description names the format explicitly, but assumes
a processor implicitly knows how to parse that format
to extract the data. A format version can be included.
This is mainly used for proprietary formats, including
binary files like Microsoft Excel and text formats like
ESRI's ArcInfo export format. This is not a recommended
way to permanently archive data because the software to
parse the format is unlikely to be available over extended
periods, but is included to allow for commonly used
physical formats.
</doc:description>
</xs:appinfo>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="formatName" type="res:NonEmptyStringType">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Format Name</doc:tooltip>
<doc:summary>Name of the format of the data
object</doc:summary>
<doc:description>Name of the format of
the data object</doc:description>
<doc:example>Microsoft Excel</doc:example>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="formatVersion" type="res:NonEmptyStringType" minOccurs="0">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Format Version</doc:tooltip>
<doc:summary>Version of the format of the
data object</doc:summary>
<doc:description>Version of the format of
the data object</doc:description>
<doc:example>2000 (9.0.2720)</doc:example>
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element name="citation" type="cit:CitationType" minOccurs="0">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Format citation</doc:tooltip>
<doc:summary>Citation providing more details about
the physical format.
</doc:summary>
<doc:description>Citation providing more detail about
the physical format, including parsing information
or information about the software required for
reading the object.</doc:description>
</xs:appinfo>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="binaryRasterFormat">
<xs:annotation>
<xs:appinfo>
<doc:tooltip>Raster image format</doc:tooltip>
<doc:summary>Contains binary raster data header
parameters</doc:summary>
<doc:description>The binaryRasterInfo element is a
container for various parameters used to described the
contents of binary raster image files. In this case, it is
based on a white paper on the ESRI site that describes the
header information used for BIP and BIL files ("Extendable
Image Formats for ArcView GIS 3.1 and
3.2").</doc:description>
</xs:appinfo>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="rowColumnOrientation">