DDI 3.1 XML Schema Documentation (2009-10-18)
© DDI Alliance 2009 - licensed under the terms of the GNU Lesser General Public License
Namespace "ddi:logicalproduct:3_1"
Targeting Schemas (1):
logicalproduct.xsd
Targeting Components:
89 global elements, 16 local elements, 44 complexTypes, 7 simpleTypes, 1 element group
Schema Summary
logicalproduct.xsd Target Namespace:
Defined Components:
89 global elements, 15 local elements, 44 complexTypes, 7 simpleTypes, 1 element group
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
http://www.ddialliance.org/DDI/schema/ddi3.1/logicalproduct.xsd, see XML source
Imports Schema:
Imported by Schemas (4):
All Element Summary
AggregationDefinition
Type:
Content:
complex, 1 attribute, 2 elements
Defined:
Used:
Anchor (in Interval) Identifies the start value for this interval.
Type:
xs:string
Content:
simple
Defined:
AttachmentGroupReference References the coordinate group to which the attribute attaches.
Type:
Content:
complex, 6 attributes, 6 elements
Defined:
Used:
AttachmentLevel Identifies attachment level of attribute
Type:
Content:
simple
Defined:
Used:
AttachmentValue (in Attribute) The value of the attachment, if not a variable.
Type:
xs:string
Content:
simple
Defined:
Attribute Defines a variable that describes an attribute of all or coordinate sections of the NCube.
Type:
Content:
complex, 5 attributes, 5 elements
Defined:
Used:
BaseLogicalProduct
Type:
Content:
complex, 11 attributes, 16 elements
Abstract:
(may not be used directly in instance XML documents)
Subst.Gr:
may be substituted with 2 elements
Defined:
Used:
CaseIdentification There may be more than one means of identifying a record.
Type:
Content:
complex, 1 element
Defined:
Used:
CaseSpecification Value of variable indicating this record type, multiple entries allow for multiple valid values or ranges.
Type:
Content:
complex, 2 elements
Defined:
Used:
Category A description of a particular category or response.
Type:
Content:
complex, 8 attributes, 7 elements
Defined:
Used:
CategoryGroup Allows for grouping of categories.
Type:
Content:
complex, 7 attributes, 7 elements
Defined:
Used:
CategoryGroupName
Type:
Content:
simple, 4 attributes
Defined:
Used:
CategoryName
Type:
Content:
simple, 4 attributes
Defined:
Used:
CategoryReference Provides the specific category of the variable included.
Type:
Content:
complex, 6 attributes, 6 elements
Defined:
Used:
CategoryReference (in Code) Reference to a category documenting the value label.
Type:
Content:
complex, 6 attributes, 6 elements
Defined:
locally within complexType CodeType in logicalproduct.xsd, see XML source
CategoryScheme Contains descriptions of particular categories used as question responses and in the logical product.
Type:
Content:
complex, 11 attributes, 9 elements
Defined:
Used:
CategorySchemeName
Type:
Content:
simple, 4 attributes
Defined:
Used:
CategorySchemeReference Reference to a previously defined category scheme either internal to or external to the xml instance.
Type:
Content:
complex, 6 attributes, 7 elements
Defined:
Used:
Code Reference to included category is found in the ReferenceType.
Type:
Content:
complex, 4 attributes, 3 elements
Defined:
Used:
CodeRepresentation Defines the representation of a variable as a set or subset of codes from a code scheme.
Type:
Content:
complex, 3 attributes, 7 elements
Subst.Gr:
may substitute for element ValueRepresentation
Defined:
Used:
never
CodeScheme Provides a description of a set of categories that have a specific relationship, such as the categories Male and Female that can be grouped together as Gender.
Type:
Content:
complex, 11 attributes, 11 elements
Defined:
Used:
CodeSchemeName
Type:
Content:
simple, 4 attributes
Defined:
Used:
CodeSchemeReference References a code scheme, or part of a code scheme.
Type:
Content:
complex, 6 attributes, 10 elements
Defined:
Used:
CodeValue (in DimensionValue) The value attached to that category in a code scheme.
Type:
xs:string
Content:
simple
Defined:
locally within complexType CohortType in logicalproduct.xsd, see XML source
CodingInstructionsReference Any special instructions that were provided to those who converted information from one form to another to derive a particular variable.
Type:
Content:
complex, 6 attributes, 6 elements
Defined:
Used:
ComponentReference Reference to variable or category used for the derivation.
Type:
Content:
complex, 6 attributes, 6 elements
Defined:
Used:
ConcatenatedValue Provides a reference to another variable and describes the method for deriving the value of this variable by concatenating a collection of other variables.
Type:
Content:
complex, 1 element
Defined:
Used:
ConceptReference General concept to which this variable belongs.
Type:
Content:
complex, 6 attributes, 6 elements
Defined:
Used:
CoordinateGroup Defines groups of dimensions (given particular values) to which attributes can be attached.
Type:
Content:
complex, 5 attributes, 5 elements
Defined:
Used:
DataExistence Allows for inclusion of upper level categories that will not have associated data.
Type:
Content:
complex, 2 elements
Defined:
Used:
DataRelationship Contains a written description of how the logical contents of the file relate to each other for programming purposes.
Type:
Content:
complex, 7 attributes, 8 elements
Defined:
Used:
DataRelationshipName
Type:
Content:
simple, 4 attributes
Defined:
Used:
DateTimeRepresentation Defines the representation of a varaible as a date or time value.
Type:
Content:
complex, 5 attributes, 2 elements
Subst.Gr:
may substitute for element ValueRepresentation
Defined:
Used:
never
Definition Definition of the category.
Type:
Content:
mixed, 3 attributes, 16 elements
Defined:
Used:
DependentDimension (in AggregationDefinition) The rank of a dimension that acts as the numerator (dependent variable).
Type:
xs:integer
Content:
simple
Defined:
Dimension Defines a variable as a dimension of the nCube, and should be repeated to describe each of the nCube's dimensions.
Type:
Content:
complex, 1 attribute, 1 element
Defined:
Used:
DimensionValue Defines a variable as a dimension of the coordinate group.
Type:
Content:
complex, 1 attribute, 3 elements
Defined:
Used:
DiscreteCategory (in DataExistence) This element is to be used if only the most discrete data elements will have data.
Type:
xs:boolean
Content:
simple
Defined:
EmbargoReference Reference to embargo information pertaining to this variable.
Type:
Content:
complex, 6 attributes, 6 elements
Defined:
Used:
ExternalCategoryRepresentation Structures a response domain based on a categorization that is external to DDI, for example, a category list for occupations or geography.
Type:
Content:
complex, 3 attributes, 4 elements
Subst.Gr:
may substitute for element ValueRepresentation
Defined:
Used:
never
Generation Generation/derivation details of the category.
Type:
Content:
complex, 3 attributes, 4 elements
Defined:
Used:
GroupType A generic element for specifying a reason for a variable or nCube group.
Type:
Content:
simple, 7 attributes
Subst.Gr:
may be substituted with 1 element
Defined:
Used:
GroupTypeCoded A suggested controlled vocabulary of group types.
Type:
Content:
simple, 11 attributes
Subst.Gr:
may substitute for element GroupType
Defined:
Used:
never
HierarchyType Identifies the type of hierarchy used in the nesting of categories within the code scheme.
Type:
Content:
simple
Defined:
Used:
ImputationReference Reference to the imputation process described in the Data Processing section
Type:
Content:
complex, 6 attributes, 6 elements
Defined:
Used:
IncludedCodeReference Allows selection of code schemes to use not based on levels.
Type:
Content:
simple, 1 attribute
Defined:
Used:
IncludedLevel (type xs:integer) Identifies specific levels to include.
Type:
xs:integer
Content:
simple
Defined:
Increment (in Interval) Value specifying the increment between categories.
Type:
xs:string
Content:
simple
Defined:
IndependentDimension (in AggregationDefinition) The rank of a dimension that acts as the denominator (independent variable).
Type:
xs:integer
Content:
simple
Defined:
Interval Identifies the interval between each value of the categories for this variable.
Type:
Content:
complex, 2 elements
Defined:
Used:
Level Used to describe the levels of the code scheme hierarchy.
Type:
Content:
complex, 1 attribute, 4 elements
Defined:
Used:
Level (in DataExistence) Indicates the levels that will have data, if only certain levels will do so.
Type:
xs:integer
Content:
simple
Defined:
LogicalProduct
Type:
Content:
complex, 11 attributes, 16 elements
Subst.Gr:
may substitute for element BaseLogicalProduct
Defined:
Used:
never
LogicalProductName
Type:
Content:
simple, 4 attributes
Defined:
Used:
LogicalRecord A logical record such as a household, family, or person record.
Type:
Content:
complex, 7 attributes, 9 elements
Defined:
Used:
LogicalRecordName
Type:
Content:
simple, 4 attributes
Defined:
Used:
Measure The measurement features of the cell content (repeatable only for regularly bundled arrays of cell content).
Type:
Content:
complex, 5 attributes, 3 elements
Defined:
Used:
Name (in Level) Name of a level in a code scheme.
Type:
xs:string
Content:
simple
Defined:
locally within complexType LevelType in logicalproduct.xsd, see XML source
NCube Describes and NCube.
Type:
Content:
complex, 10 attributes, 15 elements
Defined:
Used:
NCubeGroup Describes a group of NCubes.
Type:
Content:
complex, 7 attributes, 11 elements
Defined:
Used:
NCubeGroupName
Type:
Content:
simple, 4 attributes
Defined:
Used:
NCubeGroupReference Constituent variable group.
Type:
Content:
complex, 6 attributes, 6 elements
Defined:
Used:
NCubeLogicalProduct
Type:
Content:
complex, 11 attributes, 17 elements
Subst.Gr:
may substitute for element BaseLogicalProduct
Defined:
Used:
never
NCubeName
Type:
Content:
simple, 4 attributes
Defined:
Used:
NCubeReference Constituent variable.
Type:
Content:
complex, 6 attributes, 6 elements
Defined:
Used:
NCubeScheme Contains a collection of NCubes and NCube groups.
Type:
Content:
complex, 11 attributes, 9 elements
Defined:
Used:
NCubeSchemeName
Type:
Content:
simple, 4 attributes
Defined:
Used:
NCubeSchemeReference
Type:
Content:
complex, 6 attributes, 7 elements
Defined:
Used:
NCubesInRecord Lists the NCubes contained in the record.
Type:
Content:
complex, 1 attribute, 3 elements
Defined:
Used:
NumericRepresentation Defines the representation of a varaible as a number, number range, or sequence, or set interval of numbers.
Type:
Content:
complex, 9 attributes, 3 elements
Subst.Gr:
may substitute for element ValueRepresentation
Defined:
Used:
never
Purpose Purpose for which the nCube was created.
Type:
Content:
simple, 3 attributes
Defined:
Used:
QuestionReference Reference to question(s) used to collect data for this variable.
Type:
Content:
complex, 6 attributes, 6 elements
Defined:
Used:
Range Indicates that the Cube contains only a limited number of categories from the code scheme.
Type:
Content:
complex, 3 elements
Defined:
Used:
RangeUnit (in Range) Units in the range.
Type:
xs:string
Content:
simple
Defined:
locally within complexType RangeType in logicalproduct.xsd, see XML source
RecordReferenceSource Reference to the Source Record.
Type:
Content:
complex, 1 attribute, 2 elements
Defined:
Used:
RecordReferenceTarget Reference to the Target Record.
Type:
Content:
complex, 6 attributes, 6 elements
Defined:
Used:
RecordRelationship All relationships are pairwise.
Type:
Content:
complex, 6 attributes, 6 elements
Defined:
Used:
RecordRelationshipName
Type:
Content:
simple, 4 attributes
Defined:
Used:
RelationshipType Code describing the relationship between categories of the level.
Type:
Content:
simple
Defined:
Used:
Representation Describes the representation of the variable, including categories, data typing, and computation information.
Type:
Content:
complex, 3 attributes, 7 elements
Defined:
Used:
ResponseUnit (type xs:string)
Type:
xs:string
Content:
simple
Defined:
Role (in Representation) Describes a specific function of the variable, such as identity, weight, geographic variable, time, date, currency, etc.
Type:
xs:string
Content:
simple
Defined:
StandardWeightReference Reference to a standard weight, as described in the DataCollection module.
Type:
Content:
complex, 6 attributes, 6 elements
Defined:
Used:
SupportForMultipleSegments Information concerning support for breaking the logical record into segments for storage purposes.
Type:
Content:
complex, 2 elements
Defined:
Used:
TextRepresentation Defines the representation of a varaible as a text field.
Type:
Content:
complex, 6 attributes, 2 elements
Subst.Gr:
may substitute for element ValueRepresentation
Defined:
Used:
never
Value Value of variable indicating this record type.
Type:
Content:
simple, 1 attribute
Defined:
Used:
Value (in Code) For microdata an explicit value found in data file.
Type:
xs:string
Content:
simple
Defined:
locally within complexType CodeType in logicalproduct.xsd, see XML source
ValueRepresentation Substitution group head for describing the representation value of the variable.
Type:
Content:
complex, 3 attributes, 2 elements
Abstract:
(may not be used directly in instance XML documents)
Subst.Gr:
may be substituted with 5 elements
Defined:
Used:
Variable Describes a variable contained in the variable scheme.
Type:
Content:
complex, 10 attributes, 13 elements
Defined:
Used:
VariableConcatenation Describes the concatenation of other variables, based on a category value of this variable that can be used to identify or locate a specific record of this type.
Type:
Content:
complex, 2 elements
Defined:
Used:
VariableDefinition Additional textual descriptions of the variable.
Type:
Content:
mixed, 3 attributes, 16 elements
Defined:
Used:
never
VariableGroup Describes a variable group contained in the variable scheme.
Type:
Content:
complex, 7 attributes, 11 elements
Defined:
Used:
VariableGroupName
Type:
Content:
simple, 4 attributes
Defined:
Used:
VariableGroupReference References a variable group contained in the variable scheme.
Type:
Content:
complex, 6 attributes, 6 elements
Defined:
Used:
VariableName
Type:
Content:
simple, 4 attributes
Defined:
Used:
VariableReference References a variable contained in the variable scheme.
Type:
Content:
complex, 6 attributes, 6 elements
Defined:
Used:
at 10 locations
VariableScheme Contains a collection of variables and variable groups.
Type:
Content:
complex, 11 attributes, 11 elements
Defined:
Used:
VariableSchemeName
Type:
Content:
simple, 4 attributes
Defined:
Used:
VariableSchemeReference References a variable scheme for inclusion.
Type:
Content:
complex, 6 attributes, 7 elements
Defined:
Used:
VariablesInRecord List of all variables used in record either directly or as found in a defined VariableGroup; note that a variable can be used in multiple records.
Type:
Content:
complex, 1 attribute, 2 elements
Defined:
Used:
VariableSpecificationReference Repetition allows multi-variable specifications of unique value.
Type:
Content:
complex, 2 elements
Defined:
Used:
VariableUsedReference A variable reference which can indicate either inclusion or exclusion from the referenced scheme for each variable.
Type:
Content:
complex, 7 attributes, 6 elements
Defined:
Used:
VariableValueReference Reference to the variable containing the record type locator.
Type:
Content:
complex, 2 elements
Defined:
Used:
WeightVariableReference Reference to weight variable(s) to be used with this variable.
Type:
Content:
complex, 6 attributes, 6 elements
Defined:
Used:
Complex Type Summary
AggregationDefinitionType Identifies the independent (denominator) and dependent (numerator) dimensions for calculating aggregate measures such as percent.
Content:
complex, 1 attribute, 2 elements
Defined:
Includes:
definitions of 1 attribute and 2 elements
Used:
AttributeType Defines a variable that describes an attribute of all or coordinate sections of the NCube.
Content:
complex, 5 attributes, 5 elements
Defined:
Includes:
definitions of 4 elements
Used:
BaseLogicalProductType
Content:
complex, 11 attributes, 16 elements
Abstract:
(cannot be assigned directly to elements used in instance XML documents)
Defined:
Includes:
definitions of 13 elements
Used:
CaseIdentificationType Describes the information needed to identify an individual case within a record type.
Content:
complex, 1 element
Defined:
Includes:
definition of 1 element
Used:
CaseSpecificationType Value of variable indicating this record type, multiple entries allow for multiple valid values or ranges.
Content:
complex, 2 elements
Defined:
Includes:
definitions of 2 elements
Used:
CategoryGroupType Allows for grouping of categories.
Content:
complex, 7 attributes, 7 elements
Defined:
Includes:
definitions of 4 elements
Used:
CategorySchemeType
Content:
complex, 11 attributes, 9 elements
Defined:
Includes:
definitions of 6 elements
Used:
CategoryType A description of a particular category or response.
Content:
complex, 8 attributes, 7 elements
Defined:
Includes:
definitions of 1 attribute and 4 elements
Used:
CodeRepresentationType Describes a coded representation.
Content:
complex, 3 attributes, 7 elements
Defined:
Used:
CodeSchemeReferenceType Describes a coded representation.
Content:
complex, 6 attributes, 10 elements
Defined:
Used:
CodeSchemeType Describes the structure of a Code Scheme.
Content:
complex, 11 attributes, 11 elements
Defined:
Includes:
definitions of 8 elements
Used:
CodeType
Content:
complex, 4 attributes, 3 elements
Defined:
Includes:
definitions of 4 attributes and 3 elements
Used:
CohortType Defines a dimension and its value.
Content:
complex, 1 attribute, 3 elements
Defined:
Includes:
definitions of 1 attribute and 3 elements
Used:
ConcatenatedValueType Describes the variables whose concatenated values make up the existing concatenated variable.
Content:
complex, 1 element
Defined:
Includes:
definition of 1 element
Used:
CoordinateGroupType Defines groups of dimensions (given particular values) to which attributes can be attached.
Content:
complex, 5 attributes, 5 elements
Defined:
Includes:
definitions of 4 elements
Used:
DataExistenceType Allows for inclusion of upper level categories that will not have associated data.
Content:
complex, 2 elements
Defined:
Includes:
definitions of 2 elements
Used:
DataRelationshipType Describes the relationships among logical records in the dataset.
Content:
complex, 7 attributes, 8 elements
Defined:
Includes:
definitions of 5 elements
Used:
DimensionType
Content:
complex, 1 attribute, 1 element
Defined:
Includes:
definitions of 1 attribute and 1 element
Used:
GenerationType Generation/derivation details of the category.
Content:
complex, 3 attributes, 4 elements
Defined:
Includes:
definitions of 3 attributes and 4 elements
Used:
GroupTypeCodedType A suggested enumeration of group types.
Content:
simple, 11 attributes
Defined:
Includes:
definitions of 4 attributes
Used:
IncludedCodeReferenceType Allows selection of specific codes not based on levels.
Content:
simple, 1 attribute
Defined:
Includes:
definition of 1 attribute
Used:
IntervalType Describes the structure, starting point and increment step of an interval.
Content:
complex, 2 elements
Defined:
Includes:
definitions of 2 elements
Used:
LevelType Used to describe the levels of the code scheme hierarchy.
Content:
complex, 1 attribute, 4 elements
Defined:
Includes:
definitions of 1 attribute and 4 elements
Used:
LogicalProductType Describes the logical content of standard variables.
Content:
complex, 11 attributes, 16 elements
Defined:
Used:
LogicalRecordType Describes the logical record in terms of identification of its type, case identification, its relationship with other records, and support for multiple storage segments.
Content:
complex, 7 attributes, 9 elements
Defined:
Includes:
definitions of 2 attributes and 8 elements
Used:
MeasureType
Content:
complex, 5 attributes, 3 elements
Defined:
Includes:
definitions of 2 elements
Used:
NCubeGroupType Describes a group of NCubes.
Content:
complex, 7 attributes, 11 elements
Defined:
Includes:
definitions of 8 elements
Used:
NCubeLogicalProductType Describes the logical structure of NCubes.
Content:
complex, 11 attributes, 17 elements
Defined:
Includes:
definition of 1 element
Used:
NCubeSchemeType
Content:
complex, 11 attributes, 9 elements
Defined:
Includes:
definitions of 6 elements
Used:
NCubesInRecordType Lists the NCubes contained in the record.
Content:
complex, 1 attribute, 3 elements
Defined:
Includes:
definitions of 1 attribute and 3 elements
Used:
NCubeType Describes the structure of the NCube.
Content:
complex, 10 attributes, 15 elements
Defined:
Includes:
definitions of 3 attributes and 12 elements
Used:
RangeType
Content:
complex, 3 elements
Defined:
Includes:
definitions of 3 elements
Used:
RecordReferenceSourceType Reference to the Source Record.
Content:
complex, 1 attribute, 2 elements
Defined:
Includes:
definition of 1 attribute
Used:
RecordRelationshipType All relationships are described pairwise.
Content:
complex, 6 attributes, 6 elements
Defined:
Includes:
definitions of 1 attribute and 5 elements
Used:
RepresentationType Type to describe the representation of a variable
Content:
complex, 3 attributes, 7 elements
Defined:
Includes:
definitions of 3 attributes and 7 elements
Used:
ValueType Type for indicating value of variable
Content:
simple, 1 attribute
Defined:
Includes:
definition of 1 attribute
Used:
VariableConcatenationType Describes the structure of the concatenated variable.
Content:
complex, 2 elements
Defined:
Includes:
definitions of 2 elements
Used:
VariableGroupType Contains a group of variables, which may be hierarchical.
Content:
complex, 7 attributes, 11 elements
Defined:
Includes:
definitions of 8 elements
Used:
VariableSchemeType
Content:
complex, 11 attributes, 11 elements
Defined:
Includes:
definitions of 8 elements
Used:
VariablesInRecordType Identifies the variables in the record type.
Content:
complex, 1 attribute, 2 elements
Defined:
Includes:
definitions of 1 attribute and 2 elements
Used:
VariableSpecificationReferenceType Describes the information needed to identify a type of record.
Content:
complex, 2 elements
Defined:
Includes:
definitions of 2 elements
Used:
VariableType Describes the structure of a Variable.
Content:
complex, 10 attributes, 13 elements
Defined:
Includes:
definitions of 3 attributes and 10 elements
Used:
VariableUsedReferenceType
Content:
complex, 7 attributes, 6 elements
Defined:
Includes:
definition of 1 attribute
Used:
VariableValueReferenceType Describes the variable containing the record type locator and the value being used.
Content:
complex, 2 elements
Defined:
Includes:
definitions of 2 elements
Used:
Simple Type Summary
AdditivityCodeType
Defined:
Used:
AggregationMethodCodeType A list for describing aggregation methods.
Defined:
Used:
AttachmentLevelCodeType
Defined:
Used:
HierarchyCodeType
Defined:
Used:
IsComprehensiveType Indicates values of the isComprehensive attribute.
Defined:
Used:
RelationCodeType Indicates relation.
Defined:
Used:
ValueTypeCodeType Indicates value type.
Defined:
Used:
Element Group Summary
CodeSubsetInfo
Content:
Defined:
Includes:
definitions of 4 elements
Used:

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