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