2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)
\r
3 * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
\r
5 * This file is part of Jalview.
\r
7 * Jalview is free software: you can redistribute it and/or
\r
8 * modify it under the terms of the GNU General Public License
\r
9 * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
\r
11 * Jalview is distributed in the hope that it will be useful, but
\r
12 * WITHOUT ANY WARRANTY; without even the implied warranty
\r
13 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
\r
14 * PURPOSE. See the GNU General Public License for more details.
\r
16 * You should have received a copy of the GNU General Public License along with Jalview. If not, see <http://www.gnu.org/licenses/>.
\r
20 import java.awt.Component;
\r
21 import java.awt.event.ActionEvent;
\r
22 import java.awt.event.ActionListener;
\r
23 import java.util.Enumeration;
\r
24 import java.util.Hashtable;
\r
25 import java.util.StringTokenizer;
\r
26 import java.util.Vector;
\r
28 import javax.swing.*;
\r
30 import ext.vamsas.*;
\r
31 import jalview.datamodel.*;
\r
32 import jalview.gui.*;
\r
38 * @version $Revision$
\r
40 public class SeqSearchWSClient extends WSClient
\r
43 * server is a WSDL2Java generated stub for an archetypal MsaWSI service.
\r
45 ext.vamsas.SeqSearchI server;
\r
47 AlignFrame alignFrame;
\r
50 * Creates a new MsaWSClient object that uses a service given by an externally
\r
51 * retrieved ServiceHandle
\r
54 * service handle of type AbstractName(MsaWS)
\r
61 * @param preserveOrder
\r
65 public SeqSearchWSClient(ext.vamsas.ServiceHandle sh, String altitle,
\r
66 jalview.datamodel.AlignmentView msa, String db,
\r
67 Alignment seqdataset, AlignFrame _alignFrame)
\r
70 alignFrame = _alignFrame;
\r
71 // can generalise the two errors below for metadata mapping from interface
\r
72 // name to service client name
\r
73 if (!sh.getAbstractName().equals(this.getServiceActionKey()))
\r
75 JOptionPane.showMessageDialog(Desktop.desktop,
\r
76 "The Service called \n" + sh.getName()
\r
77 + "\nis not a \nSequence Search Service !",
\r
78 "Internal Jalview Error", JOptionPane.WARNING_MESSAGE);
\r
83 if ((wsInfo = setWebService(sh)) == null)
\r
85 JOptionPane.showMessageDialog(Desktop.desktop,
\r
86 "The Sequence Search Service named " + sh.getName()
\r
87 + " is unknown", "Internal Jalview Error",
\r
88 JOptionPane.WARNING_MESSAGE);
\r
92 startSeqSearchClient(altitle, msa, db, seqdataset);
\r
97 * non-process web service interaction - use this for calling HEADLESS
\r
98 * synchronous service methods
\r
102 public SeqSearchWSClient(ServiceHandle sh)
\r
104 setWebService(sh, true);
\r
107 public SeqSearchWSClient()
\r
111 // add a class reference to the list
\r
114 private void startSeqSearchClient(String altitle, AlignmentView msa,
\r
115 String db, Alignment seqdataset)
\r
117 if (!locateWebService())
\r
121 String visdb = (db == null || db == "") ? "default" : db; // need a visible
\r
124 boolean profileSearch = msa.getSequences().length > 2 ? true : false;
\r
125 // single sequence or profile from alignment view
\r
126 wsInfo.setProgressText("Searching "
\r
128 + (!profileSearch ? " with sequence "
\r
129 + msa.getSequences()[0].getRefSeq().getName()
\r
130 : " with profile") + " from " + altitle
\r
131 + "\nJob details\n");
\r
133 String jobtitle = WebServiceName
\r
134 + ((WebServiceName.indexOf("earch") > -1) ? " " : " search ")
\r
137 + (!profileSearch ? " with sequence "
\r
138 + msa.getSequences()[0].getRefSeq().getName()
\r
139 : " with profile") + " from " + altitle;
\r
140 SeqSearchWSThread ssthread = new SeqSearchWSThread(server, WsURL,
\r
141 wsInfo, alignFrame, WebServiceName, jobtitle, msa, db,
\r
143 wsInfo.setthisService(ssthread);
\r
148 * Initializes the server field with a valid service implementation.
\r
150 * @return true if service was located.
\r
152 private boolean locateWebService()
\r
154 // this can be abstracted using reflection
\r
155 // TODO: MuscleWS transmuted to generic MsaWS client
\r
156 SeqSearchServiceLocator loc = new SeqSearchServiceLocator(); // Default
\r
160 this.server = (SeqSearchI) loc.getSeqSearchService(new java.net.URL(
\r
162 ((SeqSearchServiceSoapBindingStub) this.server).setTimeout(60000); // One
\r
165 } catch (Exception ex)
\r
167 wsInfo.setProgressText("Serious! " + WebServiceName
\r
168 + " Service location failed\nfor URL :" + WsURL + "\n"
\r
169 + ex.getMessage());
\r
170 wsInfo.setStatus(WebserviceInfo.ERROR);
\r
171 ex.printStackTrace();
\r
176 loc.getEngine().setOption("axis", "1");
\r
181 protected String getServiceActionKey()
\r
183 return "SeqSearch";
\r
186 protected String getServiceActionDescription()
\r
188 return "Sequence Database Search";
\r
191 // simple caching of db parameters for each service endpoint
\r
192 private static Hashtable dbParamsForEndpoint;
\r
195 dbParamsForEndpoint = new Hashtable();
\r
198 public String[] getSupportedDatabases() throws Exception
\r
201 // check that we haven't already been to this service endpoint
\r
202 if (dbParamsForEndpoint.containsKey(WsURL))
\r
204 return (String[]) dbParamsForEndpoint.get(WsURL);
\r
206 if (!locateWebService())
\r
208 throw new Exception("Cannot contact service endpoint at " + WsURL);
\r
210 String database = server.getDatabase();
\r
211 if (database == null)
\r
213 dbParamsForEndpoint.put(WsURL, new String[]
\r
217 StringTokenizer en = new StringTokenizer(database.trim(), ",| ");
\r
218 String[] dbs = new String[en.countTokens()];
\r
219 for (int i = 0; i < dbs.length; i++)
\r
221 dbs[i++] = en.nextToken().trim();
\r
223 dbParamsForEndpoint.put(WsURL, dbs);
\r
227 public void attachWSMenuEntry(JMenu wsmenu, final ServiceHandle sh,
\r
228 final AlignFrame af)
\r
230 // look for existing database service submenus on wsmenu
\r
231 Hashtable dbsrchs = new Hashtable();
\r
232 Vector newdbsrch = new Vector();
\r
233 Component entries[] = wsmenu.getComponents();
\r
234 for (int i = 0; entries != null && i < entries.length; i++)
\r
236 if (entries[i] instanceof JMenu)
\r
238 dbsrchs.put(entries[i].getName(), entries[i]);
\r
241 JMenu defmenu = (JMenu) dbsrchs.get("Default Database");
\r
242 if (defmenu == null)
\r
244 dbsrchs.put("Default Database", defmenu = new JMenu(
\r
245 "Default Database"));
\r
246 newdbsrch.addElement(defmenu);
\r
249 String dbs[] = null;
\r
252 dbs = new jalview.ws.SeqSearchWSClient(sh).getSupportedDatabases();
\r
253 } catch (Exception e)
\r
255 jalview.bin.Cache.log.warn(
\r
256 "Database list request failed, so disabling SeqSearch Service client "
\r
257 + sh.getName() + " at " + sh.getEndpointURL(), e);
\r
261 // do default entry
\r
262 defmenu.add(method = new JMenuItem(sh.getName()));
\r
263 method.setToolTipText(sh.getEndpointURL());
\r
264 method.addActionListener(new ActionListener()
\r
266 public void actionPerformed(ActionEvent e)
\r
268 // use same input gatherer as for secondary structure prediction
\r
269 // we could actually parameterise the gatherer method here...
\r
270 AlignmentView msa = af.gatherSeqOrMsaForSecStrPrediction();
\r
271 new jalview.ws.SeqSearchWSClient(sh, af.getTitle(), msa, null, af
\r
272 .getViewport().getAlignment().getDataset(), af);
\r
275 // add entry for each database the service supports
\r
276 for (int db = 0; dbs != null && db < dbs.length; db++)
\r
278 JMenu dbmenu = (JMenu) dbsrchs.get(dbs[db]);
\r
279 if (dbmenu == null)
\r
281 dbsrchs.put(dbs[db], dbmenu = new JMenu(dbs[db]));
\r
282 newdbsrch.addElement(dbmenu);
\r
284 // add the client handler code for this service
\r
285 dbmenu.add(method = new JMenuItem(sh.getName()));
\r
286 method.setToolTipText(sh.getEndpointURL());
\r
287 final String searchdb = dbs[db];
\r
288 method.addActionListener(new ActionListener()
\r
290 public void actionPerformed(ActionEvent e)
\r
292 AlignmentView msa = af.gatherSeqOrMsaForSecStrPrediction();
\r
293 new jalview.ws.SeqSearchWSClient(sh, af.getTitle(), msa,
\r
294 searchdb, af.getViewport().getAlignment().getDataset(),
\r
299 // add the databases onto the seqsearch menu
\r
300 Enumeration e = newdbsrch.elements();
\r
301 while (e.hasMoreElements())
\r
303 Object el = e.nextElement();
\r
304 if (el instanceof JMenu)
\r
306 wsmenu.add((JMenu) el);
\r
310 wsmenu.add((JMenuItem) el);
\r