src/jalview/ws/jws2/MsaWSThread.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
   3  * Copyright (C) 2014 The Jalview Authors
   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
  10  * 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
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.ws.jws2;
  22
  23 import java.util.*;
  24
  25 import compbio.data.msa.MsaWS;
  26 import compbio.metadata.Argument;
  27 import compbio.metadata.ChunkHolder;
  28 import compbio.metadata.JobStatus;
  29 import compbio.metadata.Preset;
  30
  31 import jalview.analysis.*;
  32 import jalview.bin.*;
  33 import jalview.datamodel.*;
  34 import jalview.gui.*;
  35 import jalview.ws.AWsJob;
  36 import jalview.ws.WSClientI;
  37 import jalview.ws.JobStateSummary;
  38 import jalview.ws.jws2.dm.JabaWsParamSet;
  39 import jalview.ws.params.WsParamSetI;
  40
  41 class MsaWSThread extends AWS2Thread implements WSClientI
  42 {
  43   boolean submitGaps = false; // pass sequences including gaps to alignment
  44
  45   // service
  46
  47   boolean preserveOrder = true; // and always store and recover sequence
  48
  49   // order
  50
  51   class MsaWSJob extends JWs2Job
  52   {
  53     long lastChunk = 0;
  54
  55     WsParamSetI preset = null;
  56
  57     List<Argument> arguments = null;
  58
  59     /**
  60      * input
  61      */
  62     ArrayList<compbio.data.sequence.FastaSequence> seqs = new ArrayList<compbio.data.sequence.FastaSequence>();
  63
  64     /**
  65      * output
  66      */
  67     compbio.data.sequence.Alignment alignment;
  68
  69     // set if the job didn't get run - then the input is simply returned to the
  70     // user
  71     private boolean returnInput = false;
  72
  73     /**
  74      * MsaWSJob
  75      *
  76      * @param jobNum
  77      *          int
  78      * @param jobId
  79      *          String
  80      */
  81     public MsaWSJob(int jobNum, SequenceI[] inSeqs)
  82     {
  83       this.jobnum = jobNum;
  84       if (!prepareInput(inSeqs, 2))
  85       {
  86         submitted = true;
  87         subjobComplete = true;
  88         returnInput = true;
  89       }
  90
  91     }
  92
  93     Hashtable<String, Map> SeqNames = new Hashtable();
  94
  95     Vector<String[]> emptySeqs = new Vector();
  96
  97     /**
  98      * prepare input sequences for MsaWS service
  99      *
 100      * @param seqs
 101      *          jalview sequences to be prepared
 102      * @param minlen
 103      *          minimum number of residues required for this MsaWS service
 104      * @return true if seqs contains sequences to be submitted to service.
 105      */
 106     // TODO: return compbio.seqs list or nothing to indicate validity.
 107     private boolean prepareInput(SequenceI[] seqs, int minlen)
 108     {
 109       int nseqs = 0;
 110       if (minlen < 0)
 111       {
 112         throw new Error(
 113                 "Implementation error: minlen must be zero or more.");
 114       }
 115       for (int i = 0; i < seqs.length; i++)
 116       {
 117         if (seqs[i].getEnd() - seqs[i].getStart() > minlen - 1)
 118         {
 119           nseqs++;
 120         }
 121       }
 122       boolean valid = nseqs > 1; // need at least two seqs
 123       compbio.data.sequence.FastaSequence seq;
 124       for (int i = 0, n = 0; i < seqs.length; i++)
 125       {
 126
 127         String newname = jalview.analysis.SeqsetUtils.unique_name(i); // same
 128         // for
 129         // any
 130         // subjob
 131         SeqNames.put(newname,
 132                 jalview.analysis.SeqsetUtils.SeqCharacterHash(seqs[i]));
 133         if (valid && seqs[i].getEnd() - seqs[i].getStart() > minlen - 1)
 134         {
 135           // make new input sequence with or without gaps
 136           seq = new compbio.data.sequence.FastaSequence(newname,
 137                   (submitGaps) ? seqs[i].getSequenceAsString()
 138                           : AlignSeq.extractGaps(
 139                                   jalview.util.Comparison.GapChars,
 140                                   seqs[i].getSequenceAsString()));
 141           this.seqs.add(seq);
 142         }
 143         else
 144         {
 145           String empty = null;
 146           if (seqs[i].getEnd() >= seqs[i].getStart())
 147           {
 148             empty = (submitGaps) ? seqs[i].getSequenceAsString() : AlignSeq
 149                     .extractGaps(jalview.util.Comparison.GapChars,
 150                             seqs[i].getSequenceAsString());
 151           }
 152           emptySeqs.add(new String[]
 153           { newname, empty });
 154         }
 155       }
 156       return valid;
 157     }
 158
 159     /**
 160      *
 161      * @return true if getAlignment will return a valid alignment result.
 162      */
 163     public boolean hasResults()
 164     {
 165       if (subjobComplete
 166               && isFinished()
 167               && (alignment != null || (emptySeqs != null && emptySeqs
 168                       .size() > 0)))
 169       {
 170         return true;
 171       }
 172       return false;
 173     }
 174
 175     /**
 176      *
 177      * get the alignment including any empty sequences in the original order
 178      * with original ids. Caller must access the alignment.getMetadata() object
 179      * to annotate the final result passsed to the user.
 180      *
 181      * @return { SequenceI[], AlignmentOrder }
 182      */
 183     public Object[] getAlignment()
 184     {
 185       // is this a generic subjob or a Jws2 specific Object[] return signature
 186       if (hasResults())
 187       {
 188         SequenceI[] alseqs = null;
 189         char alseq_gapchar = '-';
 190         int alseq_l = 0;
 191         if (alignment.getSequences().size() > 0)
 192         {
 193           alseqs = new SequenceI[alignment.getSequences().size()];
 194           for (compbio.data.sequence.FastaSequence seq : alignment
 195                   .getSequences())
 196           {
 197             alseqs[alseq_l++] = new Sequence(seq.getId(), seq.getSequence());
 198           }
 199           alseq_gapchar = alignment.getMetadata().getGapchar();
 200
 201         }
 202         // add in the empty seqs.
 203         if (emptySeqs.size() > 0)
 204         {
 205           SequenceI[] t_alseqs = new SequenceI[alseq_l + emptySeqs.size()];
 206           // get width
 207           int i, w = 0;
 208           if (alseq_l > 0)
 209           {
 210             for (i = 0, w = alseqs[0].getLength(); i < alseq_l; i++)
 211             {
 212               if (w < alseqs[i].getLength())
 213               {
 214                 w = alseqs[i].getLength();
 215               }
 216               t_alseqs[i] = alseqs[i];
 217               alseqs[i] = null;
 218             }
 219           }
 220           // check that aligned width is at least as wide as emptySeqs width.
 221           int ow = w, nw = w;
 222           for (i = 0, w = emptySeqs.size(); i < w; i++)
 223           {
 224             String[] es = (String[]) emptySeqs.get(i);
 225             if (es != null && es[1] != null)
 226             {
 227               int sw = es[1].length();
 228               if (nw < sw)
 229               {
 230                 nw = sw;
 231               }
 232             }
 233           }
 234           // make a gapped string.
 235           StringBuffer insbuff = new StringBuffer(w);
 236           for (i = 0; i < nw; i++)
 237           {
 238             insbuff.append(alseq_gapchar);
 239           }
 240           if (ow < nw)
 241           {
 242             for (i = 0; i < alseq_l; i++)
 243             {
 244               int sw = t_alseqs[i].getLength();
 245               if (nw > sw)
 246               {
 247                 // pad at end
 248                 alseqs[i].setSequence(t_alseqs[i].getSequenceAsString()
 249                         + insbuff.substring(0, sw - nw));
 250               }
 251             }
 252           }
 253           for (i = 0, w = emptySeqs.size(); i < w; i++)
 254           {
 255             String[] es = (String[]) emptySeqs.get(i);
 256             if (es[1] == null)
 257             {
 258               t_alseqs[i + alseq_l] = new jalview.datamodel.Sequence(es[0],
 259                       insbuff.toString(), 1, 0);
 260             }
 261             else
 262             {
 263               if (es[1].length() < nw)
 264               {
 265                 t_alseqs[i + alseq_l] = new jalview.datamodel.Sequence(
 266                         es[0],
 267                         es[1] + insbuff.substring(0, nw - es[1].length()),
 268                         1, 1 + es[1].length());
 269               }
 270               else
 271               {
 272                 t_alseqs[i + alseq_l] = new jalview.datamodel.Sequence(
 273                         es[0], es[1]);
 274               }
 275             }
 276           }
 277           alseqs = t_alseqs;
 278         }
 279         AlignmentOrder msaorder = new AlignmentOrder(alseqs);
 280         // always recover the order - makes parseResult()'s life easier.
 281         jalview.analysis.AlignmentSorter.recoverOrder(alseqs);
 282         // account for any missing sequences
 283         jalview.analysis.SeqsetUtils.deuniquify(SeqNames, alseqs);
 284         return new Object[]
 285         { alseqs, msaorder };
 286       }
 287       return null;
 288     }
 289
 290     /**
 291      * mark subjob as cancelled and set result object appropriatly
 292      */
 293     void cancel()
 294     {
 295       cancelled = true;
 296       subjobComplete = true;
 297       alignment = null;
 298     }
 299
 300     /**
 301      *
 302      * @return boolean true if job can be submitted.
 303      */
 304     public boolean hasValidInput()
 305     {
 306       // TODO: get attributes for this MsaWS instance to check if it can do two
 307       // sequence alignment.
 308       if (seqs != null && seqs.size() >= 2) // two or more sequences is valid ?
 309       {
 310         return true;
 311       }
 312       return false;
 313     }
 314
 315     StringBuffer jobProgress = new StringBuffer();
 316
 317     public void setStatus(String string)
 318     {
 319       jobProgress.setLength(0);
 320       jobProgress.append(string);
 321     }
 322
 323     @Override
 324     public String getStatus()
 325     {
 326       return jobProgress.toString();
 327     }
 328
 329     @Override
 330     public boolean hasStatus()
 331     {
 332       return jobProgress != null;
 333     }
 334
 335     /**
 336      * @return the lastChunk
 337      */
 338     public long getLastChunk()
 339     {
 340       return lastChunk;
 341     }
 342
 343     /**
 344      * @param lastChunk
 345      *          the lastChunk to set
 346      */
 347     public void setLastChunk(long lastChunk)
 348     {
 349       this.lastChunk = lastChunk;
 350     }
 351
 352     String alignmentProgram = null;
 353
 354     public String getAlignmentProgram()
 355     {
 356       return alignmentProgram;
 357     }
 358
 359     public boolean hasArguments()
 360     {
 361       return (arguments != null && arguments.size() > 0)
 362               || (preset != null && preset instanceof JabaWsParamSet);
 363     }
 364
 365     public List<Argument> getJabaArguments()
 366     {
 367       List<Argument> newargs = new ArrayList<Argument>();
 368       if (preset != null && preset instanceof JabaWsParamSet)
 369       {
 370         newargs.addAll(((JabaWsParamSet) preset).getjabaArguments());
 371       }
 372       if (arguments != null && arguments.size() > 0)
 373       {
 374         newargs.addAll(arguments);
 375       }
 376       return newargs;
 377     }
 378
 379     /**
 380      * add a progess header to status string containing presets/args used
 381      */
 382     public void addInitialStatus()
 383     {
 384       if (preset != null)
 385       {
 386         jobProgress.append("Using "
 387                 + (preset instanceof JabaPreset ? "Server" : "User")
 388                 + "Preset: " + preset.getName());
 389         if (preset instanceof JabaWsParamSet)
 390         {
 391           for (Argument opt : ((JabaWsParamSet) preset).getjabaArguments())
 392           {
 393             jobProgress.append(opt.getName() + " " + opt.getDefaultValue()
 394                     + "\n");
 395           }
 396         }
 397       }
 398       if (arguments != null && arguments.size() > 0)
 399       {
 400         jobProgress.append("With custom parameters : \n");
 401         // merge arguments with preset's own arguments.
 402         for (Argument opt : arguments)
 403         {
 404           jobProgress.append(opt.getName() + " " + opt.getDefaultValue()
 405                   + "\n");
 406         }
 407       }
 408       jobProgress.append("\nJob Output:\n");
 409     }
 410
 411     public boolean isPresetJob()
 412     {
 413       return preset != null && preset instanceof JabaPreset;
 414     }
 415
 416     public Preset getServerPreset()
 417     {
 418       return (isPresetJob()) ? ((JabaPreset) preset).p : null;
 419     }
 420   }
 421
 422   String alTitle; // name which will be used to form new alignment window.
 423
 424   Alignment dataset; // dataset to which the new alignment will be
 425
 426   // associated.
 427
 428   @SuppressWarnings("unchecked")
 429   MsaWS server = null;
 430
 431   /**
 432    * set basic options for this (group) of Msa jobs
 433    *
 434    * @param subgaps
 435    *          boolean
 436    * @param presorder
 437    *          boolean
 438    */
 439   MsaWSThread(MsaWS server, String wsUrl, WebserviceInfo wsinfo,
 440           jalview.gui.AlignFrame alFrame, AlignmentView alview,
 441           String wsname, boolean subgaps, boolean presorder)
 442   {
 443     super(alFrame, wsinfo, alview, wsname, wsUrl);
 444     this.server = server;
 445     this.submitGaps = subgaps;
 446     this.preserveOrder = presorder;
 447   }
 448
 449   /**
 450    * create one or more Msa jobs to align visible seuqences in _msa
 451    *
 452    * @param title
 453    *          String
 454    * @param _msa
 455    *          AlignmentView
 456    * @param subgaps
 457    *          boolean
 458    * @param presorder
 459    *          boolean
 460    * @param seqset
 461    *          Alignment
 462    */
 463   MsaWSThread(MsaWS server2, WsParamSetI preset, List<Argument> paramset,
 464           String wsUrl, WebserviceInfo wsinfo,
 465           jalview.gui.AlignFrame alFrame, String wsname, String title,
 466           AlignmentView _msa, boolean subgaps, boolean presorder,
 467           Alignment seqset)
 468   {
 469     this(server2, wsUrl, wsinfo, alFrame, _msa, wsname, subgaps, presorder);
 470     OutputHeader = wsInfo.getProgressText();
 471     alTitle = title;
 472     dataset = seqset;
 473
 474     SequenceI[][] conmsa = _msa.getVisibleContigs('-');
 475     if (conmsa != null)
 476     {
 477       int njobs = conmsa.length;
 478       jobs = new MsaWSJob[njobs];
 479       for (int j = 0; j < njobs; j++)
 480       {
 481         if (j != 0)
 482         {
 483           jobs[j] = new MsaWSJob(wsinfo.addJobPane(), conmsa[j]);
 484         }
 485         else
 486         {
 487           jobs[j] = new MsaWSJob(0, conmsa[j]);
 488         }
 489         ((MsaWSJob) jobs[j]).preset = preset;
 490         ((MsaWSJob) jobs[j]).arguments = paramset;
 491         ((MsaWSJob) jobs[j]).alignmentProgram = wsname;
 492         if (njobs > 0)
 493         {
 494           wsinfo.setProgressName("region " + jobs[j].getJobnum(),
 495                   jobs[j].getJobnum());
 496         }
 497         wsinfo.setProgressText(jobs[j].getJobnum(), OutputHeader);
 498       }
 499     }
 500   }
 501
 502   public boolean isCancellable()
 503   {
 504     return true;
 505   }
 506
 507   public void cancelJob()
 508   {
 509     if (!jobComplete && jobs != null)
 510     {
 511       boolean cancelled = true;
 512       for (int job = 0; job < jobs.length; job++)
 513       {
 514         if (jobs[job].isSubmitted() && !jobs[job].isSubjobComplete())
 515         {
 516           String cancelledMessage = "";
 517           try
 518           {
 519             boolean cancelledJob = server.cancelJob(jobs[job].getJobId());
 520             if (true) // cancelledJob || true)
 521             {
 522               // CANCELLED_JOB
 523               // if the Jaba server indicates the job can't be cancelled, its
 524               // because its running on the server's local execution engine
 525               // so we just close the window anyway.
 526               cancelledMessage = "Job cancelled.";
 527               ((MsaWSJob) jobs[job]).cancel(); // TODO: refactor to avoid this
 528                                                // ugliness -
 529               wsInfo.setStatus(jobs[job].getJobnum(),
 530                       WebserviceInfo.STATE_CANCELLED_OK);
 531             }
 532             else
 533             {
 534               // VALID UNSTOPPABLE JOB
 535               cancelledMessage += "Server cannot cancel this job. just close the window.\n";
 536               cancelled = false;
 537               // wsInfo.setStatus(jobs[job].jobnum,
 538               // WebserviceInfo.STATE_RUNNING);
 539             }
 540           } catch (Exception exc)
 541           {
 542             cancelledMessage += ("\nProblems cancelling the job : Exception received...\n"
 543                     + exc + "\n");
 544             Cache.log.warn(
 545                     "Exception whilst cancelling " + jobs[job].getJobId(),
 546                     exc);
 547           }
 548           wsInfo.setProgressText(jobs[job].getJobnum(), OutputHeader
 549                   + cancelledMessage + "\n");
 550         } else {
 551           // if we hadn't submitted then just mark the job as cancelled.
 552           jobs[job].setSubjobComplete(true);
 553           wsInfo.setStatus(jobs[job].getJobnum(), WebserviceInfo.STATE_CANCELLED_OK);
 554
 555         }
 556       }
 557       if (cancelled)
 558       {
 559         wsInfo.setStatus(WebserviceInfo.STATE_CANCELLED_OK);
 560         jobComplete = true;
 561       }
 562       this.interrupt(); // kick thread to update job states.
 563     }
 564     else
 565     {
 566       if (!jobComplete)
 567       {
 568         wsInfo.setProgressText(OutputHeader
 569                 + "Server cannot cancel this job because it has not been submitted properly. just close the window.\n");
 570       }
 571     }
 572   }
 573
 574   public void pollJob(AWsJob job) throws Exception
 575   {
 576     // TODO: investigate if we still need to cast here in J1.6
 577     MsaWSJob j = ((MsaWSJob) job);
 578     // this is standard code, but since the interface doesn't comprise of a
 579     // basic one that implements (getJobStatus, pullExecStatistics) we have to
 580     // repeat the code for all jw2s services.
 581     j.setjobStatus(server.getJobStatus(job.getJobId()));
 582     updateJobProgress(j);
 583   }
 584
 585   /**
 586    *
 587    * @param j
 588    * @return true if more job progress data was available
 589    * @throws Exception
 590    */
 591   protected boolean updateJobProgress(MsaWSJob j) throws Exception
 592   {
 593     StringBuffer response = j.jobProgress;
 594     long lastchunk = j.getLastChunk();
 595     boolean changed = false;
 596     do
 597     {
 598       j.setLastChunk(lastchunk);
 599       ChunkHolder chunk = server
 600               .pullExecStatistics(j.getJobId(), lastchunk);
 601       if (chunk != null)
 602       {
 603         changed |= chunk.getChunk().length() > 0;
 604         response.append(chunk.getChunk());
 605         lastchunk = chunk.getNextPosition();
 606         try
 607         {
 608           Thread.sleep(50);
 609         } catch (InterruptedException x)
 610         {
 611         }
 612         ;
 613       }
 614       ;
 615     } while (lastchunk >= 0 && j.getLastChunk() != lastchunk);
 616     return changed;
 617   }
 618
 619   public void StartJob(AWsJob job)
 620   {
 621     Exception lex = null;
 622     // boiler plate template
 623     if (!(job instanceof MsaWSJob))
 624     {
 625       throw new Error("StartJob(MsaWSJob) called on a WSJobInstance "
 626               + job.getClass());
 627     }
 628     MsaWSJob j = (MsaWSJob) job;
 629     if (j.isSubmitted())
 630     {
 631       if (Cache.log.isDebugEnabled())
 632       {
 633         Cache.log.debug("Tried to submit an already submitted job "
 634                 + j.getJobId());
 635       }
 636       return;
 637     }
 638     // end boilerplate
 639
 640     if (j.seqs == null || j.seqs.size() == 0)
 641     {
 642       // special case - selection consisted entirely of empty sequences...
 643       j.setjobStatus(JobStatus.FINISHED);
 644       j.setStatus("Empty Alignment Job");
 645     }
 646     try
 647     {
 648       j.addInitialStatus(); // list the presets/parameters used for the job in
 649                             // status
 650       if (j.isPresetJob())
 651       {
 652         j.setJobId(server.presetAlign(j.seqs, j.getServerPreset()));
 653       }
 654       else if (j.hasArguments())
 655       {
 656         j.setJobId(server.customAlign(j.seqs, j.getJabaArguments()));
 657       }
 658       else
 659       {
 660         j.setJobId(server.align(j.seqs));
 661       }
 662
 663       if (j.getJobId() != null)
 664       {
 665         j.setSubmitted(true);
 666         j.setSubjobComplete(false);
 667         // System.out.println(WsURL + " Job Id '" + jobId + "'");
 668         return;
 669       }
 670       else
 671       {
 672         throw new Exception(
 673                 "Server at "
 674                         + WsUrl
 675                         + " returned null string for job id, it probably cannot be contacted. Try again later ?");
 676       }
 677     } catch (compbio.metadata.UnsupportedRuntimeException _lex)
 678     {
 679       lex = _lex;
 680       wsInfo.appendProgressText("Job could not be run because the server doesn't support this program.\n"
 681               + _lex.getMessage());
 682       wsInfo.warnUser(_lex.getMessage(), "Service not supported!");
 683       wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_SERVERERROR);
 684       wsInfo.setStatus(j.getJobnum(),
 685               WebserviceInfo.STATE_STOPPED_SERVERERROR);
 686     } catch (compbio.metadata.LimitExceededException _lex)
 687     {
 688       lex = _lex;
 689       wsInfo.appendProgressText("Job could not be run because it exceeded a hard limit on the server.\n"
 690               + _lex.getMessage());
 691       wsInfo.warnUser(_lex.getMessage(), "Input is too big!");
 692       wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_ERROR);
 693       wsInfo.setStatus(j.getJobnum(), WebserviceInfo.STATE_STOPPED_ERROR);
 694     } catch (compbio.metadata.WrongParameterException _lex)
 695     {
 696       lex = _lex;
 697       wsInfo.warnUser(_lex.getMessage(), "Invalid job parameter set!");
 698       wsInfo.appendProgressText("Job could not be run because some of the parameter settings are not supported by the server.\n"
 699               + _lex.getMessage()
 700               + "\nPlease check to make sure you have used the correct parameter set for this service!\n");
 701       wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_ERROR);
 702       wsInfo.setStatus(j.getJobnum(), WebserviceInfo.STATE_STOPPED_ERROR);
 703     } catch (Error e)
 704     {
 705       // For unexpected errors
 706       System.err
 707               .println(WebServiceName
 708                       + "Client: Failed to submit the sequences for alignment (probably a server side problem)\n"
 709                       + "When contacting Server:" + WsUrl + "\n");
 710       e.printStackTrace(System.err);
 711       wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_SERVERERROR);
 712       wsInfo.setStatus(j.getJobnum(),
 713               WebserviceInfo.STATE_STOPPED_SERVERERROR);
 714     } catch (Exception e)
 715     {
 716       // For unexpected errors
 717       System.err
 718               .println(WebServiceName
 719                       + "Client: Failed to submit the sequences for alignment (probably a server side problem)\n"
 720                       + "When contacting Server:" + WsUrl + "\n");
 721       e.printStackTrace(System.err);
 722       wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_SERVERERROR);
 723       wsInfo.setStatus(j.getJobnum(),
 724               WebserviceInfo.STATE_STOPPED_SERVERERROR);
 725     } finally
 726     {
 727       if (!j.isSubmitted())
 728       {
 729         // Boilerplate code here
 730         // TODO: JBPNote catch timeout or other fault types explicitly
 731
 732         j.setAllowedServerExceptions(0);
 733         wsInfo.appendProgressText(j.getJobnum(),
 734                 "Failed to submit sequences for alignment.\n"
 735                         + "Just close the window\n");
 736       }
 737     }
 738   }
 739
 740   public void parseResult()
 741   {
 742     long progbar = System.currentTimeMillis();
 743     wsInfo.setProgressBar("Collecting job results.", progbar);
 744     int results = 0; // number of result sets received
 745     JobStateSummary finalState = new JobStateSummary();
 746     try
 747     {
 748       for (int j = 0; j < jobs.length; j++)
 749       {
 750         MsaWSJob msjob = ((MsaWSJob) jobs[j]);
 751         if (jobs[j].isFinished() && msjob.alignment == null)
 752         {
 753           int nunchanged = 3, nexcept = 3;
 754           boolean jpchanged = false, jpex = false;
 755           do
 756           {
 757             try
 758             {
 759               jpchanged = updateJobProgress(msjob);
 760               jpex = false;
 761               if (jpchanged)
 762               {
 763                 nexcept = 3;
 764               }
 765             } catch (Exception e)
 766             {
 767
 768               Cache.log
 769                       .warn("Exception when retrieving remaining Job progress data for job "
 770                               + msjob.getJobId() + " on server " + WsUrl);
 771               e.printStackTrace();
 772               nexcept--;
 773               nunchanged = 3;
 774               // set flag remember that we've had an exception.
 775               jpex = true;
 776               jpchanged = false;
 777             }
 778             if (!jpchanged)
 779             {
 780               try
 781               {
 782                 Thread.sleep(jpex ? 2400 : 1200); // wait a bit longer if we
 783                                                   // experienced an exception.
 784               } catch (Exception ex)
 785               {
 786               }
 787               ;
 788               nunchanged--;
 789             }
 790           } while (nunchanged > 0 && nexcept > 0);
 791
 792           if (Cache.log.isDebugEnabled())
 793           {
 794             System.out.println("Job Execution file for job: "
 795                     + msjob.getJobId() + " on server " + WsUrl);
 796             System.out.println(msjob.getStatus());
 797             System.out.println("*** End of status");
 798
 799           }
 800           try
 801           {
 802             msjob.alignment = server.getResult(msjob.getJobId());
 803           } catch (compbio.metadata.ResultNotAvailableException e)
 804           {
 805             // job has failed for some reason - probably due to invalid
 806             // parameters
 807             Cache.log
 808                     .debug("Results not available for finished job - marking as broken job.",
 809                             e);
 810             msjob.jobProgress
 811                     .append("\nResult not available. Probably due to invalid input or parameter settings. Server error message below:\n\n"
 812                             + e.getLocalizedMessage());
 813             msjob.setjobStatus(JobStatus.FAILED);
 814           } catch (Exception e)
 815           {
 816             Cache.log.error("Couldn't get Alignment for job.", e);
 817             // TODO: Increment count and retry ?
 818             msjob.setjobStatus(JobStatus.UNDEFINED);
 819           }
 820         }
 821         finalState.updateJobPanelState(wsInfo, OutputHeader, jobs[j]);
 822         if (jobs[j].isSubmitted() && jobs[j].isSubjobComplete()
 823                 && jobs[j].hasResults())
 824         {
 825           results++;
 826           compbio.data.sequence.Alignment alignment = ((MsaWSJob) jobs[j]).alignment;
 827           if (alignment != null)
 828           {
 829             // server.close(jobs[j].getJobnum());
 830             // wsInfo.appendProgressText(jobs[j].getJobnum(),
 831             // "\nAlignment Object Method Notes\n");
 832             // wsInfo.appendProgressText(jobs[j].getJobnum(),
 833             // "Calculated with "+alignment.getMetadata().getProgram().toString());
 834             // JBPNote The returned files from a webservice could be
 835             // hidden behind icons in the monitor window that,
 836             // when clicked, pop up their corresponding data
 837           }
 838         }
 839       }
 840     } catch (Exception ex)
 841     {
 842
 843       Cache.log.error("Unexpected exception when processing results for "
 844               + alTitle, ex);
 845       wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_ERROR);
 846     }
 847     if (results > 0)
 848     {
 849       wsInfo.showResultsNewFrame
 850               .addActionListener(new java.awt.event.ActionListener()
 851               {
 852                 public void actionPerformed(java.awt.event.ActionEvent evt)
 853                 {
 854                   displayResults(true);
 855                 }
 856               });
 857       wsInfo.mergeResults
 858               .addActionListener(new java.awt.event.ActionListener()
 859               {
 860                 public void actionPerformed(java.awt.event.ActionEvent evt)
 861                 {
 862                   displayResults(false);
 863                 }
 864               });
 865       wsInfo.setResultsReady();
 866     }
 867     else
 868     {
 869       wsInfo.setFinishedNoResults();
 870     }
 871     updateGlobalStatus(finalState);
 872     wsInfo.setProgressBar(null, progbar);
 873   }
 874
 875   void displayResults(boolean newFrame)
 876   {
 877     // view input or result data for each block
 878     Vector alorders = new Vector();
 879     SequenceI[][] results = new SequenceI[jobs.length][];
 880     AlignmentOrder[] orders = new AlignmentOrder[jobs.length];
 881     String lastProgram = null;
 882     MsaWSJob msjob;
 883     for (int j = 0; j < jobs.length; j++)
 884     {
 885       if (jobs[j].hasResults())
 886       {
 887         msjob = (MsaWSJob) jobs[j];
 888         Object[] res = msjob.getAlignment();
 889         lastProgram = msjob.getAlignmentProgram();
 890         alorders.add(res[1]);
 891         results[j] = (SequenceI[]) res[0];
 892         orders[j] = (AlignmentOrder) res[1];
 893
 894         // SequenceI[] alignment = input.getUpdated
 895       }
 896       else
 897       {
 898         results[j] = null;
 899       }
 900     }
 901     Object[] newview = input.getUpdatedView(results, orders, getGapChar());
 902     // trash references to original result data
 903     for (int j = 0; j < jobs.length; j++)
 904     {
 905       results[j] = null;
 906       orders[j] = null;
 907     }
 908     SequenceI[] alignment = (SequenceI[]) newview[0];
 909     ColumnSelection columnselection = (ColumnSelection) newview[1];
 910     Alignment al = new Alignment(alignment);
 911     // TODO: add 'provenance' property to alignment from the method notes
 912     if (lastProgram != null)
 913     {
 914       al.setProperty("Alignment Program", lastProgram);
 915     }
 916     // accompanying each subjob
 917     if (dataset != null)
 918     {
 919       al.setDataset(dataset);
 920     }
 921
 922     propagateDatasetMappings(al);
 923     // JBNote- TODO: warn user if a block is input rather than aligned data ?
 924
 925     if (newFrame)
 926     {
 927       AlignFrame af = new AlignFrame(al, columnselection,
 928               AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
 929
 930       // initialise with same renderer settings as in parent alignframe.
 931       af.getFeatureRenderer().transferSettings(this.featureSettings);
 932       // update orders
 933       if (alorders.size() > 0)
 934       {
 935         if (alorders.size() == 1)
 936         {
 937           af.addSortByOrderMenuItem(WebServiceName + " Ordering",
 938                   (AlignmentOrder) alorders.get(0));
 939         }
 940         else
 941         {
 942           // construct a non-redundant ordering set
 943           Vector names = new Vector();
 944           for (int i = 0, l = alorders.size(); i < l; i++)
 945           {
 946             String orderName = new String(" Region " + i);
 947             int j = i + 1;
 948
 949             while (j < l)
 950             {
 951               if (((AlignmentOrder) alorders.get(i))
 952                       .equals(((AlignmentOrder) alorders.get(j))))
 953               {
 954                 alorders.remove(j);
 955                 l--;
 956                 orderName += "," + j;
 957               }
 958               else
 959               {
 960                 j++;
 961               }
 962             }
 963
 964             if (i == 0 && j == 1)
 965             {
 966               names.add(new String(""));
 967             }
 968             else
 969             {
 970               names.add(orderName);
 971             }
 972           }
 973           for (int i = 0, l = alorders.size(); i < l; i++)
 974           {
 975             af.addSortByOrderMenuItem(
 976                     WebServiceName + ((String) names.get(i)) + " Ordering",
 977                     (AlignmentOrder) alorders.get(i));
 978           }
 979         }
 980       }
 981
 982       Desktop.addInternalFrame(af, alTitle, AlignFrame.DEFAULT_WIDTH,
 983               AlignFrame.DEFAULT_HEIGHT);
 984
 985     }
 986     else
 987     {
 988       System.out.println("MERGE WITH OLD FRAME");
 989       // TODO: modify alignment in original frame, replacing old for new
 990       // alignment using the commands.EditCommand model to ensure the update can
 991       // be undone
 992     }
 993   }
 994
 995   public boolean canMergeResults()
 996   {
 997     return false;
 998   }
 999 }