2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
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 of the License, or (at your option) any later version.
11 * Jalview is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty
13 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
14 * PURPOSE. See the GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along with Jalview. If not, see <http://www.gnu.org/licenses/>.
17 * The Jalview Authors are detailed in the 'AUTHORS' file.
19 package jalview.ws.jws1;
21 import jalview.gui.AlignFrame;
22 import jalview.gui.WebserviceInfo;
23 import jalview.ws.WSClient;
24 import jalview.ws.WSMenuEntryProviderI;
26 import javax.swing.JMenu;
28 import ext.vamsas.ServiceHandle;
31 * JWS1 Specific UI attributes and methods
36 public abstract class WS1Client extends WSClient implements
41 * original service handle that this client was derived from
43 ServiceHandle serviceHandle = null;
54 * initialise WSClient service information attributes from the service handle
57 * @return the service instance information GUI for this client and job.
59 protected WebserviceInfo setWebService(ServiceHandle sh)
61 return setWebService(sh, false);
65 * initialise WSClient service information attributes from the service handle
69 * true implies no GUI objects will be created.
70 * @return the service instance information GUI for this client and job.
72 protected WebserviceInfo setWebService(ServiceHandle sh, boolean headless)
74 WebServiceName = sh.getName();
75 if (ServiceActions.containsKey(sh.getAbstractName()))
77 WebServiceJobTitle = sh.getName(); // TODO: control sh.Name specification
79 // add this for short names. +(String)
80 // ServiceActions.get(sh.getAbstractName());
84 WebServiceJobTitle = sh.getAbstractName() + " using " + sh.getName();
87 WebServiceReference = sh.getDescription();
88 WsURL = sh.getEndpointURL();
89 WebserviceInfo wsInfo = null;
92 wsInfo = new WebserviceInfo(WebServiceJobTitle, WebServiceReference);
98 * convenience method to pass the serviceHandle reference that instantiated
99 * this service on to the menu entry constructor
102 * the menu to which any menu entries/sub menus are to be attached
104 * the alignFrame instance that provides input data for the service
106 public void attachWSMenuEntry(JMenu wsmenu, final AlignFrame alignFrame)
108 if (serviceHandle == null)
111 "IMPLEMENTATION ERROR: cannot attach WS Menu Entry without service handle reference!");
113 attachWSMenuEntry(wsmenu, serviceHandle, alignFrame);
117 * method implemented by each concrete WS1Client implementation that creates
118 * menu entries that enact their service using data from alignFrame.
121 * where new menu entries (and submenus) are to be attached
122 * @param serviceHandle
123 * the serviceHandle document for the service that entries are
127 public abstract void attachWSMenuEntry(JMenu wsmenu,
128 final ServiceHandle serviceHandle, final AlignFrame alignFrame);