src/jalview/ws/jws2/Jws2Client.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
   3  * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
   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 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18 package jalview.ws.jws2;
  19
  20 import javax.swing.JMenu;
  21
  22 import jalview.gui.AlignFrame;
  23 import jalview.gui.WebserviceInfo;
  24 import jalview.ws.jws2.Jws2Discoverer.Jws2Instance;
  25
  26 /**
  27  * provides metadata for a jws2 service instance - resolves names, etc.
  28  *
  29  * @author JimP
  30  *
  31  */
  32 public abstract class Jws2Client extends jalview.ws.WSClient
  33 {
  34   protected WebserviceInfo setWebService(Jws2Instance serv, boolean b)
  35   {
  36     // serviceHandle = serv;
  37     String serviceInstance = serv.service.getClass().getName();
  38     WebServiceName = serv.serviceType;
  39     WebServiceJobTitle = serv.getActionText();
  40     WsURL = serv.hosturl;
  41     if (!b)
  42     {
  43       return new WebserviceInfo(WebServiceJobTitle, WebServiceJobTitle
  44               + " using service hosted at " + serv.hosturl);
  45     }
  46     return null;
  47   }
  48
  49   /*
  50    * Jws2Instance serviceHandle; (non-Javadoc)
  51    *
  52    * @see jalview.ws.WSMenuEntryProviderI#attachWSMenuEntry(javax.swing.JMenu,
  53    * jalview.gui.AlignFrame)
  54    *
  55    * @Override public void attachWSMenuEntry(JMenu wsmenu, AlignFrame
  56    * alignFrame) { if (serviceHandle==null) { throw new
  57    * Error("Implementation error: No service handle for this Jws2 service."); }
  58    * attachWSMenuEntry(wsmenu, serviceHandle, alignFrame); }
  59    */
  60   /**
  61    * add the menu item for a particular jws2 service instance
  62    *
  63    * @param wsmenu
  64    * @param service
  65    * @param alignFrame
  66    */
  67   abstract void attachWSMenuEntry(JMenu wsmenu, final Jws2Instance service,
  68           final AlignFrame alignFrame);
  69
  70 }