Merge branch 'Jalview-JS/develop' into merge_js_develop
[jalview.git] / src / jalview / ws / rest / RestClient.java
index 21b9e53..2d39db5 100644 (file)
@@ -1,6 +1,6 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
- * Copyright (C) 2014 The Jalview Authors
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
  */
 package jalview.ws.rest;
 
-import java.awt.event.ActionEvent;
-import java.awt.event.ActionListener;
-import java.util.Hashtable;
-import java.util.Vector;
-
-import javax.swing.JMenu;
-import javax.swing.JMenuItem;
-import javax.swing.JOptionPane;
-import javax.swing.event.MenuEvent;
-import javax.swing.event.MenuListener;
-
+import jalview.bin.ApplicationSingletonProvider;
+import jalview.bin.ApplicationSingletonProvider.ApplicationSingletonI;
 import jalview.bin.Cache;
 import jalview.datamodel.AlignmentView;
 import jalview.gui.AlignFrame;
 import jalview.gui.AlignViewport;
 import jalview.gui.AlignmentPanel;
 import jalview.gui.Desktop;
+import jalview.gui.JvOptionPane;
 import jalview.gui.WebserviceInfo;
-import jalview.io.packed.DataProvider.JvDataType;
+import jalview.util.MessageManager;
 import jalview.ws.WSClient;
 import jalview.ws.WSClientI;
 import jalview.ws.WSMenuEntryProviderI;
+import jalview.ws.rest.clientdefs.ShmrRestClient;
+
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import java.util.Vector;
+
+import javax.swing.JMenu;
+import javax.swing.JMenuItem;
+import javax.swing.event.MenuEvent;
+import javax.swing.event.MenuListener;
 
 /**
  * @author JimP
  * 
  */
-public class RestClient extends WSClient implements WSClientI,
-        WSMenuEntryProviderI
+public class RestClient extends WSClient
+implements WSClientI, WSMenuEntryProviderI, ApplicationSingletonI
 {
+
+  @SuppressWarnings("unused")
+  private RestClient()
+  {
+    // accessed by ApplicationSingletonProvider
+  }
+
+  
+private static RestClient getInstance()
+{
+return (RestClient) ApplicationSingletonProvider.getInstance(RestClient.class);
+}
+
+public static final String RSBS_SERVICES = "RSBS_SERVICES";
+
+
+  protected Vector<String> services = null;
+
+
   RestServiceDescription service;
 
   public RestClient(RestServiceDescription rsd)
@@ -81,8 +102,11 @@ public class RestClient extends WSClient implements WSClientI,
   {
     this(service2, alignFrame, false);
   }
+
   boolean headless = false;
-  public RestClient(RestServiceDescription service2, AlignFrame alignFrame, boolean nogui)
+
+  public RestClient(RestServiceDescription service2, AlignFrame alignFrame,
+          boolean nogui)
   {
     service = service2;
     af = alignFrame;
@@ -93,18 +117,19 @@ public class RestClient extends WSClient implements WSClientI,
 
   public void setWebserviceInfo(boolean headless)
   {
-    WebServiceJobTitle = service.details.Action + " using "
-            + service.details.Name;
-    WebServiceName = service.details.Name;
+    WebServiceJobTitle = MessageManager
+            .formatMessage("label.webservice_job_title", new String[]
+            { service.details.getAction(), service.details.getName() });
+    WebServiceName = service.details.getName();
     WebServiceReference = "No reference - go to url for more info";
-    if (service.details.description != null)
+    if (service.details.getDescription() != null)
     {
-      WebServiceReference = service.details.description;
+      WebServiceReference = service.details.getDescription();
     }
     if (!headless)
     {
-      wsInfo = new WebserviceInfo(WebServiceJobTitle, WebServiceName + "\n"
-              + WebServiceReference);
+      wsInfo = new WebserviceInfo(WebServiceJobTitle,
+              WebServiceName + "\n" + WebServiceReference, Desktop.FRAME_MAKE_VISIBLE);
       wsInfo.setRenderAsHtml(true);
     }
 
@@ -136,9 +161,10 @@ public class RestClient extends WSClient implements WSClientI,
   public void attachWSMenuEntry(final JMenu wsmenu,
           final AlignFrame alignFrame)
   {
-    JMenuItem submit = new JMenuItem(service.details.Name);
-    submit.setToolTipText(service.details.Action + " using "
-            + service.details.Name);
+    JMenuItem submit = new JMenuItem(service.details.getName());
+    submit.setToolTipText(MessageManager
+            .formatMessage("label.rest_client_submit", new String[]
+            { service.details.getAction(), service.details.getName() }));
     submit.addActionListener(new ActionListener()
     {
 
@@ -228,6 +254,7 @@ public class RestClient extends WSClient implements WSClientI,
    * informative name for results
    */
   public String viewTitle;
+
   protected void constructJob()
   {
     service.setInvolvesFlags();
@@ -252,40 +279,58 @@ public class RestClient extends WSClient implements WSClientI,
         {
           // intersect groups with selected region
           _input = new AlignmentView(av.getAlignment(),
-                  av.getColumnSelection(), av.getSelectionGroup(),
-                  av.hasHiddenColumns(), true, true);
-          viewTitle = "selected "
-                  + (av.hasHiddenColumns() ? "visible" : "")
-                  + " region of " + af.getTitle();
+                  av.getAlignment().getHiddenColumns(),
+                  av.getSelectionGroup(), av.hasHiddenColumns(), true,
+                  true);
+          viewTitle = MessageManager.formatMessage(
+                  "label.select_visible_region_of", new String[]
+                  { (av.hasHiddenColumns()
+                          ? MessageManager.getString("label.visible")
+                          : ""),
+                      af.getTitle() });
         }
         else
         {
           // use selected region to partition alignment
           _input = new AlignmentView(av.getAlignment(),
-                  av.getColumnSelection(), av.getSelectionGroup(),
-                  av.hasHiddenColumns(), false, true);
+                  av.getAlignment().getHiddenColumns(),
+                  av.getSelectionGroup(), av.hasHiddenColumns(), false,
+                  true);
         }
-        viewTitle = "select and unselected "
-                + (av.hasHiddenColumns() ? "visible" : "")
-                + " regions from " + af.getTitle();
+        viewTitle = MessageManager.formatMessage(
+                "label.select_unselect_visible_regions_from", new String[]
+                { (av.hasHiddenColumns()
+                        ? MessageManager.getString("label.visible")
+                        : ""),
+                    af.getTitle() });
       }
       else
       {
         // just take selected region intersection
         _input = new AlignmentView(av.getAlignment(),
-                av.getColumnSelection(), av.getSelectionGroup(),
-                av.hasHiddenColumns(), true, true);
-        viewTitle = "selected " + (av.hasHiddenColumns() ? "visible" : "")
-                + " region of " + af.getTitle();
+                av.getAlignment().getHiddenColumns(),
+                av.getSelectionGroup(), av.hasHiddenColumns(), true, true);
+        viewTitle = MessageManager.formatMessage(
+                "label.select_visible_region_of", new String[]
+                { (av.hasHiddenColumns()
+                        ? MessageManager.getString("label.visible")
+                        : ""),
+                    af.getTitle() });
       }
     }
     else
     {
       // standard alignment view without selection present
       _input = new AlignmentView(av.getAlignment(),
-              av.getColumnSelection(), null, av.hasHiddenColumns(), false,
-              true);
-      viewTitle = "" + (av.hasHiddenColumns() ? "visible region of " : "")
+              av.getAlignment().getHiddenColumns(), null,
+              av.hasHiddenColumns(), false, true);
+      viewTitle = ""
+              + (av.hasHiddenColumns()
+                      ? (new StringBuffer(" ")
+                              .append(MessageManager
+                                      .getString("label.visible_region_of"))
+                              .toString())
+                      : "")
               + af.getTitle();
     }
 
@@ -294,7 +339,8 @@ public class RestClient extends WSClient implements WSClientI,
     if (jobsthread.isValid())
     {
       setWebserviceInfo(headless);
-      if (!headless) {
+      if (!headless)
+      {
         wsInfo.setthisService(this);
         jobsthread.setWebServiceInfo(wsInfo);
       }
@@ -303,56 +349,16 @@ public class RestClient extends WSClient implements WSClientI,
     else
     {
       // TODO: try to tell the user why the job couldn't be started.
-      JOptionPane
-              .showMessageDialog(
-                      Desktop.desktop,
-                      (jobsthread.hasWarnings() ? jobsthread.getWarnings()
-                              : "The Job couldn't be started. Please check your input, and the Jalview console for any warning messages."),
-                      "Unable to start web service analysis",
-                      JOptionPane.WARNING_MESSAGE);
+      JvOptionPane.showMessageDialog(Desktop.getDesktopPane(),
+              (jobsthread.hasWarnings() ? jobsthread.getWarnings()
+                      : MessageManager.getString(
+                              "label.job_couldnt_be_started_check_input")),
+              MessageManager
+                      .getString("label.unable_start_web_service_analysis"),
+              JvOptionPane.WARNING_MESSAGE);
     }
   }
 
-  public static RestClient makeShmmrRestClient()
-  {
-    String action = "Analysis", description = "Sequence Harmony and Multi-Relief (Brandt et al. 2010)", name = "Multi-Harmony";
-    Hashtable<String, InputType> iparams = new Hashtable<String, InputType>();
-    jalview.ws.rest.params.JobConstant toolp;
-    // toolp = new jalview.ws.rest.JobConstant("tool","jalview");
-    // iparams.put(toolp.token, toolp);
-    // toolp = new jalview.ws.rest.params.JobConstant("mbjob[method]","shmr");
-    // iparams.put(toolp.token, toolp);
-    // toolp = new
-    // jalview.ws.rest.params.JobConstant("mbjob[description]","step 1");
-    // iparams.put(toolp.token, toolp);
-    // toolp = new jalview.ws.rest.params.JobConstant("start_search","1");
-    // iparams.put(toolp.token, toolp);
-    // toolp = new jalview.ws.rest.params.JobConstant("blast","0");
-    // iparams.put(toolp.token, toolp);
-
-    jalview.ws.rest.params.Alignment aliinput = new jalview.ws.rest.params.Alignment();
-    // SHMR server has a 65K limit for content pasted into the 'ali' parameter,
-    // so we always upload our files.
-    aliinput.token = "ali_file";
-    aliinput.writeAsFile = true;
-    iparams.put(aliinput.token, aliinput);
-    jalview.ws.rest.params.SeqGroupIndexVector sgroups = new jalview.ws.rest.params.SeqGroupIndexVector();
-    sgroups.setMinsize(2);
-    sgroups.min = 2;// need at least two group defined to make a partition
-    iparams.put("groups", sgroups);
-    sgroups.token = "groups";
-    sgroups.sep = " ";
-    RestServiceDescription shmrService = new RestServiceDescription(
-            action,
-            description,
-            name,
-            "http://zeus.few.vu.nl/programs/shmrwww/index.php?tool=jalview",// ?tool=jalview&mbjob[method]=shmr&mbjob[description]=step1",
-            "?tool=jalview", iparams, true, false, '-');
-    // a priori knowledge of the data returned from the service
-    shmrService.addResultDatatype(JvDataType.ANNOTATION);
-    return new RestClient(shmrService);
-  }
-
   public AlignmentPanel recoverAlignPanelForView()
   {
     AlignmentPanel[] aps = Desktop
@@ -373,28 +379,29 @@ public class RestClient extends WSClient implements WSClientI,
     return true;
   }
 
-  protected static Vector<String> services = null;
-
-  public static final String RSBS_SERVICES = "RSBS_SERVICES";
-
   public static RestClient[] getRestClients()
   {
+    return getInstance().getClients();
+  }
+    
+  private RestClient[] getClients()
+  {
     if (services == null)
     {
-      services = new Vector<String>();
+      services = new Vector<>();
       try
       {
         for (RestServiceDescription descr : RestServiceDescription
                 .parseDescriptions(jalview.bin.Cache.getDefault(
                         RSBS_SERVICES,
-                        makeShmmrRestClient().service.toString())))
+                        ShmrRestClient.makeShmmrRestClient().service.toString())))
         {
           services.add(descr.toString());
         }
       } catch (Exception ex)
       {
-        System.err
-                .println("Serious - RSBS descriptions in user preferences are corrupt!");
+        System.err.println(
+                "Serious - RSBS descriptions in user preferences are corrupt!");
         ex.printStackTrace();
       }
 
@@ -408,36 +415,9 @@ public class RestClient extends WSClient implements WSClientI,
     return lst;
   }
 
-  public static void main(String args[])
-  {
-    try
-    {
-      RestClient[] clients = getRestClients();
-      System.out.println("Got " + clients.length + " clients.");
-      int i = 0;
-      Vector<String> urls = new Vector<String>();
-      for (RestClient cl : clients)
-      {
-        System.out.println("" + (++i) + ": " + cl.service.toString());
-        urls.add(cl.service.toString());
-      }
-      setRsbsServices(urls);
-      if (clients.length != getRestClients().length)
-      {
-        System.err
-                .println("Failed. Differing numbers of clients when stringified and parsed again.");
-      }
-
-    } catch (Throwable x)
-    {
-      System.err.println("Failed. Unexpected exception.");
-      x.printStackTrace();
-    }
-  }
-
   public String getAction()
   {
-    return service.details.Action;
+    return service.details.getAction();
   }
 
   public RestServiceDescription getRestDescription()
@@ -447,7 +427,7 @@ public class RestClient extends WSClient implements WSClientI,
 
   public static Vector<String> getRsbsDescriptions()
   {
-    Vector<String> rsbsDescrs = new Vector<String>();
+    Vector<String> rsbsDescrs = new Vector<>();
     for (RestClient rsbs : getRestClients())
     {
       rsbsDescrs.add(rsbs.getRestDescription().toString());
@@ -459,10 +439,11 @@ public class RestClient extends WSClient implements WSClientI,
   {
     if (rsbsUrls != null)
     {
+      
       // TODO: consider validating services ?
-      services = new Vector<String>(rsbsUrls);
+      getInstance().services = new Vector<String>(rsbsUrls);
       StringBuffer sprop = new StringBuffer();
-      for (String s : services)
+      for (String s : getInstance().services)
       {
         sprop.append(s);
       }