schemas/JalviewWsParamSet.xsd

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