DDI 3.1 XML Schema Documentation (2009-10-18)
© DDI Alliance 2009 - licensed under the terms of the GNU Lesser General Public License
complexType "LogicalRecordType"
Namespace:
ddi:logicalproduct:3_1
Content:
complex, 7 attributes, 9 elements
Defined:
globally in logicalproduct.xsd, see XML source
Includes:
definitions of 2 attributes and 8 elements
Used:
at 1 location
XML Representation Summary
<...
    action
 = 
 ("Add" | "Update" | "Delete")
    hasLocator
 = 
 xs:boolean
    id
 = 
 xs:string
    isIdentifiable
 = 
 "true"
    objectSource
 = 
 xs:anyURI
    urn
 = 
 xs:anyURI
    variableQuantity
 = 
 xs:integer
    >
   
Content: 
 UserID*, LogicalRecordName*, r:Label*, r:Description*, VariableValueReference?, SupportForMultipleSegments?, CaseIdentification*, (VariablesInRecord | NCubesInRecord)
</...>
Content Model Elements (9):
CaseIdentification, LogicalRecordName, NCubesInRecord, r:Description, r:Label, SupportForMultipleSegments, UserID, VariablesInRecord, VariableValueReference
All Direct / Indirect Based Elements (1):
LogicalRecord
Known Usage Locations
Annotation
Describes the logical record in terms of identification of its type, case identification, its relationship with other records, and support for multiple storage segments. Required to link a description of a physical record structure to its logical record.
Type Definition Detail
Type Derivation Tree
r:AbstractIdentifiableType
  r:IdentifiableType (extension)
      LogicalRecordType (extension)
XML Source (w/o annotations (9); see within schema source)
<xs:complexType name="LogicalRecordType">
<xs:complexContent>
<xs:extension base="r:IdentifiableType">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="LogicalRecordName"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Label"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Description"/>
<xs:element minOccurs="0" ref="VariableValueReference"/>
<xs:element minOccurs="0" ref="SupportForMultipleSegments"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="CaseIdentification"/>
<xs:choice>
<xs:element ref="VariablesInRecord"/>
<xs:element ref="NCubesInRecord"/>
</xs:choice>
</xs:sequence>
<xs:attribute name="hasLocator" type="xs:boolean" use="required"/>
<xs:attribute name="variableQuantity" type="xs:integer" use="optional"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Attribute Detail (defined in this component only; 2/7)
hasLocator
Type:
xs:boolean, predefined
Use:
required
Indicates if the record type has a field which identifies its record type. In logical structures with a single record type there is generally no identifier. Most multi-record files will have a variable that identifies the record type.
XML Source (w/o annotations (1); see within schema source)
<xs:attribute name="hasLocator" type="xs:boolean" use="required"/>
variableQuantity
Type:
xs:integer, predefined
Use:
optional
Number of variables in the logical record.
XML Source (w/o annotations (1); see within schema source)
<xs:attribute name="variableQuantity" type="xs:integer" use="optional"/>
Content Element Detail (defined in this component only; 8/9)
CaseIdentification
Type:
CaseIdentificationType, complex content
There may be more than one means of identifying a record. For example a US Census Summary File has a LogicalRecordIdentifer that is unique to the original file within which it was published. A specific geography has a set of fields that identify it uniquely.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="CaseIdentification"/>
LogicalRecordName
Type:
r:NameType, simple content
Simple Content
xs:string
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="LogicalRecordName"/>
NCubesInRecord
Type:
NCubesInRecordType, complex content
List of all NCubes used in the record, either directly or as found in a defined NCubeGroup; note that an NCube can be used in multiple records. The NCubes in the logical record can be noted by inclusion or exclusion to facilitate listing. The attribute allNCubesInLogicalProduct, when set to 'true', includes all NCubes in the LogicalProduct. NCubeSchemeReference can then be used to exclude individual NCubes schemes or include schemes from other logical products. In the same way NCubeReference can be used to exclude specific variables from the previously defined variable set or include variables not already included. The simplest LogicalProduct descriptions with a single LogicalRecord can be described using only the attribute allNCubesInLogicalProduct with a value of true.
XML Source (w/o annotations (1); see within schema source)
<xs:element ref="NCubesInRecord"/>
r:Description
Type:
r:StructuredStringType, mixed content
Description of the logical record.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Description"/>
r:Label
Type:
r:LabelType, mixed content
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Label"/>
SupportForMultipleSegments
Type:
VariableValueReferenceType, complex content
Information concerning support for breaking the logical record into segments for storage purposes. Some files may be broken into record segments for storage but lack variables to support identification of specific segments. In this case segments are identified by their physical order within the storage file.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="SupportForMultipleSegments"/>
VariablesInRecord
Type:
VariablesInRecordType, complex content
List of all variables used in the record, either directly or as found in a defined VariableGroup; note that a variable can be used in multiple records. The variables in the logical record can be noted by inclusion or exclusion to facilitate listing. The attribute allVariablesInLogicalProduct, when set to 'true', includes all variables in the LogicalProduct. VariableSchemeReference can then be used to exclude individual Variables schemes or include schemes from other logical products. In the same way VariableReference can be used to exclude specific variables from the previously defined variable set or include variables not already included. The simplest LogicalProduct descriptions with a single LogicalRecord can be described using only the attribute allVariablesInLogicalProduct with a value of true.
XML Source (w/o annotations (1); see within schema source)
<xs:element ref="VariablesInRecord"/>
VariableValueReference
Type:
VariableValueReferenceType, complex content
Reference to the variable containing the record type locator.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="VariableValueReference"/>
XML schema documentation generated with DocFlex/XML SDK 1.7.2 using DocFlex/XML XSDDoc 2.1.0 template set