Changes between Version 182 and Version 183 of CMDI 1.2/Specification


Ignore:
Timestamp:
05/26/16 09:21:06 (8 years ago)
Author:
Twan Goosen
Comment:

Structure of CMDI files

Legend:

Unmodified
Added
Removed
Modified

  • CMDI 1.2/Specification

    v182 v183  
    209209}}}
    210210
     211----
     212
    211213= Structure of CMDI files =
    212214[=#structureOfCmdi]
    … …  
    218220{TODO: add caption to diagram, make clear that it serves to illustrate the document structure but that the full constraints are in the table}
    219221
    220 (Caption): The structure of a CMDI file (CMD instance). Colour scheme: Green boxes represent elements that are present in all CMDI files (the CMD instance envelope). Blue boxes represent  templates of elements defined by the CMD profile (the CMD instance payload). The diagram is meant for overview and illustration; full details to be found in the tables below.
     222(Caption): The structure of a CMDI file (CMD instance). Colour scheme: Green boxes represent elements that are potentially present in all CMDI files (the CMD instance envelope). Blue boxes represent elements defined by the CMD profile (the CMD instance payload). The diagram is meant for overview and illustration; full details to be found in the tables below.
    221223
    222224A CMDI file contains the actual metadata of one specific resource (hereafter referred to as the ''described resource''),  and might also be referred to as a ''CMD record'' or ''CMD instance''. All CMDI files have the same structure at the top level. At a lower level, parts of its structure  are defined by the CMD profile upon which it is based.
    … …  
    272274==      The `<Header>` element==
    273275
    274 The header of a CMDI file mainly contains administrative information about the metadata, that is metadata about the CMDI file itself. The following elements may be included in the order indicated:
     276The header of a CMDI instance mainly contains administrative information about the metadata, that is metadata about the CMDI file itself. The following elements may be included in the order indicated:
    275277
    276278||||=Name=||=Value type=||=Occurrences=||=Description=||
    … …  
    279281|| ||`<cmd:MdCreationDate>`||`xs:date`||0 or 1||The date this metadata file was created.||
    280282|| ||`<cmd:MdSelfLink>`||`xs:anyURI`||0 or 1||A reference to this metadata file in its home repository, in the form of a PID (`RECOMMENDED`) or a URL.||
    281 || ||`<cmd:MdProfile>`||`xs:anyURI`||1||The CMDI profile  upon which this metadata file is based, given by its identifier in a Component Registry, e.g. `clarin.eu:cr1:p_1407745711925`.||
     283|| ||`<cmd:MdProfile>`||`xs:anyURI`||1||The CMDI profile  upon which this metadata file is based, given by its identifier in a Component Registry.||
    282284|| ||`<cmd:MdCollectionDisplayName>`||`xs:string`||0 or 1||The collection to which the described resource belongs, given as a human-readable name. Exploitation tools can use this name to present metadata collections.||
    283285 
    … …  
    299301
    300302==      The `<Resources>` element ==
    301 This section of the CMDI file enumerates
     303This section of the CMDI file provides the sequence of
    302304* files which are parts of or closely related to the described resource (`<cmd:ResourceProxyList>` and `<cmd:JournalFileProxyList>`)
    303305* possible relations between pairs of these files (`<cmd:ResourceRelationList>`)
    304306
     307If these parts are present they `MUST` appear in this order:
    305308||||=Name=||=Value type=||=Occurrences=||=Description=||
    306309||||`<cmd:Resources>`||`xs:complexType`|| ||Includes 3 lists containing information about resource proxies and their interrelations.||
    … …  
    312315`<cmd:ResourceProxyList>` contains a sequence of zero or more occurrences of `<cmd:ResourceProxy>`, each of which representing a file/part of the described resource.
    313316
     317If these parts are present they `MUST` appear in this order:
    314318||||||||=Name=||=Value type=||=Occurrences=||=Description=||
    315319||||||||`<cmd:ResourceProxyList>` ||`xs:complexType`|| ||Contains a list of resource proxies (see below).||
    … …  
    324328`<cmd:JournalFileProxyList>` contains a sequence of zero or more occurrences of `<cmd:JournalFileProxy>`, each of which representing a file containing provenance information about the described resource.
    325329
     330If these parts are present they `MUST` appear in this order:
    326331||||||=Name=||=Value type=||=Occurrences=||=Description=||
    327332||||||`<cmd:JournalFileProxyList>` ||`xs:complexType`|| ||Contains a list of journal file proxies (see below).||
    … …  
    332337`<cmd:ResourceRelationList>` contains a sequence of zero or more occurrences of `<cmd:ResourceRelation>`, each of which representing a relation between any pair of `<cmd:ResourceProxies>`.
    333338
     339If these parts are present they `MUST` appear in this order:
    334340||||||||||=Name=||=Value type=||=Occurrences=||=Description=||
    335341||||||||||`<cmd:ResourceRelationList>`||`xs:complexType`|| ||Contains a list of resource relations (see below).||
    336342|| ||||||||`<cmd:ResourceRelation>`||`xs:complexType`||0 to unbounded||A representation of a relation between 2 resource proxies listed in `<cmd:ResourceProxyList>`.||
    337343|| || ||||||`<cmd:RelationType>`||`xs:string`||1||The type of the relation represented by its parent `<cmd:ResourceRelation>`.||
    338 || || || ||||`@ConceptLink`||`xs:anyURI`||0 or 1||A reference to some concept registry (CLARIN Concept Registry by default), indicating the semantics of `<cmd:RelationType>`.||
     344|| || || ||||`@ConceptLink`||`xs:anyURI`||0 or 1||A reference to some concept registry (e.g. CLARIN Concept Registry), indicating the semantics of `<cmd:RelationType>`.||
    339345|| || ||||||`<cmd:Resource>`||`xs:complexType`||2||References one of the resource proxies participating in the relationship.||
    340346|| || || ||||`@ref`||`xs:IDREF`||1||A reference to the `<cmd:ResourceProxy>` with id=ref (the `<cmd:ResourceProxy>` represented by its parent `<cmd:Resource>` element).||
    341347|| || || ||||`<cmd:Role>`||`xs:string`||0 or 1||Indicates the role its parent Resource plays in the relationship.||
    342 || || || || ||`@ConceptLink`||`xs:anyURI`||0 or 1||A reference to some concept registry (CLARIN Concept Registry by default), indicating the semantics of `<cmd:Role>`.||
     348|| || || || ||`@ConceptLink`||`xs:anyURI`||0 or 1||A reference to some concept registry (e.g. CLARIN Concept Registry), indicating the semantics of `<cmd:Role>`.||
    343349
    344350
    … …  
    378384`<cmd:IsPartOfList>` contains a sequence of zero or more occurrences of `<cmd:IsPartOf>`, each representing an external resource of which the described resource constitutes a part.
    379385
     386If these parts are present they `MUST` appear in this order:
    380387||||=Name=||=Value type=||=Occurrences=||=Description=||
    381388||||`<cmd:IsPartOfList>` ||`xs:complexType`|| ||Contains a list of `<cmd:IsPartOf>` (see below).||
    … …  
    394401This part of the CMDI file forms what may be referred to as descriptive metadata about the described resource.  Both  content and structure are completely defined by the CMD Profile  referenced by the XML element `<cmd:MdProfile>` in `<cmd:Header>`.
    395402
     403If these parts are present they `MUST` appear in this order:
    396404||||||||=Name=||=Value type=||=Occurrences=||=Description=||
    397405||||||||`<cmd:Components>` ||`xs:complexType`|| ||Container for the CMD instance payload.||
    … …  
    400408|| || ||||`@{CMDAttribute}*`||As specified in the CMD profile||As specified in the CMD profile||Custom attribute, defined as an allowed or mandatory child in a component specification.||
    401409|| || ||||`<cmdp:{CMDElement}>*`||As specified in the CMD profile||As specified in the CMD profile||Atomic piece of information about the described resource.||
    402 || || || ||`@xml:lang`||`xs:string`||0 or 1||Indicates the language of the `<cmdp:{CMDElement}>` content by a language tag.||
    403 || || || ||`@cmd:ref`||`xs:IDREF`||0 or 1||Reference to a `<cmd:ResourceProxy>` with `@id` equal to  the value of this attribute, to which this substructure specifically applies.||
     410|| || || ||`@xml:lang`||`xs:language`||0 or 1||Indicates the language of the `<cmdp:{CMDElement}>` content by a language tag.||
    404411|| || || ||`@cmd:ValueConceptLink`||`xs:anyURI`||0 or 1||Reference to a concept in an external vocabulary. Used in case the value `<cmdp:{CMDElement}>` is selected from a controlled vocabulary.||
    405412|| || || ||`@{CMDAttribute}*`||As specified in the CMD profile||As specified in the CMD profile||Custom attribute, defined as an allowed or mandatory child in a CMD element specification.||
    … …  
    410417|| || || ||`<cmdp:{CMDElement}>*`||As specified in the CMD profile||As specified in the CMD profile||Atomic piece of information related to the described resource and forming a part of its parent CMD component.||
    411418|| || || ||`<cmdp:{CMDComponent}>*`||`xs:complexType`||As specified in the CMD profile||A chunk of information related to the described resource, forming a part of its parent CMD component and further composed of CMD Elements and other CMD Components.||
     419
     420----
    412421
    413422=       The CMDI Component Specification Language (CCSL)=