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