DDI Codebook Outline -- Aggregate Data Model for Version 1.01 (Draft)

|
|
|---- 3.0 fileDscr* (ATT == ID, xml:lang, source, URI, sdatrefs, methrefs, pubrefs, access)
|     |
|     |---- 3.1 fileTxt* (ATT == ID, xml:lang, source)
|     |     |
|     |     |---- 3.1.1 fileName? (ATT ==ID, xml:lang, source)
|     |     |---- 3.1.2 fileCont? (ATT == ID, xml:lang, source)
|     |     |---- 3.1.3 fileStrc? (ATT == ID, xml:lang, source, type, linked)
|     |     |     |	    note: type {rect | hier | rel | grid }
|     |     |     |	    note: linked {Y | N}
|     |     |     |---- 3.1.3.1 recGrp* (ATT == ID, xml:lang, source, recGrp, rectype, keyvar, recidvar)
|     |     |     |     |
|     |     |     |     |---- 3.1.3.1.1 labl*      (ATT == ID, xml:lang, source, level, vendor)
|     |     |     |     +---- 3.1.3.1.2 recDimnsn? (ATT == ID, xml:lang, source, level)
|     |     |     |           |
|     |     |     |           |---- 3.1.3.1.2.1 varQnty?  (ATT == ID, xml:lang, source)
|     |     |     |           |---- 3.1.3.1.2.2 caseQnty? (ATT == ID, xml:lang, source)
|     |     |     |           +---- 3.1.3.1.2.3 logRecL?  (ATT == ID, xml:lang, source)
|     |     |     |
|     |     |     |---- 3.1.3.2 grdGrp* (ATT == ID, xml:lang, source, grdGrp, keyvar, recidvar)
|     |     |     |     |
|     |     |     |     |---- 3.1.3.2.1 labl*      (ATT == ID, xml:lang, source, level, vendor)
|     |     |     |     +---- 3.1.3.2.2 blSht? (ATT == ID, xml:lang, source, rangeBeg, rangeEnd)
|     |     |     |           |
|     |     |     |           |---- 3.1.3.2.2.1 cellQnty?  (ATT == ID, xml:lang, source)
|     |     |     |           |---- 3.1.3.2.2.2 colQnty? (ATT == ID, xml:lang, source)
|     |     |     |           +---- 3.1.3.2.2.3 rowQnty?  (ATT == ID, xml:lang, source)
|     |     |     |
|     |     |     +---- 3.1.3.3 notes* (ATT == ID, xml:lang, source, type, subject, level, resp, sdatrefs)
|     |     |
|     |     |---- 3.1.4 dimensns? (ATT == ID, xml:lang, source)
|     |     |     |
|     |     |     |---- 3.1.4.1 caseQnty*  (ATT == ID, xml:lang, source)
|     |     |     |---- 3.1.4.2 varQnty*   (ATT == ID, xml:lang, source)
|     |     |     |---- 3.1.4.3 logRecL*   (ATT == ID, xml:lang, source)
|     |     |     |---- 3.1.4.4 recPrCas*  (ATT == ID, xml:lang, source)
|     |     |     |---- 3.1.4.5 recNumTot* (ATT == ID, xml:lang, source)
|     |     |     |---- 3.1.4.6 grdPrCas*  (ATT == ID, xml:lang, source)
|     |     |     +---- 3.1.4.7 grdNumTot* (ATT == ID, xml:lang, source)
|     |     |
|     |     |---- 3.1.5 fileType?  (ATT == ID, xml:lang, source, charset)
|     |     |---- 3.1.6 format?    (ATT == ID, xml:lang, source)
|     |     |---- 3.1.7 filePlac?  (ATT == ID, xml:lang, source)
|     |     |---- 3.1.8 dataChck*  (ATT == ID, xml:lang, source)
|     |     |---- 3.1.9 ProcStat?  (ATT == ID, xml:lang, source)
|     |     |---- 3.1.10 dataMsng? (ATT == ID, xml:lang, source)
|     |     |---- 3.1.11 software* (ATT == ID, xml:lang, source, date, version)
|     |     +---- 3.1.12 verStmt?  (ATT == ID, xml:lang, source)
|     |           |
|     |           |---- 3.1.12.1 version? (ATT == ID, xml:lang, source, type, date)
|     |           |---- 3.1.12.2 verResp? (ATT == ID, xml:lang, source, affiliation)
|     |           +---- 3.1.12.3 notes*   (ATT == ID, xml:lang, source, type, subject, level,
|     |                                               resp, sdatrefs)
|     |---- 3.2 dmnsFileset* (ATT == ID, xml:lang, source, fileRefs)
|     |           |
|     |           |---- 3.2.1 fileQnty*      (ATT == ID, xml:lang, source)
|     |           |---- 3.2.2 dataItmQnty*   (ATT == ID, xml:lang, source)
|     |           |---- 3.2.3 recGrpQnty*    (ATT == ID, xml:lang, source)
|     |           |---- 3.2.4 recLink*       (ATT == ID, xml:lang, source, recGrpRefs)
|     |           |     |
|     |           |     +---- 3.2.4.1 rlkProc*   (ATT == ID, xml:lang, source)
|     |           |           |
|     |           |           |---- 3.2.4.1.2 fromRec?   (ATT == ID, xml:lang, source,
|     |           |           |                          fileRef, recGrpRef, keyvars)
|     |           |           +---- 3.2.4.1.3 toRec?     (ATT == ID, xml:lang, source,
|     |           |                                       fileRef, recGrpRef, keyvars)
|     |           |---- 3.2.5 grdGrpQnty*    (ATT == ID, xml:lang, source)
|     |           |---- 3.2.6 grdNumTot*     (ATT == ID, xml:lang, source)
|     |           +---- 3.2.7 grdLink*       (ATT == ID, xml:lang, source,
|     |                 |                     blshtRefs, grdLinkRefs, drctn)
|     |                 |      [note: blshtRefs and grdLinkRefs are IDREFS for items to link,
|     |                 |       drctn { ribbon | strip } indicates horizontal or vertical link]
|     |                 |
|     |                 +---- 3.2.7.1 glkProc   (ATT == ID, xml:lang, source)
|     |                       |
|     |                       |---- 3.2.7.1.2 colChop*    (ATT == ID, xml:lang, source,
|     |                       |                            blshtRef, order, chopRng)
|     |                       +---- 3.2.7.1.3 rowChop*    (ATT == ID, xml:lang, source,
|     |                                                    blshtRef, order, chopRng)
|     |---- 3.3 locMap? (ATT == ID, xml:lang, source)
|     |     |
|     |     +---- 3.3.1 dataItem*    (ATT == ID, xml:lang, source, varRef, nCubeRef)
|     |           |
|     |           |---- 3.3.1.1 CubeCoord*  (ATT == ID, xml:lang, source, coordNo, coordVal, coordValRef)
|     |           |                     [coordValRef is the varRef to the var where the coordVal is stored]
|     |           |
|     |           +---- 3.3.1.2 physLoc*    (ATT == ID, xml:lang, source, type, recRef, blshtRef startPos,
|     |                                      width, endPos, col, row, colCnv, rowCnv, query)
|     |                 [colCnv and rowCnv indicate the coordNo from which to derive the coordiante
|     |                  value when the value of the coordinate is obtained from a non-cube variable
|     |                  location]
|     |
|     +---- 3.4 notes* (ATT == ID, xml:lang, source, type, subject, level, resp, sdatrefs)
|
|---- 4.0 dataDscr* (ATT == ID, xml:lang, source)
|     |
|     |---- 4.1 varGrp* (ATT == ID, xml:lang, source, type, var, varGrp, nCube, name, sdatrefs, methrefs,
|     |     |                       pubrefs, access)
|     |     |
|     |     |---- 4.1.1 labl*     (ATT == ID, xml:lang, source, level, vendor)
|     |     |---- 4.1.2 txt*      (ATT == ID, xml:lang, source, level)
|     |     |---- 4.1.3 defntn?   (ATT == ID, xml:lang, source)
|     |     |---- 4.1.4 universe? (ATT == ID, xml:lang, source, level, clusion)
|     |     +---- 4.1.5 notes*    (ATT == ID, xml:lang, source, type, subject, level, resp, sdatrefs)
|     |
|     |---- 4.2 var* (ATT == ID, xml:lang, source, name, wgt, wgt-var, qstn, files,
|     |     |                vendor, dcml, intrvl, rectype, sdatrefs, methrefs, pubrefs, access,
|     |     |                aggrMeth, measUnit, scale, origin, nature, additivity)
|     |     |
|     |     |---- 4.2.1 location*    (ATT == ID, xml:lang, source, StartPos, EndPos, width, RecSegNo,
|     |     |                                    fileid, locMap)
|     |     |---- 4.2.2 labl*        (ATT == ID, xml:lang, source, level, vendor)
|     |     |---- 4.2.3 imputation?  (ATT == ID, xml:lang, source)
|     |     |---- 4.2.4 security?    (ATT == ID, xml:lang, source, date)
|     |     |---- 4.2.5 embargo?     (ATT == ID, xml:lang, source, date, event, format)
|     |     |---- 4.2.6 respUnit?    (ATT == ID, xml:lang, source)
|     |     |---- 4.2.7 anlysUnit?   (ATT == ID, xml:lang, source)
|     |     |---- 4.2.8 qstn*        (ATT == ID, xml:lang, source, qstn, var, seqNo, sdatrefs)
|     |     |     |
|     |     |     |---- 4.2.8.1 preQTxt*  (ATT == ID, xml:lang, source)
|     |     |     |---- 4.2.8.2 qstnLit*  (ATT == ID, xml:lang, source)
|     |     |     |---- 4.2.8.3 postQTxt* (ATT == ID, xml:lang, source)
|     |     |     |---- 4.2.8.4 forward*  (ATT == ID, xml:lang, source, qstn)
|     |     |     |---- 4.2.8.5 backward* (ATT == ID, xml:lang, source, qstn)
|     |     |     +---- 4.2.8.6 ivuInstr* (ATT == ID, xml:lang, source)
|     |     |
|     |     |     NOTE: qstn ELEMENT may include mixed #PCDATA content.
|     |     |
|     |     |---- 4.2.9 valrng*      (ATT == ID, xml:lang, source)
|     |     |     |
|     |     |     |---- 4.2.9.1 range* (ATT == ID, xml:lang, source, UNITS, min, minExclusive
|     |     |     |                            max, maxExclusive)
|     |     |     |---- 4.2.9.2 item*  (ATT == ID, xml:lang, source, UNITS, VALUE)
|     |     |     |---- 4.2.9.3 key?   (ATT == ID, xml:lang, source)
|     |     |     +---- 4.2.9.4 notes* (ATT == ID, xml:lang, source, type, subject, level, resp, sdatrefs)
|     |     |
|     |     |---- 4.2.10 invalrng*    (ATT == ID, xml:lang, source)
|     |     |     |
|     |     |     |---- 4.2.10.1 range* (ATT == ID, xml:lang, source, UNITS, min, minExclusive
|     |     |     |                             max, maxExclusive)
|     |     |     |---- 4.2.10.2 item*  (ATT == ID, xml:lang, source, UNITS, VALUE)
|     |     |     +---- 4.2.10.3 key?   (ATT == ID, xml:lang, source)
|     |     |     +---- 4.2.10.4 notes* (ATT == ID, xml:lang, source, type, subject, level, resp, sdatrefs)
|     |     |
|     |     |---- 4.2.11 undocCod*   (ATT == ID, xml:lang, source)
|     |     |---- 4.2.12 universe*   (ATT == ID, xml:lang, source, level, clusion)
|     |     |---- 4.2.13 TotlResp?   (ATT == ID, xml:lang, source)
|     |     |---- 4.2.14 sumStat*    (ATT == ID, xml:lang, source, wgtd, weight, type)
|     |     |---- 4.2.15 txt*        (ATT == ID, xml:lang, source, level)
|     |     |---- 4.2.16 stdCatgry*  (ATT == ID, xml:lang, source, URI)
|     |     |---- 4.2.17 catgryGrp* (ATT == ID, xml:lang, source, missing, missType, catgry, catGrp)
|     |     |     |
|     |     |     |---- 4.2.17.1 labl*    (ATT == ID, xml:lang, source, level, vendor)
|     |     |     |---- 4.2.17.2 catStat* (ATT == ID, xml:lang, source, type, URI)
|     |     |     +---- 4.2.17.3 txt*     (ATT == ID, xml:lang, source, level)
|     |     |
|     |     |---- 4.2.18 catgry*     (ATT == ID, xml:lang, source, missing, missType, country, sdatrefs,
|     |     |     |                          other, total)
|     |     |     |
|     |     |     |---- 4.2.18.1 catValu? (ATT == ID, xml:lang, source)
|     |     |     |---- 4.2.18.2 labl*    (ATT == ID, xml:lang, source, level, vendor)
|     |     |     |---- 4.2.18.3 txt*     (ATT == ID, xml:lang, source, level)
|     |     |     |---- 4.2.18.4 catStat* (ATT == ID, xml:lang, source, type, URI)
|     |     |     +---- 4.2.18.5 catgry*  (ATT == ID, xml:lang, source, missing, missType, country,
|     |     |                                         sdatrefs, other, total)
|     |     |           NOTE: catgry is recursively defined to 4.2.18.
|     |     |
|     |     |---- 4.2.19 codInstr*   (ATT == ID, xml:lang, source)
|     |     |---- 4.2.20 verStmt*    (ATT == ID, xml:lang, source)
|     |     |     |
|     |     |     |---- 4.2.20.1 version? (ATT == ID, xml:lang, source, type, date)
|     |     |     |---- 4.2.20.2 verResp? (ATT == ID, xml:lang, source, affiliation)
|     |     |     +---- 4.2.20.3 notes*   (ATT == ID, xml:lang, source, type, subject, level,
|     |     |                                         resp, sdatrefs)
|     |     |
|     |     |---- 4.2.21 concept*    (ATT == ID, xml:lang, source, vocab, vocabURI)
|     |     |---- 4.2.22 derivation? (ATT == ID, xml:lang, source, var)
|     |     |     |
|     |     |     |---- 4.2.22.1 drvdesc? (ATT == ID, xml:lang, source)
|     |     |     +---- 4.2.22.2 drvcmd?  (ATT == ID, xml:lang, source, syntax)
|     |     |
|     |     |---- 4.2.23 varFormat?  (ATT == ID, xml:lang, source, type, formatname, schema, category, URI)
|     |     +---- 4.2.24 notes*      (ATT == ID, xml:lang, source, type, subject, level, resp, sdatrefs)
|     |
|     |---- 4.3 nCube*      (ATT == ID, xml:lang, source, name, sdatrefs, methrefs, pubrefs, access,
|     |     |                       dmnsQnty, cellQnty)
|     |     |---- 4.3.1 location*    (ATT == ID, xml:lang, source, StartPos, EndPos, width, RecSegNo,
|     |     |                                fileid, locMap)
|     |     |---- 4.3.2 labl*        (ATT == ID, xml:lang, source, level, vendor)
|     |     |---- 4.3.3 txt*         (ATT == ID, xml:lang, source, level)
|     |     |---- 4.3.4 universe*    (ATT == ID, xml:lang, source, level, clusion)
|     |     |---- 4.3.5 imputation?  (ATT == ID, xml:lang, source)
|     |     |---- 4.3.6 security?    (ATT == ID, xml:lang, source, date)
|     |     |---- 4.3.7 embargo?     (ATT == ID, xml:lang, source, date, event, format)
|     |     |---- 4.3.8 respUnit?    (ATT == ID, xml:lang, source)
|     |     |---- 4.3.9 anlysUnit?   (ATT == ID, xml:lang, source)
|     |     |---- 4.3.10 verStmt*    (ATT == ID, xml:lang, source)
|     |     |     |
|     |     |     |---- 4.3.10.1 version? (ATT == ID, xml:lang, source, type, date)
|     |     |     |---- 4.3.10.2 verResp? (ATT == ID, xml:lang, source, affiliation)
|     |     |     +---- 4.3.10.3 notes*   (ATT == ID, xml:lang, source, type, subject, level,
|     |     |                                         resp, sdatrefs)
|     |     |
|     |     |---- 4.3.11 purpose?    (ATT == ID, xml:lang, source, sdatrefs, methrefs, pubrefs, URI)
|     |     |---- 4.3.12 timeDmns    (ATT == ID, xml:lang, source, rank, varRef)
|     |     |     |
|     |     |     +---- 4.3.12.1 cohort   (ATT == ID, xml:lang, source, catRef, value)
|     |     |           |
|     |     |           +---- 4.3.12.1.1 range* (ATT == ID, xml:lang, source, UNITS, min, minExclusive
|     |     |                                           max, maxExclusive)
|     |     |
|     |     |---- 4.3.13 dmns+       (ATT == ID, xml:lang, source, rank, varRef)
|     |     |     |
|     |     |     +---- 4.3.13.1 cohort   (ATT == ID, xml:lang, source, catRef, value)
|     |     |           |
|     |     |           +---- 4.3.13.1.1 range* (ATT == ID, xml:lang, source, UNITS, min, minExclusive
|     |     |                                           max, maxExclusive)
|     |     |
|     |     |---- 4.3.14 measure     (ATT == ID, xml:lang, source, varRef, aggrMeth, measUnit, scale,
|     |     |                                origin, nature, additivity)
|     |     +---- 4.3.15 notes*      (ATT == ID, xml:lang, source, type, subject, level, resp, sdatrefs)
|     |
|     |---- 4.4 notes*      (ATT == ID, xml:lang, source, type, subject, level, resp, sdatrefs)