added SeqSearch service interface. Documented and refactored web service client ...

[jalview.git] / src / jalview / ws / WSClient.java

diff --git a/src/jalview/ws/WSClient.java b/src/jalview/ws/WSClient.java
index 8c9acb5..91fd4b0 100755 (executable)
--- a/src/jalview/ws/WSClient.java
+++ b/src/jalview/ws/WSClient.java
@@ -18,23 +18,43 @@
  */
 package jalview.ws;
 
+import javax.swing.JMenu;
+
 import ext.vamsas.*;
 import jalview.gui.*;
 
-public class WSClient
+public abstract class WSClient
 {
   /**
-   * MsaWSClient
-   *
-   * @param msa SequenceI[]
+   * WSClient holds the basic attributes that are displayed to the user
+   * for all jalview web service clients
+   */
+  /**
+   * displayed name for this web service
    */
   protected String WebServiceName;
+  /**
+   * specific job title (e.g. 'ClustalW Alignment of Selection from Aligment from Cut and Paste input')
+   */
   protected String WebServiceJobTitle;
+  /**
+   * String giving additional information such as method citations for this service 
+   */
   protected String WebServiceReference;
+  /**
+   * Service endpoint
+   */
   protected String WsURL;
+  /**
+   * Web service information used to initialise the WSClient attributes
+   */
   protected WebserviceInfo wsInfo;
+  /**
+   * total number of jobs managed by this web service client instance. 
+   */
   int jobsRunning = 0;
   /**
+   * TODO: this is really service metadata, and should be moved elsewhere.
    * mappings between abstract interface names and menu entries
    */
   protected java.util.Hashtable ServiceActions;
@@ -46,9 +66,27 @@ public class WSClient
   public WSClient()
   {
   }
-
+  /**
+   * initialise WSClient service information attributes from the service handle
+   * @param sh
+   * @return the service instance information GUI for this client and job.
+   */
   protected WebserviceInfo setWebService(ServiceHandle sh)
   {
+    return setWebService(sh, false);
+  }
+  /**
+   * original service handle that this client was derived from
+   */
+  ServiceHandle serviceHandle=null;
+    /**
+     * initialise WSClient service information attributes from the service handle
+     * @param sh
+     * @param headless true implies no GUI objects will be created.
+     * @return the service instance information GUI for this client and job.
+     */
+  protected WebserviceInfo setWebService(ServiceHandle sh, boolean headless)
+  {
     WebServiceName = sh.getName();
     if (ServiceActions.containsKey(sh.getAbstractName()))
     {
@@ -62,9 +100,34 @@ public class WSClient
     }
     WebServiceReference = sh.getDescription();
     WsURL = sh.getEndpointURL();
-    WebserviceInfo wsInfo = new WebserviceInfo(WebServiceJobTitle,
+    WebserviceInfo wsInfo = null;
+    if (!headless)
+    {
+      wsInfo = new WebserviceInfo(WebServiceJobTitle,
                                                WebServiceReference);
-
+    }
     return wsInfo;
   }
+  /**
+   * convenience method to pass the serviceHandle reference that instantiated this 
+   * service on to the menu entry constructor
+   * @param wsmenu the menu to which any menu entries/sub menus are to be attached
+   * @param alignFrame the alignFrame instance that provides input data for the service
+   */
+  public void attachWSMenuEntry(JMenu wsmenu, final AlignFrame alignFrame)
+  {
+    if (serviceHandle==null)
+    {
+      throw new Error("IMPLEMENTATION ERROR: cannot attach WS Menu Entry without service handle reference!");
+    }
+    attachWSMenuEntry(wsmenu, serviceHandle, alignFrame);
+  }
+  /**
+   * method implemented by each WSClient implementation that creates menu entries that enact their service
+   * using data from alignFrame.
+   * @param wsmenu where new menu entries (and submenus) are to be attached
+   * @param serviceHandle the serviceHandle document for the service that entries are created for
+   * @param alignFrame
+   */
+  public abstract void attachWSMenuEntry(JMenu wsmenu, final ServiceHandle serviceHandle, final AlignFrame alignFrame);
 }