JAL-1620 version bump and release notes
[jalview.git] / src / jalview / ws / jws2 / dm / AAConSettings.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2b1)
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
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.jws2.dm;
22
23 import java.util.ArrayList;
24 import java.util.List;
25
26 import compbio.metadata.Argument;
27 import compbio.metadata.Option;
28
29 import jalview.util.MessageManager;
30 import jalview.ws.jws2.JabaParamStore;
31 import jalview.ws.jws2.JabaPreset;
32 import jalview.ws.jws2.ParameterUtils;
33 import jalview.ws.jws2.jabaws2.Jws2Instance;
34 import jalview.ws.params.ArgumentI;
35 import jalview.ws.params.WsParamSetI;
36
37 /**
38  * preferences for running AACon service
39  * 
40  * @author jprocter TODO: refactor to a generic 'last job and service run'
41  *         container ?
42  */
43 public class AAConSettings extends jalview.ws.params.AutoCalcSetting
44 {
45   Jws2Instance service;
46
47   public AAConSettings(boolean autoUpdate, Jws2Instance service,
48           WsParamSetI preset, List<ArgumentI> jobArgset)
49   {
50     super(preset, jobArgset, autoUpdate);
51     this.service = service;
52   }
53
54   public Jws2Instance getService()
55   {
56     return service;
57   }
58
59   public void setService(Jws2Instance service)
60   {
61     this.service = service;
62     if (preset != null)
63     {
64       // migrate preset to new service
65       for (String url : preset.getApplicableUrls())
66       {
67         if (url.equals(service.getUri()))
68         {
69           return;
70         }
71       }
72       WsParamSetI pr = service.getParamStore().getPreset(preset.getName());
73       if (pr instanceof JabaPreset && preset instanceof JabaPreset)
74       {
75         // easy - Presets are identical (we assume)
76         preset = pr;
77         return;
78       }
79       List<ArgumentI> oldargs = new ArrayList<ArgumentI>(), newargs = new ArrayList<ArgumentI>();
80       oldargs.addAll(preset.getArguments());
81       // need to compare parameters
82       for (ArgumentI newparg : pr.getArguments())
83       {
84         if (!oldargs.remove(newparg))
85         {
86           newargs.add(newparg);
87         }
88       }
89       if (oldargs.size() == 0 && newargs.size() == 0)
90       {
91         // exact match.
92         preset = pr;
93         return;
94       }
95       // Try even harder to migrate arguments.
96       throw new Error(MessageManager.getString("error.parameter_migration_not_implemented_yet"));
97     }
98   }
99
100   public List<Argument> getJobArgset()
101   {
102     return jobArgset == null ? null : JabaParamStore
103             .getJabafromJwsArgs(jobArgset);
104   }
105
106   public void setJobArgset(List<Argument> jobArgset)
107   {
108     // TODO: test if parameters valid for service
109     this.jobArgset = jobArgset == null ? null : JabaParamStore
110             .getJwsArgsfromJaba(jobArgset);
111   }
112
113   public String getWsParamFile()
114   {
115     List<Option> opts = null;
116     if (jobArgset != null)
117     {
118       opts = JabaParamStore.getJabafromJwsArgs(jobArgset);
119     }
120     else
121     {
122       if (preset != null)
123       {
124         opts = JabaParamStore.getJabafromJwsArgs(preset.getArguments());
125       }
126     }
127     if (opts == null || opts.size() == 0)
128     {
129       return "";
130     }
131     StringBuffer pset = new StringBuffer();
132     for (String ps : ParameterUtils.writeParameterSet(opts, " "))
133     {
134       pset.append(ps);
135       pset.append("\n");
136     }
137     return pset.toString();
138   }
139
140   @Override
141   public String getServiceURI()
142   {
143     return service.getServiceTypeURI();
144   }
145
146   @Override
147   public String[] getServiceURLs()
148   {
149     return new String[]
150     { service.getUri() };
151   }
152 }