src/jalview/ws/jws1/WS1Client.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.ws.jws1;
  22
  23 import jalview.gui.AlignFrame;
  24 import jalview.gui.WebserviceInfo;
  25 import jalview.util.MessageManager;
  26 import jalview.ws.WSClient;
  27 import jalview.ws.WSMenuEntryProviderI;
  28
  29 import javax.swing.JMenu;
  30
  31 import ext.vamsas.ServiceHandle;
  32
  33 /**
  34  * JWS1 Specific UI attributes and methods
  35  *
  36  * @author JimP
  37  *
  38  */
  39 public abstract class WS1Client extends WSClient implements
  40         WSMenuEntryProviderI
  41 {
  42
  43   /**
  44    * original service handle that this client was derived from
  45    */
  46   ServiceHandle serviceHandle = null;
  47
  48   /**
  49    * default constructor
  50    */
  51   public WS1Client()
  52   {
  53     super();
  54   }
  55
  56   /**
  57    * initialise WSClient service information attributes from the service handle
  58    *
  59    * @param sh
  60    * @return the service instance information GUI for this client and job.
  61    */
  62   protected WebserviceInfo setWebService(ServiceHandle sh)
  63   {
  64     return setWebService(sh, false);
  65   }
  66
  67   /**
  68    * initialise WSClient service information attributes from the service handle
  69    *
  70    * @param sh
  71    * @param headless
  72    *          true implies no GUI objects will be created.
  73    * @return the service instance information GUI for this client and job.
  74    */
  75   protected WebserviceInfo setWebService(ServiceHandle sh, boolean headless)
  76   {
  77     WebServiceName = sh.getName();
  78     if (ServiceActions.containsKey(sh.getAbstractName()))
  79     {
  80       WebServiceJobTitle = sh.getName(); // TODO: control sh.Name specification
  81       // properly
  82       // add this for short names. +(String)
  83       // ServiceActions.get(sh.getAbstractName());
  84     }
  85     else
  86     {
  87       WebServiceJobTitle = sh.getAbstractName() + " using " + sh.getName();
  88
  89     }
  90     WebServiceReference = sh.getDescription();
  91     WsURL = sh.getEndpointURL();
  92     WebserviceInfo wsInfo = null;
  93     if (!headless)
  94     {
  95       wsInfo = new WebserviceInfo(WebServiceJobTitle, WebServiceReference,
  96               true);
  97     }
  98     return wsInfo;
  99   }
 100
 101   /**
 102    * convenience method to pass the serviceHandle reference that instantiated
 103    * this service on to the menu entry constructor
 104    *
 105    * @param wsmenu
 106    *          the menu to which any menu entries/sub menus are to be attached
 107    * @param alignFrame
 108    *          the alignFrame instance that provides input data for the service
 109    */
 110   public void attachWSMenuEntry(JMenu wsmenu, final AlignFrame alignFrame)
 111   {
 112     if (serviceHandle == null)
 113     {
 114       throw new Error(
 115               MessageManager
 116                       .getString("error.implementation_error_cannot_attach_ws_menu_entry"));
 117     }
 118     attachWSMenuEntry(wsmenu, serviceHandle, alignFrame);
 119   }
 120
 121   /**
 122    * method implemented by each concrete WS1Client implementation that creates
 123    * menu entries that enact their service using data from alignFrame.
 124    *
 125    * @param wsmenu
 126    *          where new menu entries (and submenus) are to be attached
 127    * @param serviceHandle
 128    *          the serviceHandle document for the service that entries are
 129    *          created for
 130    * @param alignFrame
 131    */
 132   public abstract void attachWSMenuEntry(JMenu wsmenu,
 133           final ServiceHandle serviceHandle, final AlignFrame alignFrame);
 134
 135 }