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     processParams(sh, editParams).thenAccept((startJob) -> {
 114       if (!startJob)
 115         return;
 116
 117       if (!(sh instanceof JalviewServiceEndpointProviderI
 118               && ((JalviewServiceEndpointProviderI) sh)
 119                       .getEndpoint() instanceof MultipleSequenceAlignmentI))
 120       {
 121         // redundant at mo - but may change
 122         JvOptionPane.showMessageDialog(Desktop.getDesktopPane(),
 123                 MessageManager.formatMessage(
 124                         "label.service_called_is_not_msa_service",
 125                         new String[]
 126                         { sh.getName() }),
 127                 MessageManager.getString("label.internal_jalview_error"),
 128                 JvOptionPane.WARNING_MESSAGE);
 129
 130         return;
 131       }
 132       serviceHandle = sh;
 133       server = (MultipleSequenceAlignmentI) ((JalviewServiceEndpointProviderI) sh)
 134               .getEndpoint();
 135       if ((wsInfo = setWebService(sh, false)) == null)
 136       {
 137         JvOptionPane.showMessageDialog(Desktop.getDesktopPane(), MessageManager
 138                 .formatMessage("label.msa_service_is_unknown", new String[]
 139                 { sh.getName() }),
 140                 MessageManager.getString("label.internal_jalview_error"),
 141                 JvOptionPane.WARNING_MESSAGE);
 142
 143         return;
 144       }
 145
 146       startMsaWSClient(altitle, msa, submitGaps, preserveOrder, seqdataset);
 147     });
 148   }
 149
 150   public MsaWSClient()
 151   {
 152     super();
 153     // add a class reference to the list
 154   }
 155
 156   private void startMsaWSClient(String altitle, AlignmentView msa,
 157           boolean submitGaps, boolean preserveOrder, AlignmentI seqdataset)
 158   {
 159     // if (!locateWebService())
 160     // {
 161     // return;
 162     // }
 163
 164     wsInfo.setProgressText(((submitGaps) ? "Re-alignment" : "Alignment")
 165             + " of " + altitle + "\nJob details\n");
 166     String jobtitle = WebServiceName.toLowerCase();
 167     if (jobtitle.endsWith("alignment"))
 168     {
 169       if (submitGaps && (!jobtitle.endsWith("realignment")
 170               || jobtitle.indexOf("profile") == -1))
 171       {
 172         int pos = jobtitle.indexOf("alignment");
 173         jobtitle = WebServiceName.substring(0, pos) + "re-alignment of "
 174                 + altitle;
 175       }
 176       else
 177       {
 178         jobtitle = WebServiceName + " of " + altitle;
 179       }
 180     }
 181     else
 182     {
 183       jobtitle = WebServiceName + (submitGaps ? " re" : " ")
 184               + "alignment of " + altitle;
 185     }
 186
 187     MsaWSThread msathread = new MsaWSThread(server, preset, paramset, WsURL,
 188             wsInfo, alignFrame, WebServiceName, jobtitle, msa, submitGaps,
 189             preserveOrder, seqdataset);
 190     if (msathread.hasValidInput())
 191     {
 192       wsInfo.setthisService(msathread);
 193       wsInfo.setVisible(true);
 194       msathread.start();
 195     }
 196     else
 197     {
 198       wsInfo.setVisible(false);
 199       JvOptionPane.showMessageDialog(alignFrame,
 200               MessageManager.getString("info.invalid_msa_input_mininfo"),
 201               MessageManager.getString("info.invalid_msa_notenough"),
 202               JvOptionPane.INFORMATION_MESSAGE);
 203     }
 204   }
 205
 206   protected String getServiceActionKey()
 207   {
 208     return "MsaWS";
 209   }
 210
 211   protected String getServiceActionDescription()
 212   {
 213     return "Multiple Sequence Alignment";
 214   }
 215
 216   /**
 217    * look at ourselves and work out if we are a service that can take a profile
 218    * and align to it
 219    *
 220    * @return true if we can send gapped sequences to the alignment service
 221    */
 222   private boolean canSubmitGaps()
 223   {
 224     // TODO: query service or extract service handle props to check if we can
 225     // realign
 226     return (WebServiceName.indexOf("lustal") > -1); // cheat!
 227   }
 228
 229   @Override
 230   public void attachWSMenuEntry(JMenu rmsawsmenu,
 231           final ServiceWithParameters service, final AlignFrame alignFrame)
 232   {
 233     if (Jws2ClientFactory.registerAAConWSInstance(rmsawsmenu,
 234                     service, alignFrame))
 235     {
 236       // Alignment dependent analysis calculation WS gui
 237       return;
 238     }
 239     serviceHandle = service;
 240     setWebService(service, true); // headless
 241     attachWSMenuEntry(rmsawsmenu, alignFrame);
 242   }
 243
 244   @Override
 245   public void attachWSMenuEntry(JMenu wsmenu, AlignFrame alignFrame)
 246   {
 247     boolean finished = true, submitGaps = false;
 248     /**
 249      * temp variables holding msa service submenu or root service menu
 250      */
 251     JMenu msawsmenu = wsmenu;
 252     JMenu rmsawsmenu = wsmenu;
 253     String svcname = WebServiceName;
 254     if (svcname.endsWith("WS"))
 255     {
 256       svcname = svcname.substring(0, svcname.length() - 2);
 257     }
 258     String calcName = svcname + " ";
 259     if (canSubmitGaps())
 260     {
 261       msawsmenu = new JMenu(svcname);
 262       rmsawsmenu.add(msawsmenu);
 263       calcName = "";
 264     }
 265     boolean hasparams = serviceHandle.hasParameters();
 266     ServiceWithParameters service = (ServiceWithParameters) serviceHandle;
 267     do
 268     {
 269       String action = "Align ";
 270       if (submitGaps == true)
 271       {
 272         action = "Realign ";
 273         msawsmenu = new JMenu(MessageManager
 274                 .formatMessage("label.realign_with_params", new String[]
 275                 { svcname }));
 276         msawsmenu.setToolTipText(MessageManager
 277                 .getString("label.align_sequences_to_existing_alignment"));
 278         rmsawsmenu.add(msawsmenu);
 279       }
 280       final boolean withGaps = submitGaps;
 281
 282       JMenuItem method = new JMenuItem(MessageManager.formatMessage(
 283               "label.calcname_with_default_settings", new String[]
 284               { calcName }));
 285       method.setToolTipText(MessageManager.formatMessage(
 286               "label.action_with_default_settings", new String[]
 287               { action }));
 288
 289       method.addActionListener(new ActionListener()
 290       {
 291         @Override
 292         public void actionPerformed(ActionEvent e)
 293         {
 294           AlignmentView msa = alignFrame.gatherSequencesForAlignment();
 295
 296           if (msa != null)
 297           {
 298             new MsaWSClient(service, alignFrame.getTitle(), msa, withGaps,
 299                     true,
 300                     alignFrame.getViewport().getAlignment().getDataset(),
 301                     alignFrame);
 302           }
 303
 304         }
 305       });
 306       msawsmenu.add(method);
 307       if (hasparams)
 308       {
 309         // only add these menu options if the service has user-modifiable
 310         // arguments
 311         method = new JMenuItem(
 312                 MessageManager.getString("label.edit_settings_and_run"));
 313         method.setToolTipText(MessageManager.getString(
 314                 "label.view_and_change_parameters_before_alignment"));
 315
 316         method.addActionListener(new ActionListener()
 317         {
 318           @Override
 319           public void actionPerformed(ActionEvent e)
 320           {
 321             AlignmentView msa = alignFrame.gatherSequencesForAlignment();
 322             if (msa != null)
 323             {
 324               new MsaWSClient(service, null, null, true,
 325                       alignFrame.getTitle(), msa, withGaps, true,
 326                       alignFrame.getViewport().getAlignment().getDataset(),
 327                       alignFrame);
 328             }
 329
 330           }
 331         });
 332         msawsmenu.add(method);
 333         List<WsParamSetI> presets = service.getParamStore().getPresets();
 334         if (presets != null && presets.size() > 0)
 335         {
 336           JMenu presetlist = new JMenu(MessageManager.formatMessage(
 337                   "label.run_with_preset_params", new String[]
 338                   { calcName }));
 339
 340           final int showToolTipFor = ToolTipManager.sharedInstance()
 341                   .getDismissDelay();
 342           for (final WsParamSetI preset : presets)
 343           {
 344             final JMenuItem methodR = new JMenuItem(preset.getName());
 345             final int QUICK_TOOLTIP = 1500;
 346             // JAL-1582 shorten tooltip display time in these menu items as
 347             // they can obscure other options
 348             methodR.addMouseListener(new MouseAdapter()
 349             {
 350               @Override
 351               public void mouseEntered(MouseEvent e)
 352               {
 353                 ToolTipManager.sharedInstance()
 354                         .setDismissDelay(QUICK_TOOLTIP);
 355               }
 356
 357               @Override
 358               public void mouseExited(MouseEvent e)
 359               {
 360                 ToolTipManager.sharedInstance()
 361                         .setDismissDelay(showToolTipFor);
 362               }
 363
 364             });
 365             String tooltip = JvSwingUtils.wrapTooltip(true, "<strong>"
 366                     + (preset.isModifiable()
 367                             ? MessageManager.getString("label.user_preset")
 368                             : MessageManager
 369                                     .getString("label.service_preset"))
 370                     + "</strong><br/>" + preset.getDescription());
 371             methodR.setToolTipText(tooltip);
 372             methodR.addActionListener(new ActionListener()
 373             {
 374               @Override
 375               public void actionPerformed(ActionEvent e)
 376               {
 377                 AlignmentView msa = alignFrame
 378                         .gatherSequencesForAlignment();
 379
 380                 if (msa != null)
 381                 {
 382                   MsaWSClient msac = new MsaWSClient(service, preset,
 383                           alignFrame.getTitle(), msa, false, true,
 384                           alignFrame.getViewport().getAlignment()
 385                                   .getDataset(),
 386                           alignFrame);
 387                 }
 388
 389               }
 390
 391             });
 392             presetlist.add(methodR);
 393           }
 394           msawsmenu.add(presetlist);
 395         }
 396       }
 397       if (!submitGaps && canSubmitGaps())
 398       {
 399         submitGaps = true;
 400         finished = false;
 401       }
 402       else
 403       {
 404         finished = true;
 405       }
 406     } while (!finished);
 407   }
 408 }