Merge branch 'develop' into update_212_Dec_merge_with_21125_chamges
[jalview.git] / src / jalview / ws / jws2 / MsaWSClient.java
index 9caa803..40583ab 100644 (file)
  */
 package jalview.ws.jws2;
 
-import java.util.Locale;
+import jalview.datamodel.AlignmentI;
+import jalview.datamodel.AlignmentView;
+import jalview.gui.AlignFrame;
+import jalview.gui.Desktop;
+import jalview.gui.JvOptionPane;
+import jalview.gui.JvSwingUtils;
+import jalview.util.MessageManager;
+import jalview.ws.WSMenuEntryProviderI;
+import jalview.ws.api.JalviewServiceEndpointProviderI;
+import jalview.ws.api.MultipleSequenceAlignmentI;
+import jalview.ws.api.ServiceWithParameters;
+import jalview.ws.gui.MsaWSThread;
+import jalview.ws.params.ArgumentI;
+import jalview.ws.params.WsParamSetI;
 
 import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
 import java.awt.event.MouseAdapter;
 import java.awt.event.MouseEvent;
 import java.util.List;
+import java.util.Locale;
 
 import javax.swing.JMenu;
 import javax.swing.JMenuItem;
 import javax.swing.ToolTipManager;
 
-import compbio.data.msa.MsaWS;
-import compbio.metadata.Argument;
-import jalview.datamodel.AlignmentI;
-import jalview.datamodel.AlignmentView;
-import jalview.gui.AlignFrame;
-import jalview.gui.Desktop;
-import jalview.gui.JvOptionPane;
-import jalview.gui.JvSwingUtils;
-import jalview.util.MessageManager;
-import jalview.ws.jws2.jabaws2.Jws2Instance;
-import jalview.ws.params.WsParamSetI;
 
 /**
- * DOCUMENT ME!
+ * MsaWSClient
  * 
- * @author $author$
+ * Instantiates web service menu items for multiple alignment services, and
+ * holds logic for constructing a web service thread.
+ * 
+ * TODO remove dependency on Jws2Client methods for creating AACon service UI
+ * elements.
+ * 
+ * @author Jim Procter et al
  * @version $Revision$
  */
-public class MsaWSClient extends Jws2Client
+public class MsaWSClient extends Jws2Client implements WSMenuEntryProviderI
 {
   /**
-   * server is a WSDL2Java generated stub for an archetypal MsaWSI service.
+   * server is a proxy class implementing the core methods for submitting,
+   * monitoring and retrieving results from a multiple sequence alignment
+   * service
    */
-  MsaWS server;
+  MultipleSequenceAlignmentI server;
 
-  public MsaWSClient(Jws2Instance sh, String altitle,
+  public MsaWSClient(ServiceWithParameters sh, String altitle,
           jalview.datamodel.AlignmentView msa, boolean submitGaps,
           boolean preserveOrder, AlignmentI seqdataset,
           AlignFrame _alignFrame)
@@ -67,7 +78,8 @@ public class MsaWSClient extends Jws2Client
     // TODO Auto-generated constructor stub
   }
 
-  public MsaWSClient(Jws2Instance sh, WsParamSetI preset, String altitle,
+  public MsaWSClient(ServiceWithParameters sh, WsParamSetI preset,
+          String altitle,
           jalview.datamodel.AlignmentView msa, boolean submitGaps,
           boolean preserveOrder, AlignmentI seqdataset,
           AlignFrame _alignFrame)
@@ -93,44 +105,48 @@ public class MsaWSClient extends Jws2Client
    *          DOCUMENT ME!
    */
 
-  public MsaWSClient(Jws2Instance sh, WsParamSetI preset,
-          List<Argument> arguments, boolean editParams, String altitle,
+  public MsaWSClient(ServiceWithParameters sh, WsParamSetI preset,
+          List<ArgumentI> arguments, boolean editParams, String altitle,
           jalview.datamodel.AlignmentView msa, boolean submitGaps,
           boolean preserveOrder, AlignmentI seqdataset,
           AlignFrame _alignFrame)
   {
     super(_alignFrame, preset, arguments);
-    if (!processParams(sh, editParams))
-    {
-      return;
-    }
-
-    if (!(sh.service instanceof MsaWS))
-    {
-      // redundant at mo - but may change
-      JvOptionPane.showMessageDialog(Desktop.desktop,
-              MessageManager.formatMessage(
-                      "label.service_called_is_not_msa_service",
-                      new String[]
-                      { sh.serviceType }),
-              MessageManager.getString("label.internal_jalview_error"),
-              JvOptionPane.WARNING_MESSAGE);
-
-      return;
-    }
-    server = (MsaWS) sh.service;
-    if ((wsInfo = setWebService(sh, false)) == null)
-    {
-      JvOptionPane.showMessageDialog(Desktop.desktop, MessageManager
-              .formatMessage("label.msa_service_is_unknown", new String[]
-              { sh.serviceType }),
-              MessageManager.getString("label.internal_jalview_error"),
-              JvOptionPane.WARNING_MESSAGE);
-
-      return;
-    }
-
-    startMsaWSClient(altitle, msa, submitGaps, preserveOrder, seqdataset);
+    processParams(sh, editParams).thenAccept((startJob) -> {
+      if (!startJob)
+        return;
+      
+      if (!(sh instanceof JalviewServiceEndpointProviderI
+              && ((JalviewServiceEndpointProviderI) sh)
+                      .getEndpoint() instanceof MultipleSequenceAlignmentI))
+      {
+        // redundant at mo - but may change
+        JvOptionPane.showMessageDialog(Desktop.getDesktopPane(),
+                MessageManager.formatMessage(
+                        "label.service_called_is_not_msa_service",
+                        new String[]
+                        { sh.getName() }),
+                MessageManager.getString("label.internal_jalview_error"),
+                JvOptionPane.WARNING_MESSAGE);
+  
+        return;
+      }
+      serviceHandle = sh;
+      server = (MultipleSequenceAlignmentI) ((JalviewServiceEndpointProviderI) sh)
+              .getEndpoint();
+      if ((wsInfo = setWebService(sh, false)) == null)
+      {
+        JvOptionPane.showMessageDialog(Desktop.getDesktopPane(), MessageManager
+                .formatMessage("label.msa_service_is_unknown", new String[]
+                { sh.getName() }),
+                MessageManager.getString("label.internal_jalview_error"),
+                JvOptionPane.WARNING_MESSAGE);
+  
+        return;
+      }
+  
+      startMsaWSClient(altitle, msa, submitGaps, preserveOrder, seqdataset);
+    });
 
   }
 
@@ -215,16 +231,28 @@ public class MsaWSClient extends Jws2Client
 
   @Override
   public void attachWSMenuEntry(JMenu rmsawsmenu,
-          final Jws2Instance service, final AlignFrame af)
+          final ServiceWithParameters service, final AlignFrame alignFrame)
   {
-    if (registerAAConWSInstance(rmsawsmenu, service, af))
+    if (Jws2ClientFactory.registerAAConWSInstance(rmsawsmenu,
+                    service, alignFrame))
     {
-      // Alignment dependent analysis calculation WS gui
+           // Alignment dependent analysis calculation WS gui
       return;
     }
+    serviceHandle = service;
     setWebService(service, true); // headless
+    attachWSMenuEntry(rmsawsmenu, alignFrame);
+  }
+
+  @Override
+  public void attachWSMenuEntry(JMenu wsmenu, AlignFrame alignFrame)
+  {
     boolean finished = true, submitGaps = false;
-    JMenu msawsmenu = rmsawsmenu;
+    /**
+     * temp variables holding msa service submenu or root service menu
+     */
+    JMenu msawsmenu = wsmenu;
+    JMenu rmsawsmenu = wsmenu;
     String svcname = WebServiceName;
     if (svcname.endsWith("WS"))
     {
@@ -237,7 +265,8 @@ public class MsaWSClient extends Jws2Client
       rmsawsmenu.add(msawsmenu);
       calcName = "";
     }
-    boolean hasparams = service.hasParameters();
+    boolean hasparams = serviceHandle.hasParameters();
+    ServiceWithParameters service = (ServiceWithParameters) serviceHandle;
     do
     {
       String action = "Align ";
@@ -265,12 +294,14 @@ public class MsaWSClient extends Jws2Client
         @Override
         public void actionPerformed(ActionEvent e)
         {
-          AlignmentView msa = af.gatherSequencesForAlignment();
+          AlignmentView msa = alignFrame.gatherSequencesForAlignment();
 
           if (msa != null)
           {
-            new MsaWSClient(service, af.getTitle(), msa, withGaps, true,
-                    af.getViewport().getAlignment().getDataset(), af);
+            new MsaWSClient(service, alignFrame.getTitle(), msa, withGaps,
+                    true,
+                    alignFrame.getViewport().getAlignment().getDataset(),
+                    alignFrame);
           }
 
         }
@@ -290,10 +321,13 @@ public class MsaWSClient extends Jws2Client
           @Override
           public void actionPerformed(ActionEvent e)
           {
-            AlignmentView msa = af.gatherSequencesForAlignment();
+            AlignmentView msa = alignFrame.gatherSequencesForAlignment();
             if (msa != null)
             {
-              startJob(service, af, withGaps, msa);
+              new MsaWSClient(service, null, null, true,
+                      alignFrame.getTitle(), msa, withGaps, true,
+                      alignFrame.getViewport().getAlignment().getDataset(),
+                      alignFrame);
             }
 
           }
@@ -308,9 +342,9 @@ public class MsaWSClient extends Jws2Client
 
           final int showToolTipFor = ToolTipManager.sharedInstance()
                   .getDismissDelay();
-          for (final WsParamSetI preSet : presets)
+          for (final WsParamSetI preset : presets)
           {
-            final JMenuItem methodR = new JMenuItem(preSet.getName());
+            final JMenuItem methodR = new JMenuItem(preset.getName());
             final int QUICK_TOOLTIP = 1500;
             // JAL-1582 shorten tooltip display time in these menu items as
             // they can obscure other options
@@ -332,24 +366,27 @@ public class MsaWSClient extends Jws2Client
 
             });
             String tooltip = JvSwingUtils.wrapTooltip(true, "<strong>"
-                    + (preSet.isModifiable()
+                    + (preset.isModifiable()
                             ? MessageManager.getString("label.user_preset")
                             : MessageManager
                                     .getString("label.service_preset"))
-                    + "</strong><br/>" + preSet.getDescription());
+                    + "</strong><br/>" + preset.getDescription());
             methodR.setToolTipText(tooltip);
             methodR.addActionListener(new ActionListener()
             {
               @Override
               public void actionPerformed(ActionEvent e)
               {
-                AlignmentView msa = af.gatherSequencesForAlignment();
+                AlignmentView msa = alignFrame
+                        .gatherSequencesForAlignment();
 
                 if (msa != null)
                 {
-                  MsaWSClient msac = new MsaWSClient(service, preSet,
-                          af.getTitle(), msa, false, true,
-                          af.getViewport().getAlignment().getDataset(), af);
+                  MsaWSClient msac = new MsaWSClient(service, preset,
+                          alignFrame.getTitle(), msa, false, true,
+                          alignFrame.getViewport().getAlignment()
+                                  .getDataset(),
+                          alignFrame);
                 }
 
               }
@@ -371,21 +408,4 @@ public class MsaWSClient extends Jws2Client
       }
     } while (!finished);
   }
-
-  protected void startJob(final Jws2Instance service, final AlignFrame af,
-          final boolean withGaps, AlignmentView msa)
-  {
-    try
-    {
-      new MsaWSClient(service, null, null, true, af.getTitle(), msa,
-              withGaps, true, af.getViewport().getAlignment().getDataset(),
-              af);
-    } catch (Exception e)
-    {
-      JvOptionPane.showMessageDialog(alignFrame, e.getMessage(),
-              MessageManager.getString("label.state_job_error"),
-              JvOptionPane.WARNING_MESSAGE);
-
-    }
-  }
 }