JAL-3070 core service descriptors for JABAWS services abstracted to jalview.ws.api...
[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.jws2.JabaParamStore;
25 import jalview.ws.jws2.JabaPreset;
26 import jalview.ws.jws2.ParameterUtils;
27 import jalview.ws.jws2.jabaws2.Jws2Instance;
28 import jalview.ws.params.ArgumentI;
29 import jalview.ws.params.WsParamSetI;
30
31 import java.util.ArrayList;
32 import java.util.List;
33
34 import compbio.metadata.Argument;
35 import compbio.metadata.Option;
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<>(),
80               newargs = new ArrayList<>();
81       oldargs.addAll(preset.getArguments());
82       // need to compare parameters
83       for (ArgumentI newparg : pr.getArguments())
84       {
85         if (!oldargs.remove(newparg))
86         {
87           newargs.add(newparg);
88         }
89       }
90       if (oldargs.size() == 0 && newargs.size() == 0)
91       {
92         // exact match.
93         preset = pr;
94         return;
95       }
96       // Try even harder to migrate arguments.
97       throw new Error(MessageManager
98               .getString("error.parameter_migration_not_implemented_yet"));
99     }
100   }
101
102   public List<Argument> getJobArgset()
103   {
104     return jobArgset == null ? null
105             : JabaParamStore.getJabafromJwsArgs(jobArgset);
106   }
107
108   public void setJobArgset(List<Argument> jobArgset)
109   {
110     // TODO: test if parameters valid for service
111     this.jobArgset = jobArgset == null ? null
112             : JabaParamStore.getJwsArgsfromJaba(jobArgset);
113   }
114
115   @Override
116   public String getWsParamFile()
117   {
118     List<Option> opts = null;
119     if (jobArgset != null)
120     {
121       opts = JabaParamStore.getJabafromJwsArgs(jobArgset);
122     }
123     else
124     {
125       if (preset != null)
126       {
127         opts = JabaParamStore.getJabafromJwsArgs(preset.getArguments());
128       }
129     }
130     if (opts == null || opts.size() == 0)
131     {
132       return "";
133     }
134     StringBuffer pset = new StringBuffer();
135     for (String ps : ParameterUtils.writeParameterSet(opts, " "))
136     {
137       pset.append(ps);
138       pset.append("\n");
139     }
140     return pset.toString();
141   }
142
143   @Override
144   public String getServiceURI()
145   {
146     return service.getNameURI();
147   }
148
149   @Override
150   public String[] getServiceURLs()
151   {
152     return new String[] { service.getUri() };
153   }
154 }