2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
21 package jalview.ws.jws2;
23 import jalview.util.MessageManager;
25 import java.util.ArrayList;
26 import java.util.HashSet;
27 import java.util.List;
29 import compbio.metadata.Option;
30 import compbio.metadata.Parameter;
31 import compbio.metadata.RunnerConfig;
32 import compbio.metadata.ValueConstrain;
33 import compbio.metadata.WrongParameterException;
35 public class ParameterUtils
37 public static List<String> writeParameterSet(List<Option> optSet,
40 List<String> pset = new ArrayList<String>();
41 for (Option o : optSet)
43 pset.add(o.toCommand(pseparator));
49 * Converts options supplied via parameters file into {@code Option} objects
50 * (Refactored from compbio.ws.client.Jws2Client)
56 * @return List of Options of type T
60 * @SuppressWarnings(value = { "true" }) public static <T> List<Option<T>>
61 * processParameters(List<String> params, RunnerConfig<T> options, String
64 public static List<Option> processParameters(List<String> params,
65 RunnerConfig options, String pseparator)
67 List<Option> chosenOptions = new ArrayList<Option>();
68 for (String param : params)
71 if (isParameter(param, pseparator))
73 oname = getParamName(param, pseparator);
79 Option o = options.getArgumentByOptionName(oname);
83 .outPrintln("WARN ignoring unsuppoted parameter: " + oname);
86 if (o instanceof Parameter)
88 o = copyParameter((Parameter) o);
97 o.setDefaultValue(isParameter(param, pseparator)
98 ? getParamValue(param, pseparator)
100 } catch (WrongParameterException e)
102 jalview.bin.Console.outPrintln(
103 "Problem setting value for the parameter: " + param);
107 chosenOptions.add(o);
109 return chosenOptions;
112 static String getParamName(String fullName, String pseparator)
114 assert isParameter(fullName, pseparator);
115 return fullName.substring(0, fullName.indexOf(pseparator));
118 static String getParamValue(String fullName, String pseparator)
120 assert isParameter(fullName, pseparator);
121 return fullName.substring(fullName.indexOf(pseparator) + 1);
124 static boolean isParameter(String param, String pseparator)
126 return param.contains(pseparator);
129 public static Option copyOption(Option option)
131 Option copy = new Option(option.getName(), option.getDescription());
132 setOptionFrom(copy, option);
136 public static void setOptionFrom(Option copy, Option option)
138 copy.setName(option.getName());
139 copy.setDescription(option.getDescription());
140 copy.setBasicURL(option.getBasicURL());
141 copy.setFurtherDetails(option.getFurtherDetails());
142 copy.setRequired(option.isRequired());
143 List<String> names = option.getOptionNames();
146 if (names.size() == 1)
148 HashSet<String> st = new HashSet();
149 st.add(names.get(0));
150 copy.setOptionNames(st);
154 copy.addOptionNames(names.toArray(new String[] {}));
159 if (option.getDefaultValue() != null)
161 copy.setDefaultValue(option.getDefaultValue());
163 } catch (Exception ex)
165 ex.printStackTrace();
169 public static ValueConstrain copyValueConstrain(ValueConstrain vc)
173 ValueConstrain copy = new ValueConstrain();
174 if (vc.getMax() != null)
176 copy.setMax(vc.getMax().toString());
178 if (vc.getMin() != null)
180 copy.setMin(vc.getMin().toString());
182 if (vc.getType() != null)
184 copy.setType(vc.getType());
187 } catch (Exception e)
190 throw new Error(MessageManager.getString(
191 "error.implementation_error_couldnt_copy_value_constraint"));
195 public static Parameter copyParameter(Parameter parameter)
197 Parameter copy = new Parameter(parameter.getName(),
198 parameter.getDescription());
199 if (parameter.getValidValue() != null)
201 copy.setValidValue(copyValueConstrain(parameter.getValidValue()));
203 List<String> pv = parameter.getPossibleValues();
206 copy.addPossibleValues(pv.toArray(new String[] {}));
208 setOptionFrom(copy, parameter);