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