<?xml version="1.0" encoding="UTF-8"?> <!-- Copyright (c) 2009 DDI Alliance, DDI 3.1, 2009-10-18 This file is part of DDI 3.1 XML Schema. DDI 3.1 XML Schema is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. DDI 3.1 XML Schema 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 Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with DDI 3.1 XML Schema. If not, see <http://www.gnu.org/licenses/>. --> <xs:schema elementFormDefault="qualified" targetNamespace="ddi:physicaldataproduct:3_1" xmlns="ddi:physicaldataproduct:3_1" xmlns:ds="ddi:dataset:3_1" xmlns:r="ddi:reusable:3_1" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <!-- PHYSICAL DATA PRODUCT --> <xs:annotation> <xs:documentation> Describes the physical layout of the data documented in the logical product module. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> Describes the physical layout of the data documented in the logical product module. </xs:documentation> </xs:annotation> <xs:complexContent> <xs:sequence> <xs:annotation> <xs:documentation> References other resources related to the described physical data product. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation>Note regarding the physical data product.</xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> A maintainable scheme containing the physical structures of the physical data product. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> A maintainable scheme containing the record layouts of the physical data product. </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:annotation> <xs:documentation> A maintainable scheme describing physical structures. </xs:documentation> </xs:annotation> <xs:complexContent> <xs:sequence> <xs:annotation> <xs:documentation> A display label for the physical structure scheme. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> A description of the use of the physical structure scheme. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> Provides for inclusion by reference of external physical structure schemes. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> Describes a physical structure within the physical structure scheme. </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:annotation> <xs:documentation> Description of a physical structure .These are used by record layouts to describe the full structure of a physical instance. </xs:documentation> </xs:annotation> <xs:complexContent> <xs:sequence> <xs:annotation> <xs:documentation> References the logical data product that describes the intellectual content of this physical data product. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> Description of the physical format of data file (e.g., SAS save file, Delimited file, Fixed format file). </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> An explicit definition of the data type that is applied to the majority of the dataitems reducing the amount of repetitive markup required. It can be overridden at the dataitem level. This field is necessary in the case of some numeric data formats where the format definition would allow real values, but the values are integer values. Allowed values are: integer (default), real, string. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> Delimiter definition for delimited (free field) data that is applied to the majority of the dataitems reducing the amount of repetitive markup required. It can be overridden at the dataitem level. Allowed values are: Empty (default), Tab, Blank, AnyString. If a delimiter is used, free field (delimited data) is assumed; binary formats are not allowed. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> Number of decimal places for data with an implied decimal separator that is applied to the majority of the dataitems reducing the amount of repetitive markup required. It can be overridden at the dataitem level. Another expression is the decimal scaling factor (SAS). Default: 0. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> The character used to separate the integer and the fraction part of a number (if an explicit separator is used in the data) that is applied to the majority of the dataitems reducing the amount of repetitive markup required. It can be overridden at the dataitem level. Allowed values are: None (default), Dot, Comma, Other. On the basis of the data definition in DDI documents, data processing tools could compute the necessary precision width on the basis of the format width and the existence of separators. Appropriate data types could be used, i.e. float or double, short or long. The decimal separator definition only makes sense with some XML Schema primitives. This is a default which may be overridden in specific cases. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> The character used to separate groups of digits (if an explicit separator is used in the data) that is applied to the majority of the dataitems reducing the amount of repetitive markup required. It can be overridden at the dataitem level. Allowed values are: None (default), Dot, Comma, Other. The decimal separator definition makes only sense with some XML Schema primitives. This is a default which may be overridden in specific cases. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> General information about missing data (e.g., that missing data have been standardized across the collection, missing data are present because of merging) that is applied to the majority of the dataitems reducing the amount of repetitive markup required. It can be overridden at the dataitem level. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> Characteristics of the physical storage of a logical record, as described in the DataRelationship section of the logical product. </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:annotation> <xs:documentation> a maintainable scheme describing physical structures. </xs:documentation> </xs:annotation> <xs:complexContent> <xs:sequence> <xs:annotation> <xs:documentation>A display label for the record layout scheme.</xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> A description of the use of the record layout scheme. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> Provides for inclusion by reference of external record layout schemes. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> Describes the number and type of records in a data structure. Note that this element is abstract, and only serves as the head of a substitution group containing all the various types of record layouts. </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:annotation> <xs:documentation> Characteristics of the physical storage of a logical record type as described in the DataRelationship section of the logical product. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> Describes characteristics of the physical storage of a logical record, as described in the DataRelationship section of the logical product. </xs:documentation> </xs:annotation> <xs:complexContent> <xs:sequence> <xs:annotation> <xs:documentation> Reference to the LogicalProduct:DataRelationship:LogicalRecord:RecordType:Idenfication. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> A logical record may be stored in one or more segments housed hierarchically in a single file or in separate data files. All logical records have at least one segment. </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> <xs:annotation> <xs:documentation> Number of records segments each logical record (case) is divided into. Express as an integer. </xs:documentation> </xs:annotation> </xs:attribute> </xs:extension> </xs:complexContent> </xs:complexType> <!-- RECORD LAYOUT --> <xs:annotation> <xs:documentation> This element is an abstract element used as the head of a substitution group for other elements which describe specific record layouts. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> This type structures an abstract element which is used only as the head of a substitution group. </xs:documentation> </xs:annotation> <xs:complexContent> <xs:sequence> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:annotation> <xs:documentation> References a physical data product and the ID of the physical record segment from that is described by this record layout. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> References a physical data product and the ID of the physical record segment from that is described by this record layout. </xs:documentation> </xs:annotation> <xs:complexContent> <xs:sequence> <xs:annotation> <xs:documentation> References the ID of PhysicalRecordSegment that describes the coverage of the record contents. </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <!-- COMMON RECORD LAYOUT - NON-NCUBE --> <xs:annotation> <xs:documentation>Describes the record layout.</xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation>Describes the record layout.</xs:documentation> </xs:annotation> <xs:complexContent> <xs:sequence> <xs:annotation> <xs:documentation> Character set used in the data file (e.g., US ASCII, EBCDIC, UTF-8). This is a required field. If the character set is not known, for example for some proprietary data files, enter "unspecified". </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> Sets the array base for any arrays used in the definition (that is, whether the first value is in position 0 or 1, etc.). This may be the data array in a delimited data file or the measure array for measures that are bundled and stored in a single location. Array base is generally set to either 0 or 1. There is no override provided as systems processing a record would use a consistent array base. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> References a variable scheme for the RecordLayout. This can be overridden by individual dataitems if they are from a different variable scheme. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> Includes a reference to a variable, and information about its data item location and its data type/format. </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> <xs:annotation> <xs:documentation> If value is true, then the names of the variables are on the first row of the data file. </xs:documentation> </xs:annotation> </xs:attribute> </xs:extension> </xs:complexContent> </xs:complexType> <xs:annotation> <xs:documentation> A logical record may be stored in one or more segments housed hierarchically in a single file or in separate data files. All logical records have at least one segment. </xs:documentation> </xs:annotation> <xs:complexContent> <xs:sequence> <xs:sequence> <xs:annotation> <xs:documentation> Reference to the Unique key variable for segment identification. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> If the file containing this segment has a standard section of its file name, include it here. For example a segment number. </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:sequence> <xs:annotation> <xs:documentation> Indicates the position of this physical record segment within the logical record expressed as an integer. </xs:documentation> </xs:annotation> </xs:attribute> <xs:annotation> <xs:documentation> A value of false implies default identification is by segment order in file if segmentOrder is greater than 1. If value is true, a segment key must be declared in a KeyVariableReference. </xs:documentation> </xs:annotation> </xs:attribute> </xs:extension> </xs:complexContent> </xs:complexType> <xs:annotation> <xs:documentation> Reference to the Unique key variable for segment identification. </xs:documentation> </xs:annotation> <xs:complexContent> <xs:sequence> <xs:annotation> <xs:documentation>Value of the variable for this segment.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:annotation> <xs:documentation> Includes a reference to a variable, and information about its data item location and its data type/format. </xs:documentation> </xs:annotation> <xs:sequence> <xs:annotation> <xs:documentation> Reference to the variable expressed in this data item. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> Includes information about the relevant record group, as well as the data item location and data type/format information for the referenced variable. </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> <xs:annotation> <xs:documentation> Includes information about the data item location and its data type/format if other than the default. </xs:documentation> </xs:annotation> <xs:sequence> <xs:annotation> <xs:documentation> An explicit definition of the data type. This field is necessary in the case of some numeric data formats where the format definition would allow real values, but the values are integer values. Allowed values are: integer (default), real, string. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> Delimiter definition for delimited (free field) data. Allowed values are: Empty (default), Tab, Blank, AnyString. If a delimiter is used, free field (delimited data) is assumed; binary formats are not allowed. </xs:documentation> </xs:annotation> </xs:element> <xs:sequence> <xs:annotation> <xs:documentation> Position of the first character of the data item in fixed format file. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> Array number of the data item for delimited files. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> Position of the last character of the data item in fixed format. Must be specified if a value for Width is not provided. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> Data item width for fixed format file, maximum width for delimited file. Must be specified if a value for EndPosition is not provided. </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> <xs:annotation> <xs:documentation> Number of decimal places for data with an implied decimal separator. Another expression is the decimal scaling factor (SAS). Default: 0. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> The character used to separate the integer and the fraction part of a number (if an explicit separator is used in the data). Allowed values are: None (default), Dot, Comma, Other. On the basis of the data definition in DDI documents, data processing tools could compute the necessary precision width on the basis of the format width and the existence of separators. Appropriate data types could be used, i.e. float or double, short or long. The decimal separator definition only makes sense with some XML Schema primitives. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> The character used to separate groups of digits (if an explicit separator is used in the data). Allowed values are: None (default), Dot, Comma, Other. The decimal separator definition makes only sense with some XML Schema primitives. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation>A two-character ISO language code.</xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> A two-character ISO country code, to supplement the LanguageOfData value. </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> <xs:annotation> <xs:documentation> A maintainable scheme containing the physical structures of the physical data product. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> Reference to a physical structure scheme for inclusion by reference in another physical structure scheme. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> Describes a physical structure within physical structure scheme. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> A maintainable scheme containing the record layouts of the physical data product. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> Reference to a record layout scheme for inclusion by reference in another record layout scheme. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> References the logical data product that describes the intellectual content of this physical data product. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> Reference to the key variable that may be used to link related records. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> Reference to a default variable scheme for the RecordLayout. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> Includes a reference to a variable, and information about its data item location and its data type/format. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> Includes information about the data item location and its data type/format if other than the default. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> The character used to separate the integer and the fraction part of a number (if an explicit separator is used in the data). Allowed values are: None (default), Dot, Comma, Other. On the basis of the data definition in DDI documents, data processing tools could compute the necessary precision width on the basis of the format width and the existence of separators. Appropriate data types could be used, i.e. float or double, short or long. The decimal separator definition only makes sense with some XML Schema primitives. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> The character used to separate the integer and the fraction part of a number (if an explicit separator is used in the data). Allowed values are: None (default), Dot, Comma, Other. On the basis of the data definition in DDI documents, data processing tools could compute the necessary precision width on the basis of the format width and the existence of separators. Appropriate data types could be used, i.e. float or double, short or long. The decimal separator definition only makes sense with some XML Schema primitives. This is a default which may be overridden in specific cases. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> The character used to separate groups of digits (if an explicit separator is used in the data). Allowed values are: None (default), Dot, Comma, Other. The decimal separator definition makes only sense with some XML Schema primitives. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> The character used to separate groups of digits (if an explicit separator is used in the data). Allowed values are: None (default), Dot, Comma, Other. The decimal separator definition makes only sense with some XML Schema primitives. This is a default which may be overridden in specific cases. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> A logical record may be stored in one or more segments housed hierarchically in a single file or in separate data files. All logical records have at least one segment. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> Reference to the Unique key variable for segment identification. </xs:documentation> </xs:annotation> </xs:element> <xs:annotation> <xs:documentation> Reference to the LogicalProduct:DataRelationship:LogicalRecord:RecordType:Idenfication. </xs:documentation> </xs:annotation> </xs:element> </xs:schema> |
XML schema documentation generated with DocFlex/XML SDK 1.7.2 using DocFlex/XML XSDDoc 2.1.0 template set |