SEARCH_METADATA

Used in

Servers

Metadata (Browse)

Parent elements

Syntax

<SEARCH_METADATA	Attribute Description Table
When SEARCH_METADATA is nested: operator="and \| or" [and] When SEARCH_METADATA is the outer element: foldermask="1 - 7" fulloutput="true \| false" [true] gndextent="none \| document \| search" [none] maxresults="integer" [All records matching search criteria] operator="and \| or" [and] sort="name \| relevance \| contenttype \| local_area \| global_area \| date \| date_desc" [name] sort2="name \| relevance \| contenttype \| local_area \| global_area \| date \| date_desc" startresult="integer" [0] thumbnail="true \| false" [true] > When SEARCH_METADATA is nested: (r)<AREA... /> [And/Or (Group A)] (r)(m)<DOCUMENTINFO... /> [And/Or (Group A)] (r)(m)<SUBSET... /> [And/Or (Group A)] (r)<UPDATED... /> [And/Or (Group A)] (r)(m)<FULLTEXT... /> [And/Or (Group B)] (r)(m)<TAGTEXT... /> [And/Or (Group B)] (r)(m)<TAGVALUE... /> [And/Or (Group B)] When SEARCH_METADATA is the outer element: (r)<ENVELOPE... /> [And/Or] (r)(m)<FULLTEXT... /> [And/Or] (r)(m)<SEARCH_METADATA... /> [And/Or] (r)(m)<TAGTEXT... /> [And/Or] (r)(m)<TAGVALUE... /> [And/Or] </SEARCH_METADATA >
(r): Attribute or child element is required. (m): Child element can be used multiple times.

Description

Used to specify criteria for selecting documents.

Restrictions

Search criteria must be added to the parent SEARCH_METADATA element in the following order:

ENVELOPE. This element may be used only once.
Nested SEARCH_METADATA elements (listed as Group A in the Syntax section) containing SUBSET, DOCUMENTINFO, UPDATED, or AREA. Group A elements may be used multiple times in a nested SEARCH_METADATA element. For best results, use only one of the elements from Group A in each nested SEARCH_METADATA element. Nested SEARCH_METADATA elements containing elements from Group A may appear in any order.
FULLTEXT, SEARCH_METADATA, TAGTEXT, and TAGVALUE as child elements to the outer SEARCH_METADATA element. These elements may be used multiple times in any order.
Nested SEARCH_METADATA elements (listed as Group B in the Syntax section) containing FULLTEXT, TAGTEXT, and TAGVALUE elements. These elements may be used multiple times in any order.

The following example demonstrates the proper structure for a SEARCH_METADATA request when multiple child elements are used.

<--Outer SEARCH_METADATA element -->
<SEARCH_METADATA ...>

<--#1 -->
  <ENVELOPE ...>

<--#2 -->
  <SEARCH_METADATA ...>
    <DOCUMENTINFO .../>
    <DOCUMENTINFO .../>
  </SEARCH_METADATA>

<--#3 -->
  <FULLTEXT ...>

<--#4 -->
  <SEARCH_METADATA ...>
    <TAGTEXT .../>
  </SEARCH_METADATA>

</SEARCH_METADATA>

At least one occurrence of ENVELOPE, FULLTEXT, SEARCH_METADATA, TAGTEXT, or TAGVALUE is required. Each element can be used multiple times, except ENVELOPE.
SEARCH_METADATA may be nested inside the parent SEARCH_METADATA element. A nested SEARCH_METADATA element may not contain additional nested SEARCH_METADATA elements.

Nested SEARCH_METADATA elements must be all from Group A (SUBSET, DOCUMENTINFO, UPDATED, or AREA) or all from Group B (FULLTEXT, TAGTEXT, and TAGVALUE). You cannot mix the two groups.

The following example is valid:

<SEARCH_METADATA ...>
  <SEARCH_METADATA ...>
    <DOCUMENTINFO .../>
    <DOCUMENTINFO .../>
  </SEARCH_METADATA>
  <SEARCH_METADATA ...>
    <TAGTEXT .../>
  </SEARCH_METADATA>
</SEARCH_METADATA>

The following example is not valid because DOCUMENTINFO and TAGTEXT are from different groups:

<SEARCH_METADATA ...>
  <SEARCH_METADATA ...>
    <DOCUMENTINFO .../>
    <TAGTEXT .../>
  </SEARCH_METADATA>
</SEARCH_METADATA>

Notes

Response is zero or more occurrances of METADATA_DATASET.
The attributes maxresults and startresult work together to return a specified number of records at a time. For example, assume 10 records should be returned at a time. In this case, maxresult would be set to "10". For the first pass, records 0 through 9 are returned. To retrieve these records, startresult is set to "0". In the second pass, records 10 through 19 are retrieved. To do this, startresult should be set to 10. The programmer is responsible for keeping track and changing the value of startresult programmatically. The ArcIMS Spatial Server does not make this calculation.

Attribute Descriptions for SEARCH_METADATA

Attribute	Usage
operator	Used to define the operator for the SEARCH_METADATA query.
foldermask	Specifies folder types to be returned in the response. The value of foldermask is an integer storing the sum of one or more of the following values: 1 = Root document 2 = "Normal" folder 4 = Document For example, use "4" to return documents only. Use "7" (1 + 2 + 4) to return all types of folders. The different values are: 1 = Root document only (1) 2 = "Normal" folders only (2) 3 = Root document and "normal" folders (1 + 2) 4 = Documents only (4) 5 = Root document and documents (1 + 4) 6 = "Normal" folders and documents (2 + 4) 7 = Root document, "normal" folders, and documents (1 + 2 + 4)
fulloutput	When set to "true", XML files are generated containing the documents found by the search. A GND file is also generated for documents describing ArcIMS Image and Feature Services. Files are generated in the ArcIMS server's Output directory. When "false", XML and GND files are not returned.
gndextent	The extent written to the GND file. When "none" is selected, the default extent of the service is used. For "document" the extent is taken from the metadata document. For "search" the extent is the search extent specified in the client such as Metadata Explorer.
maxresults	By default, all records meeting the search criteria are returned. This attribute limits the number of returned records to the maximum value assigned to the attribute.
operator	Used to define the operator for the SEARCH_METADATA query.
sort	Preference for ordering results. "name" orders the results alphabetically. "relevance" lists results from highest to lowest relevance. "contenttype" sorts and groups results by content type. "local_area" lists results by area in ascending order. "global_area" lists results by area in descending order. "date" lists the documents from oldest to newest based on when the documents were published or updated. "date_desc" lists the documents from newest to oldest based on when the documents were published or updated.
sort2	Secondary preference for ordering results. Attribute values are the same as for sort. For example, if sort="contenttype" and sort="date_desc", all documents with the same contenttype will be ordered from newest to oldest. All sort criteria are applied to all results before the results are batched using startresult and maxresults.
startresult	By default, all records meeting the search criteria are returned starting with record 0. This attribute allows a specified record as the start record.
thumbnail	When set to "true", images are generated containing thumbnails for documents found by the search, if thumbnails are available. Files are generated in the ArcIMS server's Output directory. When "false", thumbnails are not returned.

Examples for SEARCH_METADATA

Example 1: When searching by name or owner of documents using DOCUMENTINFO.

<?xml version="1.0" encoding="UTF-8" ?>
<ARCXML version="1.1">
  <REQUEST>
    <GET_METADATA>
      <SEARCH_METADATA>
        <SEARCH_METADATA>
          <DOCUMENTINFO name="World" />
        </SEARCH_METADATA>
      <SEARCH_METADATA>
    </GET_METADATA>
  </REQUEST>
</ARCXML>

Example 2: When using TAGVALUE.

<?xml version="1.0" encoding="UTF-8"?>
<ARCXML version="1.1">
  <REQUEST>
    <GET_METADATA>
      <SEARCH_METADATA operator="and" maxresults="10" startresult="0" >
        <TAGVALUE tag="metadata/idinfo/citation/citeinfo/pubdate" greaterthanorequalto="20001006" lessthanorequalto="20010104"/>
      </SEARCH_METADATA>
    </GET_METADATA>
  </REQUEST>
</ARCXML>

Example 3: When using ENVELOPE, TAGVALUE, FULLTEXT, and SEARCH_METADATA recursively with TAGTEXT.

<?xml version="1.0" encoding="UTF-8" ?>
<ARCXML version="1.1">
  <REQUEST>
    <GET_METADATA>
      <SEARCH_METADATA operator="and">
        <ENVELOPE minx="-176.98" miny="18.93" maxx="-66.97" maxy="71.35" spatialoperator="within" />
        <TAGVALUE tag="metadata/dataqual/lineage/srcinfo/srccite/citeinfo/pubdate" greaterthan="1990-01-01" />
        <FULLTEXT word="cities"/>
        <SEARCH_METADATA operator="or">
          <TAGTEXT tag="metadata/idinfo/citation/citeinfo/geoform" word="data"/>
          <TAGTEXT tag="metadata/idinfo/citation/citeinfo/geoform" word="digital"/>
        </SEARCH_METADATA>
      </SEARCH_METADATA>
    </GET_METADATA>
  </REQUEST>
</ARCXML>

Example 4: When using many criteria.

<?xml version="1.0" encoding="UTF-8" ?>
<ARCXML version="1.1">
  <REQUEST>
    <GET_METADATA>
      <SEARCH_METADATA operator="and" maxresults="10" startresult="0" >
        <ENVELOPE minx="-176.98" miny="18.93" maxx="-66.97" maxy="71.35" spatialoperator="within"/>
        <SEARCH_METADATA operator="or">
          <DOCUMENTINFO content="liveData"/>
          <DOCUMENTINFO content="downloadableData"/>
          <DOCUMENTINFO content="offlineData"/>
        </SEARCH_METADATA>
        <SEARCH_METADATA>
          <DOCUMENTINFO owner="usgs"/>
        </SEARCH_METADATA>
        <SEARCH_METADATA>
          <UPDATED after="2000-01-01"/>
        </SEARCH_METADATA>
        <TAGVALUE tag="metadata/dataqual/lineage/srcinfo/srcscale" lessthanorequalto="24000"/>
        <SEARCH_METADATA operator="and">
          <FULLTEXT word="water"/>
          <FULLTEXT word="stream"/>
        </SEARCH_METADATA>
        <SEARCH_METADATA operator="or">
          <TAGTEXT tag="metadata/idinfo/keywords/theme/themekey" word="inlandWaters"/>
          <TAGVALUE tag="metadata/dataIdInfo/tpCat/TopicCatCd" attribute="value" equalto="012"/>
        </SEARCH_METADATA>
      </SEARCH_METADATA>
    </GET_METADATA>
  </REQUEST>
</ARCXML>