Project

General

Profile

« Previous | Next » 

Revision 7256

include gastil's changes re: pathquery and 'delete'
http://bugzilla.ecoinformatics.org/show_bug.cgi?id=5516

View differences:

docs/user/metacat/source/submitting.rst
32 32
Using the Registry
33 33
------------------
34 34
Metacat's optional Registry provides a simple Web-based interface for creating, 
35
editing, and submitting metadata to the Metacat repository (Figure 4.1). The 
35
editing, and submitting metadata to the Metacat repository (screenshot below). The 
36 36
interface includes help documentation, and can be customized using Metacat's 
37 37
configuration settings. The Registry also includes an administrative interface 
38 38
for managing LDAP user accounts, which is useful if you are using LDAP as your 
......
495 495
``delete``
496 496
   Archive a document and move the pointer in xml_documents to xml_revisions, 
497 497
   effectively "deleting" the document from public view, but preserving the 
498
   revision for the revision history.
498
   revision for the revision history. No further updates will be allowed for
499
   the Metacat document that was "deleted". All revisions of this identifier are no longer 
500
   public. 
499 501

  
502
.. warning::
503
   It is not possible to "delete" one revision without "deleting" all 
504
   revisions of a given identifier.
505

  
500 506
The following is an example of a Web form (see figure) that can perform all 
501 507
three tasks. Example HTML code is included in the sidebar.
502 508

  
......
548 554
   Metacat server.
549 555
 
550 556

  
551
When Metacat receives a query via HTTP (Figure 4.8), the server creates a 
557
When Metacat receives a query via HTTP (screenshot below), the server creates a 
552 558
"pathquery" document, which is an XML document populated with the specified 
553
search criteria (Figure 4.10). The pathquery document is then translated into 
554
SQL statements that are executed against the data base. Results are translated 
559
search criteria. The pathquery document is then translated into 
560
SQL statements that are executed against the database. Results are translated 
555 561
into an XML "resultset" document, which can be returned as XML or transformed 
556 562
into HTML and returned (specify which you would prefer with the returnfield 
557 563
parameter). You can also opt to submit a pathquery document directly, 
......
560 566
.. figure:: images/screenshots/image043.jpg
561 567
   :align: center
562 568
   
563
   Example of a basic search form using a query action. 
569
   Example of a basic search form using a query action. The HTML code used to create the form is displayed below.
564 570

  
565 571
::
566 572

  
......
603 609
      <querytitle>unspecified</querytitle>
604 610
      <returnfield>dataset/title</returnfield>
605 611
      <returnfield>keyword</returnfield>
606
      <returnfield>originator/individualName/surName</returnfield>
612
      <returnfield>dataset/creator/individualName/surName</returnfield>
613
      <returndoctype>eml://ecoinformatics.org/eml-2.1.0</returndoctype>      
607 614
      <returndoctype>eml://ecoinformatics.org/eml-2.0.1</returndoctype>
608 615
      <returndoctype>eml://ecoinformatics.org/eml-2.0.0</returndoctype>
609 616
      <querygroup operator="UNION">
610
        <queryterm casesensitive="false" searchmode="contains">
611
          <value>Plant</value>
612
          <pathexpr>dataset/title</pathexpr>
617
        <queryterm casesensitive="true" searchmode="contains">
618
          <value>Charismatic megafauna</value>
619
           <pathexpr>dataset/title</pathexpr>
620
         </queryterm>
621
        <queryterm casesensitive="false" searchmode="starts-with">
622
           <value>sea otter</value>
623
           <pathexpr>keyword</pathexpr>
613 624
        </queryterm>
614 625
        <queryterm casesensitive="false" searchmode="contains">
615
          <value>plant</value>
616
          <pathexpr>keyword</pathexpr>
626
          <value>Enhydra</value>
627
          <pathexpr>abstract/para</pathexpr>
617 628
        </queryterm>
618
      </querygroup>
629
       </querygroup>
630
   </pathquery>
619 631
  </pathquery>
620 632
  
621
Each ``<returnfield>`` parameter specifies a field that the data base will 
633
Each ``<returnfield>`` parameter specifies a field that the database will 
622 634
return (in addition to the fields Metacat returns by default) for each search 
623 635
result. 
624 636

  
......
647 659
  <resultset>
648 660
        <query>
649 661
          <pathquery version="1.0">
650
            <meta_file_id>unspecified</meta_file_id>
651
            <querytitle>unspecified</querytitle>
652
            <returnfield>dataset/title</returnfield>
653
            <returnfield>keyword</returnfield>
654
            <returnfield>originator/individualName/surName</returnfield>
655
            <returndoctype>eml://ecoinformatics.org/eml-2.0.1</returndoctype>
656
            <returndoctype>eml://ecoinformatics.org/eml-2.0.0</returndoctype>
657
            <querygroup operator="UNION">
658
                  <queryterm casesensitive="false" searchmode="contains">
659
                      <value>Datos</value>
660
                      <pathexpr>dataset/title</pathexpr>
661
                  </queryterm>
662
                  <queryterm casesensitive="false" searchmode="contains">
663
                     <value>plant</value>
664
                     <pathexpr>keyword</pathexpr>
665
                  </queryterm>
666
           </querygroup>
667
         </pathquery>
668
        </query>  
669
      
670
        <document>
671
          <docid>nceas.44.1</docid>
672
          <docname>resource</docname>
673
          <doctype>eml://ecoinformatics.org/eml-2.0.1</doctype>
674
          <createdate>2001-01-12 16:12:06.0</createdate>
675
          <updatedate>2001-01-12 16:12:06.0</updatedate>
676
          <param name="dataset/title">Datos Meteorologicos</param>
677
          <param name="keyword">intertidal</param>
678
          <param name="originator/individualName/surName">Smith</param>
679
        </document>  
680
        
681
        <document>
682
          <docid>nceas.42.1</docid>
683
          <docname>resource</docname>
684
          <doctype>eml://ecoinformatics.org/eml-2.0.1</doctype>
685
          <createdate>2001-01-12 16:11:31.0</createdate>
686
          <updatedate>2001-01-12 16:11:31.0</updatedate>
687
          <param name="dataset/title">Ocean Surface Temperature</param>
688
          <param name="keyword">Plant</param>
689
          <param name="originator/individualName/surName">Henry</param>   
690
       </document>
662
             <meta_file_id>unspecified</meta_file_id>
663
             <querytitle>unspecified</querytitle>
664
             <returnfield>dataset/title</returnfield>
665
             <returnfield>keyword</returnfield>
666
             <returnfield>dataset/creator/individualName/surName</returnfield>
667
             <returndoctype>eml://ecoinformatics.org/eml-2.1.0</returndoctype>
668
             <returndoctype>eml://ecoinformatics.org/eml-2.0.1</returndoctype>
669
             <returndoctype>eml://ecoinformatics.org/eml-2.0.0</returndoctype>
670
             <querygroup operator="UNION">
671
                  <queryterm casesensitive="true" searchmode="contains">
672
                       <value>Charismatic megafauna</value>
673
                       <pathexpr>dataset/title</pathexpr>
674
                   </queryterm>
675
                   <queryterm casesensitive="false" searchmode="starts-with">
676
                      <value>sea otter</value>
677
                      <pathexpr>keyword</pathexpr>
678
                   </queryterm>
679
                   <queryterm casesensitive="false" searchmode="contains">
680
                      <value>Enhydra</value>
681
                      <pathexpr>abstract/para</pathexpr>
682
                   </queryterm>
683
            </querygroup>
684
          </pathquery>
685
         </query>  
686
       
687
         <document>
688
           <docid>nrs.569.3</docid>
689
           <docname>eml</docname>
690
           <doctype>eml://ecoinformatics.org/eml-2.0.0</doctype>
691
           <createdate>2012-06-06</createdate>
692
           <updatedate>2012-06-06</updatedate>
693
           <param name="dataset/title">Marine Mammal slides</param>
694
           <param name="creator/individualName/surName">Bancroft</param>
695
         </document>
696
 
697
         <document>
698
           <docid>knb-lter-sbc.61.1</docid>
699
           <docname>eml</docname>
700
           <doctype>eml://ecoinformatics.org/eml-2.1.0</doctype>
701
           <createdate>2012-06-06</createdate>
702
           <updatedate>2012-06-06</updatedate>
703
           <param name="dataset/creator/individualName/surName">Nelson</param>
704
           <param name="dataset/creator/individualName/surName">Harrer</param>
705
           <param name="dataset/creator/individualName/surName">Reed</param>
706
           <param name="dataset/title">SBC LTER: Reef: Sightings of Sea Otters (Enhydra lutris) near Santa Barbara and Channel Islands, ongoing since 2007</param>
707
         </document>
691 708
      .....  
692 709
  </resultset>
693 710

  

Also available in: Unified diff