2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
3 * Copyright (C) 2014 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 java.awt.event.ActionEvent;
24 import java.awt.event.ActionListener;
25 import java.util.List;
29 import jalview.datamodel.*;
31 import compbio.data.msa.MsaWS;
32 import compbio.metadata.Argument;
33 import jalview.util.MessageManager;
34 import jalview.ws.jws2.jabaws2.Jws2Instance;
35 import jalview.ws.params.WsParamSetI;
43 public class MsaWSClient extends Jws2Client
46 * server is a WSDL2Java generated stub for an archetypal MsaWSI service.
50 public MsaWSClient(Jws2Instance sh, String altitle,
51 jalview.datamodel.AlignmentView msa, boolean submitGaps,
52 boolean preserveOrder, Alignment seqdataset,
53 AlignFrame _alignFrame)
55 this(sh, null, null, false, altitle, msa, submitGaps, preserveOrder,
56 seqdataset, _alignFrame);
57 // TODO Auto-generated constructor stub
60 public MsaWSClient(Jws2Instance sh, WsParamSetI preset, String altitle,
61 jalview.datamodel.AlignmentView msa, boolean submitGaps,
62 boolean preserveOrder, Alignment seqdataset,
63 AlignFrame _alignFrame)
65 this(sh, preset, null, false, altitle, msa, submitGaps, preserveOrder,
66 seqdataset, _alignFrame);
67 // TODO Auto-generated constructor stub
71 * Creates a new MsaWSClient object that uses a service given by an externally
72 * retrieved ServiceHandle
75 * service handle of type AbstractName(MsaWS)
82 * @param preserveOrder
86 public MsaWSClient(Jws2Instance sh, WsParamSetI preset,
87 List<Argument> arguments, boolean editParams, String altitle,
88 jalview.datamodel.AlignmentView msa, boolean submitGaps,
89 boolean preserveOrder, Alignment seqdataset,
90 AlignFrame _alignFrame)
92 super(_alignFrame, preset, arguments);
93 if (!processParams(sh, editParams))
98 if (!(sh.service instanceof MsaWS))
100 // redundant at mo - but may change
104 "The Service called \n"
106 + "\nis not a \nMultiple Sequence Alignment Service !",
107 "Internal Jalview Error", JOptionPane.WARNING_MESSAGE);
111 server = (MsaWS) sh.service;
112 if ((wsInfo = setWebService(sh, false)) == null)
114 JOptionPane.showMessageDialog(Desktop.desktop,
115 "The Multiple Sequence Alignment Service named "
116 + sh.serviceType + " is unknown",
117 "Internal Jalview Error", JOptionPane.WARNING_MESSAGE);
121 startMsaWSClient(altitle, msa, submitGaps, preserveOrder, seqdataset);
128 // add a class reference to the list
131 private void startMsaWSClient(String altitle, AlignmentView msa,
132 boolean submitGaps, boolean preserveOrder, Alignment seqdataset)
134 // if (!locateWebService())
139 wsInfo.setProgressText(((submitGaps) ? "Re-alignment" : "Alignment")
140 + " of " + altitle + "\nJob details\n");
141 String jobtitle = WebServiceName.toLowerCase();
142 if (jobtitle.endsWith("alignment"))
145 && (!jobtitle.endsWith("realignment") || jobtitle
146 .indexOf("profile") == -1))
148 int pos = jobtitle.indexOf("alignment");
149 jobtitle = WebServiceName.substring(0, pos) + "re-alignment of "
154 jobtitle = WebServiceName + " of " + altitle;
159 jobtitle = WebServiceName + (submitGaps ? " re" : " ")
160 + "alignment of " + altitle;
163 MsaWSThread msathread = new MsaWSThread(server, preset, paramset,
164 WsURL, wsInfo, alignFrame, WebServiceName, jobtitle, msa,
165 submitGaps, preserveOrder, seqdataset);
166 wsInfo.setthisService(msathread);
170 protected String getServiceActionKey()
175 protected String getServiceActionDescription()
177 return "Multiple Sequence Alignment";
181 * look at ourselves and work out if we are a service that can take a profile
184 * @return true if we can send gapped sequences to the alignment service
186 private boolean canSubmitGaps()
188 // TODO: query service or extract service handle props to check if we can
190 return (WebServiceName.indexOf("lustal") > -1); // cheat!
193 public void attachWSMenuEntry(JMenu rmsawsmenu,
194 final Jws2Instance service, final AlignFrame alignFrame)
196 if (registerAAConWSInstance(rmsawsmenu, service, alignFrame))
198 // Alignment dependent analysis calculation WS gui
201 setWebService(service, true); // headless
202 boolean finished = true, submitGaps = false;
203 JMenu msawsmenu = rmsawsmenu;
204 String svcname = WebServiceName;
205 if (svcname.endsWith("WS"))
207 svcname = svcname.substring(0, svcname.length() - 2);
209 String calcName = svcname + " ";
212 msawsmenu = new JMenu(svcname);
213 rmsawsmenu.add(msawsmenu);
216 boolean hasparams = service.hasParameters();
219 String action = "Align ";
220 if (submitGaps == true)
223 msawsmenu = new JMenu(MessageManager.formatMessage(
224 "label.realign_with_params", new String[]
226 msawsmenu.setToolTipText(MessageManager
227 .getString("label.align_sequences_to_existing_alignment"));
228 rmsawsmenu.add(msawsmenu);
230 final boolean withGaps = submitGaps;
232 JMenuItem method = new JMenuItem(MessageManager.formatMessage(
233 "label.calcname_with_default_settings", new String[]
235 method.setToolTipText(MessageManager.formatMessage(
236 "label.action_with_default_settings", new String[]
239 method.addActionListener(new ActionListener()
241 public void actionPerformed(ActionEvent e)
243 AlignmentView msa = alignFrame.gatherSequencesForAlignment();
244 new MsaWSClient(service, alignFrame.getTitle(), msa, withGaps,
245 true, alignFrame.getViewport().getAlignment()
246 .getDataset(), alignFrame);
250 msawsmenu.add(method);
253 // only add these menu options if the service has user-modifiable
255 method = new JMenuItem(
256 MessageManager.getString("label.edit_settings_and_run"));
257 method.setToolTipText(MessageManager
258 .getString("label.view_and_change_parameters_before_alignment"));
260 method.addActionListener(new ActionListener()
262 public void actionPerformed(ActionEvent e)
264 AlignmentView msa = alignFrame.gatherSequencesForAlignment();
265 new MsaWSClient(service, null, null, true, alignFrame
266 .getTitle(), msa, withGaps, true, alignFrame
267 .getViewport().getAlignment().getDataset(), alignFrame);
271 msawsmenu.add(method);
272 List<WsParamSetI> presets = service.getParamStore().getPresets();
273 if (presets != null && presets.size() > 0)
275 JMenu presetlist = new JMenu(MessageManager.formatMessage(
276 "label.run_with_preset_params", new String[]
279 for (final WsParamSetI preset : presets)
281 final JMenuItem methodR = new JMenuItem(preset.getName());
282 methodR.setToolTipText("<html><p>"
283 + JvSwingUtils.wrapTooltip("<strong>"
284 + (preset.isModifiable() ? "User Preset"
285 : "Service Preset") + "</strong><br/>"
286 + preset.getDescription() + "</p>") + "</html>");
287 methodR.addActionListener(new ActionListener()
289 public void actionPerformed(ActionEvent e)
291 AlignmentView msa = alignFrame
292 .gatherSequencesForAlignment();
293 new MsaWSClient(service, preset, alignFrame.getTitle(),
294 msa, false, true, alignFrame.getViewport()
295 .getAlignment().getDataset(), alignFrame);
300 presetlist.add(methodR);
302 msawsmenu.add(presetlist);
305 if (!submitGaps && canSubmitGaps())