src/jalview/ws/jws2/MsaWSClient.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   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.
  11  *
  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.
  16  *
  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.
  20  */
  21 package jalview.ws.jws2;
  22
  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;
  37
  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
  44 import javax.swing.JMenu;
  45 import javax.swing.JMenuItem;
  46 import javax.swing.ToolTipManager;
  47
  48 /**
  49  * MsaWSClient
  50  *
  51  * Instantiates web service menu items for multiple alignment services, and
  52  * holds logic for constructing a web service thread.
  53  *
  54  * TODO remove dependency on Jws2Client methods for creating AACon service UI
  55  * elements.
  56  *
  57  * @author Jim Procter et al
  58  * @version $Revision$
  59  */
  60 public class MsaWSClient extends Jws2Client implements WSMenuEntryProviderI
  61 {
  62   /**
  63    * server is a proxy class implementing the core methods for submitting,
  64    * monitoring and retrieving results from a multiple sequence alignment
  65    * service
  66    */
  67   MultipleSequenceAlignmentI server;
  68
  69   public MsaWSClient(ServiceWithParameters sh, String altitle,
  70           jalview.datamodel.AlignmentView msa, boolean submitGaps,
  71           boolean preserveOrder, AlignmentI seqdataset,
  72           AlignFrame _alignFrame)
  73   {
  74     this(sh, null, null, false, altitle, msa, submitGaps, preserveOrder,
  75             seqdataset, _alignFrame);
  76     // TODO Auto-generated constructor stub
  77   }
  78
  79   public MsaWSClient(ServiceWithParameters sh, WsParamSetI preset,
  80           String altitle,
  81           jalview.datamodel.AlignmentView msa, boolean submitGaps,
  82           boolean preserveOrder, AlignmentI seqdataset,
  83           AlignFrame _alignFrame)
  84   {
  85     this(sh, preset, null, false, altitle, msa, submitGaps, preserveOrder,
  86             seqdataset, _alignFrame);
  87     // TODO Auto-generated constructor stub
  88   }
  89
  90   /**
  91    * Creates a new MsaWSClient object that uses a service given by an externally
  92    * retrieved ServiceHandle
  93    *
  94    * @param sh
  95    *          service handle of type AbstractName(MsaWS)
  96    * @param altitle
  97    *          DOCUMENT ME!
  98    * @param msa
  99    *          DOCUMENT ME!
 100    * @param submitGaps
 101    *          DOCUMENT ME!
 102    * @param preserveOrder
 103    *          DOCUMENT ME!
 104    */
 105
 106   public MsaWSClient(ServiceWithParameters sh, WsParamSetI preset,
 107           List<ArgumentI> arguments, boolean editParams, String altitle,
 108           jalview.datamodel.AlignmentView msa, boolean submitGaps,
 109           boolean preserveOrder, AlignmentI seqdataset,
 110           AlignFrame _alignFrame)
 111   {
 112     super(_alignFrame, preset, arguments);
 113     if (!processParams(sh, editParams))
 114     {
 115       return;
 116     }
 117
 118     if (!(sh instanceof JalviewServiceEndpointProviderI
 119             && ((JalviewServiceEndpointProviderI) sh)
 120                     .getEndpoint() instanceof MultipleSequenceAlignmentI))
 121     {
 122       // redundant at mo - but may change
 123       JvOptionPane.showMessageDialog(Desktop.getDesktopPane(),
 124               MessageManager.formatMessage(
 125                       "label.service_called_is_not_msa_service",
 126                       new String[]
 127                       { sh.getName() }),
 128               MessageManager.getString("label.internal_jalview_error"),
 129               JvOptionPane.WARNING_MESSAGE);
 130
 131       return;
 132     }
 133     serviceHandle = sh;
 134     server = (MultipleSequenceAlignmentI) ((JalviewServiceEndpointProviderI) sh)
 135             .getEndpoint();
 136     if ((wsInfo = setWebService(sh, false)) == null)
 137     {
 138       JvOptionPane.showMessageDialog(Desktop.getDesktopPane(), MessageManager
 139               .formatMessage("label.msa_service_is_unknown", new String[]
 140               { sh.getName() }),
 141               MessageManager.getString("label.internal_jalview_error"),
 142               JvOptionPane.WARNING_MESSAGE);
 143
 144       return;
 145     }
 146
 147     startMsaWSClient(altitle, msa, submitGaps, preserveOrder, seqdataset);
 148
 149   }
 150
 151   public MsaWSClient()
 152   {
 153     super();
 154     // add a class reference to the list
 155   }
 156
 157   private void startMsaWSClient(String altitle, AlignmentView msa,
 158           boolean submitGaps, boolean preserveOrder, AlignmentI seqdataset)
 159   {
 160     // if (!locateWebService())
 161     // {
 162     // return;
 163     // }
 164
 165     wsInfo.setProgressText(((submitGaps) ? "Re-alignment" : "Alignment")
 166             + " of " + altitle + "\nJob details\n");
 167     String jobtitle = WebServiceName.toLowerCase();
 168     if (jobtitle.endsWith("alignment"))
 169     {
 170       if (submitGaps && (!jobtitle.endsWith("realignment")
 171               || jobtitle.indexOf("profile") == -1))
 172       {
 173         int pos = jobtitle.indexOf("alignment");
 174         jobtitle = WebServiceName.substring(0, pos) + "re-alignment of "
 175                 + altitle;
 176       }
 177       else
 178       {
 179         jobtitle = WebServiceName + " of " + altitle;
 180       }
 181     }
 182     else
 183     {
 184       jobtitle = WebServiceName + (submitGaps ? " re" : " ")
 185               + "alignment of " + altitle;
 186     }
 187
 188     MsaWSThread msathread = new MsaWSThread(server, preset, paramset, WsURL,
 189             wsInfo, alignFrame, WebServiceName, jobtitle, msa, submitGaps,
 190             preserveOrder, seqdataset);
 191     if (msathread.hasValidInput())
 192     {
 193       wsInfo.setthisService(msathread);
 194       wsInfo.setVisible(true);
 195       msathread.start();
 196     }
 197     else
 198     {
 199       wsInfo.setVisible(false);
 200       JvOptionPane.showMessageDialog(alignFrame,
 201               MessageManager.getString("info.invalid_msa_input_mininfo"),
 202               MessageManager.getString("info.invalid_msa_notenough"),
 203               JvOptionPane.INFORMATION_MESSAGE);
 204     }
 205   }
 206
 207   protected String getServiceActionKey()
 208   {
 209     return "MsaWS";
 210   }
 211
 212   protected String getServiceActionDescription()
 213   {
 214     return "Multiple Sequence Alignment";
 215   }
 216
 217   /**
 218    * look at ourselves and work out if we are a service that can take a profile
 219    * and align to it
 220    *
 221    * @return true if we can send gapped sequences to the alignment service
 222    */
 223   private boolean canSubmitGaps()
 224   {
 225     // TODO: query service or extract service handle props to check if we can
 226     // realign
 227     return (WebServiceName.indexOf("lustal") > -1); // cheat!
 228   }
 229
 230   @Override
 231   public void attachWSMenuEntry(JMenu rmsawsmenu,
 232           final ServiceWithParameters service, final AlignFrame alignFrame)
 233   {
 234     if (Jws2ClientFactory.registerAAConWSInstance(rmsawsmenu,
 235                     service, alignFrame))
 236     {
 237       // Alignment dependent analysis calculation WS gui
 238       return;
 239     }
 240     serviceHandle = service;
 241     setWebService(service, true); // headless
 242     attachWSMenuEntry(rmsawsmenu, alignFrame);
 243   }
 244
 245   @Override
 246   public void attachWSMenuEntry(JMenu wsmenu, AlignFrame alignFrame)
 247   {
 248     boolean finished = true, submitGaps = false;
 249     /**
 250      * temp variables holding msa service submenu or root service menu
 251      */
 252     JMenu msawsmenu = wsmenu;
 253     JMenu rmsawsmenu = wsmenu;
 254     String svcname = WebServiceName;
 255     if (svcname.endsWith("WS"))
 256     {
 257       svcname = svcname.substring(0, svcname.length() - 2);
 258     }
 259     String calcName = svcname + " ";
 260     if (canSubmitGaps())
 261     {
 262       msawsmenu = new JMenu(svcname);
 263       rmsawsmenu.add(msawsmenu);
 264       calcName = "";
 265     }
 266     boolean hasparams = serviceHandle.hasParameters();
 267     ServiceWithParameters service = (ServiceWithParameters) serviceHandle;
 268     do
 269     {
 270       String action = "Align ";
 271       if (submitGaps == true)
 272       {
 273         action = "Realign ";
 274         msawsmenu = new JMenu(MessageManager
 275                 .formatMessage("label.realign_with_params", new String[]
 276                 { svcname }));
 277         msawsmenu.setToolTipText(MessageManager
 278                 .getString("label.align_sequences_to_existing_alignment"));
 279         rmsawsmenu.add(msawsmenu);
 280       }
 281       final boolean withGaps = submitGaps;
 282
 283       JMenuItem method = new JMenuItem(MessageManager.formatMessage(
 284               "label.calcname_with_default_settings", new String[]
 285               { calcName }));
 286       method.setToolTipText(MessageManager.formatMessage(
 287               "label.action_with_default_settings", new String[]
 288               { action }));
 289
 290       method.addActionListener(new ActionListener()
 291       {
 292         @Override
 293         public void actionPerformed(ActionEvent e)
 294         {
 295           AlignmentView msa = alignFrame.gatherSequencesForAlignment();
 296
 297           if (msa != null)
 298           {
 299             new MsaWSClient(service, alignFrame.getTitle(), msa, withGaps,
 300                     true,
 301                     alignFrame.getViewport().getAlignment().getDataset(),
 302                     alignFrame);
 303           }
 304
 305         }
 306       });
 307       msawsmenu.add(method);
 308       if (hasparams)
 309       {
 310         // only add these menu options if the service has user-modifiable
 311         // arguments
 312         method = new JMenuItem(
 313                 MessageManager.getString("label.edit_settings_and_run"));
 314         method.setToolTipText(MessageManager.getString(
 315                 "label.view_and_change_parameters_before_alignment"));
 316
 317         method.addActionListener(new ActionListener()
 318         {
 319           @Override
 320           public void actionPerformed(ActionEvent e)
 321           {
 322             AlignmentView msa = alignFrame.gatherSequencesForAlignment();
 323             if (msa != null)
 324             {
 325               new MsaWSClient(service, null, null, true,
 326                       alignFrame.getTitle(), msa, withGaps, true,
 327                       alignFrame.getViewport().getAlignment().getDataset(),
 328                       alignFrame);
 329             }
 330
 331           }
 332         });
 333         msawsmenu.add(method);
 334         List<WsParamSetI> presets = service.getParamStore().getPresets();
 335         if (presets != null && presets.size() > 0)
 336         {
 337           JMenu presetlist = new JMenu(MessageManager.formatMessage(
 338                   "label.run_with_preset_params", new String[]
 339                   { calcName }));
 340
 341           final int showToolTipFor = ToolTipManager.sharedInstance()
 342                   .getDismissDelay();
 343           for (final WsParamSetI preset : presets)
 344           {
 345             final JMenuItem methodR = new JMenuItem(preset.getName());
 346             final int QUICK_TOOLTIP = 1500;
 347             // JAL-1582 shorten tooltip display time in these menu items as
 348             // they can obscure other options
 349             methodR.addMouseListener(new MouseAdapter()
 350             {
 351               @Override
 352               public void mouseEntered(MouseEvent e)
 353               {
 354                 ToolTipManager.sharedInstance()
 355                         .setDismissDelay(QUICK_TOOLTIP);
 356               }
 357
 358               @Override
 359               public void mouseExited(MouseEvent e)
 360               {
 361                 ToolTipManager.sharedInstance()
 362                         .setDismissDelay(showToolTipFor);
 363               }
 364
 365             });
 366             String tooltip = JvSwingUtils.wrapTooltip(true, "<strong>"
 367                     + (preset.isModifiable()
 368                             ? MessageManager.getString("label.user_preset")
 369                             : MessageManager
 370                                     .getString("label.service_preset"))
 371                     + "</strong><br/>" + preset.getDescription());
 372             methodR.setToolTipText(tooltip);
 373             methodR.addActionListener(new ActionListener()
 374             {
 375               @Override
 376               public void actionPerformed(ActionEvent e)
 377               {
 378                 AlignmentView msa = alignFrame
 379                         .gatherSequencesForAlignment();
 380
 381                 if (msa != null)
 382                 {
 383                   MsaWSClient msac = new MsaWSClient(service, preset,
 384                           alignFrame.getTitle(), msa, false, true,
 385                           alignFrame.getViewport().getAlignment()
 386                                   .getDataset(),
 387                           alignFrame);
 388                 }
 389
 390               }
 391
 392             });
 393             presetlist.add(methodR);
 394           }
 395           msawsmenu.add(presetlist);
 396         }
 397       }
 398       if (!submitGaps && canSubmitGaps())
 399       {
 400         submitGaps = true;
 401         finished = false;
 402       }
 403       else
 404       {
 405         finished = true;
 406       }
 407     } while (!finished);
 408   }
 409 }