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