schemas/JalviewWsParamSet.xsd

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6) * Copyright
   3         (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle * * This file
   4         is part of Jalview. * * Jalview is free software: you can redistribute it
   5         and/or * modify it under the terms of the GNU General Public License * as
   6         published by the Free Software Foundation, either version 3 of the License,
   7         or (at your option) any later version. * * Jalview is distributed in the
   8         hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the
   9         implied warranty * of MERCHANTABILITY or FITNESS FOR A PARTICULAR * PURPOSE.
  10         See the GNU General Public License for more details. * * You should have
  11         received a copy of the GNU General Public License along with Jalview. If
  12         not, see <http://www.gnu.org/licenses/>. -->
  13 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
  14         targetNamespace="www.jalview.org/xml/wsparamset">
  15         <xs:complexType name="WebServiceParameterSet">
  16                 <xs:sequence>
  17                         <xs:element name="Version" maxOccurs="1" minOccurs="0"
  18                                 type="xs:string">
  19                                 <xs:annotation>
  20                                         <xs:documentation>
  21                                                 A Jalview Web Service Parameter Set container
  22                                                 version number.
  23                                                 Version 1 created for storing Jaba user presets.
  24                                         </xs:documentation>
  25                                 </xs:annotation>
  26                         </xs:element>
  27                         <xs:element name="description" minOccurs="0" maxOccurs="1"
  28                                 type="xs:string">
  29                                 <xs:annotation>
  30                                         <xs:documentation>Short description - as utf8 encoded text. This is
  31                                                 usually displayed
  32                                                 in the body of an HTML capable tooltip, so HTML tags may be embedded
  33                                                 using standard UTF8 encoding.
  34                                         </xs:documentation>
  35                                 </xs:annotation>
  36                         </xs:element>
  37                         <xs:element name="serviceURL" minOccurs="1" maxOccurs="unbounded"
  38                                 type="xs:anyURI">
  39                                 <xs:annotation>
  40                                         <xs:documentation>
  41                                                 URL for which the parameter set is valid. Jalview will use it to
  42                                                 match up parameter sets to service instances that can parse the
  43                                                 parameter set payload.
  44                                 </xs:documentation>
  45                                 </xs:annotation>
  46                         </xs:element>
  47
  48                         <xs:element name="parameters" maxOccurs="1" minOccurs="1"
  49                                 type="xs:string">
  50                                 <xs:annotation>
  51                                         <xs:documentation>
  52                                                 UTF8 encoded string to be processed into a specific web services'
  53                                                 parameter set. Note - newlines may be important to the structure
  54                                                 of this file.
  55                                 </xs:documentation>
  56                                 </xs:annotation>
  57                         </xs:element>
  58                 </xs:sequence>
  59                 <xs:attribute name="name" type="xs:string" use="required">
  60                         <xs:annotation>
  61                                 <xs:documentation>
  62                                         The short name for the parameter set. This will be shown amongst the
  63                                         other presets for the web service.
  64                 </xs:documentation>
  65                         </xs:annotation>
  66                 </xs:attribute>
  67         </xs:complexType>
  68 </xs:schema>