src/jalview/ws/jws1/JPredThread.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
   3  * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18 package jalview.ws.jws1;
  19
  20 import java.util.*;
  21
  22 import jalview.analysis.*;
  23 import jalview.bin.*;
  24 import jalview.datamodel.*;
  25 import jalview.gui.*;
  26 import jalview.io.*;
  27 import jalview.util.*;
  28 import jalview.ws.AWsJob;
  29 import jalview.ws.JobStateSummary;
  30 import jalview.ws.WSClientI;
  31 import vamsas.objects.simple.JpredResult;
  32
  33 class JPredThread extends JWS1Thread implements WSClientI
  34 {
  35   // TODO: put mapping between JPredJob input and input data here -
  36   // JNetAnnotation adding is done after result parsing.
  37   class JPredJob extends WSJob
  38   {
  39     // TODO: make JPredJob deal only with what was sent to and received from a
  40     // JNet service
  41     int[] predMap = null; // mapping from sequence(i) to the original
  42
  43     // sequence(predMap[i]) being predicted on
  44
  45     vamsas.objects.simple.Sequence sequence;
  46
  47     vamsas.objects.simple.Msfalignment msa;
  48
  49     java.util.Hashtable SequenceInfo = null;
  50
  51     int msaIndex = 0; // the position of the original sequence in the array of
  52
  53     // Sequences in the input object that this job holds a
  54     // prediction for
  55
  56     /**
  57      *
  58      * @return true if getResultSet will return a valid alignment and prediction
  59      *         result.
  60      */
  61     public boolean hasResults()
  62     {
  63       if (subjobComplete && result != null && result.isFinished()
  64               && ((JpredResult) result).getPredfile() != null
  65               && ((JpredResult) result).getAligfile() != null)
  66       {
  67         return true;
  68       }
  69       return false;
  70     }
  71
  72     public boolean hasValidInput()
  73     {
  74       if (sequence != null)
  75       {
  76         return true;
  77       }
  78       return false;
  79     }
  80
  81     /**
  82      *
  83      * @return null or Object[] { annotated alignment for this prediction,
  84      *         ColumnSelection for this prediction} or null if no results
  85      *         available.
  86      * @throws Exception
  87      */
  88     public Object[] getResultSet() throws Exception
  89     {
  90       if (result == null || !result.isFinished())
  91       {
  92         return null;
  93       }
  94       Alignment al = null;
  95       ColumnSelection alcsel = null;
  96       int FirstSeq = -1; // the position of the query sequence in Alignment al
  97
  98       JpredResult result = (JpredResult) this.result;
  99
 100       jalview.bin.Cache.log.debug("Parsing output from JNet job.");
 101       // JPredFile prediction = new JPredFile("C:/JalviewX/files/jpred.txt",
 102       // "File");
 103       jalview.io.JPredFile prediction = new jalview.io.JPredFile(
 104               result.getPredfile(), "Paste");
 105       SequenceI[] preds = prediction.getSeqsAsArray();
 106       jalview.bin.Cache.log.debug("Got prediction profile.");
 107
 108       if ((this.msa != null) && (result.getAligfile() != null))
 109       {
 110         jalview.bin.Cache.log.debug("Getting associated alignment.");
 111         // we ignore the returned alignment if we only predicted on a single
 112         // sequence
 113         String format = new jalview.io.IdentifyFile().Identify(
 114                 result.getAligfile(), "Paste");
 115
 116         if (jalview.io.FormatAdapter.isValidFormat(format))
 117         {
 118           SequenceI sqs[];
 119           if (predMap != null)
 120           {
 121             Object[] alandcolsel = input
 122                     .getAlignmentAndColumnSelection(getGapChar());
 123             sqs = (SequenceI[]) alandcolsel[0];
 124             al = new Alignment(sqs);
 125             alcsel = (ColumnSelection) alandcolsel[1];
 126           }
 127           else
 128           {
 129             al = new FormatAdapter().readFile(result.getAligfile(),
 130                     "Paste", format);
 131             sqs = new SequenceI[al.getHeight()];
 132
 133             for (int i = 0, j = al.getHeight(); i < j; i++)
 134             {
 135               sqs[i] = al.getSequenceAt(i);
 136             }
 137             if (!jalview.analysis.SeqsetUtils.deuniquify(
 138                     (Hashtable) SequenceInfo, sqs))
 139             {
 140               throw (new Exception(
 141                       "Couldn't recover sequence properties for alignment."));
 142             }
 143           }
 144           FirstSeq = 0;
 145           al.setDataset(null);
 146
 147           jalview.io.JnetAnnotationMaker.add_annotation(prediction, al,
 148                   FirstSeq, false, predMap);
 149
 150         }
 151         else
 152         {
 153           throw (new Exception("Unknown format " + format
 154                   + " for file : \n" + result.getAligfile()));
 155         }
 156       }
 157       else
 158       {
 159         al = new Alignment(preds);
 160         FirstSeq = prediction.getQuerySeqPosition();
 161         if (predMap != null)
 162         {
 163           char gc = getGapChar();
 164           SequenceI[] sqs = (SequenceI[]) ((java.lang.Object[]) input
 165                   .getAlignmentAndColumnSelection(gc))[0];
 166           if (this.msaIndex >= sqs.length)
 167           {
 168             throw new Error(
 169                     "Implementation Error! Invalid msaIndex for JPredJob on parent MSA input object!");
 170           }
 171
 172           // ///
 173           // Uses RemoveGapsCommand
 174           // ///
 175           new jalview.commands.RemoveGapsCommand("Remove Gaps",
 176                   new SequenceI[]
 177                   { sqs[msaIndex] }, currentView);
 178
 179           SequenceI profileseq = al.getSequenceAt(FirstSeq);
 180           profileseq.setSequence(sqs[msaIndex].getSequenceAsString());
 181         }
 182
 183         if (!jalview.analysis.SeqsetUtils.SeqCharacterUnhash(
 184                 al.getSequenceAt(FirstSeq), SequenceInfo))
 185         {
 186           throw (new Exception(
 187                   "Couldn't recover sequence properties for JNet Query sequence!"));
 188         }
 189         else
 190         {
 191           al.setDataset(null);
 192           jalview.io.JnetAnnotationMaker.add_annotation(prediction, al,
 193                   FirstSeq, true, predMap);
 194           SequenceI profileseq = al.getSequenceAt(0); // this includes any gaps.
 195           alignToProfileSeq(al, profileseq);
 196           if (predMap != null)
 197           {
 198             // Adjust input view for gaps
 199             // propagate insertions into profile
 200             alcsel = ColumnSelection.propagateInsertions(profileseq, al, input);
 201           }
 202         }
 203       }
 204       return new Object[]
 205       { al, alcsel }; // , FirstSeq, noMsa};
 206     }
 207
 208     /**
 209      * Given an alignment where all other sequences except profileseq are
 210      * aligned to the ungapped profileseq, insert gaps in the other sequences to
 211      * realign them with the residues in profileseq
 212      *
 213      * @param al
 214      * @param profileseq
 215      */
 216     private void alignToProfileSeq(Alignment al, SequenceI profileseq)
 217     {
 218       char gc = al.getGapCharacter();
 219       int[] gapMap = profileseq.gapMap();
 220       // insert gaps into profile
 221       for (int lp = 0, r = 0; r < gapMap.length; r++)
 222       {
 223         if (gapMap[r] - lp > 1)
 224         {
 225           StringBuffer sb = new StringBuffer();
 226           for (int s = 0, ns = gapMap[r] - lp; s < ns; s++)
 227           {
 228             sb.append(gc);
 229           }
 230           for (int s = 1, ns = al.getHeight(); s < ns; s++)
 231           {
 232             String sq = al.getSequenceAt(s).getSequenceAsString();
 233             int diff = gapMap[r] - sq.length();
 234             if (diff > 0)
 235             {
 236               // pad gaps
 237               sq = sq + sb;
 238               while ((diff = gapMap[r] - sq.length()) > 0)
 239               {
 240                 sq = sq
 241                         + ((diff >= sb.length()) ? sb.toString() : sb
 242                                 .substring(0, diff));
 243               }
 244               al.getSequenceAt(s).setSequence(sq);
 245             }
 246             else
 247             {
 248               al.getSequenceAt(s).setSequence(
 249                       sq.substring(0, gapMap[r]) + sb.toString()
 250                               + sq.substring(gapMap[r]));
 251             }
 252           }
 253         }
 254         lp = gapMap[r];
 255       }
 256     }
 257
 258
 259     public JPredJob(Hashtable SequenceInfo, SequenceI seq, int[] delMap)
 260     {
 261       super();
 262       this.predMap = delMap;
 263       String sq = AlignSeq.extractGaps(Comparison.GapChars,
 264               seq.getSequenceAsString());
 265       if (sq.length() >= 20)
 266       {
 267         this.SequenceInfo = SequenceInfo;
 268         sequence = new vamsas.objects.simple.Sequence();
 269         sequence.setId(seq.getName());
 270         sequence.setSeq(sq);
 271       } else {
 272         errorMessage = "Sequence is too short to predict with JPred - need at least 20 amino acids.";
 273       }
 274     }
 275
 276     public JPredJob(Hashtable SequenceInfo, SequenceI[] msf, int[] delMap)
 277     {
 278       this(SequenceInfo, msf[0], delMap);
 279       if (sequence != null)
 280       {
 281         if (msf.length > 1)
 282         {
 283           msa = new vamsas.objects.simple.Msfalignment();
 284           jalview.io.PileUpfile pileup = new jalview.io.PileUpfile();
 285           msa.setMsf(pileup.print(msf));
 286         }
 287       }
 288     }
 289     String errorMessage="";
 290     public String getValidationMessages()
 291     {
 292       return errorMessage+"\n";
 293     }
 294   }
 295
 296   ext.vamsas.Jpred server;
 297
 298   String altitle = "";
 299
 300   JPredThread(WebserviceInfo wsinfo, String altitle,
 301           ext.vamsas.Jpred server, String wsurl, AlignmentView alview,
 302           AlignFrame alframe)
 303   {
 304     super(alframe, wsinfo, alview, wsurl);
 305     this.altitle = altitle;
 306     this.server = server;
 307   }
 308
 309   JPredThread(WebserviceInfo wsinfo, String altitle,
 310           ext.vamsas.Jpred server, String wsurl, Hashtable SequenceInfo,
 311           SequenceI seq, int[] delMap, AlignmentView alview,
 312           AlignFrame alframe)
 313   {
 314     this(wsinfo, altitle, server, wsurl, alview, alframe);
 315     JPredJob job = new JPredJob(SequenceInfo, seq, delMap);
 316     if (job.hasValidInput())
 317     {
 318       OutputHeader = wsInfo.getProgressText();
 319       jobs = new WSJob[]
 320       { job };
 321       job.setJobnum(0);
 322     } else {
 323       wsInfo.appendProgressText(job.getValidationMessages());
 324     }
 325   }
 326
 327   JPredThread(WebserviceInfo wsinfo, String altitle,
 328           ext.vamsas.Jpred server, Hashtable SequenceInfo, SequenceI[] msf,
 329           int[] delMap, AlignmentView alview, AlignFrame alframe,
 330           String wsurl)
 331   {
 332     this(wsinfo, altitle, server, wsurl, alview, alframe);
 333     JPredJob job = new JPredJob(SequenceInfo, msf, delMap);
 334     if (job.hasValidInput())
 335     {
 336       jobs = new WSJob[]
 337       { job };
 338       OutputHeader = wsInfo.getProgressText();
 339       job.setJobnum(0);
 340     } else {
 341       wsInfo.appendProgressText(job.getValidationMessages());
 342     }
 343   }
 344
 345   public void StartJob(AWsJob j)
 346   {
 347     if (!(j instanceof JPredJob))
 348     {
 349       throw new Error(
 350               "Implementation error - StartJob(JpredJob) called on "
 351                       + j.getClass());
 352     }
 353     try
 354     {
 355       JPredJob job = (JPredJob) j;
 356       if (job.msa != null)
 357       {
 358         job.setJobId(server.predictOnMsa(job.msa));
 359       }
 360       else if (job.sequence != null)
 361       {
 362         job.setJobId(server.predict(job.sequence)); // debug like : job.jobId =
 363         // "/jobs/www-jpred/jp_Yatat29";//
 364       }
 365
 366       if (job.getJobId() != null)
 367       {
 368         if (job.getJobId().startsWith("Broken"))
 369         {
 370           job.result = (vamsas.objects.simple.Result) new JpredResult();
 371           job.result.setInvalid(true);
 372           job.result.setStatus("Submission " + job.getJobId());
 373           throw new Exception(job.getJobId());
 374         }
 375         else
 376         {
 377           job.setSubmitted(true);
 378           job.setSubjobComplete(false);
 379           Cache.log.info(WsUrl + " Job Id '" + job.getJobId() + "'");
 380         }
 381       }
 382       else
 383       {
 384         throw new Exception("Server timed out - try again later\n");
 385       }
 386     } catch (Exception e)
 387     {
 388       // kill the whole job.
 389       wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_SERVERERROR);
 390       if (e.getMessage().indexOf("Exception") > -1)
 391       {
 392         wsInfo.setStatus(j.getJobnum(),
 393                 WebserviceInfo.STATE_STOPPED_SERVERERROR);
 394         wsInfo.setProgressText(
 395                 j.getJobnum(),
 396                 "Failed to submit the prediction. (Just close the window)\n"
 397                         + "It is most likely that there is a problem with the server.\n");
 398         System.err
 399                 .println("JPredWS Client: Failed to submit the prediction. Quite possibly because of a server error - see below)\n"
 400                         + e.getMessage() + "\n");
 401
 402         jalview.bin.Cache.log.warn("Server Exception", e);
 403       }
 404       else
 405       {
 406         wsInfo.setStatus(j.getJobnum(), WebserviceInfo.STATE_STOPPED_ERROR);
 407         // JBPNote - this could be a popup informing the user of the problem.
 408         wsInfo.appendProgressText(j.getJobnum(),
 409                 "Failed to submit the prediction:\n" + e.getMessage()
 410                         + wsInfo.getProgressText());
 411
 412         jalview.bin.Cache.log.debug(
 413                 "Failed Submission of job " + j.getJobnum(), e);
 414
 415       }
 416       j.setAllowedServerExceptions(-1);
 417       j.setSubjobComplete(true);
 418     }
 419   }
 420
 421   public void parseResult()
 422   {
 423     int results = 0; // number of result sets received
 424     JobStateSummary finalState = new JobStateSummary();
 425     try
 426     {
 427       for (int j = 0; j < jobs.length; j++)
 428       {
 429         finalState.updateJobPanelState(wsInfo, OutputHeader, jobs[j]);
 430         if (jobs[j].isSubmitted() && jobs[j].isSubjobComplete()
 431                 && jobs[j].hasResults())
 432         {
 433           results++;
 434         }
 435       }
 436     } catch (Exception ex)
 437     {
 438
 439       Cache.log.error("Unexpected exception when processing results for "
 440               + altitle, ex);
 441       wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_ERROR);
 442     }
 443     if (results > 0)
 444     {
 445       wsInfo.showResultsNewFrame
 446               .addActionListener(new java.awt.event.ActionListener()
 447               {
 448                 public void actionPerformed(java.awt.event.ActionEvent evt)
 449                 {
 450                   displayResults(true);
 451                 }
 452               });
 453       wsInfo.mergeResults
 454               .addActionListener(new java.awt.event.ActionListener()
 455               {
 456                 public void actionPerformed(java.awt.event.ActionEvent evt)
 457                 {
 458                   displayResults(false);
 459                 }
 460               });
 461       wsInfo.setResultsReady();
 462     }
 463     else
 464     {
 465       wsInfo.setStatus(wsInfo.STATE_STOPPED_ERROR);
 466       wsInfo.appendInfoText("No jobs ran.");
 467       wsInfo.setFinishedNoResults();
 468     }
 469   }
 470
 471   void displayResults(boolean newWindow)
 472   {
 473     // TODO: cope with multiple subjobs.
 474     if (jobs != null)
 475     {
 476       Object[] res = null;
 477       boolean msa = false;
 478       for (int jn = 0; jn < jobs.length; jn++)
 479       {
 480         Object[] jobres = null;
 481         JPredJob j = (JPredJob) jobs[jn];
 482
 483         if (j.hasResults())
 484         {
 485           // hack - we only deal with all single seuqence predictions or all
 486           // profile predictions
 487           msa = (j.msa != null) ? true : msa;
 488           try
 489           {
 490             jalview.bin.Cache.log.debug("Parsing output of job " + jn);
 491             jobres = j.getResultSet();
 492             jalview.bin.Cache.log.debug("Finished parsing output.");
 493             if (jobs.length == 1)
 494             {
 495               res = jobres;
 496             }
 497             else
 498             {
 499               // do merge with other job results
 500               throw new Error(
 501                       "Multiple JNet subjob merging not yet implemented.");
 502             }
 503           } catch (Exception e)
 504           {
 505             jalview.bin.Cache.log.error(
 506                     "JNet Client: JPred Annotation Parse Error", e);
 507             wsInfo.setStatus(j.getJobnum(),
 508                     WebserviceInfo.STATE_STOPPED_ERROR);
 509             wsInfo.appendProgressText(j.getJobnum(), OutputHeader + "\n"
 510                     + j.result.getStatus()
 511                     + "\nInvalid JNet job result data!\n" + e.getMessage());
 512             j.result.setBroken(true);
 513           }
 514         }
 515       }
 516
 517       if (res != null)
 518       {
 519         if (newWindow)
 520         {
 521           AlignFrame af;
 522           if (input == null)
 523           {
 524             if (res[1] != null)
 525             {
 526               af = new AlignFrame((Alignment) res[0],
 527                       (ColumnSelection) res[1], AlignFrame.DEFAULT_WIDTH,
 528                       AlignFrame.DEFAULT_HEIGHT);
 529             }
 530             else
 531             {
 532               af = new AlignFrame((Alignment) res[0],
 533                       AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
 534             }
 535           }
 536           else
 537           {
 538             /*
 539              * java.lang.Object[] alandcolsel =
 540              * input.getAlignmentAndColumnSelection
 541              * (alignFrame.getViewport().getGapCharacter()); if
 542              * (((SequenceI[])alandcolsel[0])[0].getLength()!=res.getWidth()) {
 543              * if (msa) { throw new Error("Implementation Error! ColumnSelection
 544              * from input alignment will not map to result alignment!"); } } if
 545              * (!msa) { // update hidden regions to account for loss of gaps in
 546              * profile. - if any // gapMap returns insert list, interpreted as
 547              * delete list by pruneDeletions //((ColumnSelection)
 548              * alandcolsel[1]).pruneDeletions(ShiftList.parseMap(((SequenceI[])
 549              * alandcolsel[0])[0].gapMap())); }
 550              */
 551
 552             af = new AlignFrame((Alignment) res[0],
 553                     (ColumnSelection) res[1], AlignFrame.DEFAULT_WIDTH,
 554                     AlignFrame.DEFAULT_HEIGHT);
 555           }
 556           Desktop.addInternalFrame(af, altitle, AlignFrame.DEFAULT_WIDTH,
 557                   AlignFrame.DEFAULT_HEIGHT);
 558         }
 559         else
 560         {
 561           Cache.log.info("Append results onto existing alignment.");
 562         }
 563       }
 564     }
 565   }
 566
 567   public void pollJob(AWsJob job) throws Exception
 568   {
 569     ((JPredJob) job).result = server.getresult(job.getJobId());
 570   }
 571
 572   public boolean isCancellable()
 573   {
 574     return false;
 575   }
 576
 577   public void cancelJob()
 578   {
 579     throw new Error("Implementation error!");
 580   }
 581
 582   public boolean canMergeResults()
 583   {
 584     return false;
 585   }
 586
 587 }