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