header updated
[jalview.git] / src / jalview / ws / MsaWSClient.java
index 253dfba..eb6ee38 100755 (executable)
@@ -1,6 +1,6 @@
 /*\r
  * Jalview - A Sequence Alignment Editor and Viewer\r
- * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
+ * Copyright (C) 2006 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
  *\r
  * This program is free software; you can redistribute it and/or\r
  * modify it under the terms of the GNU General Public License\r
@@ -43,6 +43,7 @@ public class MsaWSClient
    * server is a WSDL2Java generated stub for an archetypal MsaWSI service.\r
    */\r
   ext.vamsas.MuscleWS server;\r
+  AlignFrame alignFrame;\r
 \r
 \r
   /**\r
@@ -56,10 +57,14 @@ public class MsaWSClient
    * @param preserveOrder DOCUMENT ME!\r
    */\r
 \r
-  public MsaWSClient(ext.vamsas.ServiceHandle sh, String altitle, SequenceI[] msa,\r
-                     boolean submitGaps, boolean preserveOrder)\r
+  public MsaWSClient(ext.vamsas.ServiceHandle sh, String altitle,\r
+                     jalview.datamodel.AlignmentView msa,\r
+                     boolean submitGaps, boolean preserveOrder,\r
+                     Alignment seqdataset,\r
+                     AlignFrame _alignFrame)\r
   {\r
-\r
+    super();\r
+    alignFrame = _alignFrame;\r
     if (!sh.getAbstractName().equals("MsaWS"))\r
     {\r
       JOptionPane.showMessageDialog(Desktop.desktop,\r
@@ -71,7 +76,7 @@ public class MsaWSClient
       return;\r
     }\r
 \r
-    if ((wsInfo = this.setWebService(sh))==null)\r
+    if ((wsInfo = setWebService(sh))==null)\r
      {\r
        JOptionPane.showMessageDialog(Desktop.desktop,\r
                                      "The Multiple Sequence Alignment Service named " +\r
@@ -81,13 +86,13 @@ public class MsaWSClient
 \r
        return;\r
      }\r
-    startMsaWSClient(altitle, msa, submitGaps, preserveOrder);\r
+    startMsaWSClient(altitle, msa, submitGaps, preserveOrder, seqdataset);\r
 \r
   }\r
 \r
 \r
-  private void startMsaWSClient(String altitle, SequenceI[] msa,\r
-                     boolean submitGaps, boolean preserveOrder)\r
+  private void startMsaWSClient(String altitle, AlignmentView msa,\r
+                     boolean submitGaps, boolean preserveOrder, Alignment seqdataset)\r
   {\r
     if (!locateWebService())\r
     {\r
@@ -97,9 +102,11 @@ public class MsaWSClient
     wsInfo.setProgressText( ( (submitGaps) ? "Re-alignment" : "Alignment") +\r
                            " of " + altitle + "\nJob details\n");\r
 \r
-    MsaWSThread musclethread = new MsaWSThread(WebServiceName +\r
-                                               " alignment of " + altitle, msa,\r
-                                               submitGaps, preserveOrder);\r
+    MsaWSThread musclethread = new MsaWSThread(server, WsURL, wsInfo, alignFrame,\r
+                                               WebServiceName,\r
+                                               WebServiceName+" alignment of " + altitle,\r
+                                               msa,\r
+                                               submitGaps, preserveOrder, seqdataset);\r
     wsInfo.setthisService(musclethread);\r
     musclethread.start();\r
   }\r
@@ -125,7 +132,7 @@ public class MsaWSClient
                              " Service location failed\nfor URL :" + WsURL +\r
                              "\n" +\r
                              ex.getMessage());\r
-      wsInfo.setStatus(wsInfo.ERROR);\r
+      wsInfo.setStatus(WebserviceInfo.ERROR);\r
       ex.printStackTrace();\r
 \r
       return false;\r
@@ -136,352 +143,13 @@ public class MsaWSClient
     return true;\r
   }\r
 \r
-  protected class MsaWSThread\r
-      extends Thread implements WSClientI\r
+  protected String getServiceActionKey()\r
   {\r
-    String ServiceName = WebServiceName;\r
-    String OutputHeader;\r
-    vamsas.objects.simple.MsaResult result = null;\r
-    vamsas.objects.simple.SequenceSet seqs = new vamsas.objects.simple.\r
-        SequenceSet();\r
-    Hashtable SeqNames = null;\r
-    boolean submitGaps = false; // and always store and recover sequence order\r
-    boolean preserveOrder = true; // and always store and recover sequence order\r
-    String jobId;\r
-    String alTitle; // name which will be used to form new alignment window.\r
-    int allowedServerExceptions = 3; // thread dies if too many exceptions.\r
-    boolean jobComplete = false;\r
-\r
-    MsaWSThread(String title, SequenceI[] msa, boolean subgaps,\r
-                boolean presorder)\r
-    {\r
-      alTitle = title;\r
-      submitGaps = subgaps;\r
-      preserveOrder = presorder;\r
-\r
-      OutputHeader = wsInfo.getProgressText();\r
-      SeqNames = new Hashtable();\r
-\r
-      vamsas.objects.simple.Sequence[] seqarray = new vamsas.objects.simple.\r
-          Sequence[msa.length];\r
-\r
-      for (int i = 0; i < msa.length; i++)\r
-      {\r
-        String newname = jalview.analysis.SeqsetUtils.unique_name(i);\r
-\r
-        // uniquify as we go\r
-        // TODO: JBPNote: this is a ubiquitous transformation - set of jalview seq objects to vamsas sequences with name preservation\r
-        SeqNames.put(newname,\r
-                     jalview.analysis.SeqsetUtils.SeqCharacterHash(msa[i]));\r
-        seqarray[i] = new vamsas.objects.simple.Sequence();\r
-        seqarray[i].setId(newname);\r
-        seqarray[i].setSeq( (submitGaps) ? msa[i].getSequence()\r
-                           : AlignSeq.extractGaps(\r
-                               jalview.util.Comparison.GapChars,\r
-                               msa[i].getSequence()));\r
-      }\r
-\r
-      this.seqs = new vamsas.objects.simple.SequenceSet();\r
-      this.seqs.setSeqs(seqarray);\r
-    }\r
-\r
-    public boolean isCancellable()\r
-    {\r
-      return true;\r
-    }\r
-\r
-    public void cancelJob()\r
-    {\r
-      if ( (jobId != null) && !jobId.equals("") && !jobComplete)\r
-      {\r
-        String cancelledMessage = "";\r
-\r
-        try\r
-        {\r
-          vamsas.objects.simple.WsJobId cancelledJob = server.cancel(jobId);\r
-\r
-          if (cancelledJob.getStatus() == 2)\r
-          {\r
-            // CANCELLED_JOB\r
-            cancelledMessage = "Job cancelled.";\r
-            wsInfo.setStatus(WebserviceInfo.STATE_CANCELLED_OK);\r
-            jobComplete = true;\r
-            jobsRunning--;\r
-            result = null;\r
-          }\r
-          else if (cancelledJob.getStatus() == 3)\r
-          {\r
-            // VALID UNSTOPPABLE JOB\r
-            cancelledMessage +=\r
-                "Server cannot cancel this job. just close the window.\n";\r
-          }\r
-\r
-          if (cancelledJob.getJobId() != null)\r
-          {\r
-            cancelledMessage += ("[" + cancelledJob.getJobId() +\r
-                                 "]");\r
-          }\r
-\r
-          cancelledMessage += "\n";\r
-        }\r
-        catch (Exception exc)\r
-        {\r
-          cancelledMessage +=\r
-              ("\nProblems cancelling the job : Exception received...\n" +\r
-               exc + "\n");\r
-          exc.printStackTrace();\r
-        }\r
-\r
-        wsInfo.setProgressText(OutputHeader + cancelledMessage + "\n");\r
-      }\r
-      else\r
-      {\r
-        if (!jobComplete)\r
-        {\r
-          wsInfo.setProgressText(OutputHeader +\r
-                                 "Server cannot cancel this job because it has not been submitted properly. just close the window.\n");\r
-        }\r
-      }\r
-    }\r
-\r
-    public void run()\r
-    {\r
-      StartJob();\r
-\r
-      while (!jobComplete && (allowedServerExceptions > 0))\r
-      {\r
-        try\r
-        {\r
-          if ( (result = server.getResult(jobId)) == null)\r
-          {\r
-            throw (new Exception(\r
-                "Timed out when communicating with server\nTry again later.\n"));\r
-          }\r
-          jalview.bin.Cache.log.debug("Result state " + result.getState() +\r
-                                        "(ServerError=" + result.isServerError() +\r
-                                        ")");\r
-          if (result.isRunning())\r
-          {\r
-            wsInfo.setStatus(WebserviceInfo.STATE_RUNNING);\r
-          }\r
-          else if (result.isQueued())\r
-          {\r
-            wsInfo.setStatus(WebserviceInfo.STATE_QUEUING);\r
-          }\r
-\r
-          if (result.isFinished())\r
-          {\r
-            wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_OK);\r
-            parseResult();\r
-            jobComplete = true;\r
-            jobsRunning--;\r
-          }\r
-          else\r
-          {\r
-            if (result.getStatus() != null)\r
-            {\r
-              wsInfo.setProgressText(OutputHeader + "\n"+   result.getStatus());\r
-            }\r
-            if (result.isServerError())\r
-            {\r
-              jobComplete = true;\r
-              jobsRunning--;\r
-\r
-              break;\r
-            }\r
-            if (! (result.isJobFailed() || result.isServerError() ||\r
-                   result.isBroken() || result.isFailed()))\r
-            {\r
-              Thread.sleep(5000);\r
-\r
-              //  System.out.println("I'm alive "+seqid+" "+jobid);\r
-            }\r
-            else\r
-            {\r
-              jobComplete = true;\r
-              jobsRunning--;\r
-              break;\r
-            }\r
-          }\r
-        }\r
-        catch (Exception ex)\r
-        {\r
-          allowedServerExceptions--;\r
-          wsInfo.appendProgressText("\n" + ServiceName +\r
-                                    " Server exception!\n" + ex.getMessage());\r
-          System.err.println(ServiceName + " Server exception: " +\r
-                             ex.getMessage());\r
-\r
-          //          ex.printStackTrace(); JBPNote Debug\r
-          try\r
-          {\r
-            if (allowedServerExceptions > 0)\r
-            {\r
-              Thread.sleep(5000);\r
-            }\r
-          }\r
-          catch (InterruptedException ex1)\r
-          {\r
-          }\r
-        }\r
-        catch(OutOfMemoryError er)\r
-        {\r
-          jobComplete = true;\r
-          wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_ERROR);\r
-          JOptionPane.showInternalMessageDialog(Desktop.desktop,\r
-              "Out of memory handling result!!"\r
-             +"\nSee help files for increasing Java Virtual Machine memory."\r
-             ,"Out of memory", JOptionPane.WARNING_MESSAGE );\r
-          System.out.println("MsaWSClient: "+er);\r
-          System.gc();\r
-        }\r
-      }\r
-\r
-      if (allowedServerExceptions == 0)\r
-      {\r
-        wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_SERVERERROR);\r
-      }\r
-      else\r
-      {\r
-        if (result != null)\r
-        {\r
-          if ( !(result.isJobFailed() || result.isServerError()))\r
-          {\r
-            wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_OK);\r
-          }\r
-\r
-          if (result.isBroken() || result.isFailed())\r
-          {\r
-            wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_ERROR);\r
-          }\r
-\r
-          if (result.isServerError())\r
-          {\r
-            wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_SERVERERROR);\r
-          }\r
-        }\r
-      }\r
-    }\r
-\r
-    void StartJob()\r
-    {\r
-      try\r
-      {\r
-        vamsas.objects.simple.WsJobId jobsubmit = server.align(seqs);\r
-\r
-        if ( (jobsubmit != null) && (jobsubmit.getStatus() == 1))\r
-        {\r
-          jobId = jobsubmit.getJobId();\r
-          System.out.println(WsURL + " Job Id '" + jobId + "'");\r
-        }\r
-        else\r
-        {\r
-          if (jobsubmit == null)\r
-          {\r
-            throw new Exception("Server at " + WsURL +\r
-                                " returned null object, it probably cannot be contacted. Try again later ?");\r
-          }\r
-\r
-          throw new Exception(jobsubmit.getJobId());\r
-        }\r
-      }\r
-      catch (Exception e)\r
-      {\r
-        // TODO: JBPNote catch timeout or other fault types explicitly\r
-        // For unexpected errors\r
-        System.err.println(WebServiceName +\r
-                           "Client: Failed to submit the sequences for alignment (probably a server side problem)\n" +\r
-                           "When contacting Server:" + WsURL + "\n" +\r
-                           e.toString() +\r
-                           "\n");\r
-        this.allowedServerExceptions = 0;\r
-        wsInfo.setStatus(wsInfo.STATE_STOPPED_SERVERERROR);\r
-        wsInfo.appendProgressText(\r
-            "Failed to submit sequences for alignment.\n" +\r
-            "It is most likely that there is a problem with the server.\n" +\r
-            "Just close the window\n");\r
-\r
-        // e.printStackTrace(); // TODO: JBPNote DEBUG\r
-      }\r
-    }\r
-\r
-    private jalview.datamodel.Sequence[] getVamsasAlignment(\r
-        vamsas.objects.simple.Alignment valign)\r
-    {\r
-      vamsas.objects.simple.Sequence[] seqs = valign.getSeqs().getSeqs();\r
-      jalview.datamodel.Sequence[] msa = new jalview.datamodel.Sequence[seqs.\r
-          length];\r
-\r
-      for (int i = 0, j = seqs.length; i < j; i++)\r
-      {\r
-        msa[i] = new jalview.datamodel.Sequence(seqs[i].getId(),\r
-                                                seqs[i].getSeq());\r
-      }\r
-\r
-      return msa;\r
-    }\r
-\r
-    void parseResult()\r
-    {\r
-      SequenceI[] seqs = null;\r
-\r
-      try\r
-      {\r
-        // OutputHeader = output.getText();\r
-        if (result.isFailed())\r
-        {\r
-          OutputHeader += "Job failed.\n";\r
-        }\r
-\r
-        if (result.getStatus() != null)\r
-        {\r
-          OutputHeader += ("\n" + result.getStatus());\r
-        }\r
-\r
-        if (result.getMsa() != null)\r
-        {\r
-          OutputHeader += "\nAlignment Object Method Notes\n";\r
-\r
-          String[] lines = result.getMsa().getMethod();\r
-\r
-          for (int line = 0; line < lines.length; line++)\r
-          {\r
-            OutputHeader += (lines[line] + "\n");\r
-          }\r
-\r
-          // JBPNote The returned files from a webservice could be hidden behind icons in the monitor window that, when clicked, pop up their corresponding data\r
-          seqs = getVamsasAlignment(result.getMsa());\r
-        }\r
-\r
-        wsInfo.setProgressText(OutputHeader);\r
-\r
-        if (seqs != null)\r
-        {\r
-          AlignmentOrder msaorder = new AlignmentOrder(seqs);\r
-\r
-          if (preserveOrder)\r
-          {\r
-            jalview.analysis.AlignmentSorter.recoverOrder(seqs);\r
-          }\r
-\r
-          jalview.analysis.SeqsetUtils.deuniquify(SeqNames, seqs);\r
-\r
-          Alignment al = new Alignment(seqs);\r
-\r
-          // TODO: JBPNote Should also rename the query sequence sometime...\r
-          AlignFrame af = new AlignFrame(al);\r
-          af.addSortByOrderMenuItem(ServiceName + " Ordering",\r
-                                    msaorder);\r
+    return "MsaWS";\r
+  }\r
 \r
-          Desktop.addInternalFrame(af, alTitle,\r
-                                   AlignFrame.NEW_WINDOW_WIDTH,\r
-                                   AlignFrame.NEW_WINDOW_HEIGHT);\r
-        }\r
-      }\r
-      catch (Exception ex)\r
-      {\r
-        ex.printStackTrace();\r
-      }\r
-    }\r
+  protected String getServiceActionDescription()\r
+  {\r
+    return "Multiple Sequence Alignment";\r
   }\r
 }\r