DDI 3.1 XML Schema Documentation (2009-10-18)
© DDI Alliance 2009 - licensed under the terms of the GNU Lesser General Public License

Schema Summary

physicaldataproduct.xsd

Target Namespace: ddi:physicaldataproduct:3_1 Defined Components: 25 global elements, 19 local elements, 12 complexTypes Default Namespace-Qualified Form: Local Elements: qualified; Local Attributes: unqualified Schema Location: http://www.ddialliance.org/DDI/schema/ddi3.1/physicaldataproduct.xsd, see XML source Imports Schema: reusable.xsd Imported by Schemas (8): dataset.xsd, group.xsd, instance.xsd, physicaldataproduct_ncube_inline.xsd, physicaldataproduct_ncube_normal.xsd, physicaldataproduct_ncube_tabular.xsd, physicaldataproduct_proprietary.xsd, studyunit.xsd

All Element Summary
ArrayBase (in RecordLayout)	Sets the array base for any arrays used in the definition (that is, whether the first value is in position 0 or 1, etc.). Type: xs:integer Content: simple Defined: locally within complexType RecordLayoutType in physicaldataproduct.xsd, see XML source
ArrayPosition (type xs:integer)	Array number of the data item for delimited files. Type: xs:integer Content: simple Defined: locally within complexType PhysicalLocationType in physicaldataproduct.xsd, see XML source
BaseRecordLayout	This element is an abstract element used as the head of a substitution group for other elements which describe specific record layouts. Type: BaseRecordLayoutType Content: complex, 7 attributes, 4 elements Abstract: (may not be used directly in instance XML documents) Subst.Gr: may be substituted with 6 elements Defined: globally in physicaldataproduct.xsd, see XML source Used: at 7 locations
CharacterSet (in RecordLayout)	Character set used in the data file (e.g., US ASCII, EBCDIC, UTF-8). Type: CodeValueType Content: simple, 7 attributes Defined: locally within complexType RecordLayoutType in physicaldataproduct.xsd, see XML source
DataItem	Includes a reference to a variable, and information about its data item location and its data type/format. Type: DataItemType Content: complex, 2 elements Defined: globally in physicaldataproduct.xsd, see XML source Used: at 1 location
DecimalPositions (type xs:integer)	Number of decimal places for data with an implied decimal separator. Type: xs:integer Content: simple Defined: locally within complexType PhysicalLocationType in physicaldataproduct.xsd, see XML source
DecimalSeparator	The character used to separate the integer and the fraction part of a number (if an explicit separator is used in the data). Type: OneCharStringType Content: simple Defined: globally in physicaldataproduct.xsd, see XML source Used: at 1 location
DefaultDataType (in PhysicalStructure)	An explicit definition of the data type that is applied to the majority of the dataitems reducing the amount of repetitive markup required. Type: xs:string Content: simple Defined: locally within complexType PhysicalStructureType in physicaldataproduct.xsd, see XML source
DefaultDecimalPositions (in PhysicalStructure)	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. Type: xs:integer Content: simple Defined: locally within complexType PhysicalStructureType in physicaldataproduct.xsd, see XML source
DefaultDecimalSeparator	The character used to separate the integer and the fraction part of a number (if an explicit separator is used in the data). Type: OneCharStringType Content: simple Defined: globally in physicaldataproduct.xsd, see XML source Used: at 1 location
DefaultDelimiter (in PhysicalStructure)	Delimiter definition for delimited (free field) data that is applied to the majority of the dataitems reducing the amount of repetitive markup required. Type: xs:string Content: simple Defined: locally within complexType PhysicalStructureType in physicaldataproduct.xsd, see XML source
DefaultDigitGroupSeparator	The character used to separate groups of digits (if an explicit separator is used in the data). Type: OneCharStringType Content: simple Defined: globally in physicaldataproduct.xsd, see XML source Used: at 1 location
DefaultMissingData (in PhysicalStructure)	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. Type: xs:string Content: simple Defined: locally within complexType PhysicalStructureType in physicaldataproduct.xsd, see XML source
DefaultVariableSchemeReference	Reference to a default variable scheme for the RecordLayout. Type: ReferenceType Content: complex, 6 attributes, 6 elements Defined: globally in physicaldataproduct.xsd, see XML source Used: at 1 location
Delimiter (type xs:string)	Delimiter definition for delimited (free field) data. Type: xs:string Content: simple Defined: locally within complexType PhysicalLocationType in physicaldataproduct.xsd, see XML source
DigitGroupSeparator	The character used to separate groups of digits (if an explicit separator is used in the data). Type: OneCharStringType Content: simple Defined: globally in physicaldataproduct.xsd, see XML source Used: at 1 location
EndPosition (type xs:integer)	Position of the last character of the data item in fixed format. Type: xs:integer Content: simple Defined: locally within complexType PhysicalLocationType in physicaldataproduct.xsd, see XML source
FileNameIdentification (in PhysicalRecordSegment)	If the file containing this segment has a standard section of its file name, include it here. Type: xs:string Content: simple Defined: locally within complexType PhysicalRecordSegmentType in physicaldataproduct.xsd, see XML source
Format (in PhysicalStructure)	Description of the physical format of data file (e.g., SAS save file, Delimited file, Fixed format file). Type: xs:string Content: simple Defined: locally within complexType PhysicalStructureType in physicaldataproduct.xsd, see XML source
GrossRecordStructure	Characteristics of the physical storage of a logical record type as described in the DataRelationship section of the logical product. Type: GrossRecordStructureType Content: complex, 6 attributes, 3 elements Defined: globally in physicaldataproduct.xsd, see XML source Used: at 1 location
KeyVariableReference	Reference to the Unique key variable for segment identification. Type: KeyVariableReferenceType Content: complex, 6 attributes, 7 elements Defined: globally in physicaldataproduct.xsd, see XML source Used: at 1 location
LanguageOfData (type xs:string)	A two-character ISO language code. Type: xs:string Content: simple Defined: locally within complexType PhysicalLocationType in physicaldataproduct.xsd, see XML source
LocaleOfData (type xs:string)	A two-character ISO country code, to supplement the LanguageOfData value. Type: xs:string Content: simple Defined: locally within complexType PhysicalLocationType in physicaldataproduct.xsd, see XML source
LogicalProductReference	References the logical data product that describes the intellectual content of this physical data product. Type: ReferenceType Content: complex, 6 attributes, 6 elements Defined: globally in physicaldataproduct.xsd, see XML source Used: at 1 location
LogicalRecordReference	Reference to the LogicalProduct:DataRelationship:LogicalRecord:RecordType:Idenfication. Type: ReferenceType Content: complex, 6 attributes, 6 elements Defined: globally in physicaldataproduct.xsd, see XML source Used: at 1 location
PhysicalDataProduct	Describes the physical layout of the data documented in the logical product module. Type: PhysicalDataProductType Content: complex, 11 attributes, 10 elements Defined: globally in physicaldataproduct.xsd, see XML source Used: at 2 locations
PhysicalDataProductName	Type: NameType Content: simple, 4 attributes Defined: globally in physicaldataproduct.xsd, see XML source Used: at 1 location
PhysicalLocation	Includes information about the data item location and its data type/format if other than the default. Type: PhysicalLocationType Content: complex, 11 elements Defined: globally in physicaldataproduct.xsd, see XML source Used: at 3 locations
PhysicalRecordSegment	A logical record may be stored in one or more segments housed hierarchically in a single file or in separate data files. Type: PhysicalRecordSegmentType Content: complex, 7 attributes, 3 elements Defined: globally in physicaldataproduct.xsd, see XML source Used: at 1 location
PhysicalRecordSegmentUsed (in PhysicalStructureReference)	References the ID of PhysicalRecordSegment that describes the coverage of the record contents. Type: xs:NCName Content: simple Defined: locally within complexType PhysicalStructureReferenceType in physicaldataproduct.xsd, see XML source
PhysicalStructure	Describes a physical structure within physical structure scheme. Type: PhysicalStructureType Content: complex, 7 attributes, 12 elements Defined: globally in physicaldataproduct.xsd, see XML source Used: at 1 location
PhysicalStructureReference	References a physical data product and the ID of the physical record segment from that is described by this record layout. Type: PhysicalStructureReferenceType Content: complex, 6 attributes, 7 elements Defined: globally in physicaldataproduct.xsd, see XML source Used: at 1 location
PhysicalStructureScheme	A maintainable scheme containing the physical structures of the physical data product. Type: PhysicalStructureSchemeType Content: complex, 11 attributes, 8 elements Defined: globally in physicaldataproduct.xsd, see XML source Used: at 2 locations
PhysicalStructureSchemeName	Type: NameType Content: simple, 4 attributes Defined: globally in physicaldataproduct.xsd, see XML source Used: at 1 location
PhysicalStructureSchemeReference	Reference to a physical structure scheme for inclusion by reference in another physical structure scheme. Type: SchemeReferenceType Content: complex, 6 attributes, 7 elements Defined: globally in physicaldataproduct.xsd, see XML source Used: at 1 location
RecordLayout	Describes the record layout. Type: RecordLayoutType Content: complex, 8 attributes, 8 elements Subst.Gr: may substitute for element BaseRecordLayout Defined: globally in physicaldataproduct.xsd, see XML source Used: never
RecordLayoutScheme	A maintainable scheme containing the record layouts of the physical data product. Type: RecordLayoutSchemeType Content: complex, 11 attributes, 8 elements Defined: globally in physicaldataproduct.xsd, see XML source Used: at 2 locations
RecordLayoutSchemeName	Type: NameType Content: simple, 4 attributes Defined: globally in physicaldataproduct.xsd, see XML source Used: at 1 location
RecordLayoutSchemeReference	Reference to a record layout scheme for inclusion by reference in another record layout scheme. Type: SchemeReferenceType Content: complex, 6 attributes, 7 elements Defined: globally in physicaldataproduct.xsd, see XML source Used: at 1 location
StartPosition (type xs:integer)	Position of the first character of the data item in fixed format file. Type: xs:integer Content: simple Defined: locally within complexType PhysicalLocationType in physicaldataproduct.xsd, see XML source
StorageFormat (type CodeValueType)	An explicit definition of the data type. Type: CodeValueType Content: simple, 7 attributes Defined: locally within complexType PhysicalLocationType in physicaldataproduct.xsd, see XML source
VariableReference	Reference to the key variable that may be used to link related records. Type: ReferenceType Content: complex, 6 attributes, 6 elements Defined: globally in physicaldataproduct.xsd, see XML source Used: at 1 location
VariableValue (in KeyVariableReference)	Value of the variable for this segment. Type: xs:string Content: simple Defined: locally within complexType KeyVariableReferenceType in physicaldataproduct.xsd, see XML source
Width (type xs:integer)	Data item width for fixed format file, maximum width for delimited file. Type: xs:integer Content: simple Defined: locally within complexType PhysicalLocationType in physicaldataproduct.xsd, see XML source

Complex Type Summary
BaseRecordLayoutType	This type structures an abstract element which is used only as the head of a substitution group. Content: complex, 7 attributes, 4 elements Abstract: (cannot be assigned directly to elements used in instance XML documents) Defined: globally in physicaldataproduct.xsd, see XML source Includes: definition of 1 element Used: at 7 locations
DataItemType	Includes a reference to a variable, and information about its data item location and its data type/format. Content: complex, 2 elements Defined: globally in physicaldataproduct.xsd, see XML source Includes: definitions of 2 elements Used: at 1 location
GrossRecordStructureType	Describes characteristics of the physical storage of a logical record, as described in the DataRelationship section of the logical product. Content: complex, 6 attributes, 3 elements Defined: globally in physicaldataproduct.xsd, see XML source Includes: definitions of 1 attribute and 2 elements Used: at 1 location
KeyVariableReferenceType	Reference to the Unique key variable for segment identification. Content: complex, 6 attributes, 7 elements Defined: globally in physicaldataproduct.xsd, see XML source Includes: definition of 1 element Used: at 1 location
PhysicalDataProductType	Describes the physical layout of the data documented in the logical product module. Content: complex, 11 attributes, 10 elements Defined: globally in physicaldataproduct.xsd, see XML source Includes: definitions of 7 elements Used: at 1 location
PhysicalLocationType	Includes information about the data item location and its data type/format if other than the default. Content: complex, 11 elements Defined: globally in physicaldataproduct.xsd, see XML source Includes: definitions of 11 elements Used: at 2 locations
PhysicalRecordSegmentType	A logical record may be stored in one or more segments housed hierarchically in a single file or in separate data files. Content: complex, 7 attributes, 3 elements Defined: globally in physicaldataproduct.xsd, see XML source Includes: definitions of 2 attributes and 2 elements Used: at 1 location
PhysicalStructureReferenceType	References a physical data product and the ID of the physical record segment from that is described by this record layout. Content: complex, 6 attributes, 7 elements Defined: globally in physicaldataproduct.xsd, see XML source Includes: definition of 1 element Used: at 1 location
PhysicalStructureSchemeType	A maintainable scheme describing physical structures. Content: complex, 11 attributes, 8 elements Defined: globally in physicaldataproduct.xsd, see XML source Includes: definitions of 5 elements Used: at 1 location
PhysicalStructureType	Description of a physical structure .These are used by record layouts to describe the full structure of a physical instance. Content: complex, 7 attributes, 12 elements Defined: globally in physicaldataproduct.xsd, see XML source Includes: definitions of 9 elements Used: at 1 location
RecordLayoutSchemeType	a maintainable scheme describing physical structures. Content: complex, 11 attributes, 8 elements Defined: globally in physicaldataproduct.xsd, see XML source Includes: definitions of 5 elements Used: at 1 location
RecordLayoutType	Describes the record layout. Content: complex, 8 attributes, 8 elements Defined: globally in physicaldataproduct.xsd, see XML source Includes: definitions of 1 attribute and 4 elements Used: at 1 location

XML schema documentation generated with DocFlex/XML SDK 1.7.2 using DocFlex/XML XSDDoc 2.1.0 template set