src/jalview/ws/MsaWSThread.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer
   3  * Copyright (C) 2006 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
  18  */
  19 package jalview.ws;
  20
  21 import java.util.*;
  22
  23 import jalview.analysis.*;
  24 import jalview.bin.*;
  25 import jalview.datamodel.*;
  26 import jalview.datamodel.Alignment;
  27 import jalview.datamodel.Sequence;
  28 import jalview.gui.*;
  29 import vamsas.objects.simple.MsaResult;
  30
  31 /**
  32  * <p>
  33  * Title:
  34  * </p>
  35  *
  36  * <p>
  37  * Description:
  38  * </p>
  39  *
  40  * <p>
  41  * Copyright: Copyright (c) 2004
  42  * </p>
  43  *
  44  * <p>
  45  * Company: Dundee University
  46  * </p>
  47  *
  48  * @author not attributable
  49  * @version 1.0
  50  */
  51 class MsaWSThread
  52     extends WSThread implements WSClientI
  53 {
  54   boolean submitGaps = false; // pass sequences including gaps to alignment
  55
  56   // service
  57
  58   boolean preserveOrder = true; // and always store and recover sequence
  59
  60   // order
  61
  62   class MsaWSJob extends WSThread.WSJob
  63   {
  64     // hold special input for this
  65     vamsas.objects.simple.SequenceSet seqs = new vamsas.objects.simple.
  66         SequenceSet();
  67
  68     /**
  69      * MsaWSJob
  70      *
  71      * @param jobNum
  72      *            int
  73      * @param jobId
  74      *            String
  75      */
  76     public MsaWSJob(int jobNum, SequenceI[] inSeqs)
  77     {
  78       this.jobnum = jobNum;
  79       if (!prepareInput(inSeqs, 2))
  80       {
  81         submitted = true;
  82         subjobComplete = true;
  83         result = new MsaResult();
  84         result.setFinished(true);
  85         result.setStatus("Job never ran - input returned to user.");
  86       }
  87
  88     }
  89
  90     Hashtable SeqNames = new Hashtable();
  91     Vector emptySeqs = new Vector();
  92     /**
  93      * prepare input sequences for MsaWS service
  94      * @param seqs jalview sequences to be prepared
  95      * @param minlen minimum number of residues required for this MsaWS service
  96      * @return true if seqs contains sequences to be submitted to service.
  97      */
  98     private boolean prepareInput(SequenceI[] seqs, int minlen)
  99     {
 100       int nseqs = 0;
 101       if (minlen < 0)
 102       {
 103         throw new Error("Implementation error: minlen must be zero or more.");
 104       }
 105       for (int i = 0; i < seqs.length; i++)
 106       {
 107         if (seqs[i].getEnd() - seqs[i].getStart() > minlen - 1)
 108         {
 109           nseqs++;
 110         }
 111       }
 112       boolean valid = nseqs > 1; // need at least two seqs
 113       vamsas.objects.simple.Sequence[] seqarray =
 114           (valid)
 115           ? new vamsas.objects.simple.Sequence[nseqs]
 116           : null;
 117       for (int i = 0, n = 0; i < seqs.length; i++)
 118       {
 119
 120         String newname = jalview.analysis.SeqsetUtils.unique_name(i); // same
 121         // for
 122         // any
 123         // subjob
 124         SeqNames.put(newname, jalview.analysis.SeqsetUtils
 125                      .SeqCharacterHash(seqs[i]));
 126         if (valid && seqs[i].getEnd() - seqs[i].getStart() > minlen - 1)
 127         {
 128           seqarray[n] = new vamsas.objects.simple.Sequence();
 129           seqarray[n].setId(newname);
 130           seqarray[n++].setSeq( (submitGaps) ? seqs[i].getSequence()
 131                                : AlignSeq.extractGaps(
 132                                    jalview.util.Comparison.GapChars, seqs[i]
 133                                    .getSequence()));
 134         }
 135         else
 136         {
 137           String empty = null;
 138           if (seqs[i].getEnd() >= seqs[i].getStart())
 139           {
 140             empty = (submitGaps) ? seqs[i].getSequence()
 141                 : AlignSeq.extractGaps(
 142                     jalview.util.Comparison.GapChars, seqs[i]
 143                     .getSequence());
 144           }
 145           emptySeqs.add(new String[]
 146                         {newname, empty});
 147         }
 148       }
 149       this.seqs = new vamsas.objects.simple.SequenceSet();
 150       this.seqs.setSeqs(seqarray);
 151       return valid;
 152     }
 153
 154     /**
 155      *
 156      * @return true if getAlignment will return a valid alignment result.
 157      */
 158     public boolean hasResults()
 159     {
 160       if (subjobComplete && result != null && result.isFinished()
 161           && ((MsaResult) result).getMsa() != null && ((MsaResult) result).getMsa().getSeqs() != null)
 162       {
 163         return true;
 164       }
 165       return false;
 166     }
 167
 168     public Object[] getAlignment()
 169     {
 170
 171       if (result != null && result.isFinished())
 172       {
 173         SequenceI[] alseqs = null;
 174         char alseq_gapchar = '-';
 175         int alseq_l = 0;
 176         if (((MsaResult) result).getMsa() != null)
 177         {
 178           alseqs = getVamsasAlignment(((MsaResult) result).getMsa());
 179           alseq_gapchar = ((MsaResult) result).getMsa().getGapchar().charAt(0);
 180           alseq_l = alseqs.length;
 181         }
 182         if (emptySeqs.size() > 0)
 183         {
 184           SequenceI[] t_alseqs = new SequenceI[alseq_l + emptySeqs.size()];
 185           // get width
 186           int i, w = 0;
 187           if (alseq_l > 0)
 188           {
 189             for (i = 0, w = alseqs[0].getLength(); i < alseq_l; i++)
 190             {
 191               if (w < alseqs[i].getLength())
 192               {
 193                 w = alseqs[i].getLength();
 194               }
 195               t_alseqs[i] = alseqs[i];
 196               alseqs[i] = null;
 197             }
 198           }
 199           // check that aligned width is at least as wide as emptySeqs width.
 200           int ow = w, nw = w;
 201           for (i = 0, w = emptySeqs.size(); i < w; i++)
 202           {
 203             String[] es = (String[]) emptySeqs.get(i);
 204             if (es != null && es[1] != null)
 205             {
 206               int sw = es[1].length();
 207               if (nw < sw)
 208               {
 209                 nw = sw;
 210               }
 211             }
 212           }
 213           // make a gapped string.
 214           StringBuffer insbuff = new StringBuffer(w);
 215           for (i = 0; i < nw; i++)
 216           {
 217             insbuff.append(alseq_gapchar);
 218           }
 219           if (ow < nw)
 220           {
 221             for (i = 0; i < alseq_l; i++)
 222             {
 223               int sw = t_alseqs[i].getLength();
 224               if (nw > sw)
 225               {
 226                 // pad at end
 227                 alseqs[i].setSequence(t_alseqs[i].getSequence() +
 228                                       insbuff.substring(0, sw - nw));
 229               }
 230             }
 231           }
 232           for (i = 0, w = emptySeqs.size(); i < w; i++)
 233           {
 234             String[] es = (String[]) emptySeqs.get(i);
 235             if (es[1] == null)
 236             {
 237               t_alseqs[i +
 238                   alseq_l] = new jalview.datamodel.Sequence(es[0],
 239                   insbuff.toString(), 1, 0);
 240             }
 241             else
 242             {
 243               if (es[1].length() < nw)
 244               {
 245                 t_alseqs[i +
 246                     alseq_l] = new jalview.datamodel.Sequence(es[0],
 247                     es[1] + insbuff.substring(0, nw - es[1].length()), 1,
 248                     1 + es[1].length());
 249               }
 250               else
 251               {
 252                 t_alseqs[i +
 253                     alseq_l] = new jalview.datamodel.Sequence(es[0], es[1]);
 254               }
 255             }
 256           }
 257           alseqs = t_alseqs;
 258         }
 259         AlignmentOrder msaorder = new AlignmentOrder(alseqs);
 260         // always recover the order - makes parseResult()'s life easier.
 261         jalview.analysis.AlignmentSorter.recoverOrder(alseqs);
 262         // account for any missing sequences
 263         jalview.analysis.SeqsetUtils.deuniquify(SeqNames, alseqs);
 264         return new Object[]
 265             {
 266             alseqs, msaorder};
 267       }
 268       return null;
 269     }
 270     /**
 271      * mark subjob as cancelled and set result object appropriatly
 272      */
 273     void cancel() {
 274       cancelled=true;
 275       subjobComplete = true;
 276       result = null;
 277     }
 278     /**
 279      *
 280      * @return boolean true if job can be submitted.
 281      */
 282     boolean hasValidInput() {
 283       if (seqs.getSeqs()!=null)
 284         return true;
 285       return false;
 286     }
 287   }
 288
 289
 290   String alTitle; // name which will be used to form new alignment window.
 291   Alignment dataset; // dataset to which the new alignment will be
 292
 293   // associated.
 294
 295   ext.vamsas.MuscleWS server = null;
 296   /**
 297    * set basic options for this (group) of Msa jobs
 298    *
 299    * @param subgaps
 300    *            boolean
 301    * @param presorder
 302    *            boolean
 303    */
 304   MsaWSThread(ext.vamsas.MuscleWS server, String wsUrl,
 305               WebserviceInfo wsinfo, jalview.gui.AlignFrame alFrame,
 306               AlignmentView alview,
 307               String wsname, boolean subgaps, boolean presorder)
 308   {
 309     this.server = server;
 310     this.WsUrl = wsUrl;
 311     this.wsInfo = wsinfo;
 312     this.WebServiceName = wsname;
 313     this.input = alview;
 314     this.submitGaps = subgaps;
 315     this.preserveOrder = presorder;
 316     this.alignFrame = alFrame;
 317   }
 318
 319   /**
 320    * create one or more Msa jobs to align visible seuqences in _msa
 321    *
 322    * @param title
 323    *            String
 324    * @param _msa
 325    *            AlignmentView
 326    * @param subgaps
 327    *            boolean
 328    * @param presorder
 329    *            boolean
 330    * @param seqset
 331    *            Alignment
 332    */
 333   MsaWSThread(ext.vamsas.MuscleWS server, String wsUrl,
 334               WebserviceInfo wsinfo, jalview.gui.AlignFrame alFrame,
 335               String wsname, String title, AlignmentView _msa, boolean subgaps,
 336               boolean presorder, Alignment seqset)
 337   {
 338     this(server, wsUrl, wsinfo, alFrame, _msa, wsname, subgaps, presorder);
 339     OutputHeader = wsInfo.getProgressText();
 340     alTitle = title;
 341     dataset = seqset;
 342     SequenceI[][] conmsa = _msa.getVisibleContigs('-');
 343     if (conmsa != null)
 344     {
 345       int njobs = conmsa.length;
 346       jobs = new MsaWSJob[njobs];
 347       for (int j = 0; j < njobs; j++)
 348       {
 349         if (j != 0)
 350         {
 351           jobs[j] = new MsaWSJob(wsinfo.addJobPane(), conmsa[j]);
 352         }
 353         else
 354         {
 355           jobs[j] = new MsaWSJob(0, conmsa[j]);
 356         }
 357         if (njobs > 0)
 358           wsinfo.setProgressName("region " + jobs[j].jobnum, jobs[j].jobnum);
 359         wsinfo.setProgressText(jobs[j].jobnum, OutputHeader);
 360       }
 361     }
 362   }
 363   public boolean isCancellable()
 364   {
 365     return true;
 366   }
 367
 368   public void cancelJob()
 369   {
 370     if (!jobComplete && jobs != null)
 371     {
 372       boolean cancelled = true;
 373       for (int job = 0; job < jobs.length; job++)
 374       {
 375         if (jobs[job].submitted && !jobs[job].subjobComplete)
 376         {
 377           String cancelledMessage = "";
 378           try
 379           {
 380             vamsas.objects.simple.WsJobId cancelledJob = server
 381                 .cancel(jobs[job].jobId);
 382             if (cancelledJob.getStatus() == 2)
 383             {
 384               // CANCELLED_JOB
 385               cancelledMessage = "Job cancelled.";
 386               ((MsaWSJob) jobs[job]).cancel();
 387               wsInfo.setStatus(jobs[job].jobnum,
 388                                WebserviceInfo.STATE_CANCELLED_OK);
 389             }
 390             else if (cancelledJob.getStatus() == 3)
 391             {
 392               // VALID UNSTOPPABLE JOB
 393               cancelledMessage +=
 394                   "Server cannot cancel this job. just close the window.\n";
 395               cancelled = false;
 396               // wsInfo.setStatus(jobs[job].jobnum,
 397               //                 WebserviceInfo.STATE_RUNNING);
 398             }
 399
 400             if (cancelledJob.getJobId() != null)
 401             {
 402               cancelledMessage += ("[" + cancelledJob.getJobId() + "]");
 403             }
 404
 405             cancelledMessage += "\n";
 406           }
 407           catch (Exception exc)
 408           {
 409             cancelledMessage +=
 410                 ("\nProblems cancelling the job : Exception received...\n"
 411                  + exc + "\n");
 412             Cache.log.warn("Exception whilst cancelling "+jobs[job].jobId,exc);
 413           }
 414           wsInfo.setProgressText(jobs[job].jobnum, OutputHeader
 415                                  + cancelledMessage + "\n");
 416         }
 417       }
 418       if (cancelled)
 419       {
 420         wsInfo.setStatus(WebserviceInfo.STATE_CANCELLED_OK);
 421         jobComplete = true;
 422       }
 423       this.interrupt(); // kick thread to update job states.
 424     }
 425     else
 426     {
 427       if (!jobComplete)
 428       {
 429         wsInfo
 430             .setProgressText(OutputHeader
 431                              + "Server cannot cancel this job because it has not been submitted properly. just close the window.\n");
 432       }
 433     }
 434   }
 435   void pollJob(WSJob job) throws Exception {
 436     ((MsaWSJob) job).result = server.getResult(((MsaWSJob) job).jobId);
 437   }
 438   void StartJob(WSJob job)
 439   {
 440     if (!(job instanceof MsaWSJob)) {
 441       throw new Error("StartJob(MsaWSJob) called on a WSJobInstance "+job.getClass());
 442     }
 443     MsaWSJob j = (MsaWSJob) job;
 444     if (j.submitted)
 445     {
 446       if (Cache.log.isDebugEnabled())
 447       {
 448         Cache.log.debug("Tried to submit an already submitted job " + j.jobId);
 449       }
 450       return;
 451     }
 452     if (j.seqs.getSeqs() == null)
 453     {
 454       // special case - selection consisted entirely of empty sequences...
 455       j.submitted = true;
 456       j.result = new MsaResult();
 457       j.result.setFinished(true);
 458       j.result.setStatus("Empty Alignment Job");
 459       ((MsaResult) j.result).setMsa(null);
 460     }
 461     try
 462     {
 463       vamsas.objects.simple.WsJobId jobsubmit = server.align(j.seqs);
 464
 465       if ( (jobsubmit != null) && (jobsubmit.getStatus() == 1))
 466       {
 467         j.jobId = jobsubmit.getJobId();
 468         j.submitted = true;
 469         j.subjobComplete = false;
 470         // System.out.println(WsURL + " Job Id '" + jobId + "'");
 471       }
 472       else
 473       {
 474         if (jobsubmit == null)
 475         {
 476           throw new Exception(
 477               "Server at "
 478               + WsUrl
 479               +
 480               " returned null object, it probably cannot be contacted. Try again later ?");
 481         }
 482
 483         throw new Exception(jobsubmit.getJobId());
 484       }
 485     }
 486     catch (Exception e)
 487     {
 488       // TODO: JBPNote catch timeout or other fault types explicitly
 489       // For unexpected errors
 490       System.err
 491           .println(WebServiceName
 492                    + "Client: Failed to submit the sequences for alignment (probably a server side problem)\n"
 493                    + "When contacting Server:" + WsUrl + "\n"
 494                    + e.toString() + "\n");
 495       j.allowedServerExceptions = 0;
 496       wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_SERVERERROR);
 497       wsInfo.setStatus(j.jobnum, WebserviceInfo.STATE_STOPPED_SERVERERROR);
 498       wsInfo
 499           .appendProgressText(
 500               j.jobnum,
 501               "Failed to submit sequences for alignment.\n"
 502               + "It is most likely that there is a problem with the server.\n"
 503               + "Just close the window\n");
 504
 505       // e.printStackTrace(); // TODO: JBPNote DEBUG
 506     }
 507   }
 508
 509   private jalview.datamodel.Sequence[] getVamsasAlignment(
 510       vamsas.objects.simple.Alignment valign)
 511   {
 512     vamsas.objects.simple.Sequence[] seqs = valign.getSeqs().getSeqs();
 513     jalview.datamodel.Sequence[] msa = new jalview.datamodel.Sequence[seqs.
 514         length];
 515
 516     for (int i = 0, j = seqs.length; i < j; i++)
 517     {
 518       msa[i] = new jalview.datamodel.Sequence(seqs[i].getId(), seqs[i]
 519                                               .getSeq());
 520     }
 521
 522     return msa;
 523   }
 524
 525   void parseResult()
 526   {
 527     int results = 0; // number of result sets received
 528     JobStateSummary finalState = new JobStateSummary();
 529     try
 530     {
 531       for (int j = 0; j < jobs.length; j++)
 532       {
 533         finalState.updateJobPanelState(wsInfo, OutputHeader, jobs[j]);
 534         if (jobs[j].submitted && jobs[j].subjobComplete && jobs[j].hasResults())
 535         {
 536           results++;
 537           vamsas.objects.simple.Alignment valign = ((MsaResult) jobs[j].result).getMsa();
 538           if (valign != null)
 539           {
 540             wsInfo.appendProgressText(jobs[j].jobnum,
 541                                       "\nAlignment Object Method Notes\n");
 542             String[] lines = valign.getMethod();
 543             for (int line = 0; line < lines.length; line++)
 544             {
 545               wsInfo.appendProgressText(jobs[j].jobnum, lines[line] + "\n");
 546             }
 547             // JBPNote The returned files from a webservice could be
 548             //  hidden behind icons in the monitor window that,
 549             // when clicked, pop up their corresponding data
 550           }
 551         }
 552       }
 553     }
 554     catch (Exception ex)
 555     {
 556
 557       Cache.log.error("Unexpected exception when processing results for " +
 558                       alTitle, ex);
 559       wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_ERROR);
 560     }
 561     if (results > 0)
 562     {
 563       wsInfo.showResultsNewFrame
 564           .addActionListener(new java.awt.event.ActionListener()
 565       {
 566         public void actionPerformed(
 567             java.awt.event.ActionEvent evt)
 568         {
 569           displayResults(true);
 570         }
 571       });
 572       wsInfo.mergeResults
 573           .addActionListener(new java.awt.event.ActionListener()
 574       {
 575         public void actionPerformed(
 576             java.awt.event.ActionEvent evt)
 577         {
 578           displayResults(false);
 579         }
 580       });
 581       wsInfo.setResultsReady();
 582     } else
 583       wsInfo.setFinishedNoResults();
 584   }
 585
 586   void displayResults(boolean newFrame)
 587   {
 588     // view input or result data for each block
 589     Vector alorders = new Vector();
 590     SequenceI[][] results=new SequenceI[jobs.length][];
 591     AlignmentOrder[] orders = new AlignmentOrder[jobs.length];
 592     SequenceI[] first=null;
 593     for (int j=0; j<jobs.length; j++) {
 594       if (jobs[j].hasResults()) {
 595         Object[] res = ( (MsaWSJob) jobs[j]).getAlignment();
 596         alorders.add(res[1]);
 597         results[j] = (SequenceI[]) res[0];
 598         orders[j] = (AlignmentOrder) res[1];
 599 //    SequenceI[] alignment = input.getUpdated
 600       } else {
 601         results[j]=null;
 602       }
 603     }
 604     Object[] newview = input.getUpdatedView(results, orders, '-');
 605     // trash references to original result data
 606     for (int j=0; j<jobs.length; j++) {
 607       results[j] = null;
 608       orders[j] = null;
 609     }
 610     SequenceI[] alignment = (SequenceI[]) newview[0];
 611     ColumnSelection columnselection = (ColumnSelection) newview[1];
 612     Alignment al = new Alignment(alignment);
 613     if (dataset != null)
 614     {
 615       al.setDataset(dataset);
 616     }
 617
 618     // JBNote- TODO: warn user if a block is input rather than aligned data ?
 619
 620     if (newFrame)
 621     {
 622       AlignFrame af = new AlignFrame(al, columnselection);
 623
 624       // >>>This is a fix for the moment, until a better solution is
 625       // found!!<<<
 626       af.getFeatureRenderer().transferSettings(
 627           alignFrame.getFeatureRenderer());
 628       // update orders
 629       if (alorders.size() > 0)
 630       {
 631         if (alorders.size() == 1)
 632         {
 633           af.addSortByOrderMenuItem(WebServiceName + " Ordering",
 634                                     (AlignmentOrder) alorders.get(0));
 635         }
 636         else
 637         {
 638           // construct a non-redundant ordering set
 639           Vector names = new Vector();
 640           for (int i = 0, l = alorders.size(); i < l; i++)
 641           {
 642             String orderName = new String(" Region " + i);
 643             int j = i + 1;
 644             int r = l;
 645             while (j < l)
 646             {
 647               if ( ( (AlignmentOrder) alorders.get(i)).equals( ( (
 648                   AlignmentOrder) alorders.get(j))))
 649               {
 650                 alorders.remove(j);
 651                 l--;
 652                 orderName += "," + j;
 653               }
 654               else
 655               {
 656                 j++;
 657               }
 658             }
 659
 660             if (i == 0 && j == 1)
 661             {
 662               names.add(new String(""));
 663             }
 664             else
 665             {
 666               names.add(orderName);
 667             }
 668           }
 669           for (int i = 0, l = alorders.size(); i < l; i++)
 670           {
 671             af.addSortByOrderMenuItem(WebServiceName
 672                                       +( (String) names.get(i)) +
 673                                       " Ordering",
 674                                       (AlignmentOrder) alorders.get(i));
 675           }
 676         }
 677       }
 678
 679       Desktop.addInternalFrame(af, alTitle,
 680                                AlignFrame.NEW_WINDOW_WIDTH,
 681                                AlignFrame.NEW_WINDOW_HEIGHT);
 682
 683     }
 684     else
 685     {
 686       System.out.println("MERGE WITH OLD FRAME");
 687
 688     }
 689   }
 690
 691   public boolean canMergeResults()
 692   {
 693     return false;
 694   }
 695 }