src/jalview/ws/jws2/Jws2Client.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.jws2;
  22
  23 import jalview.gui.AlignFrame;
  24 import jalview.ws.api.ServiceWithParameters;
  25 import jalview.ws.params.ArgumentI;
  26 import jalview.ws.params.WsParamSetI;
  27 import java.util.List;
  28
  29 import javax.swing.JMenu;
  30
  31 /**
  32  * provides metadata for a jabaws2 service instance - resolves names, etc.
  33  *
  34  * @author JimP
  35  *
  36  */
  37 public abstract class Jws2Client extends jalview.ws.WSClient
  38 {
  39   /**
  40    * instantiate a new service client. preset and arguments are assumed to be
  41    * valid for the service
  42    *
  43    * @param _alignFrame
  44    * @param preset
  45    * @param arguments
  46    */
  47
  48   public Jws2Client(AlignFrame _alignFrame, WsParamSetI preset,
  49           List<ArgumentI> arguments)
  50   {
  51     super(_alignFrame, preset, arguments);
  52
  53   }
  54
  55   public Jws2Client()
  56   {
  57     // anonymous constructor - used for headless method calls only
  58   }
  59
  60
  61   /*
  62    * Jws2Instance serviceHandle; (non-Javadoc)
  63    *
  64    * @see jalview.ws.WSMenuEntryProviderI#attachWSMenuEntry(javax.swing.JMenu,
  65    * jalview.gui.AlignFrame)
  66    *
  67    * @Override public void attachWSMenuEntry(JMenu wsmenu, AlignFrame
  68    * alignFrame) { if (serviceHandle==null) { throw new
  69    * Error("Implementation error: No service handle for this Jws2 service."); }
  70    * attachWSMenuEntry(wsmenu, serviceHandle, alignFrame); }
  71    */
  72   /**
  73    * add the menu item for a particular jws2 service instance
  74    *
  75    * @param wsmenu
  76    * @param service
  77    * @param alignFrame
  78    */
  79   abstract void attachWSMenuEntry(JMenu wsmenu,
  80           final ServiceWithParameters service,
  81           final AlignFrame alignFrame);
  82
  83
  84 }