src/jalview/ws/params/AutoCalcSetting.java

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