The Metacat Server provides an interface for searching of metadata stored in the Metacat database.

Steps to performing a query in Metacat

1. A pathquery document is created from the search criteria provide through the servlet parameters.
2. This pathquery document is sent to DBQuery where it is processed and translated into SQL statements.
3. The SQL statements are executed against the database and the resultsets are translated into an xml document of doctype "resultset".
4. The resultset document is either returned directly to the client as XML or is transformed through XSLT and returned as HTML.

   <pathquery version="1.0">
      <meta_file_id>unspecified</meta_file_id>
      <querytitle>unspecified</querytitle>
      <returnfield>resource/dataset/originator/individualName/surName</returnfield>
      <returnfield>resource/dataset/originator/individualName/givenName</returnfield>
      <returnfield>resource/dataset/keywordInfo/keyword</returnfield>
      <returndoctype></returndoctype>
      <querygroup operator="UNION">
        <queryterm casesensitive="false" searchmode="contains">
          <value>%</value>
        </queryterm>
        <queryterm casesensitive="false" searchmode="contains">
          <value>-//NCEAS//resource//EN</value>
          <pathexpr>returndoc</pathexpr>
        </queryterm>
        <queryterm casesensitive="false" searchmode="contains">
          <value>-//NCEAS//eml-dataset//EN</value>
          <pathexpr>returndoc</pathexpr>
        </queryterm>
      </querygroup>
    </pathquery>
  

The pathquery document was designed to be flexible enough to query specific fields of any XML document. It also allows the client to specify which fields from a returned document are returned in the initial resultset. Each <returnfield> parameter specifies a field which the DB will return for any query hit. The returndoctype fields allows the client to limit the type of documents to be returned. If left blank, all document types are returned. A <querygroup> creates an AND or an OR statement of the <queryterm>s in the group. The operator can be UNION or INTERSECTION. A <queryterm> defines the actual field against which the query is being performed. The value of the queryterm that we are quering for is encased in <value> tags. The <pathexpr> tag specifies an exact path to which you want to restrict the search. A <pathexpr> tag which contains the keyword returndoc is a special case which is discussed in Packages and Relations.

When the pathquery document is submitted and processed, Metacat returns another XML document called a resultset document.

        <resultset>
        <query>
          <pathquery version="1.0">
            <meta_file_id>unspecified</meta_file_id>
            <querytitle>unspecified</querytitle>
            <returnfield>resource/dataset/originator/individualName/surName</returnfield>
            <returnfield>resource/dataset/originator/individualName/givenName</returnfield>
            <returnfield>resource/dataset/keywordInfo/keyword</returnfield>
            <returndoctype></returndoctype>
            <querygroup operator="UNION">
              <queryterm casesensitive="false" searchmode="contains">
                <value>%</value>
              </queryterm>
              <queryterm casesensitive="false" searchmode="contains">
                <value>-//NCEAS//resource//EN</value>
                <pathexpr>returndoc</pathexpr>
              </queryterm>
              <queryterm casesensitive="false" searchmode="contains">
                <value>-//NCEAS//eml-dataset//EN</value>
                <pathexpr>returndoc</pathexpr>
              </queryterm>
            </querygroup>
          </pathquery>
        </query>  
      
        <document>
          <docid>nceas.44.1</docid>
          <docname>resource</docname>
          <doctype>-//NCEAS//resource//EN</doctype>
          <doctitle>Surgras1.txt</doctitle>
          <createdate>2001-01-12 16:12:06.0</createdate>
          <updatedate>2001-01-12 16:12:06.0</updatedate>
          <param name="resource/dataset/keywordInfo/keyword">surfgrass</param>
          <param name="resource/dataset/keywordInfo/keyword">intertidal</param>
          <param name="resource/dataset/keywordInfo/keyword">Ventura</param>
          <param name="resource/dataset/keywordInfo/keyword">Los Angeles</param>
          <relation>
            <relationtype>hasTransitiveRelationTo</relationtype>
            <relationdoc>Metacat://dev.nceas.ucsb.edu:8090/Metacat?docid=nceas.43</relationdoc>
            <relationdoctype>-//NCEAS//eml-file//EN</relationdoctype>
          </relation>
          <relation>
            <relationtype>isresourcemetadatafor</relationtype>
            <relationdoc>http://www.nceas.ucsb.edu/marine/data/ambrose/surgras1.txt</relationdoc>
            <relationdoctype>null</relationdoctype>
          </relation>
        </document>  
        
        <document>
          <docid>nceas.42.1</docid>
          <docname>resource</docname>
          <doctype>-//NCEAS//resource//EN</doctype>
          <doctitle>SLottia.txt</doctitle>
          <createdate>2001-01-12 16:11:31.0</createdate>
          <updatedate>2001-01-12 16:11:31.0</updatedate>
          <param name="resource/dataset/keywordInfo/keyword">lottia</param>
          <param name="resource/dataset/keywordInfo/keyword">intertidal</param>
          <param name="resource/dataset/keywordInfo/keyword">Orange</param>
          <relation>
            <relationtype>hasTransitiveRelationTo</relationtype>
            <relationdoc>Metacat://dev.nceas.ucsb.edu:8090/Metacat?docid=nceas.41</relationdoc>
            <relationdoctype>-//NCEAS//eml-file//EN</relationdoctype>
          </relation>
          <relation>
            <relationtype>isresourcemetadatafor</relationtype>
            <relationdoc>http://www.nceas.ucsb.edu/marine/data/murray/SLottia.txt</relationdoc>
            <relationdoctype>null</relationdoctype>
          </relation>
        </document>
      .....  
      </resultset>
    
  

The first element in the resultset is <query>. As you may notice, its content is just the pathquery document. The resultset always returns the pathquery document that created it in the <query> tag. The next major tag is <document>. Each XML document returned by the query is represented by a <document> tag. The default information returned about a document are docid, docname, doctype, doctitle, createdate and updatedate. The param tags are present if the document found contained the returnfield chosen in the pathquery document. The name attribute of the param tag is the full path to the node specified by the returnfield. <relation> tags specify any documents to which the returned document is related. Relations and packages are talked about later.

Back | Home | Next