src/jalview/ws/JPredClient.java

   1 /*\r
   2  * Jalview - A Sequence Alignment Editor and Viewer\r
   3  * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
   4  *\r
   5  * This program is free software; you can redistribute it and/or\r
   6  * modify it under the terms of the GNU General Public License\r
   7  * as published by the Free Software Foundation; either version 2\r
   8  * of the License, or (at your option) any later version.\r
   9  *\r
  10  * This program is distributed in the hope that it will be useful,\r
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  13  * GNU General Public License for more details.\r
  14  *\r
  15  * You should have received a copy of the GNU General Public License\r
  16  * along with this program; if not, write to the Free Software\r
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
  18  */\r
  19 package jalview.ws;\r
  20 \r
  21 import java.util.*;\r
  22 \r
  23 import javax.swing.*;\r
  24 \r
  25 import ext.vamsas.*;\r
  26 import jalview.analysis.*;\r
  27 import jalview.datamodel.*;\r
  28 import jalview.gui.*;\r
  29 \r
  30 public class JPredClient\r
  31     extends WSClient\r
  32 {\r
  33   ext.vamsas.Jpred server;\r
  34   String altitle = "";\r
  35   java.util.Hashtable SequenceInfo = null;\r
  36   public JPredClient(ext.vamsas.ServiceHandle sh, String title, SequenceI seq) {\r
  37     wsInfo = setWebService(sh);\r
  38     startJPredClient(title, seq);\r
  39   }\r
  40   public JPredClient(ext.vamsas.ServiceHandle sh, String title, SequenceI[] msa) {\r
  41     wsInfo = setWebService(sh);\r
  42     startJPredClient(title, msa);\r
  43   }\r
  44 \r
  45   public JPredClient(String title, SequenceI[] msf) {\r
  46     startJPredClient(title, msf);\r
  47   }\r
  48 \r
  49   public JPredClient(String title, SequenceI seq) {\r
  50     startJPredClient(title, seq);\r
  51   }\r
  52 \r
  53   private void startJPredClient(String title, SequenceI[] msf)\r
  54   {\r
  55     if (wsInfo==null)\r
  56       wsInfo = setWebService();\r
  57 \r
  58     SequenceI seq = msf[0];\r
  59     altitle = "JNet prediction on " + seq.getName() +\r
  60         " using alignment from " + title;\r
  61 \r
  62     wsInfo.setProgressText("Job details for MSA based prediction (" +\r
  63                            title + ") on sequence :\n>" + seq.getName() + "\n" +\r
  64                            AlignSeq.extractGaps("-. ", seq.getSequence()) +\r
  65                            "\n");\r
  66 \r
  67     SequenceInfo = jalview.analysis.SeqsetUtils.SeqCharacterHash(seq);\r
  68 \r
  69     if (!locateWebService())\r
  70     {\r
  71       return;\r
  72     }\r
  73 \r
  74     JPredThread jthread = new JPredThread(msf);\r
  75     jthread.start();\r
  76   }\r
  77 \r
  78   public void startJPredClient(String title, SequenceI seq)\r
  79   {\r
  80     if (wsInfo==null)\r
  81       wsInfo = setWebService();\r
  82     wsInfo.setProgressText("Job details for prediction on sequence :\n>" +\r
  83                            seq.getName() + "\n" +\r
  84                            AlignSeq.extractGaps("-. ", seq.getSequence()) +\r
  85                            "\n");\r
  86     altitle = "JNet prediction for sequence " + seq.getName() + " from " +\r
  87         title;\r
  88 \r
  89     SequenceInfo = jalview.analysis.SeqsetUtils.SeqCharacterHash(seq);\r
  90 \r
  91     if (!locateWebService())\r
  92     {\r
  93       return;\r
  94     }\r
  95 \r
  96     JPredThread jthread = new JPredThread(seq);\r
  97     jthread.start();\r
  98   }\r
  99 \r
 100   private WebserviceInfo setWebService()\r
 101   {\r
 102     WebServiceName = "JNetWS";\r
 103     WebServiceJobTitle = "JNet secondary structure prediction";\r
 104     WebServiceReference =\r
 105         "\"Cuff J. A and Barton G.J (1999) Application of enhanced " +\r
 106         "multiple sequence alignment profiles to improve protein secondary structure prediction, " +\r
 107         "Proteins 40:502-511\".";\r
 108     WsURL = "http://www.compbio.dundee.ac.uk/JalviewWS/services/jpred";\r
 109 \r
 110     WebserviceInfo wsInfo = new WebserviceInfo(WebServiceJobTitle,\r
 111                                                WebServiceReference);\r
 112 \r
 113     return wsInfo;\r
 114   }\r
 115 \r
 116   private boolean locateWebService()\r
 117   {\r
 118     ext.vamsas.JpredServiceLocator loc = new JpredServiceLocator(); // Default\r
 119 \r
 120     try\r
 121     {\r
 122       this.server = loc.getjpred(new java.net.URL(WsURL)); // JBPNote will be set from properties\r
 123       ( (JpredSoapBindingStub)this.server).setTimeout(60000); // one minute stub\r
 124     }\r
 125     catch (Exception ex)\r
 126     {\r
 127       JOptionPane.showMessageDialog(Desktop.desktop,\r
 128                                     "The Secondary Structure Prediction Service named " +\r
 129                                     WebServiceName + " at " + WsURL +\r
 130                                     " couldn't be located.",\r
 131                                     "Internal Jalview Error",\r
 132                                     JOptionPane.WARNING_MESSAGE);\r
 133       wsInfo.setProgressText("Serious! " + WebServiceName +\r
 134                              " Service location failed\nfor URL :" + WsURL +\r
 135                              "\n" +\r
 136                              ex.getMessage());\r
 137       wsInfo.setStatus(wsInfo.STATE_STOPPED_SERVERERROR);\r
 138 \r
 139       return false;\r
 140     }\r
 141 \r
 142     return true;\r
 143   }\r
 144 \r
 145   class JPredThread\r
 146       extends Thread\r
 147   {\r
 148     String OutputHeader;\r
 149     vamsas.objects.simple.JpredResult result;\r
 150     vamsas.objects.simple.Sequence sequence;\r
 151     vamsas.objects.simple.Msfalignment msa;\r
 152     String jobId;\r
 153     boolean jobComplete = false;\r
 154     int allowedServerExceptions = 3; // thread dies if too many exceptions.\r
 155 \r
 156     JPredThread(SequenceI seq)\r
 157     {\r
 158       OutputHeader = wsInfo.getProgressText();\r
 159       this.sequence = new vamsas.objects.simple.Sequence();\r
 160       this.sequence.setId(seq.getName());\r
 161       this.sequence.setSeq(AlignSeq.extractGaps("-. ", seq.getSequence()));\r
 162     }\r
 163 \r
 164     JPredThread(SequenceI[] msf)\r
 165     {\r
 166       OutputHeader = wsInfo.getProgressText();\r
 167       this.sequence = new vamsas.objects.simple.Sequence();\r
 168       this.sequence.setId(msf[0].getName());\r
 169       this.sequence.setSeq(AlignSeq.extractGaps("-. ",\r
 170                                                 msf[0].getSequence()));\r
 171 \r
 172       jalview.io.PileUpfile mwrite = new jalview.io.PileUpfile();\r
 173       this.msa = new vamsas.objects.simple.Msfalignment();\r
 174       msa.setMsf(mwrite.print(msf));\r
 175     }\r
 176 \r
 177     public void run()\r
 178     {\r
 179       StartJob();\r
 180 \r
 181       while (!jobComplete && (allowedServerExceptions > 0))\r
 182       {\r
 183         try\r
 184         {\r
 185           if ( (result = server.getresult(jobId)) == null)\r
 186           {\r
 187             throw (new Exception(\r
 188                 "Timed out when communicating with server\nTry again later.\n"));\r
 189           }\r
 190           if (result.getState()==0)\r
 191             jalview.bin.Jalview.log.debug("Finished "+jobId);\r
 192           if (result.isRunning())\r
 193           {\r
 194             wsInfo.setStatus(WebserviceInfo.STATE_RUNNING);\r
 195           }\r
 196           if (result.isQueued())\r
 197           {\r
 198             wsInfo.setStatus(WebserviceInfo.STATE_QUEUING);\r
 199           }\r
 200 \r
 201           wsInfo.setProgressText(OutputHeader + "\n" +\r
 202                                  result.getStatus());\r
 203 \r
 204           if (result.isFinished())\r
 205           {\r
 206 \r
 207             parseResult();\r
 208             jobComplete = true;\r
 209             jobsRunning--;\r
 210           } else {\r
 211             // catch exceptions\r
 212             if (! (result.isJobFailed() || result.isServerError()))\r
 213             {\r
 214               try\r
 215               {\r
 216                 Thread.sleep(5000);\r
 217               }\r
 218               catch (InterruptedException ex1)\r
 219               {\r
 220               }\r
 221 \r
 222               //  System.out.println("I'm alive "+seqid+" "+jobid);\r
 223             }\r
 224             else\r
 225             {\r
 226               wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_ERROR);\r
 227               jobsRunning--;\r
 228               jobComplete = true;\r
 229             }\r
 230           }\r
 231         }\r
 232         catch (Exception ex)\r
 233         {\r
 234           allowedServerExceptions--;\r
 235           wsInfo.appendProgressText("\nJPredWS Server exception!\n" +\r
 236                                     ex.getMessage());\r
 237 \r
 238           try\r
 239           {\r
 240             if (allowedServerExceptions > 0)\r
 241             {\r
 242               Thread.sleep(5000);\r
 243             }\r
 244           }\r
 245           catch (InterruptedException ex1)\r
 246           {\r
 247           }\r
 248         }\r
 249       }\r
 250 \r
 251       if (! (result.isJobFailed() || result.isServerError()))\r
 252       {\r
 253         wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_OK);\r
 254       }\r
 255       else\r
 256       {\r
 257         wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_ERROR);\r
 258       }\r
 259     }\r
 260 \r
 261     void StartJob()\r
 262     {\r
 263       try\r
 264       {\r
 265         if (msa != null)\r
 266         {\r
 267           jobId = server.predictOnMsa(msa);\r
 268         }\r
 269         else\r
 270         {\r
 271           jobId = server.predict(sequence);\r
 272         }\r
 273 \r
 274         if (jobId != null)\r
 275         {\r
 276           if (jobId.startsWith("Broken"))\r
 277           {\r
 278             throw new Exception("Submission " + jobId);\r
 279           }\r
 280           else\r
 281           {\r
 282             System.out.println(WsURL + " Job Id '" + jobId + "'");\r
 283           }\r
 284         }\r
 285         else\r
 286         {\r
 287           throw new Exception("Server timed out - try again later\n");\r
 288         }\r
 289       }\r
 290       catch (Exception e)\r
 291       {\r
 292         wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_SERVERERROR);\r
 293         allowedServerExceptions = 0;\r
 294         jobComplete = false;\r
 295 \r
 296         wsInfo.appendProgressText("Failed to submit the prediction.\n"\r
 297                                   +\r
 298                                   "It is most likely that there is a problem with the server.\n"\r
 299                                   + "Just close the window\n");\r
 300         System.err.println(\r
 301             "JPredWS Client: Failed to submit the prediction (Probably a server error - see below)\n" +\r
 302             e.toString() + "\n");\r
 303 \r
 304         jalview.bin.Jalview.log.debug("Failed Submission",e);\r
 305       }\r
 306     }\r
 307 \r
 308 \r
 309 \r
 310     private void addFloatAnnotations(Alignment al, int[] gapmap,\r
 311                                      Vector values, String Symname,\r
 312                                      String Visname, float min,\r
 313                                      float max, int winLength)\r
 314     {\r
 315       Annotation[] annotations = new Annotation[al.getWidth()];\r
 316 \r
 317       for (int j = 0; j < values.size(); j++)\r
 318       {\r
 319         float value = Float.parseFloat(values.get(j).toString());\r
 320         annotations[gapmap[j]] = new Annotation("", value + "", ' ',\r
 321                                                 value);\r
 322       }\r
 323 \r
 324       al.addAnnotation(new AlignmentAnnotation(Symname, Visname,\r
 325                                                annotations, min, max, winLength));\r
 326     }\r
 327 \r
 328     void parseResult()\r
 329     {\r
 330       // OutputHeader = output.getText();\r
 331       if (result.isFailed())\r
 332       {\r
 333         OutputHeader += "Job failed.\n";\r
 334       }\r
 335 \r
 336       if (result.getStatus() != null)\r
 337       {\r
 338         OutputHeader += ("\n" + result.getStatus());\r
 339       }\r
 340 \r
 341       if (result.getPredfile() != null)\r
 342       {\r
 343         OutputHeader += ("\n" + result.getPredfile());\r
 344 \r
 345         // JBPNote The returned files from a webservice could be hidden behind icons in the monitor window that, when clicked, pop up their corresponding data\r
 346       }\r
 347 \r
 348       if (result.getAligfile() != null)\r
 349       {\r
 350         OutputHeader += ("\n" + result.getAligfile());\r
 351       }\r
 352 \r
 353       wsInfo.setProgressText(OutputHeader);\r
 354 \r
 355       try\r
 356       {\r
 357         // JPredFile prediction = new JPredFile("C:/JalviewX/files/jpred.txt", "File");\r
 358         jalview.io.JPredFile prediction = new jalview.io.JPredFile(result.\r
 359             getPredfile(),\r
 360             "Paste");\r
 361         SequenceI[] preds = prediction.getSeqsAsArray();\r
 362         Alignment al;\r
 363         int FirstSeq; // the position of the query sequence in Alignment al\r
 364         boolean noMsa = true; // set if no MSA has been returned by JPred\r
 365 \r
 366         if ( (this.msa != null) && (result.getAligfile() != null))\r
 367         {\r
 368           // we ignore the returned alignment if we only predicted on a single sequence\r
 369           String format = jalview.io.IdentifyFile.Identify(result.getAligfile(),\r
 370               "Paste");\r
 371 \r
 372           if (jalview.io.FormatAdapter.formats.contains(format))\r
 373           {\r
 374             al = new Alignment(jalview.io.FormatAdapter.readFile(\r
 375                 result.getAligfile(), "Paste", format));\r
 376             noMsa = false;\r
 377             FirstSeq = 0;\r
 378           }\r
 379           else\r
 380           {\r
 381             throw (new Exception(\r
 382                 "Unknown format 'format' for file : \n" +\r
 383                 result.getAligfile()));\r
 384           }\r
 385         }\r
 386         else\r
 387         {\r
 388           al = new Alignment(preds);\r
 389           FirstSeq = prediction.getQuerySeqPosition();\r
 390         }\r
 391 \r
 392         if (!jalview.analysis.SeqsetUtils.SeqCharacterUnhash(\r
 393             al.getSequenceAt(FirstSeq), SequenceInfo))\r
 394         {\r
 395           throw (new Exception(\r
 396               "Couldn't recover sequence properties for JNet Query sequence!"));\r
 397         }\r
 398 \r
 399         AlignmentAnnotation annot;\r
 400         Annotation[] annotations = null;\r
 401         int i = 0;\r
 402         int width = preds[0].getSequence().length();\r
 403 \r
 404         int[] gapmap = al.getSequenceAt(FirstSeq).gapMap();\r
 405 \r
 406         if (gapmap.length != width)\r
 407         {\r
 408           throw (new Exception(\r
 409               "Jnet Client Error\nNumber of residues in supposed query sequence :\n" +\r
 410               al.getSequenceAt(FirstSeq).getName() + "\n" +\r
 411               al.getSequenceAt(FirstSeq).getSequence() +\r
 412               "\nDiffer from number of prediction sites in \n" +\r
 413               result.getPredfile() + "\n"));\r
 414         }\r
 415 \r
 416         // JBPNote Should also rename the query sequence sometime...\r
 417         i = 0;\r
 418 \r
 419         while (i < preds.length)\r
 420         {\r
 421           String id = preds[i].getName().toUpperCase();\r
 422 \r
 423           if (id.startsWith("LUPAS") || id.startsWith("JNET") ||\r
 424               id.startsWith("JPRED"))\r
 425           {\r
 426             annotations = new Annotation[al.getWidth()];\r
 427 \r
 428             if (id.equals("JNETPRED") || id.equals("JNETPSSM") ||\r
 429                 id.equals("JNETFREQ") || id.equals("JNETHMM") ||\r
 430                 id.equals("JNETALIGN") || id.equals("JPRED"))\r
 431             {\r
 432               for (int j = 0; j < width; j++)\r
 433               {\r
 434                 annotations[gapmap[j]] = new Annotation("", "",\r
 435                     preds[i].getCharAt(j), 0);\r
 436               }\r
 437             }\r
 438             else if (id.equals("JNETCONF"))\r
 439             {\r
 440               for (int j = 0; j < width; j++)\r
 441               {\r
 442                 float value = Float.parseFloat(preds[i].getCharAt(\r
 443                     j) + "");\r
 444                 annotations[gapmap[j]] = new Annotation(preds[i].getCharAt(\r
 445                     j) + "", "", preds[i].getCharAt(j),\r
 446                     value);\r
 447               }\r
 448             }\r
 449             else\r
 450             {\r
 451               for (int j = 0; j < width; j++)\r
 452               {\r
 453                 annotations[gapmap[j]] = new Annotation(preds[i].getCharAt(\r
 454                     j) + "", "", ' ', 0);\r
 455               }\r
 456             }\r
 457 \r
 458             if (id.equals("JNETCONF"))\r
 459             {\r
 460               annot = new AlignmentAnnotation(preds[i].getName(),\r
 461                                               "JNet Output", annotations, 0f,\r
 462                                               10f, 1);\r
 463             }\r
 464             else\r
 465             {\r
 466               annot = new AlignmentAnnotation(preds[i].getName(),\r
 467                                               "JNet Output", annotations);\r
 468             }\r
 469 \r
 470             al.addAnnotation(annot);\r
 471 \r
 472             if (noMsa)\r
 473             {\r
 474               al.deleteSequence(preds[i]);\r
 475             }\r
 476           }\r
 477 \r
 478           i++;\r
 479         }\r
 480 \r
 481         Hashtable scores = prediction.getScores();\r
 482 \r
 483         /*  addFloatAnnotations(al, gapmap,  (Vector)scores.get("JNETPROPH"),\r
 484                               "JnetpropH", "Jnet Helix Propensity", 0f,1f,1);\r
 485 \r
 486           addFloatAnnotations(al, gapmap,  (Vector)scores.get("JNETPROPB"),\r
 487          "JnetpropB", "Jnet Beta Sheet Propensity", 0f,1f,1);\r
 488 \r
 489           addFloatAnnotations(al, gapmap,  (Vector)scores.get("JNETPROPC"),\r
 490                               "JnetpropC", "Jnet Coil Propensity", 0f,1f,1);\r
 491          */\r
 492         AlignFrame af = new AlignFrame(al);\r
 493 \r
 494         Desktop.addInternalFrame(af, altitle,\r
 495                                  AlignFrame.NEW_WINDOW_WIDTH,\r
 496                                  AlignFrame.NEW_WINDOW_HEIGHT);\r
 497       }\r
 498       catch (Exception ex)\r
 499       {\r
 500         jalview.bin.Jalview.log.warn("Exception whilst parsing JNet style secondary structure prediction.");\r
 501         jalview.bin.Jalview.log.debug(ex);\r
 502       }\r
 503     }\r
 504   }\r
 505 }\r