Changeset 6654


Ignore:
Timestamp:
01/03/10 14:43:56 (9 years ago)
Author:
sdonegan
Message:

Took out lots of \n & \t 's in annotation fields so can present better in xsd view for upload to API docs.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • TI01-discovery-API/trunk/MEDINDiscoveryService/src/main/resources/META-INF/DiscoverySchema.xsd

    r6653 r6654  
    3434                        <xs:element name="RetrieveCriteria" type="tns:RetrieveCriteriaType" minOccurs="0"> 
    3535                                <xs:annotation> 
    36                                         <xs:documentation>Comparison of a date or date range to 
    37                                                 specified/default dates within metadata.</xs:documentation> 
     36                                        <xs:documentation>Comparison of a date dood  or date range to specified/default dates within metadata.</xs:documentation> 
    3837                                </xs:annotation> 
    3938                        </xs:element> 
     
    4544                        <xs:element name="OrderBy" type="tns:OrderByType" minOccurs="0" maxOccurs="unbounded"> 
    4645                                <xs:annotation> 
    47                                         <xs:documentation>Optional set of field(s) by which to order 
    48                                                 records in the result set and hence the search response. Direction 
    49                                                 can be specified alongside each field.</xs:documentation> 
     46                                        <xs:documentation>Optional set of field(s) by which to order records in the result set and hence the search response. Direction can be specified alongside each field.</xs:documentation> 
    5047                                </xs:annotation> 
    5148                        </xs:element> 
    5249                        <xs:element name="RecordDetail" type="xs:string" minOccurs="0"> 
    5350                                <xs:annotation> 
    54                                         <xs:documentation>Level of detail to be used for each record in the 
    55                                                 search response (before initiating doPresent). Values taken from 
    56                                                 recordDetailList. Default = "id", i.e. just the document id. 
     51                                        <xs:documentation>Level of detail to be used for each record in the search response (before initiating doPresent). Values taken from recordDetailList. Default = "id", i.e. just the document id. 
    5752                                        </xs:documentation> 
    5853                                </xs:annotation> 
     
    6560                        <xs:element name="SearchCriteria"> 
    6661                                <xs:annotation> 
    67                                         <xs:documentation>Must have at least one of : termSearch, 
    68                                                 spatialSearch, temporalSearch.</xs:documentation> 
     62                                        <xs:documentation>Must have at least one of : termSearch, spatialSearch, temporalSearch.</xs:documentation> 
    6963                                </xs:annotation> 
    7064                                <xs:complexType> 
     
    7367                                                        maxOccurs="unbounded"> 
    7468                                                        <xs:annotation> 
    75                                                                 <xs:documentation>Can have multiple term searches - will treat 
    76                                                                         multiple termSearches in "AND" combination, unless multiple 
    77                                                                         instances of same termTarget, in which case "OR" combination is 
    78                                                                         used for those with the same termTarget.</xs:documentation> 
     69                                                                <xs:documentation>Can have multiple term searches - will treat multiple termSearches in "AND" combination, unless multiple instances of same termTarget, in which case "OR" combination is used for those with the same termTarget.</xs:documentation> 
    7970                                                        </xs:annotation> 
    8071                                                </xs:element> 
    8172                                                <xs:element name="SpatialSearch" type="tns:SpatialType" minOccurs="0"> 
    8273                                                        <xs:annotation> 
    83                                                                 <xs:documentation>Comparison of a single search bounding box to 
    84                                                                         spatial coverage(s) of data.</xs:documentation> 
     74                                                                <xs:documentation>Comparison of a single search bounding box to spatial coverage(s) of data.</xs:documentation> 
    8575                                                        </xs:annotation> 
    8676                                                </xs:element> 
    8777                                                <xs:element name="TemporalSearch" type="tns:TemporalType" minOccurs="0"> 
    8878                                                        <xs:annotation> 
    89                                                                 <xs:documentation>Comparison of a date or date range to 
    90                                                                         specified/default dates within metadata.</xs:documentation> 
     79                                                                <xs:documentation>Comparison of a date or date range to specified/default dates within metadata.</xs:documentation> 
    9180                                                        </xs:annotation> 
    9281                                                </xs:element> 
     
    9685                        <xs:element name="RetrieveCriteria" type="tns:RetrieveCriteriaType" minOccurs="0"> 
    9786                                <xs:annotation> 
    98                                         <xs:documentation>Comparison of a date or date range to 
    99                                                 specified/default dates within metadata.</xs:documentation> 
     87                                        <xs:documentation>Comparison of a date or date range to specified/default dates within metadata.</xs:documentation> 
    10088                                </xs:annotation> 
    10189                        </xs:element> 
    10290                        <xs:element name="Start" type="xs:unsignedInt" minOccurs="0"> 
    10391                                <xs:annotation> 
    104                                         <xs:documentation>Sequential record number within result set used 
    105                                                 as first record within returned search response. Useful for 
    106                                                 pagination.</xs:documentation> 
     92                                        <xs:documentation>Sequential record number within result set used as first record within returned search response. Useful for pagination.</xs:documentation> 
    10793                                </xs:annotation> 
    10894                        </xs:element> 
    10995                        <xs:element name="HowMany" type="xs:unsignedInt" minOccurs="0"> 
    11096                                <xs:annotation> 
    111                                         <xs:documentation>How many records from result set to include in 
    112                                                 search response.</xs:documentation> 
     97                                        <xs:documentation>How many records from result set to include in search response.</xs:documentation> 
    11398                                </xs:annotation> 
    11499                        </xs:element> 
    115100                        <xs:element name="Scope" type="xs:string" minOccurs="0" maxOccurs="unbounded"> 
    116101                                <xs:annotation> 
    117                                         <xs:documentation>Optional term used to restrict search to records 
    118                                                 tagged with a data provider "scope" as listed in scopeList. 
    119                                         </xs:documentation> 
     102                                        <xs:documentation>Optional term used to restrict search to records tagged with a data provider "scope" as listed in scopeList. </xs:documentation> 
    120103                                </xs:annotation> 
    121104                        </xs:element> 
    122105                        <xs:element name="Format" type="xs:string" minOccurs="0"> 
    123106                                <xs:annotation> 
    124                                         <xs:documentation>restrict records to specific original input 
    125                                                 formats. </xs:documentation> 
     107                                        <xs:documentation>restrict records to specific original input formats. </xs:documentation> 
    126108                                </xs:annotation> 
    127109                        </xs:element> 
     
    193175                        <xs:element name="Date" type="tns:DateValueType" maxOccurs="2"> 
    194176                                <xs:annotation> 
    195                                         <xs:documentation>Single date, or pair of dates representing a date 
    196                                                 range, to be used in search against specified date target in 
    197                                                 metadata.</xs:documentation> 
     177                                        <xs:documentation>Single date, or pair of dates representing a date range, to be used in search against specified date target in metadata.</xs:documentation> 
    198178                                </xs:annotation> 
    199179                        </xs:element> 
    200180                        <xs:element name="DateRangeTarget" type="xs:string" minOccurs="0"> 
    201181                                <xs:annotation> 
    202                                         <xs:documentation>Target date to which date search should be 
    203                                                 applied (e.g. temporal coverage of data, date of publication). 
    204                                                 Value to be chosen from dateRangeTargetList. Default = 
    205                                                 temporalCoverage.</xs:documentation> 
     182                                        <xs:documentation>Target date to which date search should be applied (e.g. temporal coverage of data, date of publication). Value to be chosen from dateRangeTargetList. Default = temporalCoverage.</xs:documentation> 
    206183                                </xs:annotation> 
    207184                        </xs:element> 
     
    222199                        <xs:element name="BoundingBox" type="tns:BoundingBoxType"> 
    223200                                <xs:annotation> 
    224                                         <xs:documentation>Bounding box with coordinates by default in 
    225                                                 EPSG:4326 (lat/lon)</xs:documentation> 
     201                                        <xs:documentation>Bounding box with coordinates by default in EPSG:4326 (lat/lon)</xs:documentation> 
    226202                                </xs:annotation> 
    227203                        </xs:element> 
    228204                        <xs:element name="SpatialOperator" type="xs:string" minOccurs="0"> 
    229205                                <xs:annotation> 
    230                                         <xs:documentation>Operator used to compare search bounding box with 
    231                                                 spatial coverage in metadata. Values from spatialOperatorList. 
    232                                                 Default is "overlaps".</xs:documentation> 
     206                                        <xs:documentation>Operator used to compare search bounding box with spatial coverage in metadata. Values from spatialOperatorList. Default is "overlaps".</xs:documentation> 
    233207                                </xs:annotation> 
    234208                        </xs:element> 
    235209                        <xs:element name="SpatialReferenceSystem" type="xs:string" minOccurs="0"> 
    236210                                <xs:annotation> 
    237                                         <xs:documentation>Spatial reference system used for search bounding 
    238                                                 box e.g. EPSG:4326, taken from list spatialReferenceSystemList 
    239                                         </xs:documentation> 
     211                                        <xs:documentation>Spatial reference system used for search bounding box e.g. EPSG:4326, taken from list spatialReferenceSystemList </xs:documentation> 
    240212                                </xs:annotation> 
    241213                        </xs:element> 
     
    247219                        <xs:element name="Term" type="xs:string"> 
    248220                                <xs:annotation> 
    249                                         <xs:documentation>String(s) used in search. Whitespace between 
    250                                                 strings interpreted as OR combinations of those strings, unless 
    251                                                 "+" used to combine them, in which case AND combination. 
    252                                         </xs:documentation> 
     221                                        <xs:documentation>String(s) used in search. Whitespace between strings interpreted as OR combinations of those strings, unless "+" used to combine them, in which case AND combination. </xs:documentation> 
    253222                                </xs:annotation> 
    254223                        </xs:element> 
    255224                        <xs:element name="TermTarget" type="xs:string" minOccurs="0" maxOccurs="1"> 
    256225                                <xs:annotation> 
    257                                         <xs:documentation>Metadata field used as target for search. From 
    258                                                 list termTargetList</xs:documentation> 
     226                                        <xs:documentation>Metadata field used as target for search. From list termTargetList</xs:documentation> 
    259227                                </xs:annotation> 
    260228                        </xs:element> 
     
    266234                        <xs:element name="DateRange" type="tns:DateRangeType"> 
    267235                                <xs:annotation> 
    268                                         <xs:documentation>Specify start or end date, or both, along with 
    269                                                 target date field within metadata.</xs:documentation> 
     236                                        <xs:documentation>Specify start or end date, or both, along with target date field within metadata.</xs:documentation> 
    270237                                </xs:annotation> 
    271238                        </xs:element> 
     
    284251                        <xs:element name="MetricValue" type="xs:string" minOccurs="0"> 
    285252                                <xs:annotation> 
    286                                         <xs:documentation>Specific value of the metric when used in a 1:1 
    287                                                 context with a document return</xs:documentation> 
     253                                        <xs:documentation>Specific value of the metric when used in a 1:1 context with a document return</xs:documentation> 
    288254                                </xs:annotation> 
    289255                        </xs:element> 
     
    296262                        <xs:element name="TemporalOperator" type="xs:string" minOccurs="0"> 
    297263                                <xs:annotation> 
    298                                         <xs:documentation>Comparison operator taken from 
    299                                                 temporalOperatorList. Default = "equals"</xs:documentation> 
     264                                        <xs:documentation>Comparison operator taken from temporalOperatorList. Default = "equals"</xs:documentation> 
    300265                                </xs:annotation> 
    301266                        </xs:element> 
     
    307272                        <xs:element name="OrderByField" type="xs:string"> 
    308273                                <xs:annotation> 
    309                                         <xs:documentation>Field to use for ordering within result set (and 
    310                                                 hence search response). Value taken from orderByFieldList 
    311                                         </xs:documentation> 
     274                                        <xs:documentation>Field to use for ordering within result set (and hence search response). Value taken from orderByFieldList </xs:documentation> 
    312275                                </xs:annotation> 
    313276                        </xs:element> 
    314277                        <xs:element name="OrderByDirection" type="tns:OrderByDirectionType" minOccurs="0"> 
    315278                                <xs:annotation> 
    316                                         <xs:documentation>Direction of ordering used in result set and 
    317                                                 hence search response. Valid values : "ascending" or "descending". 
    318                                                 Default is descending.</xs:documentation> 
     279                                        <xs:documentation>Direction of ordering used in result set and hence search response. Valid values : "ascending" or "descending". Default is descending.</xs:documentation> 
    319280                                </xs:annotation> 
    320281                        </xs:element> 
     
    343304                                                maxOccurs="unbounded"> 
    344305                                                <xs:annotation> 
    345                                                         <xs:documentation>Name value pair(s) representing field(s) 
    346                                                                 corresoponding to orderBy fields in search request. 
    347                                                         </xs:documentation> 
     306                                                        <xs:documentation>Name value pair(s) representing field(s) corresoponding to orderBy fields in search request. </xs:documentation> 
    348307                                                </xs:annotation> 
    349308                                        </xs:element> 
     
    361320                                                maxOccurs="unbounded"> 
    362321                                                <xs:annotation> 
    363                                                         <xs:documentation>Name value pair(s) representing field(s) 
    364                                                                 corresoponding to orderBy fields in search request. 
    365                                                         </xs:documentation> 
     322                                                        <xs:documentation>Name value pair(s) representing field(s) corresoponding to orderBy fields in search request. </xs:documentation> 
    366323                                                </xs:annotation> 
    367324                                        </xs:element> 
     
    385342                                                maxOccurs="unbounded"> 
    386343                                                <xs:annotation> 
    387                                                         <xs:documentation>Name value pair(s) representing field(s) 
    388                                                                 corresoponding to orderBy fields in search request. 
    389                                                         </xs:documentation> 
     344                                                        <xs:documentation>Name value pair(s) representing field(s) corresoponding to orderBy fields in search request. </xs:documentation> 
    390345                                                </xs:annotation> 
    391346                                        </xs:element> 
     
    397352                                        <xs:element name="Document" type="xs:string"> 
    398353                                                <xs:annotation> 
    399                                                         <xs:documentation>CDATA content of returned XML document. 
    400                                                         </xs:documentation> 
     354                                                        <xs:documentation>CDATA content of returned XML document. </xs:documentation> 
    401355                                                </xs:annotation> 
    402356                                        </xs:element> 
Note: See TracChangeset for help on using the changeset viewer.