head	1.8;
access;
symbols;
locks; strict;
comment	@# @;


1.8
date	2007.01.09.00.00.00;	author MoinMoin;	state Exp;
branches;
next	1.7;

1.7
date	2007.01.09.00.00.00;	author MoinMoin;	state Exp;
branches;
next	1.6;

1.6
date	2007.01.09.00.00.00;	author MoinMoin;	state Exp;
branches;
next	1.5;

1.5
date	2007.01.09.00.00.00;	author MoinMoin;	state Exp;
branches;
next	1.4;

1.4
date	2007.01.09.00.00.00;	author MoinMoin;	state Exp;
branches;
next	1.3;

1.3
date	2007.01.09.00.00.00;	author MoinMoin;	state Exp;
branches;
next	1.2;

1.2
date	2007.01.09.00.00.00;	author MoinMoin;	state Exp;
branches;
next	1.1;

1.1
date	2007.01.09.00.00.00;	author MoinMoin;	state Exp;
branches;
next	;


desc
@Initial revision
@


1.8
log
@Revision 8
@
text
@---+ Custom Search Request

This is a "subtype" of a SearchRequest that allows to define a custom ResponseStructure for the response. It is equivalent to the existing DiGIR searches where you can specify a record structure to be returned.

For counting matches and returned records as well as the paging mechanism we need to give a RecordDefinition here, listing concepts from within our custom record structure. See RecordDefinition for more details.
 

---+++++ Proposed Custom Search
   * CustomSearchProposalOne


@


1.7
log
@Revision 7
@
text
@d3 1
a3 1
This is a "subtype" of a search request that allows to define a custom ResponseStructure for the response. This ResponseStructure is very loosly based on the xml schema language.
d8 2
a9 25
<verbatim>
<search start="0" limit="2" count="true">
   <customDocument xmlns:abcd="http://www.tdwg.org/schemas/abcd/1.2" xmlns:temp="http://unknown.namespace.org">
      <recordDefinition>/Taxon</recordDefinition>
      <structure>
         <element name="temp:Taxon" datatype="String" min="0" max="unbounded">
            <attributes>
               <attribute name="FullName" datatype="String" min="1" datatype="string" path="abcd:/DataSets/DataSet/Units/Unit/Identifications/Identification/TaxonIdentified/NameAuthorYearString" CustomSearch>
               <attribute name="HigherTaxon" datatype="String" min="0" datatype="string" path="abcd:/DataSets/DataSet/Units/Unit/Identifications/Identification/TaxonIdentified/HigherTaxa/HigherTaxon" CustomSearch>
            </attributes>
            <subelements>
               <element name="temp:Coordinates" min="0" max="unbounded">
                  <subelements>
                     <element name="lat" min="0" max="1" datatype="string" path="abcd:/DataSets/DataSet/Units/Unit/Gathering/GatheringSite/SiteCoordinateSets/SiteCoordinates/CoordinatesLatLong/LatitudeDecimal" CustomSearch>
                     <element name="long" min="0" max="1" datatype="string" path="abcd:/DataSets/DataSet/Units/Unit/Gathering/GatheringSite/SiteCoordinateSets/SiteCoordinates/CoordinatesLatLong/LongitudeDecimal" CustomSearch>
                  </subelements>
               </element>
            </subelements>
         </element>
      </structure>
   </customDocument>
   <filter>
      <like path="abcd:/DataSets/DataSet/Units/Unit/Identifications/Identification/TaxonIdentified/NameAuthorYearString">Ast*</like>
   </filter>
</search>
a10 1
</verbatim>
a11 1
Note: recordDefinition is used only for count and paging purposes.
@


1.6
log
@Revision 6
@
text
@d3 1
a3 1
This is a "subtype" of a search request that allows to define a custom ResponseStructure for the response.
d5 2
a6 1
As the xml schema language is too complex we suggest to use a simplified version which resembles the schema language:
@


1.5
log
@Revision 5
@
text
@d34 2
@


1.4
log
@Revision 4
@
text
@d9 1
a9 1
   <customDocument responseNS="http://unknown.namespace.org">
d12 1
a12 1
         <element name="Taxon" datatype="String" min="0" max="-1">
d14 2
a15 2
               <attribute name="FullName" datatype="String" min="1" datatype="string" schema="http://www.tdwg.org/schemas/abcd/1.2" path="/DataSets/DataSet/Units/Unit/Identifications/Identification/TaxonIdentified/NameAuthorYearString" CustomSearch>
               <attribute name="HigherTaxon" datatype="String" min="0" datatype="string" schema="http://www.tdwg.org/schemas/abcd/1.2" path="/DataSets/DataSet/Units/Unit/Identifications/Identification/TaxonIdentified/HigherTaxa/HigherTaxon" CustomSearch>
d17 6
a22 8
            <children>
               <element name="Coordinates" min="0" max="-1">
                  <children>
                     <element name="lat" min="0" max="1" datatype="string" schema="http://www.tdwg.org/schemas/abcd/1.2" path="/DataSets/DataSet/Units/Unit/Gathering/GatheringSite/SiteCoordinateSets/SiteCoordinates/CoordinatesLatLong/LatitudeDecimal">
                  </element>
                     <element name="long" min="0" max="1" datatype="string" schema="http://www.tdwg.org/schemas/abcd/1.2" path="/DataSets/DataSet/Units/Unit/Gathering/GatheringSite/SiteCoordinateSets/SiteCoordinates/CoordinatesLatLong/LongitudeDecimal">
                  </element>
                  </children>
d24 1
a24 1
            </children>
d29 1
a29 1
      <like schema="http://www.tdwg.org/schemas/abcd/1.2" path="/DataSets/DataSet/Units/Unit/Identifications/Identification/TaxonIdentified/NameAuthorYearString">Ast*</like>
@


1.3
log
@Revision 3
@
text
@d11 14
a24 9
      <element name="Taxon" datatype="String" min="0" max="-1">
         <attributes>
            <attribute name="FullName" datatype="String" min="1" datatype="string" schema="http://www.tdwg.org/schemas/abcd/1.2" path="/DataSets/DataSet/Units/Unit/Identifications/Identification/TaxonIdentified/NameAuthorYearString" CustomSearch>
            <attribute name="HigherTaxon" datatype="String" min="0" datatype="string" schema="http://www.tdwg.org/schemas/abcd/1.2" path="/DataSets/DataSet/Units/Unit/Identifications/Identification/TaxonIdentified/HigherTaxa/HigherTaxon" CustomSearch>
         </attributes>
         <children>
            <element name="Coordinates" min="0" max="-1">
               <children>
                  <element name="lat" min="0" max="1" datatype="string" schema="http://www.tdwg.org/schemas/abcd/1.2" path="/DataSets/DataSet/Units/Unit/Gathering/GatheringSite/SiteCoordinateSets/SiteCoordinates/CoordinatesLatLong/LatitudeDecimal">
d26 3
a28 6
                  <element name="long" min="0" max="1" datatype="string" schema="http://www.tdwg.org/schemas/abcd/1.2" path="/DataSets/DataSet/Units/Unit/Gathering/GatheringSite/SiteCoordinateSets/SiteCoordinates/CoordinatesLatLong/LongitudeDecimal">
               </element>
               </children>
            </element>
         </children>
      </element>
d34 1
@


1.2
log
@Revision 2
@
text
@d27 1
@


1.1
log
@Initial revision
@
text
@d3 1
a3 1
This is a "subtype" of a search request that allows to define a custom structure of the response.
@