Difference between revisions of "Documenting Identifiers"

From Earth Science Information Partners (ESIP)
Line 12: Line 12:
  
 
==Crosswalks==
 
==Crosswalks==
<table width="95%" border="1" cellpadding="3" cellspacing="3" style="border-collapse: collapse;">
+
<table xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:cw="http://www.ngdc.noaa.gov/metadata/published/xsd/crosswalk.xsd" xmlns:xs="http://www.w3.org/2001/XMLSchema" width="95%" border="1" cellpadding="3" cellspacing="3" style="border-collapse: collapse;">
<tr>
+
  <tr>
<th>Concept</th>
+
      <th>Concept</th>
<th>Description</th>
+
      <th>Description</th>
<th>Paths</th>
+
      <th>Dialect (Fit) Paths</th>
</tr>
+
  </tr>
<tr>
+
  <tr>
<td style="word-break:break-all;">Metadata Identifier</td>
+
      <td style="word-break:break-all;">Metadata Identifier</td>
<td style="word-break:break-all;">A unique reference to the record within the catalogue (Metadata Identifier)</td>
+
      <td style="word-break:break-all;">A phrase or string which uniquely identifies the metadata file/record.</td>
<td style="word-break:break-all;"><b>DIF</b> /dif:Entry_Id<br><b>ISO</b> /*/gmd:fileIdentifier/gco:CharacterString<br></td>
+
      <td style="word-break:break-all;"><b>DIF</b> /dif:Entry_Id<br><b>ISO</b> /*/gmd:fileIdentifier/gco:CharacterString<br></td>
</tr>
+
  </tr>
<tr>
+
  <tr>
<td style="word-break:break-all;">Resource Identifier</td>
+
      <td style="word-break:break-all;">Resource Identifier</td>
<td style="word-break:break-all;">Identifier for the cited resource</td>
+
      <td style="word-break:break-all;">Identifier for the cited resource</td>
<td style="word-break:break-all;"><b>DIF</b> /dif:DIF/dif:Data_Set_Citation/dif:Dataset_DOI<br><b>DIF</b> /dif:DIF/dif:Reference/dif:DOI<br><b>ECHO</b> /echo:Collection/echo:DataSetId<br><b>ISO</b> /*/gmd:identificationInfo/*/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:code/gco:CharacterString<br><b>ISO-1</b> //cit:CI_Citation/cit:identifier/cit:MD_Identifier/cit:code<br><b>THREDDS</b> /thredds:catalog/thredds:dataset/@thredds:ID<br><b>netCDF</b> /nc:netcdf/nc:attribute[@name=id]/@value<br></td>
+
      <td style="word-break:break-all;"><b>DIF</b> /dif:DIF/dif:Data_Set_Citation/dif:Dataset_DOI<br><b>DIF</b> /dif:DIF/dif:Reference/dif:DOI<br><b>ECHO</b> /*/echo:DataSetId<br><b>ECHO</b> (1)  /*/echo:ShortName | /*/echo:LongName<br><b>ISO</b> /*/gmd:identificationInfo/*/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:code/gco:CharacterString<br></td>
</tr>
+
  </tr>
<tr>
+
  <tr>
<td style="word-break:break-all;">Naming Authority</td>
+
      <td style="word-break:break-all;">Related Resource Identifier</td>
<td style="word-break:break-all;">The organization responsible for the maintenance of the identifier (namespace)</td>
+
      <td style="word-break:break-all;">Identifier for a resource related to the resource being described.</td>
<td style="word-break:break-all;"><b>ISO</b> /*/gmd:identificationInfo/*/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:authority<br><b>ISO</b> /*/gmd:identificationInfo/*/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:codeSpace
+
      <td style="word-break:break-all;"><b>ECHO</b> (1)  /*/echo:CollectionAssociations/echo:CollectionAssociation/echo:ShortName<br><b>ECHO</b> (1)  /*/echo:Spatial/echo:HorizontalSpatialDomain/echo:ZoneIdentifier<br><b>ECHO</b> (1)  /*/echo:ProcessingLevelId<br><b>ECHO</b> (1)  /*/echo:Campaigns/echo:Campaign/echo:ShortName | /*/echo:Campaigns/echo:Campaign/echo:LongName<br><b>ECHO</b> (1)  /*/echo:Platforms/echo:Platform/echo:ShortName | /*/echo:Platforms/echo:Platform/echo:LongName<br><b>ECHO</b> (1)  /*/echo:Platforms/echo:Platform/echo:Instruments/echo:Instrument/echo:ShortName | /echo:*/echo:Platforms/echo:Platform/echo:Instruments/echo:Instrument/echo:LongName<br><b>ECHO</b> (1)  /*/echo:Platforms/echo:Platform/echo:Instruments/echo:Instrument/echo:Sensors/echo:Sensor/echo:ShortName | /*/echo:Platforms/echo:Platform/echo:Instruments/echo:Instrument/echo:Sensors/echo:Sensor/echo:LongName<br><b>ECHO</b> (1)  /*/echo:AssociatedDIFs/echo:DIF/echo:EntryId<br><b>ISO</b> (1)  /*/gmd:identificationInfo/*/gmd:aggregationInfo/gmd:MD_AggregateInformation/gmd:aggregateDataSetIdentifier/gmd:MD_Identifier/gmd:code/gco:CharacterString<br><b>ISO</b> (1)  /*/gmd:identificationInfo/*/gmd:extent/gmd:EX_Extent/gmd:geographicElement/gmd:EX_GeographicDescription/gmd:geographicIdentifier/gmd:MD_Identifier/gmd:code/gco:CharacterString<br><b>ISO</b> (1)  /*/gmd:identificationInfo/*/gmd:processingLevel/gmd:MD_Identifier/gmd:code/gco:CharacterString<br><b>ISO</b> (1)  /gmi:MI_Metadata/gmd:dataQualityInfo/gmd:DQ_DataQuality/gmd:report/gmd:DQ_AccuracyOfATimeMeasurement/gmd:measureIdentification/gmd:MD_Identifier/gmd:code/gco:CharacterString<br><b>ISO</b> (1)  /gmi:MI_Metadata/gmi:acquisitionInformation/eos:EOS_AcquisitionInformation/gmi:operation/gmi:MI_Operation/gmi:identifier/gmd:MD_Identifier/gmd:code/gco:CharacterString<br><b>ISO</b> (1)  /gmi:MI_Metadata/gmi:acquisitionInformation/gmi:MI_AcquisitionInformation/gmi:platform/gmi:MI_Platform/gmi:identifier/gmd:MD_Identifier/gmd:code/gco:CharacterString<br><b>ISO</b> (1)  /gmi:MI_Metadata/gmi:acquisitionInformation/gmi:MI_AcquisitionInformation/gmi:instrument/gmi:MI_Instrument/gmi:identifier/gmd:MD_Identifier/gmd:code/gco:CharacterString<br><b>ISO</b> /gmi:MI_Metadata/gmi:acquisitionInformation/eos:EOS_AcquisitionInformation/eos:sensor/eos:EOS_Sensor/eos:identifier/gmd:MD_Identifier/gmd:code/gco:CharacterString<br></td>
(19115-1)<br><b>THREDDS</b> /thredds:catalog/thredds:dataset/@thredds:authority<br><b>netCDF</b> /nc:netcdf/nc:attribute[@name=naming_authority]/@value<br></td>
+
  </tr>
</tr>
+
  <tr>
<tr>
+
      <td style="word-break:break-all;">Naming Authority</td>
<td style="word-break:break-all;">Parent Identifier</td>
+
      <td style="word-break:break-all;">The organization responsible for the maintenance of the identifier (namespace)</td>
<td style="word-break:break-all;">A unique identifier for a parent dataset or collection</td>
+
      <td style="word-break:break-all;"><b>ISO</b> /*/gmd:identificationInfo/*/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:authority<br><b>ISO</b> /*/gmd:identificationInfo/*/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:codeSpace
<td style="word-break:break-all;"><b>DIF</b> /dif:DIF/dif:Parent_DIF<br><b>ISO</b> /*/gmd:parentIdentifier/gco:CharacterString<br></td>
+
        (19115-1)<br></td>
</tr>
+
  </tr>
 +
  <tr>
 +
      <td style="word-break:break-all;">Parent Identifier</td>
 +
      <td style="word-break:break-all;">A unique identifier for a parent dataset or collection</td>
 +
      <td style="word-break:break-all;"><b>DIF</b> /dif:DIF/dif:Parent_DIF<br><b>ISO</b> /*/gmd:parentIdentifier/gco:CharacterString<br></td>
 +
  </tr>
 
</table>
 
</table>
 
''xPath Note:'' The xPaths included in this table use several wildcards. // means
 
''xPath Note:'' The xPaths included in this table use several wildcards. // means
Line 48: Line 53:
 
could be gmd:identificationInfo/gmd:MD_DataIdentification/gmd:descriptiveKeywords
 
could be gmd:identificationInfo/gmd:MD_DataIdentification/gmd:descriptiveKeywords
 
or gmd:identificationInfo/srv:SV_ServiceIdentification/gmd:descriptiveKeywords.
 
or gmd:identificationInfo/srv:SV_ServiceIdentification/gmd:descriptiveKeywords.
 +
''Fit:'' The fit of the dialect path with the concept is estimated on a scale of 1
 +
= excellent two-way fit, 2 = one-way fit or some other problem, 3 - extension required.
 
[[Category:Documentation Connections]]
 
[[Category:Documentation Connections]]

Revision as of 10:55, August 6, 2013

Unique identifiers in metadata records are becoming more and more important for data citation and attribution and for identifying resources related to the resource being described in the metadata. Some mechanism must exist for ensuring that these identifiers are unique. This can be accomplished by using an identifier scheme that guarantees uniqueness (UUID) or by specifying the naming authority or namespace for the identifier. It is the responsibility of the manager of the namespace to ensure that the identifiers in that namespace are unique.

Metadata Record Identifiers

As metadata are shared between National and International repositories it is becoming increasing important to be able to unambiguously identify and refer to specific records. This requirement is facilitated by including an identifier for metadata record in the metadata itself.

Resource Identifiers

Metadata must include an unambiguous identifier for the resource that it describes.

Related Resource Identifiers

Metadata records increasingly refer to resources that are related to the resource being described. These external resources can be many different type of things.

Crosswalks

Concept Description Dialect (Fit) Paths
Metadata Identifier A phrase or string which uniquely identifies the metadata file/record. DIF /dif:Entry_Id
ISO /*/gmd:fileIdentifier/gco:CharacterString
Resource Identifier Identifier for the cited resource DIF /dif:DIF/dif:Data_Set_Citation/dif:Dataset_DOI
DIF /dif:DIF/dif:Reference/dif:DOI
ECHO /*/echo:DataSetId
ECHO (1) /*/echo:ShortName | /*/echo:LongName
ISO /*/gmd:identificationInfo/*/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:code/gco:CharacterString
Related Resource Identifier Identifier for a resource related to the resource being described. ECHO (1) /*/echo:CollectionAssociations/echo:CollectionAssociation/echo:ShortName
ECHO (1) /*/echo:Spatial/echo:HorizontalSpatialDomain/echo:ZoneIdentifier
ECHO (1) /*/echo:ProcessingLevelId
ECHO (1) /*/echo:Campaigns/echo:Campaign/echo:ShortName | /*/echo:Campaigns/echo:Campaign/echo:LongName
ECHO (1) /*/echo:Platforms/echo:Platform/echo:ShortName | /*/echo:Platforms/echo:Platform/echo:LongName
ECHO (1) /*/echo:Platforms/echo:Platform/echo:Instruments/echo:Instrument/echo:ShortName | /echo:*/echo:Platforms/echo:Platform/echo:Instruments/echo:Instrument/echo:LongName
ECHO (1) /*/echo:Platforms/echo:Platform/echo:Instruments/echo:Instrument/echo:Sensors/echo:Sensor/echo:ShortName | /*/echo:Platforms/echo:Platform/echo:Instruments/echo:Instrument/echo:Sensors/echo:Sensor/echo:LongName
ECHO (1) /*/echo:AssociatedDIFs/echo:DIF/echo:EntryId
ISO (1) /*/gmd:identificationInfo/*/gmd:aggregationInfo/gmd:MD_AggregateInformation/gmd:aggregateDataSetIdentifier/gmd:MD_Identifier/gmd:code/gco:CharacterString
ISO (1) /*/gmd:identificationInfo/*/gmd:extent/gmd:EX_Extent/gmd:geographicElement/gmd:EX_GeographicDescription/gmd:geographicIdentifier/gmd:MD_Identifier/gmd:code/gco:CharacterString
ISO (1) /*/gmd:identificationInfo/*/gmd:processingLevel/gmd:MD_Identifier/gmd:code/gco:CharacterString
ISO (1) /gmi:MI_Metadata/gmd:dataQualityInfo/gmd:DQ_DataQuality/gmd:report/gmd:DQ_AccuracyOfATimeMeasurement/gmd:measureIdentification/gmd:MD_Identifier/gmd:code/gco:CharacterString
ISO (1) /gmi:MI_Metadata/gmi:acquisitionInformation/eos:EOS_AcquisitionInformation/gmi:operation/gmi:MI_Operation/gmi:identifier/gmd:MD_Identifier/gmd:code/gco:CharacterString
ISO (1) /gmi:MI_Metadata/gmi:acquisitionInformation/gmi:MI_AcquisitionInformation/gmi:platform/gmi:MI_Platform/gmi:identifier/gmd:MD_Identifier/gmd:code/gco:CharacterString
ISO (1) /gmi:MI_Metadata/gmi:acquisitionInformation/gmi:MI_AcquisitionInformation/gmi:instrument/gmi:MI_Instrument/gmi:identifier/gmd:MD_Identifier/gmd:code/gco:CharacterString
ISO /gmi:MI_Metadata/gmi:acquisitionInformation/eos:EOS_AcquisitionInformation/eos:sensor/eos:EOS_Sensor/eos:identifier/gmd:MD_Identifier/gmd:code/gco:CharacterString
Naming Authority The organization responsible for the maintenance of the identifier (namespace) ISO /*/gmd:identificationInfo/*/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:authority
ISO /*/gmd:identificationInfo/*/gmd:citation/gmd:CI_Citation/gmd:identifier/gmd:MD_Identifier/gmd:codeSpace (19115-1)
Parent Identifier A unique identifier for a parent dataset or collection DIF /dif:DIF/dif:Parent_DIF
ISO /*/gmd:parentIdentifier/gco:CharacterString

xPath Note: The xPaths included in this table use several wildcards. // means any path, so //gmd:CI_ResponsibleParty indicates a gmd:CI_ResponsibleParty anywhere in an XML file. /*/ indicates a single level with several possible elements. This usually indicates one of several concrete realizations of an abstract object. For example /*/gmd:identificationInfo could be gmd:MD_Metadata/gmd:identificationInfo or gmi:MI_Metadata/gmd:identificationInfo and gmd:identificationInfo//*/gmd:descriptiveKeywords could be gmd:identificationInfo/gmd:MD_DataIdentification/gmd:descriptiveKeywords or gmd:identificationInfo/srv:SV_ServiceIdentification/gmd:descriptiveKeywords. Fit: The fit of the dialect path with the concept is estimated on a scale of 1 = excellent two-way fit, 2 = one-way fit or some other problem, 3 - extension required.