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


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

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.9
log
@Revision 9
@
text
@---+ CustomSearchProposalOne

A proposal to fit the CustomSearch requirements.

The ResponseStructure (starting with <structure>) is defined here in a simple xml schema alike way.

The PyWrapper already uses a simliar structure as the ResponseStructure proposed here to store and map any ConceptualSchema. The implemented PyWrapperAlgorithm for creating a valid xml output for a given ResponseStructure has proven to work when substituting the ConceptualBinding with an actual database mapping (table.attribute) of a specific provider.

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. 

---+++++ Request
<verbatim>
<request>
   <header>
      ...
   </header>
   <search start="0" limit="2" count="true">
      <customDocument schema="http://default.response.namespace.org" xmlns:temp="http://unknown.namespace.org">
         <recordDefinition>/Taxon</recordDefinition> *
         <structure>
            <element name="Taxon" min="0" max="unbounded"> *
               <attributes>
                  <attribute name="FullName" datatype="String" min="1" datatype="string" path="abcd:/DataSets/DataSet/Units/Unit/Identifications/Identification/TaxonIdentified/NameAuthorYearString" CustomSearchProposalOne> *
                  <attribute name="HigherTaxon" datatype="String" min="0" datatype="string" path="abcd:/DataSets/DataSet/Units/Unit/Identifications/Identification/TaxonIdentified/HigherTaxa/HigherTaxon" CustomSearchProposalOne>
               </attributes>
               <subelements>
                  <element name="temp:Coordinates" min="0" max="unbounded"> *
                     <subelements>
                        <element name="temp:lat" min="0" max="1" datatype="string" path="abcd:/DataSets/DataSet/Units/Unit/Gathering/GatheringSite/SiteCoordinateSets/SiteCoordinates/CoordinatesLatLong/LatitudeDecimal" CustomSearchProposalOne> *
                        <element name="temp:long" min="0" max="1" datatype="string" path="abcd:/DataSets/DataSet/Units/Unit/Gathering/GatheringSite/SiteCoordinateSets/SiteCoordinates/CoordinatesLatLong/LongitudeDecimal" CustomSearchProposalOne>
                     </subelements>
                  </element>
               </subelements>
            </element>
         </structure>
      </customDocument>
      <filter xmlns:abcd="http://www.tdwg.org/schemas/abcd/1.2">
         <like path="abcd:/DataSets/DataSet/Units/Unit/Identifications/Identification/TaxonIdentified/NameAuthorYearString">Ast*</like>
      </filter>
   </search>
</request>

with* indicating repeatable elements
</verbatim>


---+++++ Response
<verbatim>
<response>
   <header>
      ...
   </header>
   <content xmlns="http://default.response.namespace.org" xmlns:temp="http://unknown.namespace.org">
      <Taxon FullName="Abies alba Mill." HigherTaxon="Pinaceae"> *
         <temp:Coordinates> *
            <temp:lat>45.40</temp:lat>
            <temp:long>13.10</temp:long>
         </temp:Coordinates>
         <temp:Coordinates>
            <temp:lat>43.10</temp:lat>
            <temp:long>12.70</temp:long>
         </temp:Coordinates>
      </Taxon>
   </content>
</response>

with* indicating repeatable elements
</verbatim>

@


1.8
log
@Revision 8
@
text
@d21 1
a21 1
            <element name="Taxon" datatype="String" min="0" max="unbounded"> *
@


1.7
log
@Revision 7
@
text
@d19 1
a19 1
         <recordDefinition>/Taxon</recordDefinition>
d21 1
a21 1
            <element name="Taxon" datatype="String" min="0" max="unbounded">
d23 1
a23 1
                  <attribute name="FullName" datatype="String" min="1" datatype="string" path="abcd:/DataSets/DataSet/Units/Unit/Identifications/Identification/TaxonIdentified/NameAuthorYearString" CustomSearchProposalOne>
d27 1
a27 1
                  <element name="temp:Coordinates" min="0" max="unbounded">
d29 1
a29 1
                        <element name="temp:lat" min="0" max="1" datatype="string" path="abcd:/DataSets/DataSet/Units/Unit/Gathering/GatheringSite/SiteCoordinateSets/SiteCoordinates/CoordinatesLatLong/LatitudeDecimal" CustomSearchProposalOne>
d42 2
d54 2
a55 2
      <Taxon FullName="Abies alba Mill." HigherTaxon="Pinaceae">
         <temp:Coordinates>
d66 2
@


1.6
log
@Revision 6
@
text
@d9 1
a9 1
For counting matches and returned records as well as the paging mechanism we need to give a Record Definition here, listing concepts from within our custom record structure. See Record Definition for more details. 
@


1.5
log
@Revision 5
@
text
@d9 1
@


1.4
log
@Revision 4
@
text
@d17 1
a17 1
      <customDocument schema="http://default.response.namespace.org" xmlns:abcd="http://www.tdwg.org/schemas/abcd/1.2" xmlns:temp="http://unknown.namespace.org">
d36 1
a36 1
      <filter>
@


1.3
log
@Revision 3
@
text
@d17 1
a17 1
      <customDocument xmlns:abcd="http://www.tdwg.org/schemas/abcd/1.2" xmlns:temp="http://unknown.namespace.org">
d20 1
a20 1
            <element name="temp:Taxon" datatype="String" min="0" max="unbounded">
d28 2
a29 2
                        <element name="lat" min="0" max="1" datatype="string" path="abcd:/DataSets/DataSet/Units/Unit/Gathering/GatheringSite/SiteCoordinateSets/SiteCoordinates/CoordinatesLatLong/LatitudeDecimal" CustomSearchProposalOne>
                        <element name="long" min="0" max="1" datatype="string" path="abcd:/DataSets/DataSet/Units/Unit/Gathering/GatheringSite/SiteCoordinateSets/SiteCoordinates/CoordinatesLatLong/LongitudeDecimal" CustomSearchProposalOne>
@


1.2
log
@Revision 2
@
text
@d3 7
@


1.1
log
@Initial revision
@
text
@d39 17
@