<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Content Discovery — v2.1.0-beta</title>
<link rel="stylesheet" href="../_static/dataone.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.1.0-beta',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/mathjax_pre.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="//cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-MML-AM_CHTML"></script>
<script type="text/javascript" src="../_static/sidebar.js"></script>
<link rel="author" title="About these documents" href="../about.html" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Search Metadata Elements Extracted from EML" href="SearchMetadata_eml.html" />
<link rel="prev" title="Data Packaging" href="DataPackage.html" />
<link media="only screen and (max-device-width: 480px)" href="../_static/small_dataone.css" type= "text/css" rel="stylesheet" />
</head>
<body role="document">
<div class="version_notice">
<p>
<span class='bold'>Warning:</span> These documents are under active
development and subject to change (version 2.1.0-beta).<br />
The latest release documents are at:
<a href="https://purl.dataone.org/architecture">https://purl.dataone.org/architecture</a>
</p>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="SearchMetadata_eml.html" title="Search Metadata Elements Extracted from EML"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="DataPackage.html" title="Data Packaging"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html"></a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U"><no title></a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-SearchMetadata">
<span id="content-discovery"></span><h1><a class="toc-backref" href="#id5">Content Discovery</a><a class="headerlink" href="#module-SearchMetadata" title="Permalink to this headline">¶</a></h1>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#module-SearchMetadata" id="id5">Content Discovery</a><ul>
<li><a class="reference internal" href="#querying-the-solr-index" id="id6">Querying the SOLR Index</a></li>
<li><a class="reference internal" href="#system-metadata-index-properties" id="id7">System Metadata Index Properties</a><ul>
<li><a class="reference internal" href="#populating-permission-fields" id="id8">Populating Permission Fields</a></li>
<li><a class="reference internal" href="#example-queries" id="id9">Example Queries</a></li>
</ul>
</li>
<li><a class="reference internal" href="#properties-of-the-index-derived-from-resource-maps" id="id10">Properties of the Index Derived from Resource Maps</a><ul>
<li><a class="reference internal" href="#populating-object-relation-fields" id="id11">Populating Object Relation Fields</a><ul>
<li><a class="reference internal" href="#adding-package-1" id="id12">Adding Package 1</a></li>
<li><a class="reference internal" href="#adding-package-2" id="id13">Adding Package 2</a></li>
<li><a class="reference internal" href="#adding-package-3" id="id14">Adding Package 3</a></li>
</ul>
</li>
<li><a class="reference internal" href="#limitations-of-multi-valued-fields-in-solr" id="id15">Limitations of Multi-Valued Fields in SOLR</a></li>
</ul>
</li>
<li><a class="reference internal" href="#values-extracted-from-science-metadata" id="id16">Values Extracted from Science Metadata</a></li>
<li><a class="reference internal" href="#date-representations-in-science-metadata-documents" id="id17">Date Representations in Science Metadata Documents</a></li>
<li><a class="reference internal" href="#science-metadata-examples" id="id18">Science metadata examples</a></li>
<li><a class="reference internal" href="#standard-specific-metadata-extraction-notes" id="id19">Standard Specific Metadata Extraction Notes</a></li>
<li><a class="reference internal" href="#attribute-descriptions-and-notes" id="id20">Attribute Descriptions and Notes</a></li>
<li><a class="reference internal" href="#creating-citations-from-index-fields" id="id21">Creating Citations from Index Fields</a></li>
</ul>
</li>
</ul>
</div>
<p>Searching for content is a functionality that is primarily supported by
Coordinating Nodes, programmatically through the CN_read.search method, and
through a web browser interface that connects through a user interface
implemented by <a class="reference external" href="http://mercury.ornl.gov/">Mercury</a> which utilizes a <a class="reference external" href="http://lucene.apache.org/solr/">SOLR</a> index to support search
operations.</p>
<p>This document describes the properties of the SOLR index, how it is populated,
and how it can be used to support programmatic search and introspection into the
DataONE holdings.</p>
<p>The SOLR index is populated from content that is copied to Coordinating Nodes,
that is <a class="reference internal" href="../glossary.html#term-80"><span class="xref std std-term">System Metadata</span></a>, <a class="reference internal" href="../glossary.html#term-71"><span class="xref std std-term">Science Metadata</span></a> and <a class="reference internal" href="../glossary.html#term-resource-maps"><span class="xref std std-term">Resource
Maps</span></a>. Each index entry represents information about the information referenced
by a single identifier (PID). For PIDs that refer to science data objects the
index entry will be constructed from system metadata and zero or more resource
maps that reference the object. If a PID identifies a science metadata object,
the index entry will have fields populated with content extracted from the
system metadata for the object, the science metadata document and zero or more
resource maps that reference the science metadata. Similarly, if the PID
identifies a resource map, then the index entry fields for that PID will be
populated by the System Metadata and resource map values for that PID.</p>
<p>The general sequence for indexing content is illustrated in Figure 1 below.</p>
<p>The general process of indexing content involves retrieving a System Metadata
document, parsing system metadata properties such as permission rules to
generate a SOLR index document, then optionally adding to the document if the
PID refers to a science metadata or resource map object. The general sequence
of operations is outlined in Figure 1. If the PID refers to a resource map,
then it is necessary to update the <a class="reference internal" href="#SearchMetadata.documents" title="SearchMetadata.documents"><code class="xref py py-attr docutils literal"><span class="pre">documents</span></code></a> and
<a class="reference internal" href="#SearchMetadata.isDocumentedBy" title="SearchMetadata.isDocumentedBy"><code class="xref py py-attr docutils literal"><span class="pre">isDocumentedBy</span></code></a> properties of the Science Metadata and
data objects that appear in the data package defined by the Resource Map.</p>
<div class="figure">
<img alt="../_images/index_sequence.png" src="../_images/index_sequence.png" />
</div>
<p>A full list of index fields is provided in Table 4 below.</p>
<div class="section" id="querying-the-solr-index">
<h2><a class="toc-backref" href="#id6">Querying the SOLR Index</a><a class="headerlink" href="#querying-the-solr-index" title="Permalink to this headline">¶</a></h2>
<p>The <a class="reference external" href="http://wiki.apache.org/solr/SolrQuerySyntax">SOLR query syntax</a> is based on the <a class="reference external" href="http://lucene.apache.org/java/2_9_1/queryparsersyntax.html">Lucene query syntax</a> and adds a
couple of extensions. The SOLR search index is exposed directly as a SOLR search
service with the base url of:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">http</span><span class="p">(</span><span class="n">s</span><span class="p">):</span><span class="o">//</span><span class="n">server</span><span class="o">.</span><span class="n">name</span><span class="o">/</span><span class="n">solr</span><span class="o">/</span>
</pre></div>
</div>
</div>
<div class="section" id="system-metadata-index-properties">
<h2><a class="toc-backref" href="#id7">System Metadata Index Properties</a><a class="headerlink" href="#system-metadata-index-properties" title="Permalink to this headline">¶</a></h2>
<p>The main goals for indexing system metadata include:</p>
<ol class="arabic simple">
<li>Support access control rules for search results</li>
<li>Support efficient discovery of objects by their properties</li>
</ol>
<p>Table 1 provides a list of SOLR attributes that are populated by values taken
from System Metadata.</p>
<p><strong>Table 1.</strong> Elements derived from System Metadata and available for all
objects. “Multi” fields may be populated with more than a single value per
document (PID) indexed.</p>
<table border="1" class="docutils" id="id1">
<caption><span class="caption-text">System</span><a class="headerlink" href="#id1" title="Permalink to this table">¶</a></caption>
<colgroup>
<col width="19%" />
<col width="13%" />
<col width="6%" />
<col width="63%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Attribute</th>
<th class="head">Type</th>
<th class="head">Multi?</th>
<th class="head">Content Origin</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.blockedReplicationMN" title="SearchMetadata.blockedReplicationMN"><code class="xref py py-attr docutils literal"><span class="pre">blockedReplicationMN</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td><a class="reference internal" href="../apis/Types.html#Types.ReplicationPolicy.blockedMemberNode" title="Types.ReplicationPolicy.blockedMemberNode"><code class="xref py py-attr docutils literal"><span class="pre">Types.ReplicationPolicy.blockedMemberNode</span></code></a></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.checksum" title="SearchMetadata.checksum"><code class="xref py py-attr docutils literal"><span class="pre">checksum</span></code></a></td>
<td>string</td>
<td>No</td>
<td><a class="reference internal" href="../apis/Types.html#Types.SystemMetadata.checksum" title="Types.SystemMetadata.checksum"><code class="xref py py-attr docutils literal"><span class="pre">Types.SystemMetadata.checksum</span></code></a></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.checksumAlgorithm" title="SearchMetadata.checksumAlgorithm"><code class="xref py py-attr docutils literal"><span class="pre">checksumAlgorithm</span></code></a></td>
<td>string</td>
<td>No</td>
<td><code class="xref py py-attr docutils literal"><span class="pre">Types.Checksum.algorithm</span></code></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.dataUrl" title="SearchMetadata.dataUrl"><code class="xref py py-attr docutils literal"><span class="pre">dataUrl</span></code></a></td>
<td>string</td>
<td>No</td>
<td>Resolve REST URL created from PID</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.datasource" title="SearchMetadata.datasource"><code class="xref py py-attr docutils literal"><span class="pre">datasource</span></code></a></td>
<td>string</td>
<td>No</td>
<td><a class="reference internal" href="../apis/Types.html#Types.SystemMetadata.originMemberNode" title="Types.SystemMetadata.originMemberNode"><code class="xref py py-attr docutils literal"><span class="pre">Types.SystemMetadata.originMemberNode</span></code></a></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.dateUploaded" title="SearchMetadata.dateUploaded"><code class="xref py py-attr docutils literal"><span class="pre">dateUploaded</span></code></a></td>
<td>date</td>
<td>No</td>
<td><a class="reference internal" href="../apis/Types.html#Types.SystemMetadata.dateUploaded" title="Types.SystemMetadata.dateUploaded"><code class="xref py py-attr docutils literal"><span class="pre">Types.SystemMetadata.dateUploaded</span></code></a></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.dateModified" title="SearchMetadata.dateModified"><code class="xref py py-attr docutils literal"><span class="pre">dateModified</span></code></a></td>
<td>date</td>
<td>No</td>
<td><a class="reference internal" href="../apis/Types.html#Types.SystemMetadata.dateSysMetadataModified" title="Types.SystemMetadata.dateSysMetadataModified"><code class="xref py py-attr docutils literal"><span class="pre">Types.SystemMetadata.dateSysMetadataModified</span></code></a></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.id" title="SearchMetadata.id"><code class="xref py py-attr docutils literal"><span class="pre">id</span></code></a></td>
<td>string</td>
<td>No</td>
<td><a class="reference internal" href="../apis/Types.html#Types.SystemMetadata.identifier" title="Types.SystemMetadata.identifier"><code class="xref py py-attr docutils literal"><span class="pre">Types.SystemMetadata.identifier</span></code></a></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.numberReplicas" title="SearchMetadata.numberReplicas"><code class="xref py py-attr docutils literal"><span class="pre">numberReplicas</span></code></a></td>
<td>string</td>
<td>No</td>
<td><code class="xref py py-attr docutils literal"><span class="pre">Types.replicationPolicy.numberReplicas</span></code></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.formatId" title="SearchMetadata.formatId"><code class="xref py py-attr docutils literal"><span class="pre">formatId</span></code></a></td>
<td>string</td>
<td>No</td>
<td><a class="reference internal" href="../apis/Types.html#Types.SystemMetadata.formatId" title="Types.SystemMetadata.formatId"><code class="xref py py-attr docutils literal"><span class="pre">Types.SystemMetadata.formatId</span></code></a></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.obsoletes" title="SearchMetadata.obsoletes"><code class="xref py py-attr docutils literal"><span class="pre">obsoletes</span></code></a></td>
<td>string</td>
<td>No</td>
<td><a class="reference internal" href="../apis/Types.html#Types.SystemMetadata.obsoletes" title="Types.SystemMetadata.obsoletes"><code class="xref py py-attr docutils literal"><span class="pre">Types.SystemMetadata.obsoletes</span></code></a></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.preferredReplicationMN" title="SearchMetadata.preferredReplicationMN"><code class="xref py py-attr docutils literal"><span class="pre">preferredReplicationMN</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td><a class="reference internal" href="../apis/Types.html#Types.ReplicationPolicy.preferredMemberNode" title="Types.ReplicationPolicy.preferredMemberNode"><code class="xref py py-attr docutils literal"><span class="pre">Types.ReplicationPolicy.preferredMemberNode</span></code></a></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.replicationAllowed" title="SearchMetadata.replicationAllowed"><code class="xref py py-attr docutils literal"><span class="pre">replicationAllowed</span></code></a></td>
<td>boolean</td>
<td>No</td>
<td><a class="reference internal" href="../apis/Types.html#Types.ReplicationPolicy.replicationAllowed" title="Types.ReplicationPolicy.replicationAllowed"><code class="xref py py-attr docutils literal"><span class="pre">Types.ReplicationPolicy.replicationAllowed</span></code></a></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.rightsHolder" title="SearchMetadata.rightsHolder"><code class="xref py py-attr docutils literal"><span class="pre">rightsHolder</span></code></a></td>
<td>string</td>
<td>No</td>
<td><code class="xref py py-attr docutils literal"><span class="pre">SystemMetadata.rightsHolder</span></code></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.size" title="SearchMetadata.size"><code class="xref py py-attr docutils literal"><span class="pre">size</span></code></a></td>
<td>long</td>
<td>No</td>
<td><a class="reference internal" href="../apis/Types.html#Types.SystemMetadata.size" title="Types.SystemMetadata.size"><code class="xref py py-attr docutils literal"><span class="pre">Types.SystemMetadata.size</span></code></a></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.submitter" title="SearchMetadata.submitter"><code class="xref py py-attr docutils literal"><span class="pre">submitter</span></code></a></td>
<td>string</td>
<td>No</td>
<td><a class="reference internal" href="../apis/Types.html#Types.SystemMetadata.submitter" title="Types.SystemMetadata.submitter"><code class="xref py py-attr docutils literal"><span class="pre">Types.SystemMetadata.submitter</span></code></a></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.authoritativeMN" title="SearchMetadata.authoritativeMN"><code class="xref py py-attr docutils literal"><span class="pre">authoritativeMN</span></code></a></td>
<td>string</td>
<td>No</td>
<td><a class="reference internal" href="../apis/Types.html#Types.SystemMetadata.authoritativeMemberNode" title="Types.SystemMetadata.authoritativeMemberNode"><code class="xref py py-attr docutils literal"><span class="pre">Types.SystemMetadata.authoritativeMemberNode</span></code></a></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.replicaMN" title="SearchMetadata.replicaMN"><code class="xref py py-attr docutils literal"><span class="pre">replicaMN</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td><code class="xref py py-attr docutils literal"><span class="pre">Types.Replica.replicationMemberNode</span></code></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.readPermission" title="SearchMetadata.readPermission"><code class="xref py py-attr docutils literal"><span class="pre">readPermission</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td><a class="reference internal" href="../apis/Types.html#Types.AccessRule.subject" title="Types.AccessRule.subject"><code class="xref py py-attr docutils literal"><span class="pre">Types.AccessRule.subject</span></code></a> where permission = read</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.writePermission" title="SearchMetadata.writePermission"><code class="xref py py-attr docutils literal"><span class="pre">writePermission</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td><a class="reference internal" href="../apis/Types.html#Types.AccessRule.subject" title="Types.AccessRule.subject"><code class="xref py py-attr docutils literal"><span class="pre">Types.AccessRule.subject</span></code></a> where permission = write</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.changePermission" title="SearchMetadata.changePermission"><code class="xref py py-attr docutils literal"><span class="pre">changePermission</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td><a class="reference internal" href="../apis/Types.html#Types.AccessRule.subject" title="Types.AccessRule.subject"><code class="xref py py-attr docutils literal"><span class="pre">Types.AccessRule.subject</span></code></a> where permission = changePermission</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.isPublic" title="SearchMetadata.isPublic"><code class="xref py py-attr docutils literal"><span class="pre">isPublic</span></code></a></td>
<td>boolean</td>
<td>No</td>
<td><a class="reference internal" href="../glossary.html#term-54"><span class="xref std std-term">Public User</span></a></td>
</tr>
</tbody>
</table>
<div class="section" id="populating-permission-fields">
<h3><a class="toc-backref" href="#id8">Populating Permission Fields</a><a class="headerlink" href="#populating-permission-fields" title="Permalink to this headline">¶</a></h3>
<p>This process is fairly straight forward, and requires simply de-duping entries
so that each of the permission fields contains a distinct list of subjects
granted that permission. If the DataONE <a class="reference internal" href="../glossary.html#term-54"><span class="xref std std-term">public user</span></a> is present in the
read permissions, then the <em>isPublic</em> field is set to True.</p>
</div>
<div class="section" id="example-queries">
<h3><a class="toc-backref" href="#id9">Example Queries</a><a class="headerlink" href="#example-queries" title="Permalink to this headline">¶</a></h3>
<p>The following provide some example queries that may be issued directly against
the SOLR index operating on the Coordinating Nodes. Note that search terms must
be properly escaped for the SOLR query syntax, and additionally if submitted
directly as part of a URL, must also be properly URL escaped.</p>
<ol class="arabic">
<li><p class="first">Index entries that match PID (should be at most one match):</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="nb">id</span><span class="p">:</span><span class="s2">"PID"</span>
</pre></div>
</div>
<p>where PID = identifier of object being located</p>
</li>
<li><p class="first">Index entries with PID that starts with “some_prefix”:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="nb">id</span><span class="p">:</span><span class="s2">"some_prefix*"</span>
</pre></div>
</div>
</li>
<li><p class="first">Index entries that match a particular format id:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">formatId</span><span class="p">:</span><span class="s2">"format_a"</span>
</pre></div>
</div>
<p>where format_a = the formatId being located</p>
</li>
<li><p class="first">Entries with formatId matching “fmtid_1” or “fmtid_2”:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">formatId</span><span class="p">:</span><span class="s2">"fmtid_1"</span> <span class="o">||</span> <span class="n">formatId</span><span class="p">:</span><span class="s2">"fmtid_2"</span>
</pre></div>
</div>
</li>
<li><p class="first">Entries with byte size less than or equal to 10000:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">size</span><span class="p">:[</span><span class="o">*</span> <span class="n">TO</span> <span class="mi">10000</span><span class="p">]</span>
</pre></div>
</div>
</li>
<li><p class="first">Entries with byte size less than 10000:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">size</span><span class="p">:{</span><span class="o">*</span> <span class="n">TO</span> <span class="mi">10000</span><span class="p">}</span>
</pre></div>
</div>
</li>
<li><p class="first">Objects modified before 09:56:04 on 2012-01-03 UTC:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">datemodified</span><span class="p">:{</span><span class="o">*</span> <span class="n">TO</span> <span class="mi">2012</span><span class="o">-</span><span class="mi">01</span><span class="o">-</span><span class="mi">03</span><span class="n">T09</span><span class="p">:</span><span class="mi">56</span><span class="p">:</span><span class="mf">04.000</span><span class="n">Z</span><span class="p">}</span>
</pre></div>
</div>
</li>
<li><p class="first">Objects modified less than 10 minutes ago:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">datemodified</span><span class="p">:[</span><span class="n">NOW</span><span class="o">-</span><span class="mi">10</span><span class="n">MINUTE</span> <span class="n">TO</span> <span class="o">*</span><span class="p">]</span>
</pre></div>
</div>
</li>
<li><p class="first">Objects of a formatId equal to “format_a” and modified within one day:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">formatId</span><span class="p">:</span><span class="s2">"format_a"</span> <span class="n">AND</span> <span class="n">datemodified</span><span class="p">:[</span><span class="n">NOW</span><span class="o">-</span><span class="mi">1</span><span class="n">DAY</span> <span class="n">TO</span> <span class="o">*</span><span class="p">]</span>
</pre></div>
</div>
</li>
<li><p class="first">Metadata associated with data objects of relevance to Photosynthesis:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">photosynthesis</span> <span class="n">AND</span> <span class="n">documents</span><span class="p">:[</span><span class="o">*</span> <span class="n">TO</span> <span class="o">*</span><span class="p">]</span>
</pre></div>
</div>
</li>
</ol>
</div>
</div>
<div class="section" id="properties-of-the-index-derived-from-resource-maps">
<h2><a class="toc-backref" href="#id10">Properties of the Index Derived from Resource Maps</a><a class="headerlink" href="#properties-of-the-index-derived-from-resource-maps" title="Permalink to this headline">¶</a></h2>
<p>Table 2 provides a list of SOLR attributes that are populated by values obtained
by parsing resource map objects.</p>
<p><strong>Table 2.</strong> Elements derived from Resource Map documents. “Multi” fields may be
populated with more than a single value per document (PID) indexed.</p>
<table border="1" class="docutils" id="id2">
<caption><span class="caption-text">Resource</span><a class="headerlink" href="#id2" title="Permalink to this table">¶</a></caption>
<colgroup>
<col width="19%" />
<col width="13%" />
<col width="6%" />
<col width="63%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Attribute</th>
<th class="head">Type</th>
<th class="head">Multi?</th>
<th class="head">Content Origin</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.isDocumentedBy" title="SearchMetadata.isDocumentedBy"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.isDocumentedBy</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td> </td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.documents" title="SearchMetadata.documents"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.documents</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td> </td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.resourceMap" title="SearchMetadata.resourceMap"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.resourceMap</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td> </td>
</tr>
</tbody>
</table>
<div class="section" id="populating-object-relation-fields">
<h3><a class="toc-backref" href="#id11">Populating Object Relation Fields</a><a class="headerlink" href="#populating-object-relation-fields" title="Permalink to this headline">¶</a></h3>
<p>The fields <em>resourceMap</em>, <em>documents</em>, and <em>isDocumentedBy</em> contain
identifiers of other objects in the DataONE system related to the subject of
the current record. These relationships are recorded in OAI-ORE resource map
documents as described in the section <a class="reference internal" href="DataPackage.html"><span class="doc">Data Packaging</span></a>. Since the values for
these fields are contained in resource maps, it is necessary to build these
fields in progression as additional resource maps are synchronized with the
coordinating nodes.</p>
<p>For each object, a query is issued against the index to retrieve the list of
resource maps in which the object identifier is present, enabling population of
the <em>resourceMaps</em> field for the object. Each of those resource maps is examined
to obtain the list of identifiers for the <em>documents</em> field if the object is
science metadata, and the <em>isDocumentedBy</em> field if the object is data.</p>
<p><strong>Example Sequence for Index Population</strong></p>
<p>The following sequence steps through the generation of index entries for three
data packages, providing an example of how the index entries are updated
depending on relationships between the objects being added.</p>
<div class="section" id="adding-package-1">
<h4><a class="toc-backref" href="#id12">Adding Package 1</a><a class="headerlink" href="#adding-package-1" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><img src="../_images/graphviz-eb0f4153d7cc19d6740fe4a97933bbd23a8de960.png" alt="digraph RM1 {
graph [rankdir="LR", label="Package 1"];
A [shape=folder];
B [shape=note];
C [shape=oval];
A -> B;
A -> C;
}" />
</div></blockquote>
<p>A simple data package with a Resource Map <em>A</em> indicating that the metadata
document <em>B</em> and the data object <em>C</em> together form a data package, and that
<em>B</em> documents <em>C</em> and that <em>C</em> isDocumentedBy <em>B</em>.</p>
<p>Index entries after Package 1 is added.</p>
<blockquote>
<div><table border="1" class="docutils">
<colgroup>
<col width="25%" />
<col width="25%" />
<col width="25%" />
<col width="25%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">PID</th>
<th class="head">resourceMaps</th>
<th class="head">documents</th>
<th class="head">isDocumentedBy</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>A</td>
<td> </td>
<td> </td>
<td> </td>
</tr>
<tr class="row-odd"><td>B</td>
<td>A</td>
<td>C</td>
<td> </td>
</tr>
<tr class="row-even"><td>C</td>
<td>A</td>
<td> </td>
<td>B</td>
</tr>
</tbody>
</table>
</div></blockquote>
</div>
<div class="section" id="adding-package-2">
<h4><a class="toc-backref" href="#id13">Adding Package 2</a><a class="headerlink" href="#adding-package-2" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><img src="../_images/graphviz-1b5b55d83cb444ddaa89047237c30179d436c181.png" alt="digraph RM1 {
graph [rankdir="LR", label="Package 2"];
D [shape=folder];
B [shape=note];
E [shape=oval];
D -> B;
D -> E;
}" />
</div></blockquote>
<p>A simple data package with a Resource Map <em>D</em> indicating that the metadata
document <em>B</em> and the data object <em>E</em> together form a data package, and that
<em>B</em> documents <em>E</em> and that <em>E</em> isDocumentedBy <em>B</em>. Note that the metadata
document <em>B</em> is also used in Package 1.</p>
<p>Index entries after package 2 is added. New entries and changes to existing
are indicated in <strong>bold</strong>.</p>
<blockquote>
<div><table border="1" class="docutils">
<colgroup>
<col width="25%" />
<col width="25%" />
<col width="25%" />
<col width="25%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">PID</th>
<th class="head">resourceMaps</th>
<th class="head">documents</th>
<th class="head">isDocumentedBy</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>A</td>
<td> </td>
<td> </td>
<td> </td>
</tr>
<tr class="row-odd"><td>B</td>
<td>A, <strong>D</strong></td>
<td>C, <strong>E</strong></td>
<td> </td>
</tr>
<tr class="row-even"><td>C</td>
<td>A</td>
<td> </td>
<td>B</td>
</tr>
<tr class="row-odd"><td>D</td>
<td> </td>
<td> </td>
<td> </td>
</tr>
<tr class="row-even"><td>E</td>
<td><strong>D</strong></td>
<td> </td>
<td><strong>B</strong></td>
</tr>
</tbody>
</table>
</div></blockquote>
</div>
<div class="section" id="adding-package-3">
<h4><a class="toc-backref" href="#id14">Adding Package 3</a><a class="headerlink" href="#adding-package-3" title="Permalink to this headline">¶</a></h4>
<blockquote>
<div><img src="../_images/graphviz-d21cd89863becf69a6ec7eb1802e1fe52e9ad510.png" alt="digraph RM1 {
graph [rankdir="LR", label="Package 3"];
F [shape=folder];
G [shape=note];
D [shape=folder];
F -> G;
F -> D;
}" />
</div></blockquote>
<p>A data package that references another, already indexed data package
(represented by the Resource Map <em>D</em>) as its data object.</p>
<p>Index entries after package 3 is added. New entries and changes to existing
are indicated in <strong>bold</strong>.</p>
<blockquote>
<div><table border="1" class="docutils">
<colgroup>
<col width="25%" />
<col width="25%" />
<col width="25%" />
<col width="25%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">PID</th>
<th class="head">resourceMaps</th>
<th class="head">documents</th>
<th class="head">isDocumentedBy</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>A</td>
<td> </td>
<td> </td>
<td> </td>
</tr>
<tr class="row-odd"><td>B</td>
<td>A, D</td>
<td>C, E</td>
<td> </td>
</tr>
<tr class="row-even"><td>C</td>
<td>A</td>
<td> </td>
<td>B</td>
</tr>
<tr class="row-odd"><td>D</td>
<td><strong>F</strong></td>
<td> </td>
<td><strong>G</strong></td>
</tr>
<tr class="row-even"><td>E</td>
<td>D</td>
<td> </td>
<td>B</td>
</tr>
<tr class="row-odd"><td>F</td>
<td> </td>
<td> </td>
<td> </td>
</tr>
<tr class="row-even"><td>G</td>
<td><strong>F</strong></td>
<td><strong>D</strong></td>
<td> </td>
</tr>
</tbody>
</table>
</div></blockquote>
</div>
</div>
<div class="section" id="limitations-of-multi-valued-fields-in-solr">
<h3><a class="toc-backref" href="#id15">Limitations of Multi-Valued Fields in SOLR</a><a class="headerlink" href="#limitations-of-multi-valued-fields-in-solr" title="Permalink to this headline">¶</a></h3>
<p>Multi-valued fields in SOLR have an internal representation that can be
likened to a delimited concatenation of all the values for the field. The
fields have a configurable limit to the maximum field size, and this limit may
be encountered in the various entries such as the permission fields or object
relation fields where a potentially large number of subjects or identifiers
may be stored. Further research has indicated this problem is unlikely since
simply increasing the SOLR <em>maxFieldLength</em> configuration value will enable
larger field content, with examples in the wild of several thousand entries
equivalent to DataONE identifiers in a single field.</p>
</div>
</div>
<div class="section" id="values-extracted-from-science-metadata">
<h2><a class="toc-backref" href="#id16">Values Extracted from Science Metadata</a><a class="headerlink" href="#values-extracted-from-science-metadata" title="Permalink to this headline">¶</a></h2>
<p>Indexing the system metadata entries provides a mechanism for selection of
content using low level attributes of the objects such as the type, size and
relationships, however is not useful for locating content relevant to a
particular topic or purpose. The <a class="reference internal" href="../glossary.html#term-71"><span class="xref std std-term">science metadata</span></a> contains such
information and the index records associated with these documents contain
additional information described below.</p>
<p>The initial web user interface to DataONE utilizes the <a class="reference external" href="http://mercury.ornl.gov/">Mercury</a> system. This
in turn relies upon a SOLR index to support the search, faceting, and
sub-setting operations that are exposed through Mercury. The underlying SOLR
index is also exposed through as an API, so other clients (such as the file
system driver) can leverage the search capabilities thus provided.</p>
<p>The remainder of this document describes the search properties that are
extracted from the various formats and syntaxes of of science metadata that
are supported by the DataONE indexing system.</p>
<p><strong>Table 3.</strong> Index fields populated from science metadata documents. “Multi”
fields may be populated with more than a single value per document (PID)
indexed.</p>
<table border="1" class="docutils" id="id3">
<caption><span class="caption-text">Resource</span><a class="headerlink" href="#id3" title="Permalink to this table">¶</a></caption>
<colgroup>
<col width="14%" />
<col width="7%" />
<col width="7%" />
<col width="71%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Field</th>
<th class="head">Type</th>
<th class="head">Multi?</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.abstract" title="SearchMetadata.abstract"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.abstract</span></code></a></td>
<td>text</td>
<td>No</td>
<td>The full text of the abstract as provided in the science metadata document.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.author" title="SearchMetadata.author"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.author</span></code></a></td>
<td>string</td>
<td>No</td>
<td>Principle Investigator (PI) / Author as listed in the metadata document.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.authorLastName" title="SearchMetadata.authorLastName"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.authorLastName</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td>The LAST name(s) of the author(s)</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.beginDate" title="SearchMetadata.beginDate"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.beginDate</span></code></a></td>
<td>date</td>
<td>No</td>
<td>The starting date of the temporal range of the content described by the metadata document.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.class" title="SearchMetadata.class"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.class</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td>Taxonomic class name(s)</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.contactOrganization" title="SearchMetadata.contactOrganization"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.contactOrganization</span></code></a></td>
<td>string</td>
<td>No</td>
<td>Name of the organization to contact for more information about the dataset</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.decade" title="SearchMetadata.decade"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.decade</span></code></a></td>
<td>string</td>
<td>No</td>
<td>The latest decade that is covered by the dataset, expressed in the form “1999-2009”</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.eastBoundCoord" title="SearchMetadata.eastBoundCoord"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.eastBoundCoord</span></code></a></td>
<td>sfloat</td>
<td>No</td>
<td>Eastern most longitude of the spatial extent, in decimal degrees, WGS84</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.edition" title="SearchMetadata.edition"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.edition</span></code></a></td>
<td>text</td>
<td>No</td>
<td>The version or edition number of the item described.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.endDate" title="SearchMetadata.endDate"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.endDate</span></code></a></td>
<td>date</td>
<td>No</td>
<td>The ending date of the temporal range of the content described by the metadata document.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.family" title="SearchMetadata.family"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.family</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td>Taxonomic family name(s)</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.fileID" title="SearchMetadata.fileID"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.fileID</span></code></a></td>
<td>string</td>
<td>No</td>
<td>Contains the <a class="reference internal" href="../apis/CN_APIs.html#CNRead.resolve" title="CNRead.resolve"><code class="xref py py-func docutils literal"><span class="pre">CNRead.resolve()</span></code></a> URL for the object ONLY if the object is a science metadata object.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.fullText" title="SearchMetadata.fullText"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.fullText</span></code></a></td>
<td>text</td>
<td>No</td>
<td>Full text of the metadata record, used to support full text searches</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.gcmdKeyword" title="SearchMetadata.gcmdKeyword"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.gcmdKeyword</span></code></a></td>
<td>text</td>
<td>Yes</td>
<td>Keywords drawn from the GCMD controlled vocabulary</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.genus" title="SearchMetadata.genus"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.genus</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td>Taxonomic genus name(s)</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.geoform" title="SearchMetadata.geoform"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.geoform</span></code></a></td>
<td>string</td>
<td>No</td>
<td>The name of the general form in which the item’s geospatial data is presented</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.geohash_1" title="SearchMetadata.geohash_1"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.geohash_1</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td>An encoded string that represents the geographic coordinates of the centroid of a spatial extent. This can be used for searching and plotting.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.geohash_2" title="SearchMetadata.geohash_2"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.geohash_2</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td>An encoded string that represents the geographic coordinates of the centroid of a spatial extent. This can be used for searching and plotting.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.geohash_3" title="SearchMetadata.geohash_3"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.geohash_3</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td>An encoded string that represents the geographic coordinates of the centroid of a spatial extent. This can be used for searching and plotting.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.geohash_4" title="SearchMetadata.geohash_4"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.geohash_4</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td>An encoded string that represents the geographic coordinates of the centroid of a spatial extent. This can be used for searching and plotting.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.geohash_5" title="SearchMetadata.geohash_5"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.geohash_5</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td>An encoded string that represents the geographic coordinates of the centroid of a spatial extent. This can be used for searching and plotting.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.geohash_6" title="SearchMetadata.geohash_6"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.geohash_6</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td>An encoded string that represents the geographic coordinates of the centroid of a spatial extent. This can be used for searching and plotting.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.geohash_7" title="SearchMetadata.geohash_7"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.geohash_7</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td>An encoded string that represents the geographic coordinates of the centroid of a spatial extent. This can be used for searching and plotting.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.geohash_8" title="SearchMetadata.geohash_8"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.geohash_8</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td>An encoded string that represents the geographic coordinates of the centroid of a spatial extent. This can be used for searching and plotting.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.geohash_9" title="SearchMetadata.geohash_9"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.geohash_9</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td>An encoded string that represents the geographic coordinates of the centroid of a spatial extent. This can be used for searching and plotting.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.investigator" title="SearchMetadata.investigator"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.investigator</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td>Name of the investigator(s) responsible for developing the dataset and associated content.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.isSpatial" title="SearchMetadata.isSpatial"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.isSpatial</span></code></a></td>
<td>string</td>
<td>No</td>
<td>Set to “Y” for records that contain spatial information</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.keywords" title="SearchMetadata.keywords"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.keywords</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td>Keywords recorded in the science metadata document. These may be controlled by the generator of the metadata or by the metadata standard of the document, but are effectively uncontrolled within the DataONE context.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.kingdom" title="SearchMetadata.kingdom"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.kingdom</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td>Taxonomic kingdom(s)</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.LTERSite" title="SearchMetadata.LTERSite"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.LTERSite</span></code></a></td>
<td>string</td>
<td>No</td>
<td>Data provider organization identifier, for sources within the LTER network.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.noBoundingBox" title="SearchMetadata.noBoundingBox"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.noBoundingBox</span></code></a></td>
<td>string</td>
<td>No</td>
<td>Set to “Y” if there is no bounding box information available (i.e., the east, west, north, south most coordinates)</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.northBoundCoord" title="SearchMetadata.northBoundCoord"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.northBoundCoord</span></code></a></td>
<td>sfloat</td>
<td>No</td>
<td>Northern most latitude of the spatial extent, in decimal degrees, WGS84</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.ogcUrl" title="SearchMetadata.ogcUrl"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.ogcUrl</span></code></a></td>
<td>text</td>
<td>No</td>
<td>URL for Open Geospatial Web service if available.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.order" title="SearchMetadata.order"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.order</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td>Taxonomic order name(s)</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.origin" title="SearchMetadata.origin"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.origin</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td>Investigator or Investigator organization name.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.originator" title="SearchMetadata.originator"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.originator</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td>Investigator or Investigator organization name. Derived by normalizing origin.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.parameter" title="SearchMetadata.parameter"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.parameter</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td>A characteristic, or variable, that is measured or derived as part of data-collection activities.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.phylum" title="SearchMetadata.phylum"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.phylum</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td>Taxonomic phylum (or division) name(s)</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.placeKey" title="SearchMetadata.placeKey"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.placeKey</span></code></a></td>
<td>text</td>
<td>Yes</td>
<td>A place name keyword, assigned by the metadata creator. It is one keyword from the thesaurus named in <placekt></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.presentationCat" title="SearchMetadata.presentationCat"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.presentationCat</span></code></a></td>
<td>string</td>
<td>No</td>
<td>Type of data being preserved (maps, text, etc.)</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.project" title="SearchMetadata.project"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.project</span></code></a></td>
<td>string</td>
<td>No</td>
<td>The authorized name of a research effort for which data is collected. This name is often reduced to a convenient abbreviation or acronym. All investigators involved in a project should use a common, agreed-upon name.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.pubDate" title="SearchMetadata.pubDate"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.pubDate</span></code></a></td>
<td>date</td>
<td>No</td>
<td>Publication date for the dataset (this may or may not be coincident with when the content is added to DataONE).</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.purpose" title="SearchMetadata.purpose"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.purpose</span></code></a></td>
<td>text</td>
<td>No</td>
<td>The “Purpose” describes the “why” aspects of the data set (For example, why was the data set created?).</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.sensor" title="SearchMetadata.sensor"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.sensor</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td>Also called “instrument.” A device that is used for collecting data for a data set.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.site" title="SearchMetadata.site"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.site</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td>The name or description of the physical location where the data were collected</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.source" title="SearchMetadata.source"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.source</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td>Also called “platform.” The mechanism used to support the sensor or instrument that gathers data</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.southBoundCoord" title="SearchMetadata.southBoundCoord"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.southBoundCoord</span></code></a></td>
<td>sfloat</td>
<td>No</td>
<td>Southern most latitude of the spatial extent, in decimal degrees, WGS84</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.species" title="SearchMetadata.species"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.species</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td>Taxonomic species name(s)</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.term" title="SearchMetadata.term"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.term</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td>A secondary subject area within which parameters can be categorized. Approved terms include “agricultural chemicals” and “atmospheric chemistry,” among many others. When entering a term in the LandVal Metadata Editor, users should select a standard expression from the pick list for terms if at all possible.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.title" title="SearchMetadata.title"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.title</span></code></a></td>
<td>string</td>
<td>No</td>
<td>Title of the dataset as recorded in the science metadata.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.topic" title="SearchMetadata.topic"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.topic</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td>The most general subject area within which a parameter is categorized. Approved topics include “agriculture,” “atmosphere,” and “hydrosphere,” among others.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.webUrl" title="SearchMetadata.webUrl"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.webUrl</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td>Link to the investigator’s web-site.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.westBoundCoord" title="SearchMetadata.westBoundCoord"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.westBoundCoord</span></code></a></td>
<td>sfloat</td>
<td>No</td>
<td>Western most longitude of the spatial extent, in decimal degrees, WGS84</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.keyConcept" title="SearchMetadata.keyConcept"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.keyConcept</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td>Terms drawn from a controlled vocabulary of concepts that are applicable to the content described by the metadata document.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.namedLocation" title="SearchMetadata.namedLocation"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.namedLocation</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td>The name of the location(s) relevant to the content described by the metadata document.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#SearchMetadata.relatedOrganizations" title="SearchMetadata.relatedOrganizations"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.relatedOrganizations</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td>Organizations that played an indirect role in the development of the data set and metadata that should be cited or mentioned as contributing to the development of the data or metadata.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#SearchMetadata.scientificName" title="SearchMetadata.scientificName"><code class="xref py py-attr docutils literal"><span class="pre">SearchMetadata.scientificName</span></code></a></td>
<td>string</td>
<td>Yes</td>
<td>Taxonomic scientific name(s) at the most precise level available for the organisms of relevance to the dataset</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="date-representations-in-science-metadata-documents">
<h2><a class="toc-backref" href="#id17">Date Representations in Science Metadata Documents</a><a class="headerlink" href="#date-representations-in-science-metadata-documents" title="Permalink to this headline">¶</a></h2>
<p>The following are examples of date values extracted from FGDC, ISO-19115, and
EML science metadata documents currently in use. The literal value appearing in
the document and the interpreted date value are shown.</p>
<p>Examples of date values appearing in FGDC <em><pubdate></em>:</p>
<table border="1" class="docutils">
<colgroup>
<col width="63%" />
<col width="37%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Value</th>
<th class="head">Interpreted Value</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>Unknown</td>
<td>Null</td>
</tr>
<tr class="row-odd"><td>unknown</td>
<td>Null</td>
</tr>
<tr class="row-even"><td>Unpublished material</td>
<td>Null</td>
</tr>
<tr class="row-odd"><td>unpublished material</td>
<td>Null</td>
</tr>
<tr class="row-even"><td>1993</td>
<td>1993-01-01 00:00:00Z</td>
</tr>
<tr class="row-odd"><td>199607</td>
<td>1996-07-01 00:00:00Z</td>
</tr>
<tr class="row-even"><td>20000101</td>
<td>2000-01-01 00:00:00Z</td>
</tr>
<tr class="row-odd"><td>19981231</td>
<td>1998-12-31 00:00:00Z</td>
</tr>
<tr class="row-even"><td>196820405</td>
<td>1968-01-01 00:00:00Z</td>
</tr>
<tr class="row-odd"><td>1992 onwards</td>
<td>1992-01-01 00:00:00Z</td>
</tr>
<tr class="row-even"><td>1989 and 1990</td>
<td>1989-01-01 00:00:00Z</td>
</tr>
<tr class="row-odd"><td>varies</td>
<td>Null</td>
</tr>
<tr class="row-even"><td>Present</td>
<td>Null</td>
</tr>
<tr class="row-odd"><td>1995/1996</td>
<td>1995-01-01 00:00:00Z</td>
</tr>
<tr class="row-even"><td>1991-1992</td>
<td>1991-01-01 00:00:00Z</td>
</tr>
<tr class="row-odd"><td>variouis</td>
<td>Null</td>
</tr>
<tr class="row-even"><td>April 1999</td>
<td>1999-04-01 00:00:00Z</td>
</tr>
<tr class="row-odd"><td>1980 on</td>
<td>1980-01-01 00:00:00Z</td>
</tr>
<tr class="row-even"><td>2005-06-24</td>
<td>2005-06-24 00:00:00Z</td>
</tr>
<tr class="row-odd"><td>NA</td>
<td>Null</td>
</tr>
<tr class="row-even"><td>1990- [unpublished annual reports]</td>
<td>1990-01-01 00:00:00Z</td>
</tr>
<tr class="row-odd"><td>November, 1994</td>
<td>1994-11-01 00:00:00Z</td>
</tr>
</tbody>
</table>
<p>Examples of date values appearing in ISO-19115 <em><gco:Date></em>:</p>
<table border="1" class="docutils">
<colgroup>
<col width="63%" />
<col width="37%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Value</th>
<th class="head">Interpreted Value</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>1999</td>
<td>1999-01-01 00:00:00Z</td>
</tr>
<tr class="row-odd"><td>2010-03-03</td>
<td>2010-03-03 00:00:00Z</td>
</tr>
</tbody>
</table>
<p>Examples of date values appearing in EML <em><calendarDate></em>:</p>
<table border="1" class="docutils">
<colgroup>
<col width="63%" />
<col width="37%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Value</th>
<th class="head">Interpreted Value</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>2002-06-20</td>
<td>2002-06-20 00:00:00Z</td>
</tr>
<tr class="row-odd"><td>1998</td>
<td>1998-01-01 00:00:00Z</td>
</tr>
<tr class="row-even"><td>2004-02-13</td>
<td>2004-02-13 00:00:00Z</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="science-metadata-examples">
<h2><a class="toc-backref" href="#id18">Science metadata examples</a><a class="headerlink" href="#science-metadata-examples" title="Permalink to this headline">¶</a></h2>
<p>Examples for integration testing:</p>
<blockquote>
<div><a class="reference external" href="https://repository.dataone.org/software/cicore/trunk/d1_integration/src/test/resources/d1_testdocs/">https://repository.dataone.org/software/cicore/trunk/d1_integration/src/test/resources/d1_testdocs/</a></div></blockquote>
<p>FGDC:</p>
<blockquote>
<div><a class="reference external" href="http://mercury.ornl.gov/metadata/nbii/xml/nbii/">http://mercury.ornl.gov/metadata/nbii/xml/nbii/</a></div></blockquote>
<p>ISO 19115:</p>
<blockquote>
<div><a class="reference external" href="http://mercury.ornl.gov/metadata/ornldaac/xml/daac/iso/">http://mercury.ornl.gov/metadata/ornldaac/xml/daac/iso/</a></div></blockquote>
<p>EML:</p>
<blockquote>
<div><p>2.0.0: <a class="reference external" href="https://repository.dataone.org/software/cicore/trunk/d1_integration/src/test/resources/d1_testdocs/eml200/">https://repository.dataone.org/software/cicore/trunk/d1_integration/src/test/resources/d1_testdocs/eml200/</a></p>
<p>2.0.1: <a class="reference external" href="https://repository.dataone.org/software/cicore/trunk/d1_integration/src/test/resources/d1_testdocs/eml201/">https://repository.dataone.org/software/cicore/trunk/d1_integration/src/test/resources/d1_testdocs/eml201/</a></p>
<p>2.1.0: <a class="reference external" href="https://repository.dataone.org/software/cicore/trunk/d1_integration/src/test/resources/d1_testdocs/eml210/">https://repository.dataone.org/software/cicore/trunk/d1_integration/src/test/resources/d1_testdocs/eml210/</a></p>
</div></blockquote>
</div>
<div class="section" id="standard-specific-metadata-extraction-notes">
<h2><a class="toc-backref" href="#id19">Standard Specific Metadata Extraction Notes</a><a class="headerlink" href="#standard-specific-metadata-extraction-notes" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="SearchMetadata_eml.html">Search Metadata Elements Extracted from EML</a></li>
<li class="toctree-l1"><a class="reference internal" href="SearchMetadata_fgdc.html">Search Metadata Elements Extracted from FGDC</a></li>
<li class="toctree-l1"><a class="reference internal" href="SearchMetadata_dryad.html">Search Metadata Elements Extracted from Dryad</a></li>
</ul>
</div>
</div>
<div class="section" id="attribute-descriptions-and-notes">
<h2><a class="toc-backref" href="#id20">Attribute Descriptions and Notes</a><a class="headerlink" href="#attribute-descriptions-and-notes" title="Permalink to this headline">¶</a></h2>
<p>A list of all fields in search index, their origin and brief description. Source
column indicates which DataONE content the values are retrieved from: Y = System
Metadata, S = Science Metadata, R = Resource Map, and C = copied internally by
the search index.</p>
<table border="1" class="docutils" id="id4">
<caption><span class="caption-text">.</span><a class="headerlink" href="#id4" title="Permalink to this table">¶</a></caption>
<colgroup>
<col width="8%" />
<col width="8%" />
<col width="8%" />
<col width="77%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Index Field</th>
<th class="head">Multi?</th>
<th class="head">Source</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.abstract">
<code class="descclassname">SearchMetadata.</code><code class="descname">abstract</code><a class="headerlink" href="#SearchMetadata.abstract" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>S</td>
<td>The full text of the abstract as provided in the science metadata document.</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.author">
<code class="descclassname">SearchMetadata.</code><code class="descname">author</code><a class="headerlink" href="#SearchMetadata.author" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>S</td>
<td>Principle Investigator (PI) / Author as listed in the metadata document.</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.authoritativeMN">
<code class="descclassname">SearchMetadata.</code><code class="descname">authoritativeMN</code><a class="headerlink" href="#SearchMetadata.authoritativeMN" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>Y</td>
<td>The node Id of the authoritative Member Node for the object.</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.authorLastName">
<code class="descclassname">SearchMetadata.</code><code class="descname">authorLastName</code><a class="headerlink" href="#SearchMetadata.authorLastName" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>The LAST name(s) of the author(s)</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.beginDate">
<code class="descclassname">SearchMetadata.</code><code class="descname">beginDate</code><a class="headerlink" href="#SearchMetadata.beginDate" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>S</td>
<td>The starting date of the temporal range of the content described by the metadata document.</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.blockedReplicationMN">
<code class="descclassname">SearchMetadata.</code><code class="descname">blockedReplicationMN</code><a class="headerlink" href="#SearchMetadata.blockedReplicationMN" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>Y</td>
<td>A multi-valued field that contains the node Ids of member nodes that are blocked from holding replicas of this object.</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.changePermission">
<code class="descclassname">SearchMetadata.</code><code class="descname">changePermission</code><a class="headerlink" href="#SearchMetadata.changePermission" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>Y</td>
<td>List of subjects (groups and individuals) that have change permission on PID.</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.checksum">
<code class="descclassname">SearchMetadata.</code><code class="descname">checksum</code><a class="headerlink" href="#SearchMetadata.checksum" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>Y</td>
<td>The checksum for the object</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.checksumAlgorithm">
<code class="descclassname">SearchMetadata.</code><code class="descname">checksumAlgorithm</code><a class="headerlink" href="#SearchMetadata.checksumAlgorithm" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>Y</td>
<td>Algorithm used for generating the object checksum</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.class">
<code class="descclassname">SearchMetadata.</code><code class="descname">class</code><a class="headerlink" href="#SearchMetadata.class" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>Taxonomic class name(s)</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.contactOrganization">
<code class="descclassname">SearchMetadata.</code><code class="descname">contactOrganization</code><a class="headerlink" href="#SearchMetadata.contactOrganization" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>S</td>
<td>Name of the organization to contact for more information about the dataset</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.contactOrganizationText">
<code class="descclassname">SearchMetadata.</code><code class="descname">contactOrganizationText</code><a class="headerlink" href="#SearchMetadata.contactOrganizationText" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>C</td>
<td>Copy from <a class="reference internal" href="#SearchMetadata.contactOrganization" title="SearchMetadata.contactOrganization"><code class="xref py py-attr docutils literal"><span class="pre">contactOrganization</span></code></a></td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.datasource">
<code class="descclassname">SearchMetadata.</code><code class="descname">datasource</code><a class="headerlink" href="#SearchMetadata.datasource" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>Y</td>
<td>The node Id of the member node that originally contributed the content.</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.dataUrl">
<code class="descclassname">SearchMetadata.</code><code class="descname">dataUrl</code><a class="headerlink" href="#SearchMetadata.dataUrl" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>Y</td>
<td>The URL that can be used to resolve the location of the object given its PID.</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.dateModified">
<code class="descclassname">SearchMetadata.</code><code class="descname">dateModified</code><a class="headerlink" href="#SearchMetadata.dateModified" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>Y</td>
<td>The date and time when the object system metadata was last updated.</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.dateUploaded">
<code class="descclassname">SearchMetadata.</code><code class="descname">dateUploaded</code><a class="headerlink" href="#SearchMetadata.dateUploaded" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>Y</td>
<td>The date and time when the object was uploaded to the Member Node.</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.decade">
<code class="descclassname">SearchMetadata.</code><code class="descname">decade</code><a class="headerlink" href="#SearchMetadata.decade" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>S</td>
<td>The latest decade that is covered by the dataset, expressed in the form “1999-2009”</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.documents">
<code class="descclassname">SearchMetadata.</code><code class="descname">documents</code><a class="headerlink" href="#SearchMetadata.documents" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>R</td>
<td>Lists all PIDs that this object describes. Obtained by parsing all resource maps in which this object is referenced. Not set for data or resource map objects.</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.eastBoundCoord">
<code class="descclassname">SearchMetadata.</code><code class="descname">eastBoundCoord</code><a class="headerlink" href="#SearchMetadata.eastBoundCoord" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>S</td>
<td>Eastern most longitude of the spatial extent, in decimal degrees, WGS84</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.edition">
<code class="descclassname">SearchMetadata.</code><code class="descname">edition</code><a class="headerlink" href="#SearchMetadata.edition" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>S</td>
<td>The version or edition number of the item described.</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.endDate">
<code class="descclassname">SearchMetadata.</code><code class="descname">endDate</code><a class="headerlink" href="#SearchMetadata.endDate" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>S</td>
<td>The ending date of the temporal range of the content described by the metadata document.</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.family">
<code class="descclassname">SearchMetadata.</code><code class="descname">family</code><a class="headerlink" href="#SearchMetadata.family" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>Taxonomic family name(s)</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.fileID">
<code class="descclassname">SearchMetadata.</code><code class="descname">fileID</code><a class="headerlink" href="#SearchMetadata.fileID" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>S</td>
<td>Contains the <a class="reference internal" href="../apis/CN_APIs.html#CNRead.resolve" title="CNRead.resolve"><code class="xref py py-func docutils literal"><span class="pre">CNRead.resolve()</span></code></a> URL for the object ONLY if the object is a science metadata object.</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.formatId">
<code class="descclassname">SearchMetadata.</code><code class="descname">formatId</code><a class="headerlink" href="#SearchMetadata.formatId" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>Y</td>
<td>The format identifier indicating the type of content this record refers to.</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.fullText">
<code class="descclassname">SearchMetadata.</code><code class="descname">fullText</code><a class="headerlink" href="#SearchMetadata.fullText" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>S</td>
<td>Full text of the metadata record, used to support full text searches</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.gcmdKeyword">
<code class="descclassname">SearchMetadata.</code><code class="descname">gcmdKeyword</code><a class="headerlink" href="#SearchMetadata.gcmdKeyword" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>Keywords drawn from the GCMD controlled vocabulary</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.genus">
<code class="descclassname">SearchMetadata.</code><code class="descname">genus</code><a class="headerlink" href="#SearchMetadata.genus" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>Taxonomic genus name(s)</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.geoform">
<code class="descclassname">SearchMetadata.</code><code class="descname">geoform</code><a class="headerlink" href="#SearchMetadata.geoform" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>S</td>
<td>The name of the general form in which the item’s geospatial data is presented</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.geohash_1">
<code class="descclassname">SearchMetadata.</code><code class="descname">geohash_1</code><a class="headerlink" href="#SearchMetadata.geohash_1" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>An encoded string that represents the geographic coordinates of the centroid of a spatial extent. This can be used for searching and plotting.</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.geohash_2">
<code class="descclassname">SearchMetadata.</code><code class="descname">geohash_2</code><a class="headerlink" href="#SearchMetadata.geohash_2" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>An encoded string that represents the geographic coordinates of the centroid of a spatial extent. This can be used for searching and plotting.</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.geohash_3">
<code class="descclassname">SearchMetadata.</code><code class="descname">geohash_3</code><a class="headerlink" href="#SearchMetadata.geohash_3" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>An encoded string that represents the geographic coordinates of the centroid of a spatial extent. This can be used for searching and plotting.</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.geohash_4">
<code class="descclassname">SearchMetadata.</code><code class="descname">geohash_4</code><a class="headerlink" href="#SearchMetadata.geohash_4" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>An encoded string that represents the geographic coordinates of the centroid of a spatial extent. This can be used for searching and plotting.</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.geohash_5">
<code class="descclassname">SearchMetadata.</code><code class="descname">geohash_5</code><a class="headerlink" href="#SearchMetadata.geohash_5" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>An encoded string that represents the geographic coordinates of the centroid of a spatial extent. This can be used for searching and plotting.</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.geohash_6">
<code class="descclassname">SearchMetadata.</code><code class="descname">geohash_6</code><a class="headerlink" href="#SearchMetadata.geohash_6" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>An encoded string that represents the geographic coordinates of the centroid of a spatial extent. This can be used for searching and plotting.</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.geohash_7">
<code class="descclassname">SearchMetadata.</code><code class="descname">geohash_7</code><a class="headerlink" href="#SearchMetadata.geohash_7" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>An encoded string that represents the geographic coordinates of the centroid of a spatial extent. This can be used for searching and plotting.</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.geohash_8">
<code class="descclassname">SearchMetadata.</code><code class="descname">geohash_8</code><a class="headerlink" href="#SearchMetadata.geohash_8" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>An encoded string that represents the geographic coordinates of the centroid of a spatial extent. This can be used for searching and plotting.</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.geohash_9">
<code class="descclassname">SearchMetadata.</code><code class="descname">geohash_9</code><a class="headerlink" href="#SearchMetadata.geohash_9" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>An encoded string that represents the geographic coordinates of the centroid of a spatial extent. This can be used for searching and plotting.</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.id">
<code class="descclassname">SearchMetadata.</code><code class="descname">id</code><a class="headerlink" href="#SearchMetadata.id" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>Y</td>
<td>The identifier of the object being indexed.</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.identifier">
<code class="descclassname">SearchMetadata.</code><code class="descname">identifier</code><a class="headerlink" href="#SearchMetadata.identifier" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>C</td>
<td>Copy from <a class="reference internal" href="#SearchMetadata.id" title="SearchMetadata.id"><code class="xref py py-attr docutils literal"><span class="pre">id</span></code></a></td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.investigator">
<code class="descclassname">SearchMetadata.</code><code class="descname">investigator</code><a class="headerlink" href="#SearchMetadata.investigator" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>Name of the investigator(s) responsible for developing the dataset and associated content.</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.investigatorText">
<code class="descclassname">SearchMetadata.</code><code class="descname">investigatorText</code><a class="headerlink" href="#SearchMetadata.investigatorText" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>C</td>
<td>Copy from <a class="reference internal" href="#SearchMetadata.investigator" title="SearchMetadata.investigator"><code class="xref py py-attr docutils literal"><span class="pre">investigator</span></code></a></td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.isDocumentedBy">
<code class="descclassname">SearchMetadata.</code><code class="descname">isDocumentedBy</code><a class="headerlink" href="#SearchMetadata.isDocumentedBy" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>R</td>
<td>Lists all PIDs that describe this object. Obtained by parsing all resource maps in which this object is referenced.</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.isPublic">
<code class="descclassname">SearchMetadata.</code><code class="descname">isPublic</code><a class="headerlink" href="#SearchMetadata.isPublic" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>Y</td>
<td>Set to True if the DataONE <a class="reference internal" href="../glossary.html#term-54"><span class="xref std std-term">public user</span></a> is present in the list of subjects with readPermission on PID.</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.isSpatial">
<code class="descclassname">SearchMetadata.</code><code class="descname">isSpatial</code><a class="headerlink" href="#SearchMetadata.isSpatial" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>S</td>
<td>Set to “Y” for records that contain spatial information</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.keyConcept">
<code class="descclassname">SearchMetadata.</code><code class="descname">keyConcept</code><a class="headerlink" href="#SearchMetadata.keyConcept" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>Terms drawn from a controlled vocabulary of concepts that are applicable to the content described by the metadata document.</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.keywords">
<code class="descclassname">SearchMetadata.</code><code class="descname">keywords</code><a class="headerlink" href="#SearchMetadata.keywords" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>Keywords recorded in the science metadata document. These may be controlled by the generator of the metadata or by the metadata standard of the document, but are effectively uncontrolled within the DataONE context.</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.keywordsText">
<code class="descclassname">SearchMetadata.</code><code class="descname">keywordsText</code><a class="headerlink" href="#SearchMetadata.keywordsText" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>C</td>
<td>Copy from <a class="reference internal" href="#SearchMetadata.keywords" title="SearchMetadata.keywords"><code class="xref py py-attr docutils literal"><span class="pre">keywords</span></code></a></td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.kingdom">
<code class="descclassname">SearchMetadata.</code><code class="descname">kingdom</code><a class="headerlink" href="#SearchMetadata.kingdom" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>Taxonomic kingdom(s)</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.LTERSite">
<code class="descclassname">SearchMetadata.</code><code class="descname">LTERSite</code><a class="headerlink" href="#SearchMetadata.LTERSite" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>S</td>
<td>Data provider organization identifier, for sources within the LTER network.</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.namedLocation">
<code class="descclassname">SearchMetadata.</code><code class="descname">namedLocation</code><a class="headerlink" href="#SearchMetadata.namedLocation" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>The name of the location(s) relevant to the content described by the metadata document.</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.noBoundingBox">
<code class="descclassname">SearchMetadata.</code><code class="descname">noBoundingBox</code><a class="headerlink" href="#SearchMetadata.noBoundingBox" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>S</td>
<td>Set to “Y” if there is no bounding box information available (i.e., the east, west, north, south most coordinates)</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.northBoundCoord">
<code class="descclassname">SearchMetadata.</code><code class="descname">northBoundCoord</code><a class="headerlink" href="#SearchMetadata.northBoundCoord" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>S</td>
<td>Northern most latitude of the spatial extent, in decimal degrees, WGS84</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.numberReplicas">
<code class="descclassname">SearchMetadata.</code><code class="descname">numberReplicas</code><a class="headerlink" href="#SearchMetadata.numberReplicas" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>Y</td>
<td>Requested number of replicas for the object</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.obsoletes">
<code class="descclassname">SearchMetadata.</code><code class="descname">obsoletes</code><a class="headerlink" href="#SearchMetadata.obsoletes" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>Y</td>
<td>If set, indicates the object that this record obsoletes.</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.ogcUrl">
<code class="descclassname">SearchMetadata.</code><code class="descname">ogcUrl</code><a class="headerlink" href="#SearchMetadata.ogcUrl" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>S</td>
<td>URL for Open Geospatial Web service if available.</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.order">
<code class="descclassname">SearchMetadata.</code><code class="descname">order</code><a class="headerlink" href="#SearchMetadata.order" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>Taxonomic order name(s)</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.origin">
<code class="descclassname">SearchMetadata.</code><code class="descname">origin</code><a class="headerlink" href="#SearchMetadata.origin" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>Investigator or Investigator organization name.</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.originator">
<code class="descclassname">SearchMetadata.</code><code class="descname">originator</code><a class="headerlink" href="#SearchMetadata.originator" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>Investigator or Investigator organization name. Derived by normalizing origin.</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.originatorText">
<code class="descclassname">SearchMetadata.</code><code class="descname">originatorText</code><a class="headerlink" href="#SearchMetadata.originatorText" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>C</td>
<td>Copy from <a class="reference internal" href="#SearchMetadata.originator" title="SearchMetadata.originator"><code class="xref py py-attr docutils literal"><span class="pre">originator</span></code></a></td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.originText">
<code class="descclassname">SearchMetadata.</code><code class="descname">originText</code><a class="headerlink" href="#SearchMetadata.originText" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>C</td>
<td>Copy from <a class="reference internal" href="#SearchMetadata.origin" title="SearchMetadata.origin"><code class="xref py py-attr docutils literal"><span class="pre">origin</span></code></a></td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.parameter">
<code class="descclassname">SearchMetadata.</code><code class="descname">parameter</code><a class="headerlink" href="#SearchMetadata.parameter" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>A characteristic, or variable, that is measured or derived as part of data-collection activities.</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.parameterText">
<code class="descclassname">SearchMetadata.</code><code class="descname">parameterText</code><a class="headerlink" href="#SearchMetadata.parameterText" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>C</td>
<td>Copy from <a class="reference internal" href="#SearchMetadata.parameter" title="SearchMetadata.parameter"><code class="xref py py-attr docutils literal"><span class="pre">parameter</span></code></a></td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.phylum">
<code class="descclassname">SearchMetadata.</code><code class="descname">phylum</code><a class="headerlink" href="#SearchMetadata.phylum" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>Taxonomic phylum (or division) name(s)</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.placeKey">
<code class="descclassname">SearchMetadata.</code><code class="descname">placeKey</code><a class="headerlink" href="#SearchMetadata.placeKey" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>A place name keyword, assigned by the metadata creator. It is one keyword from the thesaurus named in <placekt></td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.preferredReplicationMN">
<code class="descclassname">SearchMetadata.</code><code class="descname">preferredReplicationMN</code><a class="headerlink" href="#SearchMetadata.preferredReplicationMN" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>Y</td>
<td>A list of member node identifiers that are preferred replication targets for this object.</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.presentationCat">
<code class="descclassname">SearchMetadata.</code><code class="descname">presentationCat</code><a class="headerlink" href="#SearchMetadata.presentationCat" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>S</td>
<td>Type of data being preserved (maps, text, etc.)</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.project">
<code class="descclassname">SearchMetadata.</code><code class="descname">project</code><a class="headerlink" href="#SearchMetadata.project" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>S</td>
<td>The authorized name of a research effort for which data is collected. This name is often reduced to a convenient abbreviation or acronym. All investigators involved in a project should use a common, agreed-upon name.</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.projectText">
<code class="descclassname">SearchMetadata.</code><code class="descname">projectText</code><a class="headerlink" href="#SearchMetadata.projectText" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>C</td>
<td>Copy from <a class="reference internal" href="#SearchMetadata.project" title="SearchMetadata.project"><code class="xref py py-attr docutils literal"><span class="pre">project</span></code></a></td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.pubDate">
<code class="descclassname">SearchMetadata.</code><code class="descname">pubDate</code><a class="headerlink" href="#SearchMetadata.pubDate" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>S</td>
<td>Publication date for the dataset (this may or may not be coincident with when the content is added to DataONE).</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.purpose">
<code class="descclassname">SearchMetadata.</code><code class="descname">purpose</code><a class="headerlink" href="#SearchMetadata.purpose" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>S</td>
<td>The “Purpose” describes the “why” aspects of the data set (For example, why was the data set created?).</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.readPermission">
<code class="descclassname">SearchMetadata.</code><code class="descname">readPermission</code><a class="headerlink" href="#SearchMetadata.readPermission" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>Y</td>
<td>List of subjects (groups and individuals) that have read permission on PID.</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.relatedOrganizations">
<code class="descclassname">SearchMetadata.</code><code class="descname">relatedOrganizations</code><a class="headerlink" href="#SearchMetadata.relatedOrganizations" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>Organizations that played an indirect role in the development of the data set and metadata that should be cited or mentioned as contributing to the development of the data or metadata.</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.replicaMN">
<code class="descclassname">SearchMetadata.</code><code class="descname">replicaMN</code><a class="headerlink" href="#SearchMetadata.replicaMN" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>Y</td>
<td>One or more node Ids holding copies of the object.</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.replicationAllowed">
<code class="descclassname">SearchMetadata.</code><code class="descname">replicationAllowed</code><a class="headerlink" href="#SearchMetadata.replicationAllowed" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>Y</td>
<td>True if this object can be replicated.</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.resourceMap">
<code class="descclassname">SearchMetadata.</code><code class="descname">resourceMap</code><a class="headerlink" href="#SearchMetadata.resourceMap" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>R</td>
<td>List of resource map PIDs that reference this PID.</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.rightsHolder">
<code class="descclassname">SearchMetadata.</code><code class="descname">rightsHolder</code><a class="headerlink" href="#SearchMetadata.rightsHolder" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>Y</td>
<td>The <a class="reference internal" href="../glossary.html#term-74"><span class="xref std std-term">Subject</span></a> that acts as the rights holder for the object.</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.scientificName">
<code class="descclassname">SearchMetadata.</code><code class="descname">scientificName</code><a class="headerlink" href="#SearchMetadata.scientificName" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>Taxonomic scientific name(s) at the most precise level available for the organisms of relevance to the dataset</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.sensor">
<code class="descclassname">SearchMetadata.</code><code class="descname">sensor</code><a class="headerlink" href="#SearchMetadata.sensor" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>Also called “instrument.” A device that is used for collecting data for a data set.</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.sensorText">
<code class="descclassname">SearchMetadata.</code><code class="descname">sensorText</code><a class="headerlink" href="#SearchMetadata.sensorText" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>C</td>
<td>Copy from <a class="reference internal" href="#SearchMetadata.sensor" title="SearchMetadata.sensor"><code class="xref py py-attr docutils literal"><span class="pre">sensor</span></code></a></td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.site">
<code class="descclassname">SearchMetadata.</code><code class="descname">site</code><a class="headerlink" href="#SearchMetadata.site" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>The name or description of the physical location where the data were collected</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.siteText">
<code class="descclassname">SearchMetadata.</code><code class="descname">siteText</code><a class="headerlink" href="#SearchMetadata.siteText" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>C</td>
<td>Copy from <a class="reference internal" href="#SearchMetadata.site" title="SearchMetadata.site"><code class="xref py py-attr docutils literal"><span class="pre">site</span></code></a></td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.size">
<code class="descclassname">SearchMetadata.</code><code class="descname">size</code><a class="headerlink" href="#SearchMetadata.size" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>Y</td>
<td>The size of the object, in bytes.</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.sku">
<code class="descclassname">SearchMetadata.</code><code class="descname">sku</code><a class="headerlink" href="#SearchMetadata.sku" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>C</td>
<td>Copy from <a class="reference internal" href="#SearchMetadata.id" title="SearchMetadata.id"><code class="xref py py-attr docutils literal"><span class="pre">id</span></code></a></td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.source">
<code class="descclassname">SearchMetadata.</code><code class="descname">source</code><a class="headerlink" href="#SearchMetadata.source" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>Also called “platform.” The mechanism used to support the sensor or instrument that gathers data</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.sourceText">
<code class="descclassname">SearchMetadata.</code><code class="descname">sourceText</code><a class="headerlink" href="#SearchMetadata.sourceText" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>C</td>
<td>Copy from <a class="reference internal" href="#SearchMetadata.source" title="SearchMetadata.source"><code class="xref py py-attr docutils literal"><span class="pre">source</span></code></a></td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.southBoundCoord">
<code class="descclassname">SearchMetadata.</code><code class="descname">southBoundCoord</code><a class="headerlink" href="#SearchMetadata.southBoundCoord" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>S</td>
<td>Southern most latitude of the spatial extent, in decimal degrees, WGS84</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.species">
<code class="descclassname">SearchMetadata.</code><code class="descname">species</code><a class="headerlink" href="#SearchMetadata.species" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>Taxonomic species name(s)</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.submitter">
<code class="descclassname">SearchMetadata.</code><code class="descname">submitter</code><a class="headerlink" href="#SearchMetadata.submitter" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>Y</td>
<td>The <a class="reference internal" href="../glossary.html#term-74"><span class="xref std std-term">Subject</span></a> name of the original submitter of the content to DataONE.</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.term">
<code class="descclassname">SearchMetadata.</code><code class="descname">term</code><a class="headerlink" href="#SearchMetadata.term" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>A secondary subject area within which parameters can be categorized. Approved terms include “agricultural chemicals” and “atmospheric chemistry,” among many others. When entering a term in the LandVal Metadata Editor, users should select a standard expression from the pick list for terms if at all possible.</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.termText">
<code class="descclassname">SearchMetadata.</code><code class="descname">termText</code><a class="headerlink" href="#SearchMetadata.termText" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>C</td>
<td>Copy from <a class="reference internal" href="#SearchMetadata.term" title="SearchMetadata.term"><code class="xref py py-attr docutils literal"><span class="pre">term</span></code></a></td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.text">
<code class="descclassname">SearchMetadata.</code><code class="descname">text</code><a class="headerlink" href="#SearchMetadata.text" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>C</td>
<td>contactOrganization, datasource, decade, features, fileID, fullText, gcmdKeyword, geoform, id, includes, investigator, keywords, LTERSite, manu, name, origin, originator, parameter, placeKey, presentationCat, project, purpose, sensor, site, source, term, title, topic</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.title">
<code class="descclassname">SearchMetadata.</code><code class="descname">title</code><a class="headerlink" href="#SearchMetadata.title" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>S</td>
<td>Title of the dataset as recorded in the science metadata.</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.titlestr">
<code class="descclassname">SearchMetadata.</code><code class="descname">titlestr</code><a class="headerlink" href="#SearchMetadata.titlestr" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>C</td>
<td>Copy from <a class="reference internal" href="#SearchMetadata.title" title="SearchMetadata.title"><code class="xref py py-attr docutils literal"><span class="pre">title</span></code></a></td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.titleText">
<code class="descclassname">SearchMetadata.</code><code class="descname">titleText</code><a class="headerlink" href="#SearchMetadata.titleText" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>C</td>
<td>Copy from <a class="reference internal" href="#SearchMetadata.title" title="SearchMetadata.title"><code class="xref py py-attr docutils literal"><span class="pre">title</span></code></a></td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.topic">
<code class="descclassname">SearchMetadata.</code><code class="descname">topic</code><a class="headerlink" href="#SearchMetadata.topic" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>The most general subject area within which a parameter is categorized. Approved topics include “agriculture,” “atmosphere,” and “hydrosphere,” among others.</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.topicText">
<code class="descclassname">SearchMetadata.</code><code class="descname">topicText</code><a class="headerlink" href="#SearchMetadata.topicText" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>C</td>
<td>Copy from <a class="reference internal" href="#SearchMetadata.topic" title="SearchMetadata.topic"><code class="xref py py-attr docutils literal"><span class="pre">topic</span></code></a></td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.updateDate">
<code class="descclassname">SearchMetadata.</code><code class="descname">updateDate</code><a class="headerlink" href="#SearchMetadata.updateDate" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>C</td>
<td>Copy from <code class="xref py py-attr docutils literal"><span class="pre">dateuploaded</span></code></td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.webUrl">
<code class="descclassname">SearchMetadata.</code><code class="descname">webUrl</code><a class="headerlink" href="#SearchMetadata.webUrl" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>S</td>
<td>Link to the investigator’s web-site.</td>
</tr>
<tr class="row-even"><td><dl class="first last attribute">
<dt id="SearchMetadata.westBoundCoord">
<code class="descclassname">SearchMetadata.</code><code class="descname">westBoundCoord</code><a class="headerlink" href="#SearchMetadata.westBoundCoord" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>No</td>
<td>S</td>
<td>Western most longitude of the spatial extent, in decimal degrees, WGS84</td>
</tr>
<tr class="row-odd"><td><dl class="first last attribute">
<dt id="SearchMetadata.writePermission">
<code class="descclassname">SearchMetadata.</code><code class="descname">writePermission</code><a class="headerlink" href="#SearchMetadata.writePermission" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</td>
<td>Yes</td>
<td>Y</td>
<td>List of subjects (groups and individuals) that have write permission on PID.</td>
</tr>
</tbody>
</table>
</div>
<hr class="docutils" />
<div class="section" id="creating-citations-from-index-fields">
<h2><a class="toc-backref" href="#id21">Creating Citations from Index Fields</a><a class="headerlink" href="#creating-citations-from-index-fields" title="Permalink to this headline">¶</a></h2>
<p><strong>Table 3.</strong> Cross reference of index fields and elements useful in citation
best practices as exemplified in the <a class="reference external" href="http://wiki.esipfed.org/index.php/Interagency_Data_Stewardship/Citations/provider_guidelines">interagency data stewardship</a> wiki page
of ESIP. * = Mandatory (if applicable). COinS tags provide a mechanism of
embedding <a class="reference external" href="http://www.niso.org/kst/reports/standards/kfile_download?id%3Austring%3Aiso-8859-1=Z39-88-2004.pdf&pt=RkGKiXzW643YeUaYUqZ1BFwDhIG4-24RJbcZBWg8uE4vWdpZsJDs4RjLz0t90_d5_ymGsj_IKVaGZww13HuDlZQ8NBt1sTxP_v4iiGqH7rSaAeVDnMfeKJrrJ_JSEGPB">Z39.88-2004</a> elements in HTML for consumption by citation manager
tools.</p>
<table border="1" class="docutils">
<colgroup>
<col width="20%" />
<col width="20%" />
<col width="20%" />
<col width="20%" />
<col width="20%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Citation Element</th>
<th class="head">FGDC CSDGM field</th>
<th class="head">DataCite Metadata Scheme ID and Property</th>
<th class="head">DataONE Index Field</th>
<th class="head"><a class="reference external" href="http://ocoins.info/">COinS</a> Tag</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>Author or Creator*</td>
<td>idinfo > citation > citeinfo > “origin”</td>
<td>2 Creator*</td>
<td><a class="reference internal" href="#SearchMetadata.author" title="SearchMetadata.author"><code class="xref py py-attr docutils literal"><span class="pre">author</span></code></a></td>
<td>rft.creator</td>
</tr>
<tr class="row-odd"><td>Release Date*</td>
<td>idinfo > citation > citeinfo > “pubdate” and sometimes “othercit”</td>
<td>5 PublicationYear*</td>
<td><code class="xref py py-attr docutils literal"><span class="pre">datePublished</span></code></td>
<td>rft.date</td>
</tr>
<tr class="row-even"><td>Title*</td>
<td>idinfo > citation > citeinfo > “title” and possibly “edition”</td>
<td>3 Title*</td>
<td><a class="reference internal" href="#SearchMetadata.title" title="SearchMetadata.title"><code class="xref py py-attr docutils literal"><span class="pre">title</span></code></a></td>
<td>rft.title</td>
</tr>
<tr class="row-odd"><td>Version*</td>
<td> </td>
<td>15 Version</td>
<td>See notes below.</td>
<td> </td>
</tr>
<tr class="row-even"><td>Archive and/or Distributor*</td>
<td>idinfo > citation > citeinfo > “publish”</td>
<td>4 Publisher*</td>
<td>See notes below.</td>
<td>rft.publisher</td>
</tr>
<tr class="row-odd"><td>Locator, Identifier, or Distribution Medium*</td>
<td>idinfo > citation > citeinfo > “othercit” or “onlink”</td>
<td>1 Identifier*</td>
<td><code class="xref py py-attr docutils literal"><span class="pre">pid</span></code></td>
<td>rft.identifier</td>
</tr>
<tr class="row-even"><td>Access Date and Time*</td>
<td>not applicable</td>
<td>8 Date</td>
<td>perhaps <a class="reference internal" href="#SearchMetadata.dateUploaded" title="SearchMetadata.dateUploaded"><code class="xref py py-attr docutils literal"><span class="pre">dateUploaded</span></code></a></td>
<td> </td>
</tr>
<tr class="row-odd"><td>Subset Used</td>
<td>not applicable</td>
<td>12 RelatedIdentifier DataCite recommends obtaining an identifier for
any subset that needs to be cited as well as an identifier for the
larger whole.</td>
<td>perhaps a reference to the resource map?</td>
<td> </td>
</tr>
<tr class="row-even"><td>Editor or Other Important Role</td>
<td>idinfo > citation > citeinfo > “origin”</td>
<td>7 Contributor</td>
<td>See notes below.</td>
<td>rft.source</td>
</tr>
<tr class="row-odd"><td>Publication Place</td>
<td>idinfo > citation > citeinfo > “pubplace”</td>
<td>17 Description</td>
<td>See notes below.</td>
<td> </td>
</tr>
<tr class="row-even"><td>Distributor, Associate Archive, or other Institutional Role</td>
<td>idinfo > citation > citeinfo > “othercit”</td>
<td>7 Contributor or possibly 4 Publisher</td>
<td>“<a class="reference external" href="http://dataone.org">http://dataone.org</a>“</td>
<td> </td>
</tr>
<tr class="row-odd"><td>Data Within a Larger Work</td>
<td>idinfo > citation > citeinfo > “othercit” or “lworkcit”</td>
<td>12 RelatedIdentifier</td>
<td>perhaps a reference to the resource map?</td>
<td> </td>
</tr>
<tr class="row-even"><td> </td>
<td> </td>
<td> </td>
<td><code class="xref py py-attr docutils literal"><span class="pre">keyWord</span></code></td>
<td>rft.subject</td>
</tr>
<tr class="row-odd"><td> </td>
<td> </td>
<td> </td>
<td><a class="reference internal" href="#SearchMetadata.abstract" title="SearchMetadata.abstract"><code class="xref py py-attr docutils literal"><span class="pre">abstract</span></code></a></td>
<td>rft.description</td>
</tr>
<tr class="row-even"><td> </td>
<td> </td>
<td> </td>
<td>object format name, or “data” | “metadata” | “resource map”</td>
<td>rft.type</td>
</tr>
<tr class="row-odd"><td> </td>
<td> </td>
<td> </td>
<td>object format type</td>
<td>rft.format</td>
</tr>
<tr class="row-even"><td> </td>
<td> </td>
<td> </td>
<td>constructed from bounding box</td>
<td>rft.coverage</td>
</tr>
</tbody>
</table>
<p><strong>Notes</strong></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Version:</th><td class="field-body">There is no clear recommendation on how to express version. For an object
with a linear revision history (A is obsoleted by B is obsoleted by C),
object C might be considered to have a version of “2”. However, it is
possible for an object to have a tree lineage (A1 and A2 are obsoleted by
B1, and B1, A3 and Z are obsoleted by C). A suggestion for a version
indicator in this case may be the total number of parent objects, 5 in this
case. Another option may be to indicate the number of contributing objects
at each revision, 1.1 in the first case, and 2.3 in the second.</td>
</tr>
<tr class="field-even field"><th class="field-name">Publisher:</th><td class="field-body">The publisher in DataONE may in some cases be the origin member node,
however this will not always be the case. For example, many data sets in the
KNB are published by LTER, though KNB would be the member node. Where
possible the publisher information should be pulled from the science
metadata, though this may be complicated where multiple data and metadata
entries occur within a data package and there are several publishers listed.
In this case, a simple concatenation of the publishers (semi-colon + space
delimited) may be sufficient.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Date:</th><td class="field-body">In the DataCite 2.2 document, a mapping between Date and the dcterms:date is
suggested. The description of dcterms:date is “A point or period of time
associated with an event in the lifecycle of the resource.” In DataONE there
are two main dates related to an object, when the content is added to the
system, and when the properties of the object (access control, and so forth)
are modified. Since the content of the object does not change once submitted
to DataONE, the <code class="xref py py-attr docutils literal"><span class="pre">SystemMetadata.dateUploaded</span></code> value seems appropriate
here, expressed as <a class="reference internal" href="#SearchMetadata.dateUploaded" title="SearchMetadata.dateUploaded"><code class="xref py py-attr docutils literal"><span class="pre">dateUploaded</span></code></a> in the search index.</td>
</tr>
<tr class="field-even field"><th class="field-name">Subset Used:</th><td class="field-body">DataONE does not provide a mechanism for identifying sets of information
other than through resource maps which describe data packages. It is
possible that a resource map may contain references to additional resource
maps, conceptually equivalent to subsets of content. The simplest option
here would be to use the identifier of the resource map object describing
the package in question.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Contributor:</th><td class="field-body">Described in DataCite 2.2 as “The institution or person responsible for
collecting, creating, or otherwise contributing to the development of the
dataset”, this optional element can be populated by the citeinfo/origin
element from FGDC.</td>
</tr>
<tr class="field-even field"><th class="field-name" colspan="2">Publication Place:</th></tr>
<tr class="field-even field"><td> </td><td class="field-body">In CSDGM, “the name of the city (and state or province, and country, if
needed to identify the city) where the data set was published or released”.</td>
</tr>
<tr class="field-odd field"><th class="field-name" colspan="2">Data Within a Larger Work:</th></tr>
<tr class="field-odd field"><td> </td><td class="field-body">This is similar to the “Subset Used” entry except in the other direction of
containment. The identifier of the containing resource map relevant to the
current package should be used.</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="http://dataone.org">
<img class="logo" src="../_static/dataone_logo.png" alt="Logo"/>
</a></p>
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Content Discovery</a><ul>
<li><a class="reference internal" href="#querying-the-solr-index">Querying the SOLR Index</a></li>
<li><a class="reference internal" href="#system-metadata-index-properties">System Metadata Index Properties</a><ul>
<li><a class="reference internal" href="#populating-permission-fields">Populating Permission Fields</a></li>
<li><a class="reference internal" href="#example-queries">Example Queries</a></li>
</ul>
</li>
<li><a class="reference internal" href="#properties-of-the-index-derived-from-resource-maps">Properties of the Index Derived from Resource Maps</a><ul>
<li><a class="reference internal" href="#populating-object-relation-fields">Populating Object Relation Fields</a><ul>
<li><a class="reference internal" href="#adding-package-1">Adding Package 1</a></li>
<li><a class="reference internal" href="#adding-package-2">Adding Package 2</a></li>
<li><a class="reference internal" href="#adding-package-3">Adding Package 3</a></li>
</ul>
</li>
<li><a class="reference internal" href="#limitations-of-multi-valued-fields-in-solr">Limitations of Multi-Valued Fields in SOLR</a></li>
</ul>
</li>
<li><a class="reference internal" href="#values-extracted-from-science-metadata">Values Extracted from Science Metadata</a></li>
<li><a class="reference internal" href="#date-representations-in-science-metadata-documents">Date Representations in Science Metadata Documents</a></li>
<li><a class="reference internal" href="#science-metadata-examples">Science metadata examples</a></li>
<li><a class="reference internal" href="#standard-specific-metadata-extraction-notes">Standard Specific Metadata Extraction Notes</a></li>
<li><a class="reference internal" href="#attribute-descriptions-and-notes">Attribute Descriptions and Notes</a></li>
<li><a class="reference internal" href="#creating-citations-from-index-fields">Creating Citations from Index Fields</a></li>
</ul>
</li>
</ul>
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation Overview</a><ul>
<li><a href="index.html"><no title></a><ul>
<li>Previous: <a href="DataPackage.html" title="previous chapter">Data Packaging</a></li>
<li>Next: <a href="SearchMetadata_eml.html" title="next chapter">Search Metadata Elements Extracted from EML</a></li>
</ul></li>
</ul></li>
</ul>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
<div id="copyright">
© Copyright <a href="http://www.dataone.org">2009-2017, DataONE</a>.
[ <a href="../_sources/design/SearchMetadata.txt"
rel="nofollow">Page Source</a> |
<a href='https://redmine.dataone.org/projects/d1/repository/changes/documents/Projects/cicore/architecture/api-documentation/source/design/SearchMetadata.txt'
rel="nofollow">Revision History</a> ]
</div>
<div id="acknowledgement">
<p>This material is based upon work supported by the National Science Foundation
under Grant Numbers <a href="http://www.nsf.gov/awardsearch/showAward?AWD_ID=0830944">083094</a> and <a href="http://www.nsf.gov/awardsearch/showAward?AWD_ID=1430508">1430508</a>.</p>
<p>Any opinions, findings, and conclusions or recommendations expressed in this
material are those of the author(s) and do not necessarily reflect the views
of the National Science Foundation.</p>
</div>
</div>
<!--
<hr />
<div id="HCB_comment_box"><a href="http://www.htmlcommentbox.com">HTML Comment Box</a> is loading comments...</div>
<link rel="stylesheet" type="text/css" href="_static/skin.css" />
<script type="text/javascript" language="javascript" id="hcb">
/*<! -*/
(function()
{s=document.createElement("script");
s.setAttribute("type","text/javascript");
s.setAttribute("src", "http://www.htmlcommentbox.com/jread?page="+escape((typeof hcb_user !== "undefined" && hcb_user.PAGE)||(""+window.location)).replace("+","%2B")+"&mod=%241%24wq1rdBcg%24Gg8J5iYSHJWwAJtlYu/yU."+"&opts=21407&num=10");
if (typeof s!="undefined") document.getElementsByTagName("head")[0].appendChild(s);})();
/* ->*/
</script>
-->
</body>
</html>