XML Schema "dataset.xsd"
Target Namespace:
ddi:dataset:3_2
Defined Components:
elements (10 global + 1 local), complexTypes (8)
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
D:\XMLSchema\DDI\DDI_3_2_2014-02-05_Documentation_XMLSchema\XMLSchema\dataset.xsd; see XML source
Imports Schemas (2):
physicaldataproduct.xsd [src], reusable.xsd [src]
Imported by Schemas (1):
instance.xsd [src]
All Element Summary
DataSet
DataSet is a substitution for a BaseRecordLayout and allows for in-line inclusion of micro or unit level data in the metadata file.
Type:
Content:
complex, 7 attributes, 20 elements
Subst.Gr:
may substitute for element p:BaseRecordLayout
Defined:
globally; see XML source
Used:
DataSetName
Name of the Data Set using the DDI Name structure.
Type:
Content:
complex, 2 attributes, 1 element
Defined:
globally; see XML source
Used:
IdentifyingVariableReference
Reference to an existing Variable using the Reference structure.
Type:
Content:
complex, 7 attributes, 6 elements
Defined:
globally; see XML source
Used:
ItemSet
Storage form for random order item variables.
Type:
Content:
complex, 1 element
Defined:
globally; see XML source
Used:
ItemValue
Each value in the data set linked to it's variable and record identification.
Type:
Content:
complex, 3 elements
Defined:
globally; see XML source
Used:
Record
For each record, contains the values for the items in order by the specified variable sequence.
Type:
Content:
complex, 1 element
Defined:
globally; see XML source
Used:
RecordReference
The value of the record identifier or key.
Type:
xs:string
Content:
simple
Defined:
locally within ItemValueType complexType; see XML source
RecordSet
Storage format arranged record by record.
Type:
Content:
complex, 2 elements
Defined:
globally; see XML source
Used:
VariableItem
The set of values associated with a single variable (one for each record in storage order of records).
Type:
Content:
complex, 2 elements
Defined:
globally; see XML source
Used:
VariableOrder
A set of References to Variable found in the record in storage order.
Type:
Content:
complex, 1 element
Defined:
globally; see XML source
Used:
VariableSet
Storage form arranged variable by variable.
Type:
Content:
complex, 1 element
Defined:
globally; see XML source
Used:
Complex Type Summary
DataSet is a substitution for a BaseRecordLayout and allows for in-line inclusion of micro or unit level data in the metadata file.
Content:
complex, 7 attributes, 20 elements
Defined:
globally; see XML source
Includes:
definitions of 7 elements
Used:
Storage format for random order item variables.
Content:
complex, 1 element
Defined:
globally; see XML source
Includes:
definition of 1 element
Used:
Each value in the data set linked to it's variable and record identification.
Content:
complex, 3 elements
Defined:
globally; see XML source
Includes:
definitions of 3 elements
Used:
Storage format arranged record by record.
Content:
complex, 2 elements
Defined:
globally; see XML source
Includes:
definitions of 2 elements
Used:
For each record, contains the values for the items in order by the specified variable sequence.
Content:
complex, 1 element
Defined:
globally; see XML source
Includes:
definition of 1 element
Used:
The set of values associated with a single variable (one for each record in storage order of records).
Content:
complex, 2 elements
Defined:
globally; see XML source
Includes:
definitions of 2 elements
Used:
A set of References to Variable found in the record in storage order.
Content:
complex, 1 element
Defined:
globally; see XML source
Includes:
definition of 1 element
Used:
Storage format arranged variable by variable.
Content:
complex, 1 element
Defined:
globally; see XML source
Includes:
definition of 1 element
Used:
XML Source
<?xml version="1.0" encoding="UTF-8"?>
<!--

Copyright (c) 2014 DDI Alliance, DDI 3.2 release, 2014-02-05

This file is part of DDI 3.2 XML Schema.

DDI 3.2 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.2 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.2 XML Schema. If not, see <http://www.gnu.org/licenses/>.
-->
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="ddi:dataset:3_2" xmlns="ddi:dataset:3_2" xmlns:p="ddi:physicaldataproduct:3_2" xmlns:r="ddi:reusable:3_2" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="ddi:reusable:3_2" schemaLocation="reusable.xsd"/>
<xs:import namespace="ddi:physicaldataproduct:3_2" schemaLocation="physicaldataproduct.xsd"/>
<xs:element name="DataSet" substitutionGroup="p:BaseRecordLayout" type="DataSetType">
<xs:annotation>
<xs:documentation>
DataSet is a substitution for a BaseRecordLayout and allows for in-line inclusion of micro or unit level data in the metadata file. Data may be organized as a Record Set, Item Set, or Variable Set.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="DataSetType">
<xs:annotation>
<xs:documentation>
DataSet is a substitution for a BaseRecordLayout and allows for in-line inclusion of micro or unit level data in the metadata file. This is valuable for small datasets or cases where there is a need to combine the metadata and data within a single file. In addition to the PhysicalStructureReference the DataSet indicates the ArrayBase if applicable, a name for the DataSet, a reference to the default Variable Scheme used by the data set, a reference to an Identifying Variable (e.g. case number), and a choice of organization order for the data: Record Set, Item Set, or Variable Set. RecordSet describes records of data which contain the same variables in the same order, ItemSet describes individual items of a dataset in any order. VariableSet describes the values for a given variable in record order.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="p:BaseRecordLayoutType">
<xs:sequence>
<xs:element minOccurs="0" ref="r:ArrayBase">
<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.).
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="DataSetName">
<xs:annotation>
<xs:documentation>
A name for the data set. May be expressed in multiple languages. Repeat the element to express names with different content, for example different names for different systems.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="IdentifyingVariableReference">
<xs:annotation>
<xs:documentation>
Reference to the variable used to identify a specific record within the data set (unique identifier or key).
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:DefaultVariableSchemeReference">
<xs:annotation>
<xs:documentation>
A reference to the Variable Scheme containing all or a majority of the variables in the data set. May be overridden by an individual VariableReference.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:choice minOccurs="0">
<xs:element ref="RecordSet">
<xs:annotation>
<xs:documentation>
Storage format arranged record by record. A RecordSet requires a list of variables to appear in a specified order.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="ItemSet">
<xs:annotation>
<xs:documentation>
Storage format for random order item variables. Each ItemValue references it's defining variable, it's record identifier, and the it's value.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="VariableSet">
<xs:annotation>
<xs:documentation>
Storage format arranged variable by variable. Item values are listed in record order with the assumption that each record will occupy the position in each array.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="RecordSetType">
<xs:annotation>
<xs:documentation>
Storage format arranged record by record. A RecordSet requires a list of variables to appear in a specified order. Provides a consistent order for the variables and a set of values for each record displayed in variable order.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element minOccurs="0" ref="VariableOrder">
<xs:annotation>
<xs:documentation>
Provides the sequence of variables representing the order of storage within each record.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" ref="Record">
<xs:annotation>
<xs:documentation>
For each record, contains the values for the items in order by the specified variable sequence.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:element name="RecordSet" type="RecordSetType">
<xs:annotation>
<xs:documentation>
Storage format arranged record by record. A RecordSet requires a list of variables to appear in a specified order.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="VariableOrderType">
<xs:annotation>
<xs:documentation>
A set of References to Variable found in the record in storage order.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element maxOccurs="unbounded" ref="r:VariableReference">
<xs:annotation>
<xs:documentation>
References variables in storage order. One reference per variable.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:element name="VariableOrder" type="VariableOrderType">
<xs:annotation>
<xs:documentation>
A set of References to Variable found in the record in storage order.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="RecordType">
<xs:annotation>
<xs:documentation>
For each record, contains the values for the items in order by the specified variable sequence.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element maxOccurs="unbounded" ref="r:Value">
<xs:annotation>
<xs:documentation>An individual item value.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:element name="Record" type="RecordType">
<xs:annotation>
<xs:documentation>
For each record, contains the values for the items in order by the specified variable sequence.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="ItemSetType">
<xs:annotation>
<xs:documentation>
Storage format for random order item variables. Each ItemValue references it's defining variable, it's record identifier, and the it's value.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element maxOccurs="unbounded" ref="ItemValue">
<xs:annotation>
<xs:documentation>
Each value in the data set linked to it's variable and record identification.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="ItemValueType">
<xs:annotation>
<xs:documentation>
Each value in the data set linked to it's variable and record identification.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element minOccurs="0" ref="r:VariableReference">
<xs:annotation>
<xs:documentation>Reference to the variable describing the item.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="RecordReference" type="xs:string">
<xs:annotation>
<xs:documentation>
The value of the record identifier or key. This is the value found in the item linked to the variable identified by the DataSet in the IdentifyingVariableReference.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" ref="r:Value">
<xs:annotation>
<xs:documentation>
The value of the item for the specified variable and record.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:element name="DataSetName" type="r:NameType">
<xs:annotation>
<xs:documentation>
Name of the Data Set using the DDI Name structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:annotation>
<xs:documentation>
Reference to an existing Variable using the Reference structure. TypeOfObject should be set to Variable.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ItemSet" type="ItemSetType">
<xs:annotation>
<xs:documentation>Storage form for random order item variables.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ItemValue" type="ItemValueType">
<xs:annotation>
<xs:documentation>
Each value in the data set linked to it's variable and record identification.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="VariableSetType">
<xs:annotation>
<xs:documentation>
Storage format arranged variable by variable. Item values are listed in record order with the assumption that each record will occupy the position in each array.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element maxOccurs="unbounded" ref="VariableItem">
<xs:annotation>
<xs:documentation>
The set of values associated with a single variable (one for each record in storage order of records).
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:element name="VariableSet" type="VariableSetType">
<xs:annotation>
<xs:documentation>Storage form arranged variable by variable.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="VariableItemType">
<xs:annotation>
<xs:documentation>
The set of values associated with a single variable (one for each record in storage order of records).
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element minOccurs="0" ref="r:VariableReference">
<xs:annotation>
<xs:documentation>
Reference to the variable associated with the values given.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" ref="r:Value">
<xs:annotation>
<xs:documentation>
Value associated with the referenced variable in record storage order.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:element name="VariableItem" type="VariableItemType">
<xs:annotation>
<xs:documentation>
The set of values associated with a single variable (one for each record in storage order of records).
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:schema>

XML schema documentation generated with DocFlex/XML RE 1.9.0 using DocFlex/XML XSDDoc 2.8.0 template set