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.datamodel.AlignmentI;
24 import jalview.datamodel.AlignmentView;
25 import jalview.gui.AlignFrame;
26 import jalview.gui.Desktop;
27 import jalview.gui.JvOptionPane;
28 import jalview.gui.JvSwingUtils;
29 import jalview.util.MessageManager;
30 import jalview.ws.WSMenuEntryProviderI;
31 import jalview.ws.api.JalviewServiceEndpointProviderI;
32 import jalview.ws.api.MultipleSequenceAlignmentI;
33 import jalview.ws.api.ServiceWithParameters;
34 import jalview.ws.gui.MsaWSThread;
35 import jalview.ws.params.ArgumentI;
36 import jalview.ws.params.WsParamSetI;
38 import java.awt.event.ActionEvent;
39 import java.awt.event.ActionListener;
40 import java.awt.event.MouseAdapter;
41 import java.awt.event.MouseEvent;
42 import java.util.List;
43 import java.util.Locale;
45 import javax.swing.JMenu;
46 import javax.swing.JMenuItem;
47 import javax.swing.ToolTipManager;
53 * Instantiates web service menu items for multiple alignment services, and
54 * holds logic for constructing a web service thread.
56 * TODO remove dependency on Jws2Client methods for creating AACon service UI
59 * @author Jim Procter et al
62 public class MsaWSClient extends Jws2Client implements WSMenuEntryProviderI
65 * server is a proxy class implementing the core methods for submitting,
66 * monitoring and retrieving results from a multiple sequence alignment
69 MultipleSequenceAlignmentI server;
71 public MsaWSClient(ServiceWithParameters sh, String altitle,
72 jalview.datamodel.AlignmentView msa, boolean submitGaps,
73 boolean preserveOrder, AlignmentI seqdataset,
74 AlignFrame _alignFrame)
76 this(sh, null, null, false, altitle, msa, submitGaps, preserveOrder,
77 seqdataset, _alignFrame);
78 // TODO Auto-generated constructor stub
81 public MsaWSClient(ServiceWithParameters sh, WsParamSetI preset,
83 jalview.datamodel.AlignmentView msa, boolean submitGaps,
84 boolean preserveOrder, AlignmentI seqdataset,
85 AlignFrame _alignFrame)
87 this(sh, preset, null, false, altitle, msa, submitGaps, preserveOrder,
88 seqdataset, _alignFrame);
89 // TODO Auto-generated constructor stub
93 * Creates a new MsaWSClient object that uses a service given by an externally
94 * retrieved ServiceHandle
97 * service handle of type AbstractName(MsaWS)
104 * @param preserveOrder
108 public MsaWSClient(ServiceWithParameters sh, WsParamSetI preset,
109 List<ArgumentI> arguments, boolean editParams, String altitle,
110 jalview.datamodel.AlignmentView msa, boolean submitGaps,
111 boolean preserveOrder, AlignmentI seqdataset,
112 AlignFrame _alignFrame)
114 super(_alignFrame, preset, arguments);
115 processParams(sh, editParams).thenAccept((startJob) -> {
119 if (!(sh instanceof JalviewServiceEndpointProviderI
120 && ((JalviewServiceEndpointProviderI) sh)
121 .getEndpoint() instanceof MultipleSequenceAlignmentI))
123 // redundant at mo - but may change
124 JvOptionPane.showMessageDialog(Desktop.getDesktopPane(),
125 MessageManager.formatMessage(
126 "label.service_called_is_not_msa_service",
129 MessageManager.getString("label.internal_jalview_error"),
130 JvOptionPane.WARNING_MESSAGE);
135 server = (MultipleSequenceAlignmentI) ((JalviewServiceEndpointProviderI) sh)
137 if ((wsInfo = setWebService(sh, false)) == null)
139 JvOptionPane.showMessageDialog(Desktop.getDesktopPane(), MessageManager
140 .formatMessage("label.msa_service_is_unknown", new String[]
142 MessageManager.getString("label.internal_jalview_error"),
143 JvOptionPane.WARNING_MESSAGE);
148 startMsaWSClient(altitle, msa, submitGaps, preserveOrder, seqdataset);
156 // add a class reference to the list
159 private void startMsaWSClient(String altitle, AlignmentView msa,
160 boolean submitGaps, boolean preserveOrder, AlignmentI seqdataset)
162 // if (!locateWebService())
167 wsInfo.setProgressText(((submitGaps) ? "Re-alignment" : "Alignment")
168 + " of " + altitle + "\nJob details\n");
169 String jobtitle = WebServiceName.toLowerCase(Locale.ROOT);
170 if (jobtitle.endsWith("alignment"))
172 if (submitGaps && (!jobtitle.endsWith("realignment")
173 || jobtitle.indexOf("profile") == -1))
175 int pos = jobtitle.indexOf("alignment");
176 jobtitle = WebServiceName.substring(0, pos) + "re-alignment of "
181 jobtitle = WebServiceName + " of " + altitle;
186 jobtitle = WebServiceName + (submitGaps ? " re" : " ")
187 + "alignment of " + altitle;
190 MsaWSThread msathread = new MsaWSThread(server, preset, paramset, WsURL,
191 wsInfo, alignFrame, WebServiceName, jobtitle, msa, submitGaps,
192 preserveOrder, seqdataset);
193 if (msathread.hasValidInput())
195 wsInfo.setthisService(msathread);
196 wsInfo.setVisible(true);
201 wsInfo.setVisible(false);
202 JvOptionPane.showMessageDialog(alignFrame,
203 MessageManager.getString("info.invalid_msa_input_mininfo"),
204 MessageManager.getString("info.invalid_msa_notenough"),
205 JvOptionPane.INFORMATION_MESSAGE);
209 protected String getServiceActionKey()
214 protected String getServiceActionDescription()
216 return "Multiple Sequence Alignment";
220 * look at ourselves and work out if we are a service that can take a profile
223 * @return true if we can send gapped sequences to the alignment service
225 private boolean canSubmitGaps()
227 // TODO: query service or extract service handle props to check if we can
229 return (WebServiceName.indexOf("lustal") > -1); // cheat!
233 public void attachWSMenuEntry(JMenu rmsawsmenu,
234 final Jws2Instance service, final AlignFrame alignFrame)
236 if (registerAAConWSInstance(rmsawsmenu, service, alignFrame))
238 // Alignment dependent analysis calculation WS gui
241 serviceHandle = service;
242 setWebService(service, true); // headless
243 attachWSMenuEntry(rmsawsmenu, alignFrame);
247 public void attachWSMenuEntry(JMenu wsmenu, AlignFrame alignFrame)
249 boolean finished = true, submitGaps = false;
251 * temp variables holding msa service submenu or root service menu
253 JMenu msawsmenu = wsmenu;
254 JMenu rmsawsmenu = wsmenu;
255 String svcname = WebServiceName;
256 if (svcname.endsWith("WS"))
258 svcname = svcname.substring(0, svcname.length() - 2);
260 String calcName = svcname + " ";
263 msawsmenu = new JMenu(svcname);
264 rmsawsmenu.add(msawsmenu);
267 boolean hasparams = serviceHandle.hasParameters();
268 ServiceWithParameters service = (ServiceWithParameters) serviceHandle;
271 String action = "Align ";
272 if (submitGaps == true)
275 msawsmenu = new JMenu(MessageManager
276 .formatMessage("label.realign_with_params", new String[]
278 msawsmenu.setToolTipText(MessageManager
279 .getString("label.align_sequences_to_existing_alignment"));
280 rmsawsmenu.add(msawsmenu);
282 final boolean withGaps = submitGaps;
284 JMenuItem method = new JMenuItem(MessageManager.formatMessage(
285 "label.calcname_with_default_settings", new String[]
287 method.setToolTipText(MessageManager.formatMessage(
288 "label.action_with_default_settings", new String[]
291 method.addActionListener(new ActionListener()
294 public void actionPerformed(ActionEvent e)
296 AlignmentView msa = alignFrame.gatherSequencesForAlignment();
300 new MsaWSClient(service, alignFrame.getTitle(), msa, withGaps,
302 alignFrame.getViewport().getAlignment().getDataset(),
308 msawsmenu.add(method);
311 // only add these menu options if the service has user-modifiable
313 method = new JMenuItem(
314 MessageManager.getString("label.edit_settings_and_run"));
315 method.setToolTipText(MessageManager.getString(
316 "label.view_and_change_parameters_before_alignment"));
318 method.addActionListener(new ActionListener()
321 public void actionPerformed(ActionEvent e)
323 AlignmentView msa = alignFrame.gatherSequencesForAlignment();
326 new MsaWSClient(service, null, null, true,
327 alignFrame.getTitle(), msa, withGaps, true,
328 alignFrame.getViewport().getAlignment().getDataset(),
334 msawsmenu.add(method);
335 List<WsParamSetI> presets = service.getParamStore().getPresets();
336 if (presets != null && presets.size() > 0)
338 JMenu presetlist = new JMenu(MessageManager.formatMessage(
339 "label.run_with_preset_params", new String[]
342 final int showToolTipFor = ToolTipManager.sharedInstance()
344 for (final WsParamSetI preset : presets)
346 final JMenuItem methodR = new JMenuItem(preset.getName());
347 final int QUICK_TOOLTIP = 1500;
348 // JAL-1582 shorten tooltip display time in these menu items as
349 // they can obscure other options
350 methodR.addMouseListener(new MouseAdapter()
353 public void mouseEntered(MouseEvent e)
355 ToolTipManager.sharedInstance()
356 .setDismissDelay(QUICK_TOOLTIP);
360 public void mouseExited(MouseEvent e)
362 ToolTipManager.sharedInstance()
363 .setDismissDelay(showToolTipFor);
367 String tooltip = JvSwingUtils.wrapTooltip(true, "<strong>"
368 + (preset.isModifiable()
369 ? MessageManager.getString("label.user_preset")
371 .getString("label.service_preset"))
372 + "</strong><br/>" + preset.getDescription());
373 methodR.setToolTipText(tooltip);
374 methodR.addActionListener(new ActionListener()
377 public void actionPerformed(ActionEvent e)
379 AlignmentView msa = alignFrame
380 .gatherSequencesForAlignment();
384 MsaWSClient msac = new MsaWSClient(service, preset,
385 alignFrame.getTitle(), msa, false, true,
386 alignFrame.getViewport().getAlignment()
394 presetlist.add(methodR);
396 msawsmenu.add(presetlist);
399 if (!submitGaps && canSubmitGaps())