webservices/compbio/ws/client/Services.java

   1 /* Copyright (c) 2011 Peter Troshin\r
   2  *  \r
   3  *  JAva Bioinformatics Analysis Web Services (JABAWS) @version: 2.0     \r
   4  * \r
   5  *  This library is free software; you can redistribute it and/or modify it under the terms of the\r
   6  *  Apache License version 2 as published by the Apache Software Foundation\r
   7  * \r
   8  *  This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without\r
   9  *  even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Apache \r
  10  *  License for more details.\r
  11  * \r
  12  *  A copy of the license is in apache_license.txt. It is also available here:\r
  13  * @see: http://www.apache.org/licenses/LICENSE-2.0.txt\r
  14  * \r
  15  * Any republication or derived work distributed in source code form\r
  16  * must include this copyright and license notice.\r
  17  */\r
  18 \r
  19 package compbio.ws.client;\r
  20 \r
  21 import java.net.URL;\r
  22 import java.util.Set;\r
  23 \r
  24 import javax.xml.bind.annotation.XmlAccessType;\r
  25 import javax.xml.bind.annotation.XmlAccessorType;\r
  26 import javax.xml.namespace.QName;\r
  27 import javax.xml.ws.Service;\r
  28 \r
  29 import compbio.data.msa.JABAService;\r
  30 import compbio.data.msa.MsaWS;\r
  31 import compbio.data.msa.SequenceAnnotation;\r
  32 \r
  33 /**\r
  34  * List of web services currently supported by JABAWS version 2\r
  35  * \r
  36  */\r
  37 public enum Services {\r
  38         /*\r
  39          * Make sure this class has NO references to runners or engines as it is a\r
  40          * part of minimal client package. Such things should go into ServicesUtil\r
  41          */\r
  42         MafftWS, MuscleWS, ClustalWS, ClustalOWS, TcoffeeWS, ProbconsWS, AAConWS, JronnWS, DisemblWS, GlobPlotWS, IUPredWS, JpredWS, RNAalifoldWS;\r
  43 \r
  44         public static Services getService(String servName) {\r
  45                 servName = servName.trim().toLowerCase();\r
  46                 for (Services service : Services.values()) {\r
  47                         if (service.toString().equalsIgnoreCase(servName)) {\r
  48                                 return service;\r
  49                         }\r
  50                 }\r
  51                 return null;\r
  52         }\r
  53 \r
  54         Service getService(URL url, String sqname) {\r
  55                 QName qname = new QName(sqname, this.toString());\r
  56                 return Service.create(url, qname);\r
  57         }\r
  58 \r
  59         public static String toString(Set<Services> services) {\r
  60                 if (services == null || services.isEmpty()) {\r
  61                         return "No known services...\n";\r
  62                 }\r
  63                 String value = "";\r
  64                 for (Services serv : services) {\r
  65                         if (null != serv) {\r
  66                                 value += serv + "\n";\r
  67                         } else {\r
  68                                 value += "Unknown Service\n";\r
  69                         }\r
  70                 }\r
  71                 return value;\r
  72         }\r
  73 \r
  74         Class<? extends JABAService> getServiceType() {\r
  75                 switch (this) {\r
  76                         case AAConWS :\r
  77                         case JronnWS :\r
  78                         case DisemblWS :\r
  79                         case GlobPlotWS :\r
  80                         case IUPredWS :\r
  81                         case RNAalifoldWS :\r
  82                                 return SequenceAnnotation.class;\r
  83                         case JpredWS :\r
  84                         case ClustalWS :\r
  85                         case ClustalOWS :\r
  86                         case MafftWS :\r
  87                         case MuscleWS :\r
  88                         case ProbconsWS :\r
  89                         case TcoffeeWS :\r
  90                                 return MsaWS.class;\r
  91 \r
  92                         default :\r
  93                                 throw new RuntimeException("Unrecognised Web Service Type " + this + " - Should never happen!");\r
  94                 }\r
  95         }\r
  96 \r
  97         \r
  98         String getServiceNamespace() {\r
  99                 switch (this) {\r
 100                         case RNAalifoldWS :\r
 101                         case AAConWS :\r
 102                         case JronnWS :\r
 103                         case DisemblWS :\r
 104                         case GlobPlotWS :\r
 105                         case IUPredWS :\r
 106                                 return JABAService.V2_SERVICE_NAMESPACE;\r
 107                         case ClustalOWS :\r
 108                         case JpredWS :\r
 109                         case ClustalWS :\r
 110                         case MafftWS :\r
 111                         case MuscleWS :\r
 112                         case ProbconsWS :\r
 113                         case TcoffeeWS :\r
 114                                 return JABAService.SERVICE_NAMESPACE;\r
 115                         default :\r
 116                                 throw new RuntimeException("Unrecognised JABAWS Namespace for service " + this +"!");\r
 117                 }\r
 118         }\r
 119         \r
 120         JABAService getInterface(Service service) {\r
 121                 assert service != null;\r
 122 \r
 123                 QName portName = new QName(service.getServiceName().getNamespaceURI(), this.toString() + "Port");\r
 124                 return service.getPort(portName, this.getServiceType());\r
 125         }\r
 126 \r
 127         public String getServiceInfo() {\r
 128                 switch (this) {\r
 129                         case AAConWS :\r
 130                                 return AACON_INFO;\r
 131                         case JpredWS :\r
 132                                 return JPRED_INFO;\r
 133                         case ClustalOWS :\r
 134                                 return CLUSTAL_OMEGA_INFO;\r
 135                         case ClustalWS :\r
 136                                 return CLUSTAL_INFO;\r
 137                         case DisemblWS :\r
 138                                 return DISEMBL_INFO;\r
 139                         case GlobPlotWS :\r
 140                                 return GLOBPLOT_INFO;\r
 141                         case IUPredWS :\r
 142                                 return IUPRED_INFO;\r
 143                         case JronnWS :\r
 144                                 return JRONN_INFO;\r
 145                         case MafftWS :\r
 146                                 return MAFFT_INFO;\r
 147                         case MuscleWS :\r
 148                                 return MUSCLE_INFO;\r
 149                         case ProbconsWS :\r
 150                                 return PROBCONS_INFO;\r
 151                         case TcoffeeWS :\r
 152                                 return TCOFFEE_INFO;\r
 153                         case RNAalifoldWS :\r
 154                                 return RNAALIFOLD_INFO;\r
 155                         default :\r
 156                                 throw new RuntimeException("Unrecognised Web Service Type " + this + " - Should never happen!");\r
 157                 }\r
 158         }\r
 159 \r
 160         public static final String AACON_INFO = new ServiceInfo(AAConWS,\r
 161                         "in preparation", "1.0", "http://www.compbio.dundee.ac.uk/aacon").toString();\r
 162 \r
 163         public static final String JPRED_INFO = new ServiceInfo(JpredWS,\r
 164                         "Cole C, Barber JD, Barton GJ.reparation" + \r
 165                         "The Jpred 3 secondary structure prediction server\n" +\r
 166                         "Nucl. Acids Res. (2008) 36 (suppl 2): W197-W201., doi: 10.1093/nar/gkn238", \r
 167                         "3.0", "http://www.compbio.dundee.ac.uk/www-jpred").toString();\r
 168         \r
 169         public static final String CLUSTAL_INFO = new ServiceInfo(ClustalWS,\r
 170                         "Larkin MA, Blackshields G, Brown NP, Chenna R, McGettigan PA, McWilliam H, Valentin F, " + \r
 171                         "Wallace IM, Wilm A, Lopez R, Thompson JD, Gibson TJ, Higgins DG.\n" +\r
 172                         "(2007). Clustal W and Clustal X version 2.0. Bioinformatics, 23, 2947-2948.",\r
 173                         "2.0.12", "http://www.clustal.org/clustal2/").toString();\r
 174 \r
 175         public static final String CLUSTAL_OMEGA_INFO = new ServiceInfo(ClustalOWS,\r
 176                         "Fast, scalable generation of high quality protein multiple sequence alignments using Clustal Omega\r\n"\r
 177                         + "Fabian Sievers, Andreas Wilm, David Dineen, Toby J. Gibson, Kevin Karplus, Weizhong Li, Rodrigo Lopez, Hamish McWilliam, Michael Remmert, Johannes Söding, Julie D. Thompson, Desmond G. Higgins",\r
 178                         "1.0.2", "http://www.clustal.org/omega").toString();\r
 179 \r
 180         public static final String DISEMBL_INFO = new ServiceInfo(DisemblWS,\r
 181                         "R. Linding, L.J. Jensen, F. Diella, P. Bork, T.J. Gibson and R.B. Russell\r\n"\r
 182                         + "Protein disorder prediction: implications for structural proteomics\r\n"\r
 183                         + "Structure Vol 11, Issue 11, 4 November 2003", "1.5",\r
 184                         "http://dis.embl.de/").toString();\r
 185 \r
 186         public static final String GLOBPLOT_INFO = new ServiceInfo(GlobPlotWS,\r
 187                         "Rune Linding, Robert B. Russell, Victor Neduva and Toby J. Gibson " +\r
 188                         "'GlobPlot: exploring protein sequences for globularity and disorder.' " + \r
 189                         "Nucl. Acids Res. (2003) 31 (13): 3701-3708. doi: 10.1093/nar/gkg519\r\n",\r
 190                         "2.3", "http://globplot.embl.de/").toString();\r
 191 \r
 192         public static final String IUPRED_INFO = new ServiceInfo(IUPredWS,\r
 193                         "The Pairwise Energy Content Estimated from Amino Acid Composition Discriminates between Folded and Intrinsically Unstructured Proteins\r\n"\r
 194                         + "Zsuzsanna Dosztányi, Veronika Csizmók, Péter Tompa and István Simon\r\n"\r
 195                         + "J. Mol. Biol. (2005) 347, 827-839.", "1.0",\r
 196                         "http://iupred.enzim.hu/").toString();\r
 197 \r
 198         public static final String TCOFFEE_INFO = new ServiceInfo(TcoffeeWS,\r
 199                         "T-Coffee: A novel method for multiple sequence alignments  "\r
 200                         + "Notredame, Higgins, Heringa, JMB, 302 (205-217) 2000",\r
 201                         "8.99", "http://tcoffee.crg.cat/apps/tcoffee/index.html").toString();\r
 202 \r
 203         public static final String MUSCLE_INFO = new ServiceInfo(\r
 204                         MuscleWS,\r
 205                         "Edgar, R.C. (2004) MUSCLE: multiple sequence alignment with high accuracy and high throughput.Nucleic Acids Res. 32(5):1792-1797.\r\n"\r
 206                         + "doi:10.1093/nar/gkh340", "3.8.31",\r
 207                         "http://www.drive5.com/muscle/").toString();\r
 208 \r
 209         public static final String PROBCONS_INFO = new ServiceInfo(\r
 210                         ProbconsWS,\r
 211                         "Do, C.B., Mahabhashyam, M.S.P., Brudno, M., and Batzoglou, S. 2005. PROBCONS: "\r
 212                         + "Probabilistic Consistency-based Multiple Sequence Alignment. Genome Research 15: 330-340. ",\r
 213                         "1.12", "http://probcons.stanford.edu/").toString();\r
 214 \r
 215         public static final String JRONN_INFO = new ServiceInfo(\r
 216                         JronnWS,\r
 217                         "unpublished, original algorithm Yang,Z.R., Thomson,R., McMeil,P. and Esnouf,R.M. (2005) "\r
 218                                         + "RONN: the bio-basis function neural network technique applied to the "\r
 219                                         + "dectection of natively disordered regions in proteins Bioinformatics 21: 3369-3376\r\n",\r
 220                         "1.0", "http://www.compbio.dundee.ac.uk/jabaws/").toString();\r
 221 \r
 222         public static final String MAFFT_INFO = new ServiceInfo(\r
 223                         MafftWS,\r
 224                         "Katoh, Toh 2010 (Bioinformatics 26:1899-1900)\r\n"\r
 225                                         + "Parallelization of the MAFFT multiple sequence alignment program. ",\r
 226                         "6.8.57", "http://mafft.cbrc.jp/alignment/software/").toString();\r
 227 \r
 228         public static final String RNAALIFOLD_INFO = new ServiceInfo(\r
 229                         RNAalifoldWS,\r
 230                         "Ivo L. Hofacker, Martin Fekete, and Peter F. Stadler 'Secondary Structure Prediction"\r
 231                         + " for Aligned RNA Sequences'. J.Mol.Biol. 319: 1059-1066, 2002. Stephan H. Bernhart,"\r
 232                         + " Ivo L. Hofacker, Sebastian Will, Andreas R. Gruber, and Peter F. Stadler. "\r
 233                         + "'RNAalifold: Improved consensus structure prediction for RNA alignments'. BMC Bioinformatics, 9:474, 2008.\r\n",\r
 234                         "2.1.2", "http://www.tbi.univie.ac.at/RNA/").toString();\r
 235 \r
 236         @XmlAccessorType(XmlAccessType.FIELD)\r
 237         static class ServiceInfo {\r
 238                 Services service;\r
 239                 String reference;\r
 240                 String version;\r
 241                 String moreinfo;\r
 242                 final static String jabaws_version = "2.5";\r
 243                 final static String line_delimiter = "\n";\r
 244 \r
 245                 private ServiceInfo() {\r
 246                         // Default constructor for JAXB\r
 247                 }\r
 248                 private ServiceInfo(Services service, String reference, String version,\r
 249                                 String moreinfo) {\r
 250                         this.service = service;\r
 251                         this.reference = reference;\r
 252                         this.version = version;\r
 253                         this.moreinfo = moreinfo;\r
 254                 }\r
 255 \r
 256                 @Override\r
 257                 public String toString() {\r
 258                         String value = "SERVICE: " + service + " version " + version + line_delimiter;\r
 259                         value += "JABAWS v. " + jabaws_version + line_delimiter;\r
 260                         value += "REFERENCES: " + reference + line_delimiter;\r
 261                         value += "MORE INFORMATION: " + moreinfo + line_delimiter;\r
 262                         return value;\r
 263                 }\r
 264         }\r
 265 \r
 266         public static void main(String[] args) {\r
 267                 System.out.println(MUSCLE_INFO);\r
 268         }\r
 269 }\r