src/jalview/ws/WSClient.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.1)
   3  * Copyright (C) 2014 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 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  * The Jalview Authors are detailed in the 'AUTHORS' file.
  18  */
  19 package jalview.ws;
  20
  21 import jalview.gui.*;
  22
  23 public abstract class WSClient // implements WSMenuEntryProviderI
  24 {
  25   /**
  26    * WSClient holds the basic attributes that are displayed to the user for all
  27    * jalview web service clients
  28    */
  29   /**
  30    * displayed name for this web service
  31    */
  32   protected String WebServiceName;
  33
  34   /**
  35    * specific job title (e.g. 'ClustalW Alignment of Selection from Aligment
  36    * from Cut and Paste input')
  37    */
  38   protected String WebServiceJobTitle;
  39
  40   /**
  41    * String giving additional information such as method citations for this
  42    * service
  43    */
  44   protected String WebServiceReference;
  45
  46   /**
  47    * Service endpoint
  48    */
  49   protected String WsURL;
  50
  51   /**
  52    * Web service information used to initialise the WSClient attributes
  53    */
  54   protected WebserviceInfo wsInfo;
  55
  56   /**
  57    * total number of jobs managed by this web service client instance.
  58    */
  59   int jobsRunning = 0;
  60
  61   /**
  62    * TODO: this is really service metadata, and should be moved elsewhere.
  63    * mappings between abstract interface names and menu entries
  64    */
  65   protected java.util.Hashtable ServiceActions;
  66   {
  67     ServiceActions = new java.util.Hashtable();
  68     ServiceActions.put("MsaWS", "Multiple Sequence Alignment");
  69     ServiceActions.put("SecStrPred", "Secondary Structure Prediction");
  70   };
  71
  72   public WSClient()
  73   {
  74   }
  75 }