3 import jalview.bin.Cache;
4 import jalview.datamodel.SequenceI;
5 import jalview.gui.Preferences;
6 import jalview.util.MessageManager;
7 import jalview.viewmodel.AlignmentViewport;
8 import jalview.ws.params.ArgumentI;
9 import jalview.ws.params.ParamDatastoreI;
10 import jalview.ws.params.WsParamSetI;
11 import jalview.ws.params.simple.BooleanOption;
12 import jalview.ws.params.simple.DoubleParameter;
13 import jalview.ws.params.simple.IntegerParameter;
14 import jalview.ws.params.simple.LogarithmicParameter;
15 import jalview.ws.params.simple.Option;
16 import jalview.ws.params.simple.StringParameter;
18 import java.io.IOException;
19 import java.util.ArrayList;
20 import java.util.Arrays;
21 import java.util.Collection;
22 import java.util.List;
23 import java.util.Scanner;
25 public final class HMMERParamStore implements ParamDatastoreI
27 private static final String HMMBUILD = "hmmbuild";
29 private static final String HMMALIGN = "hmmalign";
31 private static final String HMMSEARCH = "hmmsearch";
35 private List<WsParamSetI> presets = new ArrayList<>();
37 private AlignmentViewport viewport;
39 private HMMERParamStore(String nam, AlignmentViewport av)
45 public static HMMERParamStore forBuild(AlignmentViewport viewport)
47 return new HMMERParamStore(HMMBUILD, viewport);
50 public static HMMERParamStore forAlign(AlignmentViewport viewport)
52 return new HMMERParamStore(HMMALIGN, viewport);
55 public static HMMERParamStore forSearch(AlignmentViewport viewport)
57 return new HMMERParamStore(HMMSEARCH, viewport);
61 public List<WsParamSetI> getPresets()
67 public WsParamSetI getPreset(String nam)
73 public List<ArgumentI> getServiceParameters()
75 List<ArgumentI> args = new ArrayList<>();
79 getHMMSearchParams(args);
82 getHMMAlignParams(args);
85 getHMMBuildParams(args);
94 * Answers default parameters for hmmsearch, taking into account any
95 * configured as user preferences
99 private void getHMMSearchParams(List<ArgumentI> args)
104 addChoiceOfHmm(args);
106 String names = Cache.getProperty(Preferences.HMMSEARCH_DBS);
107 if (names != null && !names.isEmpty())
109 List<String> databases = new ArrayList<>();
110 databases.add(MessageManager.getString(HMMSearch.THIS_ALIGNMENT_KEY));
111 Scanner nameScanner = new Scanner(names);
113 if (nameScanner.hasNext())
115 while (nameScanner.hasNext())
117 String next = nameScanner.next();
118 if ("null".equals(next))
120 Cache.setProperty(Preferences.HMMSEARCH_DBS, "");
121 Cache.setProperty(Preferences.HMMSEARCH_DB_PATHS, "");
130 args.add(new Option(MessageManager.getString(HMMSearch.DATABASE_KEY),
131 MessageManager.getString("label.database_for_hmmsearch"),
132 true, MessageManager.getString(HMMSearch.THIS_ALIGNMENT_KEY),
133 MessageManager.getString(HMMSearch.THIS_ALIGNMENT_KEY),
136 args.add(new BooleanOption(
137 MessageManager.getString(HMMSearch.AUTO_ALIGN_SEQS_KEY),
138 MessageManager.getString("label.auto_align_seqs_desc"), false,
140 args.add(new BooleanOption(
141 MessageManager.getString(HMMSearch.USE_ACCESSIONS_KEY),
142 MessageManager.getString("label.use_accessions_desc"), false,
144 args.add(new BooleanOption(
145 MessageManager.getString(HMMSearch.TRIM_TERMINI_KEY),
146 MessageManager.getString("label.trim_termini_desc"), false,
152 args.add(new IntegerParameter(
153 MessageManager.getString(HMMSearch.NUMBER_OF_RESULTS_KEY),
154 MessageManager.getString("label.number_of_results_desc"), true,
156 args.add(new StringParameter(
157 MessageManager.getString(HMMSearch.REPORTING_CUTOFF_KEY), null,
158 true, HMMSearch.CUTOFF_NONE, HMMSearch.CUTOFF_NONE,
159 Arrays.asList(HMMSearch.CUTOFF_NONE, HMMSearch.CUTOFF_EVALUE,
160 HMMSearch.CUTOFF_SCORE)));
161 args.add(new LogarithmicParameter(
162 MessageManager.getString(HMMSearch.SEQ_EVALUE_KEY),
163 MessageManager.getString("label.seq_e_value_desc"), false, 1D,
165 args.add(new LogarithmicParameter(
166 MessageManager.getString(HMMSearch.DOM_EVALUE_KEY),
167 MessageManager.getString("label.dom_e_value_desc"), false, 1D,
171 MessageManager.getString(HMMSearch.SEQ_SCORE_KEY),
172 MessageManager.getString("label.seq_score_desc"), false,
176 MessageManager.getString(HMMSearch.DOM_SCORE_KEY),
177 MessageManager.getString("label.dom_score_desc"), false,
182 * Answers default parameters for hmmalign, taking into account any configured
183 * as user preferences
187 private void getHMMAlignParams(List<ArgumentI> args)
189 addChoiceOfHmm(args);
191 boolean def = Cache.getDefault(Preferences.HMMALIGN_TRIM_TERMINI,
193 args.add(new BooleanOption(
194 MessageManager.getString("label.trim_termini"),
195 MessageManager.getString("label.trim_termini_desc"),
196 false, false, def, null));
200 * Adds an argument representing the choice of HMM sequences (profiles)
201 * against which to perform align or search, provided more than one is found
205 protected void addChoiceOfHmm(List<ArgumentI> args)
207 List<SequenceI> hmms = viewport.getAlignment().getHmmSequences();
210 List<String> options = new ArrayList<>();
211 for (SequenceI hmmSeq : hmms)
213 options.add(hmmSeq.getName());
215 String defseq = options.get(0);
216 Option option = new Option(MessageManager.getString("label.use_hmm"),
217 "", true, defseq, defseq, options, null);
223 * Answers default parameters for hmmbuild, taking into account any configured
224 * as user preferences
228 private void getHMMBuildParams(List<ArgumentI> args)
231 * name to give the computed alignment HMM consensus sequence
232 * (Jalview constructs group HMM consensus sequence names)
234 String defValue = "Alignment_HMM";
235 StringParameter nameParam = new StringParameter(MessageManager.getString("label.hmm_name"),
236 MessageManager.getString("label.hmm_name_desc"), true, defValue,
241 * only enable Use Reference Annotation if RF is present
243 if (viewport.hasReferenceAnnotation())
245 args.add(new BooleanOption(
246 MessageManager.getString("label.use_reference"),
247 MessageManager.getString("label.use_reference_desc"), true,
252 * choice of whether to compute HMM for alignment and/or group(s)
254 Collection<String> options = new ArrayList<>();
255 options.add(MessageManager.getString("label.alignment"));
256 options.add(MessageManager.getString("label.groups_and_alignment"));
257 options.add(MessageManager.getString("label.groups"));
258 options.add(MessageManager.getString("label.selected_group"));
259 args.add(new Option(MessageManager.getString("label.hmmbuild_for"),
260 MessageManager.getString("label.hmmbuild_for_desc"), true,
261 MessageManager.getString("label.alignment"),
262 MessageManager.getString("label.alignment"), options, null));
266 public boolean presetExists(String forName)
272 public void deletePreset(String forName)
277 public void storePreset(String presetName, String text,
278 List<ArgumentI> jobParams)
283 public void updatePreset(String oldName, String presetName, String text,
284 List<ArgumentI> jobParams)
289 public WsParamSetI parseServiceParameterFile(String forName,
290 String description, String[] serviceURL, String parameters)
297 public String generateServiceParameterFile(WsParamSetI pset)