src/jalview/ws/MsaWSThread.java

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