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     SequenceI aln[] = new SequenceI[msf.length];\r
  67     for (int i=0,j=msf.length; i<j;i++)\r
  68       aln[i] = new jalview.datamodel.Sequence(msf[i]);\r
  69     SequenceInfo = jalview.analysis.SeqsetUtils.uniquify(aln, true);\r
  70 \r
  71     if (!locateWebService())\r
  72     {\r
  73       return;\r
  74     }\r
  75 \r
  76     JPredThread jthread = new JPredThread(aln);\r
  77     jthread.start();\r
  78   }\r
  79 \r
  80   public void startJPredClient(String title, SequenceI seq)\r
  81   {\r
  82     if (wsInfo==null)\r
  83       wsInfo = setWebService();\r
  84     wsInfo.setProgressText("Job details for prediction on sequence :\n>" +\r
  85                            seq.getName() + "\n" +\r
  86                            AlignSeq.extractGaps("-. ", seq.getSequence()) +\r
  87                            "\n");\r
  88     altitle = "JNet prediction for sequence " + seq.getName() + " from " +\r
  89         title;\r
  90 \r
  91     SequenceInfo = jalview.analysis.SeqsetUtils.SeqCharacterHash(seq);\r
  92 \r
  93     if (!locateWebService())\r
  94     {\r
  95       return;\r
  96     }\r
  97 \r
  98     JPredThread jthread = new JPredThread(seq);\r
  99     jthread.start();\r
 100   }\r
 101 \r
 102   private WebserviceInfo setWebService()\r
 103   {\r
 104     WebServiceName = "JNetWS";\r
 105     WebServiceJobTitle = "JNet secondary structure prediction";\r
 106     WebServiceReference =\r
 107         "\"Cuff J. A and Barton G.J (1999) Application of enhanced " +\r
 108         "multiple sequence alignment profiles to improve protein secondary structure prediction, " +\r
 109         "Proteins 40:502-511\".";\r
 110     WsURL = "http://www.compbio.dundee.ac.uk/JalviewWS/services/jpred";\r
 111 \r
 112     WebserviceInfo wsInfo = new WebserviceInfo(WebServiceJobTitle,\r
 113                                                WebServiceReference);\r
 114 \r
 115     return wsInfo;\r
 116   }\r
 117 \r
 118   private boolean locateWebService()\r
 119   {\r
 120     ext.vamsas.JpredServiceLocator loc = new JpredServiceLocator(); // Default\r
 121 \r
 122     try\r
 123     {\r
 124       this.server = loc.getjpred(new java.net.URL(WsURL)); // JBPNote will be set from properties\r
 125       ( (JpredSoapBindingStub)this.server).setTimeout(60000); // one minute stub\r
 126     }\r
 127     catch (Exception ex)\r
 128     {\r
 129       JOptionPane.showMessageDialog(Desktop.desktop,\r
 130                                     "The Secondary Structure Prediction Service named " +\r
 131                                     WebServiceName + " at " + WsURL +\r
 132                                     " couldn't be located.",\r
 133                                     "Internal Jalview Error",\r
 134                                     JOptionPane.WARNING_MESSAGE);\r
 135       wsInfo.setProgressText("Serious! " + WebServiceName +\r
 136                              " Service location failed\nfor URL :" + WsURL +\r
 137                              "\n" +\r
 138                              ex.getMessage());\r
 139       wsInfo.setStatus(wsInfo.STATE_STOPPED_SERVERERROR);\r
 140 \r
 141       return false;\r
 142     }\r
 143 \r
 144     return true;\r
 145   }\r
 146 \r
 147   class JPredThread\r
 148       extends Thread\r
 149   {\r
 150     String OutputHeader;\r
 151     vamsas.objects.simple.JpredResult result;\r
 152     vamsas.objects.simple.Sequence sequence;\r
 153     vamsas.objects.simple.Msfalignment msa;\r
 154     String jobId;\r
 155     boolean jobComplete = false;\r
 156     int allowedServerExceptions = 3; // thread dies if too many exceptions.\r
 157 \r
 158     JPredThread(SequenceI seq)\r
 159     {\r
 160       OutputHeader = wsInfo.getProgressText();\r
 161       this.sequence = new vamsas.objects.simple.Sequence();\r
 162       this.sequence.setId(seq.getName());\r
 163       this.sequence.setSeq(AlignSeq.extractGaps("-. ", seq.getSequence()));\r
 164     }\r
 165 \r
 166     JPredThread(SequenceI[] msf)\r
 167     {\r
 168       OutputHeader = wsInfo.getProgressText();\r
 169       this.sequence = new vamsas.objects.simple.Sequence();\r
 170       this.sequence.setId(msf[0].getName());\r
 171       this.sequence.setSeq(AlignSeq.extractGaps("-. ",\r
 172                                                 msf[0].getSequence()));\r
 173 \r
 174       jalview.io.PileUpfile mwrite = new jalview.io.PileUpfile();\r
 175       this.msa = new vamsas.objects.simple.Msfalignment();\r
 176       msa.setMsf(mwrite.print(msf));\r
 177     }\r
 178 \r
 179     public void run()\r
 180     {\r
 181       StartJob();\r
 182 \r
 183       while (!jobComplete && (allowedServerExceptions > 0))\r
 184       {\r
 185         try\r
 186         {\r
 187           if ( (result = server.getresult(jobId)) == null)\r
 188           {\r
 189             throw (new Exception(\r
 190                 "Timed out when communicating with server\nTry again later.\n"));\r
 191           }\r
 192           if (result.getState()==0)\r
 193             jalview.bin.Jalview.log.debug("Finished "+jobId);\r
 194           if (result.isRunning())\r
 195           {\r
 196             wsInfo.setStatus(WebserviceInfo.STATE_RUNNING);\r
 197           }\r
 198           if (result.isQueued())\r
 199           {\r
 200             wsInfo.setStatus(WebserviceInfo.STATE_QUEUING);\r
 201           }\r
 202 \r
 203           wsInfo.setProgressText(OutputHeader + "\n" +\r
 204                                  result.getStatus());\r
 205 \r
 206           if (result.isFinished())\r
 207           {\r
 208 \r
 209             parseResult();\r
 210             jobComplete = true;\r
 211             jobsRunning--;\r
 212           } else {\r
 213             // catch exceptions\r
 214             if (! (result.isJobFailed() || result.isServerError()))\r
 215             {\r
 216               try\r
 217               {\r
 218                 Thread.sleep(5000);\r
 219               }\r
 220               catch (InterruptedException ex1)\r
 221               {\r
 222               }\r
 223 \r
 224               //  System.out.println("I'm alive "+seqid+" "+jobid);\r
 225             }\r
 226             else\r
 227             {\r
 228               wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_ERROR);\r
 229               jobsRunning--;\r
 230               jobComplete = true;\r
 231             }\r
 232           }\r
 233         }\r
 234         catch (Exception ex)\r
 235         {\r
 236           allowedServerExceptions--;\r
 237           wsInfo.appendProgressText("\nJPredWS Server exception!\n" +\r
 238                                     ex.getMessage());\r
 239 \r
 240           try\r
 241           {\r
 242             if (allowedServerExceptions > 0)\r
 243             {\r
 244               Thread.sleep(5000);\r
 245             }\r
 246           }\r
 247           catch (InterruptedException ex1)\r
 248           {\r
 249           }\r
 250         }\r
 251         catch (OutOfMemoryError er)\r
 252         {\r
 253           jobComplete = true;\r
 254           wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_ERROR);\r
 255           JOptionPane.showInternalMessageDialog(Desktop.desktop,\r
 256                                                 "Out of memory handling result!!"\r
 257                                                 +\r
 258               "\nSee help files for increasing Java Virtual Machine memory."\r
 259                                                 , "Out of memory",\r
 260                                                 JOptionPane.WARNING_MESSAGE);\r
 261           System.out.println("JPredClient: "+er);\r
 262         }\r
 263       }\r
 264       if (result!=null)\r
 265         if (! (result.isJobFailed() || result.isServerError()))\r
 266         {\r
 267           wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_OK);\r
 268         }\r
 269         else\r
 270         {\r
 271           wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_ERROR);\r
 272         }\r
 273     }\r
 274 \r
 275     void StartJob()\r
 276     {\r
 277       try\r
 278       {\r
 279         if (msa != null)\r
 280         {\r
 281           jobId = server.predictOnMsa(msa);\r
 282         }\r
 283         else\r
 284         {\r
 285           jobId = server.predict(sequence);\r
 286         }\r
 287 \r
 288         if (jobId != null)\r
 289         {\r
 290           if (jobId.startsWith("Broken"))\r
 291           {\r
 292             throw new Exception("Submission " + jobId);\r
 293           }\r
 294           else\r
 295           {\r
 296             System.out.println(WsURL + " Job Id '" + jobId + "'");\r
 297           }\r
 298         }\r
 299         else\r
 300         {\r
 301           throw new Exception("Server timed out - try again later\n");\r
 302         }\r
 303       }\r
 304       catch (Exception e)\r
 305       {\r
 306         wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_SERVERERROR);\r
 307         allowedServerExceptions = -1;\r
 308         jobComplete = true;\r
 309 \r
 310         wsInfo.setProgressText("Failed to submit the prediction. (Just close the window)\n"\r
 311                                   + ((e.getMessage().indexOf("Exception")>-1) ? (\r
 312                                   "It is most likely that there is a problem with the server.\n")\r
 313                               : e.getMessage())\r
 314                                   +wsInfo.getProgressText());\r
 315         System.err.println(\r
 316             "JPredWS Client: Failed to submit the prediction (Possibly a server error - see below)\n" +\r
 317             e.getMessage() + "\n");\r
 318 \r
 319         jalview.bin.Jalview.log.debug("Failed Submission",e);\r
 320       }\r
 321     }\r
 322 \r
 323 \r
 324 \r
 325     private void addFloatAnnotations(Alignment al, int[] gapmap,\r
 326                                      Vector values, String Symname,\r
 327                                      String Visname, float min,\r
 328                                      float max, int winLength)\r
 329     {\r
 330       Annotation[] annotations = new Annotation[al.getWidth()];\r
 331 \r
 332       for (int j = 0; j < values.size(); j++)\r
 333       {\r
 334         float value = Float.parseFloat(values.get(j).toString());\r
 335         annotations[gapmap[j]] = new Annotation("", value + "", ' ',\r
 336                                                 value);\r
 337       }\r
 338 \r
 339       al.addAnnotation(new AlignmentAnnotation(Symname, Visname,\r
 340                                                annotations, min, max, winLength));\r
 341     }\r
 342 \r
 343     void parseResult()\r
 344     {\r
 345       // OutputHeader = output.getText();\r
 346       if (result.isFailed())\r
 347       {\r
 348         OutputHeader += "Job failed.\n";\r
 349       }\r
 350 \r
 351       if (result.getStatus() != null)\r
 352       {\r
 353         OutputHeader += ("\n" + result.getStatus());\r
 354       }\r
 355 \r
 356       if (result.getPredfile() != null)\r
 357       {\r
 358         OutputHeader += ("\n" + result.getPredfile());\r
 359 \r
 360         // 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
 361       }\r
 362 \r
 363       if (result.getAligfile() != null)\r
 364       {\r
 365         OutputHeader += ("\n" + result.getAligfile());\r
 366       }\r
 367 \r
 368       wsInfo.setProgressText(OutputHeader+"Parsing...");\r
 369 \r
 370       try\r
 371       {\r
 372         jalview.bin.Jalview.log.debug("Parsing output from JNet job.");\r
 373         // JPredFile prediction = new JPredFile("C:/JalviewX/files/jpred.txt", "File");\r
 374         jalview.io.JPredFile prediction = new jalview.io.JPredFile(result.\r
 375             getPredfile(),\r
 376             "Paste");\r
 377         SequenceI[] preds = prediction.getSeqsAsArray();\r
 378         jalview.bin.Jalview.log.debug("Got prediction profile.");\r
 379         Alignment al;\r
 380         int FirstSeq; // the position of the query sequence in Alignment al\r
 381         boolean noMsa = true; // set if no MSA has been returned by JPred\r
 382 \r
 383         if ( (this.msa != null) && (result.getAligfile() != null))\r
 384         {\r
 385           jalview.bin.Jalview.log.debug("Getting associated alignment.");\r
 386           // we ignore the returned alignment if we only predicted on a single sequence\r
 387           String format = jalview.io.IdentifyFile.Identify(result.getAligfile(),\r
 388               "Paste");\r
 389 \r
 390           if (jalview.io.FormatAdapter.formats.contains(format))\r
 391           {\r
 392             al = new Alignment(jalview.io.FormatAdapter.readFile(\r
 393                 result.getAligfile(), "Paste", format));\r
 394             for (int i=0, j=al.getHeight(); i<j; i++) {\r
 395               SequenceI sq = al.getSequenceAt(i);\r
 396               if (!jalview.analysis.SeqsetUtils.SeqCharacterUnhash(\r
 397                   sq, (Hashtable) SequenceInfo.get(sq.getName())))\r
 398               {\r
 399                 throw (new Exception(\r
 400                     "Couldn't recover sequence properties for JNet "\r
 401                     +((i==0) ? "Query sequence" : "alignment sequence ("+i+")")));\r
 402               }\r
 403             }\r
 404             noMsa = false;\r
 405             FirstSeq = 0;\r
 406           }\r
 407           else\r
 408           {\r
 409             throw (new Exception(\r
 410                 "Unknown format 'format' for file : \n" +\r
 411                 result.getAligfile()));\r
 412           }\r
 413         }\r
 414         else\r
 415         {\r
 416           al = new Alignment(preds);\r
 417           FirstSeq = prediction.getQuerySeqPosition();\r
 418           if (!jalview.analysis.SeqsetUtils.SeqCharacterUnhash(\r
 419               al.getSequenceAt(FirstSeq), SequenceInfo))\r
 420           {\r
 421             throw (new Exception(\r
 422                 "Couldn't recover sequence properties for JNet Query sequence!"));\r
 423           }\r
 424         }\r
 425 \r
 426 \r
 427         AlignmentAnnotation annot;\r
 428         Annotation[] annotations = null;\r
 429         int i = 0;\r
 430         int width = preds[0].getSequence().length();\r
 431 \r
 432         int[] gapmap = al.getSequenceAt(FirstSeq).gapMap();\r
 433 \r
 434         if (gapmap.length != width)\r
 435         {\r
 436           throw (new Exception(\r
 437               "Jnet Client Error\nNumber of residues in supposed query sequence :\n" +\r
 438               al.getSequenceAt(FirstSeq).getName() + "\n" +\r
 439               al.getSequenceAt(FirstSeq).getSequence() +\r
 440               "\nDiffer from number of prediction sites in \n" +\r
 441               result.getPredfile() + "\n"));\r
 442         }\r
 443 \r
 444         // JBPNote Should also rename the query sequence sometime...\r
 445         i = 0;\r
 446 \r
 447         while (i < preds.length)\r
 448         {\r
 449           String id = preds[i].getName().toUpperCase();\r
 450 \r
 451           if (id.startsWith("LUPAS") || id.startsWith("JNET") ||\r
 452               id.startsWith("JPRED"))\r
 453           {\r
 454             annotations = new Annotation[al.getWidth()];\r
 455 \r
 456             if (id.equals("JNETPRED") || id.equals("JNETPSSM") ||\r
 457                 id.equals("JNETFREQ") || id.equals("JNETHMM") ||\r
 458                 id.equals("JNETALIGN") || id.equals("JPRED"))\r
 459             {\r
 460               for (int j = 0; j < width; j++)\r
 461               {\r
 462                 annotations[gapmap[j]] = new Annotation("", "",\r
 463                     preds[i].getCharAt(j), 0);\r
 464               }\r
 465             }\r
 466             else if (id.equals("JNETCONF"))\r
 467             {\r
 468               for (int j = 0; j < width; j++)\r
 469               {\r
 470                 float value = Float.parseFloat(preds[i].getCharAt(\r
 471                     j) + "");\r
 472                 annotations[gapmap[j]] = new Annotation(preds[i].getCharAt(\r
 473                     j) + "", "", preds[i].getCharAt(j),\r
 474                     value);\r
 475               }\r
 476             }\r
 477             else\r
 478             {\r
 479               for (int j = 0; j < width; j++)\r
 480               {\r
 481                 annotations[gapmap[j]] = new Annotation(preds[i].getCharAt(\r
 482                     j) + "", "", ' ', 0);\r
 483               }\r
 484             }\r
 485 \r
 486             if (id.equals("JNETCONF"))\r
 487             {\r
 488               annot = new AlignmentAnnotation(preds[i].getName(),\r
 489                                               "JNet Output", annotations, 0f,\r
 490                                               10f, 1);\r
 491             }\r
 492             else\r
 493             {\r
 494               annot = new AlignmentAnnotation(preds[i].getName(),\r
 495                                               "JNet Output", annotations);\r
 496             }\r
 497 \r
 498             al.addAnnotation(annot);\r
 499 \r
 500             if (noMsa)\r
 501             {\r
 502               al.deleteSequence(preds[i]);\r
 503             }\r
 504           }\r
 505 \r
 506           i++;\r
 507         }\r
 508 \r
 509         Hashtable scores = prediction.getScores();\r
 510 \r
 511         /*  addFloatAnnotations(al, gapmap,  (Vector)scores.get("JNETPROPH"),\r
 512                               "JnetpropH", "Jnet Helix Propensity", 0f,1f,1);\r
 513 \r
 514           addFloatAnnotations(al, gapmap,  (Vector)scores.get("JNETPROPB"),\r
 515          "JnetpropB", "Jnet Beta Sheet Propensity", 0f,1f,1);\r
 516 \r
 517           addFloatAnnotations(al, gapmap,  (Vector)scores.get("JNETPROPC"),\r
 518                               "JnetpropC", "Jnet Coil Propensity", 0f,1f,1);\r
 519          */\r
 520 \r
 521         wsInfo.setProgressText(OutputHeader);\r
 522         jalview.bin.Jalview.log.debug("Finished parsing output.");\r
 523         AlignFrame af = new AlignFrame(al);\r
 524 \r
 525         Desktop.addInternalFrame(af, altitle,\r
 526                                  AlignFrame.NEW_WINDOW_WIDTH,\r
 527                                  AlignFrame.NEW_WINDOW_HEIGHT);\r
 528       }\r
 529       catch (Exception ex)\r
 530       {\r
 531         jalview.bin.Jalview.log.warn("Exception whilst parsing JNet style secondary structure prediction.");\r
 532         jalview.bin.Jalview.log.debug("Exception: ",ex);\r
 533       }\r
 534     }\r
 535   }\r
 536 }\r