Allow for frame insets
[jalview.git] / src / jalview / ws / MsaWSClient.java
index 44ffa11..c159a94 100755 (executable)
-package jalview.ws;\r
-\r
-import org.apache.axis.client.*;\r
-import javax.xml.namespace.QName;\r
-import java.util.*;\r
-import jalview.datamodel.*;\r
-import jalview.gui.*;\r
-import javax.swing.*;\r
-import java.util.*;\r
-import java.awt.*;\r
-import jalview.analysis.AlignSeq;\r
-import ext.vamsas.*;\r
-import vamsas.objects.*;\r
-\r
-public class MsaWSClient\r
-{\r
-  int jobsRunning = 0;\r
-  ext.vamsas.MuscleWS server;\r
-  WebserviceInfo wsInfo;\r
-  /**\r
-   * MsaWSClient\r
-   *\r
-   * @param msa SequenceI[]\r
-   */\r
-  public MsaWSClient(SequenceI[] msa)\r
-  {\r
-    wsInfo = new jalview.gui.WebserviceInfo("Muscle Alignment job",\r
-                                "Edgar, Robert C. (2004), MUSCLE: multiple sequence alignment with high accuracy and high throughput, Nucleic Acids Research 32(5), 1792-97.");\r
-\r
-\r
-    wsInfo.setProgressText("Job details\n");\r
-\r
-\r
-    MuscleWSServiceLocator loc = new MuscleWSServiceLocator(); // Default\r
-    try {\r
-      this.server = (MuscleWS) loc.getMuscleWS(); // JBPNote will be set from properties\r
-    }\r
-    catch (Exception ex) {\r
-      wsInfo.setProgressText("Serious! MuscleWS Service location failed\nfor URL :"\r
-                     +loc.getMuscleWSAddress()+"\n"+ex.getMessage());\r
-      ex.printStackTrace();\r
-    }\r
-\r
-    MsaWSThread musclethread = new MsaWSThread(msa);\r
-    wsInfo.setthisService(musclethread);\r
-    musclethread.start();\r
-  }\r
-\r
-\r
-  protected class MsaWSThread extends Thread implements WSClientI\r
-  {\r
-    String ServiceName = "MuscleWS";\r
-    public boolean isCancellable()\r
-    {\r
-      return true;\r
-    }\r
-\r
-    String OutputHeader;\r
-    vamsas.objects.simple.MsaResult result = null;\r
-    vamsas.objects.simple.SequenceSet seqs = new vamsas.objects.simple.\r
-        SequenceSet();\r
-    String jobId;\r
-    int allowedServerExceptions = 3; // thread dies if too many exceptions.\r
-    MsaWSThread(SequenceI[] msa)\r
-    {\r
-      OutputHeader = wsInfo.getProgressText();\r
-      vamsas.objects.simple.Sequence[] seqarray = new vamsas.objects.simple.\r
-          Sequence[msa.length];\r
-      for (int i = 0; i < msa.length; i++)\r
-      {\r
-        seqarray[i] = new vamsas.objects.simple.Sequence();\r
-        seqarray[i].setId(msa[i].getName());\r
-        seqarray[i].setSeq(AlignSeq.extractGaps("-. ", msa[i].getSequence()));\r
-      }\r
-      this.seqs = new vamsas.objects.simple.SequenceSet();\r
-      this.seqs.setSeqs(seqarray);\r
-    }\r
-\r
-    boolean jobComplete = false;\r
-\r
-    public void cancelJob() {\r
-      if (!jobComplete) {\r
-        String cancelledMessage="";\r
-        try {\r
-          vamsas.objects.simple.WsJobId cancelledJob = server.cancel(jobId);\r
-          if (cancelledJob.getStatus() == 2)\r
-          {\r
-            // CANCELLED_JOB\r
-            cancelledMessage = "Job cancelled.";\r
-            jobComplete = true;\r
-            jobsRunning--;\r
-            result = null;\r
-          }\r
-          else\r
-          if (cancelledJob.getStatus() == 3)\r
-          {\r
-            // VALID UNSTOPPABLE JOB\r
-            cancelledMessage +=\r
-                "Server cannot cancel this job. just close the window.\n";\r
-          }\r
-          if (cancelledJob.getJobId() != null)\r
-            cancelledMessage += "[" + cancelledJob.getJobId() + "]";\r
-          cancelledMessage +="\n";\r
-        } catch (Exception exc) {\r
-          cancelledMessage +="\nProblems cancelling the job : Exception received...\n"+exc+"\n";\r
-          exc.printStackTrace();\r
-        }\r
-        wsInfo.setProgressText(OutputHeader + cancelledMessage+"\n");\r
-      }\r
-    }\r
-\r
-    public void run()\r
-    {\r
-\r
-      StartJob();\r
-\r
-      while (!jobComplete && (allowedServerExceptions > 0))\r
-      {\r
-        try\r
-        {\r
-          result = server.getResult(jobId);\r
-\r
-         if( result.isRunning() )\r
-           wsInfo.setStatus(WebserviceInfo.STATE_RUNNING);\r
-         else if( result.isQueued() )\r
-           wsInfo.setStatus(WebserviceInfo.STATE_QUEUING);\r
-\r
-          if (result.isFinished())\r
-          {\r
-            parseResult();\r
-            jobComplete = true;\r
-            jobsRunning--;\r
-          }\r
-          else\r
-          {\r
-            wsInfo.setProgressText(OutputHeader + "\n" + result.getStatus());\r
-            if (! (result.isJobFailed() || result.isServerError()))\r
-            {\r
-              Thread.sleep(5000);\r
-              //  System.out.println("I'm alive "+seqid+" "+jobid);\r
-            }\r
-          }\r
-        }\r
-        catch (Exception ex)\r
-        {\r
-          allowedServerExceptions--;\r
-          wsInfo.appendProgressText("\n"+ServiceName+" Server exception!\n" + ex.getMessage());\r
-          ex.printStackTrace();\r
-        }\r
-      }\r
-\r
-      if (! (result!=null && (result.isJobFailed() || result.isServerError())))\r
-        wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_OK);\r
-      else\r
-        wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_ERROR);\r
-    }\r
-\r
-    void StartJob()\r
-    {\r
-      try\r
-      {\r
-        vamsas.objects.simple.WsJobId jobsubmit = server.align(seqs);\r
-        if (jobsubmit.getStatus()==1) {\r
-          System.out.println(jobId=jobsubmit.getJobId());\r
-        } else {\r
-          throw new Exception(jobsubmit.getJobId());\r
-        }\r
-      }\r
-      catch (Exception e)\r
-      {\r
-        System.out.println(ServiceName + " Client: Failed to submit the prediction\n" +\r
-                           e.toString() + "\n");\r
-        e.printStackTrace();\r
-      }\r
-    }\r
-\r
-    private void addFloatAnnotations(Alignment al, int[] gapmap, Vector values, String Symname, String Visname, float min, float max, int winLength) {\r
-\r
-      Annotation[] annotations = new Annotation[al.getWidth()];\r
-      for (int j = 0; j < values.size(); j++)\r
-      {\r
-        float value = Float.parseFloat(values.get(j).toString());\r
-        annotations[gapmap[j]] = new Annotation("", value+"",' ',value);\r
-      }\r
-      al.addAnnotation(new AlignmentAnnotation(Symname, Visname, annotations, min, max, winLength));\r
-    }\r
-    private jalview.datamodel.Sequence[] getVamsasAlignment(vamsas.objects.simple.Alignment valign) {\r
-      vamsas.objects.simple.Sequence[] seqs = valign.getSeqs().getSeqs();\r
-      jalview.datamodel.Sequence[] msa = new jalview.datamodel.Sequence[seqs.length];\r
-      for (int i=0, j=seqs.length; i<j;i++)\r
-        msa[i] = new jalview.datamodel.Sequence(seqs[i].getId(), seqs[i].getSeq());\r
-      return msa;\r
-    }\r
-    void parseResult()\r
-    {\r
-      SequenceI[] seqs=null;\r
-      try {\r
-        // OutputHeader = output.getText();\r
-        if (result.isFailed()) {\r
-          OutputHeader +="Job failed.\n";\r
-        }\r
-        if (result.getStatus()!=null) {\r
-          OutputHeader += "\n"+result.getStatus();\r
-        }\r
-        if (result.getMsa()!=null) {\r
-          OutputHeader += "\nAlignment Object Method Notes\n";\r
-          String lines[] = result.getMsa().getMethod();\r
-          for (int line=0;line<lines.length; line++)\r
-            OutputHeader+=lines[line]+"\n";\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
-        if (seqs!=null) {\r
-          Alignment al;\r
-          al = new Alignment(seqs);\r
-\r
-          // TODO: JBPNote Should also rename the query sequence sometime...\r
-          AlignFrame af = new AlignFrame(al);\r
-          Desktop.addInternalFrame(af,\r
-                                   ServiceName + " Alignment",\r
-                                   AlignFrame.NEW_WINDOW_WIDTH,\r
-                                   AlignFrame.NEW_WINDOW_HEIGHT);\r
-        }\r
-      }catch(Exception ex){ex.printStackTrace();}\r
-\r
-    }\r
-\r
-  }\r
-  }\r
-\r
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer
+ * Copyright (C) 2006 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+ */
+package jalview.ws;
+
+import ext.vamsas.*;
+
+import jalview.datamodel.*;
+
+import jalview.gui.*;
+
+import javax.swing.*;
+
+/**
+ * DOCUMENT ME!
+ *
+ * @author $author$
+ * @version $Revision$
+ */
+public class MsaWSClient
+    extends WSClient
+{
+  /**
+   * server is a WSDL2Java generated stub for an archetypal MsaWSI service.
+   */
+  ext.vamsas.MuscleWS server;
+  AlignFrame alignFrame;
+
+
+  /**
+   * Creates a new MsaWSClient object that uses a service
+   * given by an externally retrieved ServiceHandle
+   *
+   * @param sh service handle of type AbstractName(MsaWS)
+   * @param altitle DOCUMENT ME!
+   * @param msa DOCUMENT ME!
+   * @param submitGaps DOCUMENT ME!
+   * @param preserveOrder DOCUMENT ME!
+   */
+
+  public MsaWSClient(ext.vamsas.ServiceHandle sh, String altitle,
+                     jalview.datamodel.AlignmentView msa,
+                     boolean submitGaps, boolean preserveOrder,
+                     Alignment seqdataset,
+                     AlignFrame _alignFrame)
+  {
+    super();
+    alignFrame = _alignFrame;
+    if (!sh.getAbstractName().equals("MsaWS"))
+    {
+      JOptionPane.showMessageDialog(Desktop.desktop,
+                                    "The Service called \n" + sh.getName() +
+          "\nis not a \nMultiple Sequence Alignment Service !",
+                                    "Internal Jalview Error",
+                                    JOptionPane.WARNING_MESSAGE);
+
+      return;
+    }
+
+    if ((wsInfo = setWebService(sh))==null)
+     {
+       JOptionPane.showMessageDialog(Desktop.desktop,
+                                     "The Multiple Sequence Alignment Service named " +
+                                     sh.getName() +
+                                     " is unknown", "Internal Jalview Error",
+                                     JOptionPane.WARNING_MESSAGE);
+
+       return;
+     }
+    startMsaWSClient(altitle, msa, submitGaps, preserveOrder, seqdataset);
+
+  }
+
+
+  private void startMsaWSClient(String altitle, AlignmentView msa,
+                     boolean submitGaps, boolean preserveOrder, Alignment seqdataset)
+  {
+    if (!locateWebService())
+    {
+      return;
+    }
+
+    wsInfo.setProgressText( ( (submitGaps) ? "Re-alignment" : "Alignment") +
+                           " of " + altitle + "\nJob details\n");
+    String jobtitle = WebServiceName.toLowerCase();
+    if (jobtitle.endsWith("alignment")) {
+        if (submitGaps
+                && (!jobtitle.endsWith("realignment")
+                ||   jobtitle.indexOf("profile")==-1)) {
+            int pos=jobtitle.indexOf("alignment");
+            jobtitle = WebServiceName.substring(0, pos) + "re-alignment of "+altitle;
+        } else {
+            jobtitle = WebServiceName+" of "+altitle;
+        }
+    } else {
+        jobtitle = WebServiceName+(submitGaps? " re" : " ") +"alignment of "+altitle;
+    }
+
+    MsaWSThread msathread = new MsaWSThread(server, WsURL, wsInfo, alignFrame,
+                                               WebServiceName,
+                                               jobtitle,
+                                               msa,
+                                               submitGaps, preserveOrder, seqdataset);
+    wsInfo.setthisService(msathread);
+    msathread.start();
+  }
+
+  /**
+   * Initializes the server field with a valid service implementation.
+   *
+   * @return true if service was located.
+   */
+  private boolean locateWebService()
+  {
+    // TODO: MuscleWS transmuted to generic MsaWS client
+    MuscleWSServiceLocator loc = new MuscleWSServiceLocator(); // Default
+
+    try
+    {
+      this.server = (MuscleWS) loc.getMuscleWS(new java.net.URL(WsURL));
+      ( (MuscleWSSoapBindingStub)this.server).setTimeout(60000); // One minute timeout
+    }
+    catch (Exception ex)
+    {
+      wsInfo.setProgressText("Serious! " + WebServiceName +
+                             " Service location failed\nfor URL :" + WsURL +
+                             "\n" +
+                             ex.getMessage());
+      wsInfo.setStatus(WebserviceInfo.ERROR);
+      ex.printStackTrace();
+
+      return false;
+    }
+
+    loc.getEngine().setOption("axis", "1");
+
+    return true;
+  }
+
+  protected String getServiceActionKey()
+  {
+    return "MsaWS";
+  }
+
+  protected String getServiceActionDescription()
+  {
+    return "Multiple Sequence Alignment";
+  }
+}