src/jalview/ws/params/AutoCalcSetting.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
   3  * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, 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.params;
  19
  20 import java.util.List;
  21
  22 public abstract class AutoCalcSetting
  23 {
  24
  25   protected boolean autoUpdate;
  26
  27   protected WsParamSetI preset;
  28
  29   protected List<ArgumentI> jobArgset;
  30
  31   public AutoCalcSetting(WsParamSetI preset2, List<ArgumentI> jobArgset2,
  32           boolean autoUpdate2)
  33   {
  34     autoUpdate = autoUpdate2;
  35     preset = preset2;
  36     jobArgset = jobArgset2;
  37   }
  38
  39   public boolean isAutoUpdate()
  40   {
  41     return autoUpdate;
  42   }
  43
  44   public void setAutoUpdate(boolean autoUpdate)
  45   {
  46     this.autoUpdate = autoUpdate;
  47   }
  48
  49   public WsParamSetI getPreset()
  50   {
  51     return preset;
  52   }
  53
  54   public void setPreset(WsParamSetI preset)
  55   {
  56     // TODO: test if service URL is in presets
  57     this.preset = preset;
  58   }
  59
  60   public List<ArgumentI> getArgumentSet()
  61   {
  62     return jobArgset;
  63   }
  64
  65   /**
  66    *
  67    * @return characteristic URI for this service. The URI should reflect the
  68    *         type and version of this service, enabling the service client code
  69    *         to recover the correct client for this calculation.
  70    */
  71   public abstract String getServiceURI();
  72
  73   /**
  74    * return any concrete service endpoints associated with this calculation.
  75    * built in services should return a zero length array
  76    *
  77    * @return
  78    */
  79   public abstract String[] getServiceURLs();
  80
  81   /**
  82    *
  83    * @return stringified representation of the parameters for this setting
  84    */
  85   public abstract String getWsParamFile();
  86
  87 }