element <sampleFrame> (global)

Namespace:	ddi:codebook:2_5
Type:	sampleFrameType
Content:	complex, 8 attributes, 10 elements
Defined:	globally in codebook.xsd; see XML source
Used:	at 1 location

XML Representation Summary

<sampleFrame

ID	=	xs:ID
xml-lang	=	xs:NMTOKEN
xml:lang	=	xs:language
source	=	("archive" \| "producer") : "producer"
elementVersion	=	xs:string
elementVersionDate	=	(xs:dateTime \| xs:date \| xs:gYearMonth \| xs:gYear)
ddiLifecycleUrn	=	xs:anyURI
ddiCodebookUrn	=	xs:anyURI

Content:

sampleFrameName*, labl*, txt*, validPeriod*, custodian*, useStmt*, universe*, frameUnit*, referencePeriod*, updateProcedure*

</sampleFrame>

Content model elements (10):

custodian, frameUnit, labl, referencePeriod, sampleFrameName, txt, universe, updateProcedure, useStmt, validPeriod

Included in content model of elements (1):

dataColl

Known Usage Locations

Within global complexTypes (1):
dataCollType [ref]

Annotation

Sample Frame

Description

Sample frame describes the sampling frame used for identifying the population from which the sample was taken. For example, a telephone book may be a sample frame for a phone survey. In addition to the name, label and text describing the sample frame, this structure lists who maintains the sample frame, the period for which it is valid, a use statement, the universe covered, the type of unit contained in the frame as well as the number of units available, the reference period of the frame and procedures used to update the frame. Use multiple use statements to provide different uses under different conditions. Repeat elements within the use statement to support multiple languages.

XML Source (w/o annotations (1); see within schema source)

<xs:element name="sampleFrame" type="sampleFrameType"/>

Attribute Detail (all declarations; 8/8)

ddiCodebookUrn

Type:	xs:anyURI, predefined
Use:	optional
Defined:	locally within GLOBALS attributeGroup

Used to capture the DDI-Codebook type URN for the element. This is used to assign a DDI-Codebook specific URN to the element, according the format prescribed by the DDI-Codebook standard.

XML Source (w/o annotations (1); see within schema source)

<xs:attribute name="ddiCodebookUrn" type="xs:anyURI" use="optional"/>

ddiLifecycleUrn

Type:	xs:anyURI, predefined
Use:	optional
Defined:	locally within GLOBALS attributeGroup

Used to capture the DDI-Lifecycle type URN for the element. This may be captured during translation from DDI-Lifecycle to DDI-Codebook structure or in preparation for transferring to a DDI-Lifecycle structure.

XML Source (w/o annotations (1); see within schema source)

<xs:attribute name="ddiLifecycleUrn" type="xs:anyURI" use="optional"/>

elementVersion

Type:	xs:string, predefined
Use:	optional
Defined:	locally within GLOBALS attributeGroup

Captures version of the element

XML Source (w/o annotations (1); see within schema source)

<xs:attribute name="elementVersion" type="xs:string" use="optional"/>

elementVersionDate

Type:	dateSimpleType
Use:	optional
Defined:	locally within GLOBALS attributeGroup

Indicates version date for the element. Use YYYY-MM-DD, YYYY-MM, or YYYY formats.

Attribute Value

xs:dateTime | xs:date | xs:gYearMonth | xs:gYear

XML Source (w/o annotations (1); see within schema source)

<xs:attribute name="elementVersionDate" type="dateSimpleType" use="optional"/>

Type:	xs:ID, predefined
Use:	optional
Defined:	locally within GLOBALS attributeGroup

XML Source (see within schema source)

<xs:attribute name="ID" type="xs:ID" use="optional"/>

source

Type:	anonymous simpleType (restriction of xs:NMTOKEN)
Use:	optional
Defined:	locally within GLOBALS attributeGroup

Attribute Value

enumeration of xs:NMTOKEN

Enumeration:	"archive", "producer"
Default:	"producer"

Anonymous simpleType

Type Derivation Tree

xs:NMTOKEN (restriction)

simpleType

Derivation:

restriction of xs:NMTOKEN

Facets:

enumeration:

"archive", "producer"

XML Source (see within schema source)

<xs:attribute default="producer" name="source">

<xs:simpleType>

<xs:restriction base="xs:NMTOKEN">

<xs:enumeration value="archive"/>

<xs:enumeration value="producer"/>

</xs:restriction>

</xs:simpleType>

</xs:attribute>

xml-lang

Type:	xs:NMTOKEN, predefined
Use:	optional
Defined:	locally within GLOBALS attributeGroup

DO NOT USE THIS ATTRIBUTE. Its inclusion is an error that was persisted to retain backward compatibility. If this attribute has been used, transfer the content to xml:lang.

XML Source (w/o annotations (1); see within schema source)

<xs:attribute name="xml-lang" type="xs:NMTOKEN" use="optional"/>

xml:lang

Type:	xs:language, predefined
Use:	optional
Defined:	by reference within GLOBALS attributeGroup

XML Source (see within schema source)

<xs:attribute ref="xml:lang" use="optional"/>

Content Element Detail (all declarations; 10/10)

custodian

Type:	custodianType, simple content
Defined:	by reference within sampleFrameType complexType

Simple Content

xs:string

XML Source (see within schema source)

<xs:element maxOccurs="unbounded" minOccurs="0" ref="custodian"/>

frameUnit

Type:	frameUnitType, complex content
Defined:	by reference within sampleFrameType complexType

XML Source (see within schema source)

<xs:element maxOccurs="unbounded" minOccurs="0" ref="frameUnit"/>

labl

Type:	lablType, mixed content
Defined:	by reference within sampleFrameType complexType

XML Source (see within schema source)

<xs:element maxOccurs="unbounded" minOccurs="0" ref="labl"/>

referencePeriod

Type:	eventDateType, simple content
Defined:	by reference within sampleFrameType complexType

Simple Content

xs:dateTime | xs:date | xs:gYearMonth | xs:gYear

XML Source (see within schema source)

<xs:element maxOccurs="unbounded" minOccurs="0" ref="referencePeriod"/>

sampleFrameName

Type:	stringType, simple content
Defined:	by reference within sampleFrameType complexType

Simple Content

xs:string

XML Source (see within schema source)

<xs:element maxOccurs="unbounded" minOccurs="0" ref="sampleFrameName"/>

txt

Type:	txtType, mixed content
Defined:	by reference within sampleFrameType complexType

XML Source (see within schema source)

<xs:element maxOccurs="unbounded" minOccurs="0" ref="txt"/>

universe

Type:	universeType, mixed content
Defined:	by reference within sampleFrameType complexType

XML Source (see within schema source)

<xs:element maxOccurs="unbounded" minOccurs="0" ref="universe"/>

updateProcedure

Type:	simpleTextType, mixed content
Defined:	by reference within sampleFrameType complexType

XML Source (see within schema source)

<xs:element maxOccurs="unbounded" minOccurs="0" ref="updateProcedure"/>

useStmt

Type:	useStmtType, complex content
Defined:	by reference within sampleFrameType complexType

XML Source (see within schema source)

<xs:element maxOccurs="unbounded" minOccurs="0" ref="useStmt"/>

validPeriod

Type:	eventDateType, simple content
Defined:	by reference within sampleFrameType complexType

Simple Content

xs:dateTime | xs:date | xs:gYearMonth | xs:gYear

XML Source (see within schema source)

<xs:element maxOccurs="unbounded" minOccurs="0" ref="validPeriod"/>

XML schema documentation generated with DocFlex/XML 1.8.7 using DocFlex/XML XSDDoc 2.7.0 template set