src/jalview/ws/jws2/MsaWSClient.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)
   3  * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
   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 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18 package jalview.ws.jws2;
  19
  20 import java.awt.event.ActionEvent;
  21 import java.awt.event.ActionListener;
  22 import java.util.List;
  23
  24 import javax.swing.*;
  25
  26 import jalview.datamodel.*;
  27 import jalview.gui.*;
  28 import compbio.data.msa.MsaWS;
  29 import compbio.metadata.Argument;
  30 import compbio.metadata.Preset;
  31 import compbio.metadata.PresetManager;
  32 import jalview.ws.jws2.Jws2Discoverer.Jws2Instance;
  33
  34 /**
  35  * DOCUMENT ME!
  36  *
  37  * @author $author$
  38  * @version $Revision$
  39  */
  40 public class MsaWSClient extends Jws2Client
  41 {
  42   /**
  43    * server is a WSDL2Java generated stub for an archetypal MsaWSI service.
  44    */
  45   MsaWS server;
  46
  47   AlignFrame alignFrame;
  48
  49   private Preset preset;
  50
  51   private List<Argument> paramset;
  52
  53   public MsaWSClient(Jws2Discoverer.Jws2Instance sh, String altitle,
  54           jalview.datamodel.AlignmentView msa, boolean submitGaps,
  55           boolean preserveOrder, Alignment seqdataset,
  56           AlignFrame _alignFrame)
  57   {
  58     this(sh, null, null, false, altitle, msa, submitGaps, preserveOrder,
  59             seqdataset, _alignFrame);
  60     // TODO Auto-generated constructor stub
  61   }
  62
  63   public MsaWSClient(Jws2Discoverer.Jws2Instance sh, Preset preset,
  64           String altitle, jalview.datamodel.AlignmentView msa,
  65           boolean submitGaps, boolean preserveOrder, Alignment seqdataset,
  66           AlignFrame _alignFrame)
  67   {
  68     this(sh, preset, null, false, altitle, msa, submitGaps, preserveOrder,
  69             seqdataset, _alignFrame);
  70     // TODO Auto-generated constructor stub
  71   }
  72
  73   /**
  74    * Creates a new MsaWSClient object that uses a service given by an externally
  75    * retrieved ServiceHandle
  76    *
  77    * @param sh
  78    *          service handle of type AbstractName(MsaWS)
  79    * @param altitle
  80    *          DOCUMENT ME!
  81    * @param msa
  82    *          DOCUMENT ME!
  83    * @param submitGaps
  84    *          DOCUMENT ME!
  85    * @param preserveOrder
  86    *          DOCUMENT ME!
  87    */
  88
  89   public MsaWSClient(Jws2Discoverer.Jws2Instance sh, Preset preset,
  90           List<Argument> arguments, boolean editParams, String altitle,
  91           jalview.datamodel.AlignmentView msa, boolean submitGaps,
  92           boolean preserveOrder, Alignment seqdataset,
  93           AlignFrame _alignFrame)
  94   {
  95     super();
  96     alignFrame = _alignFrame;
  97     if (!(sh.service instanceof MsaWS))
  98     {
  99       // redundant at mo - but may change
 100       JOptionPane
 101               .showMessageDialog(
 102                       Desktop.desktop,
 103                       "The Service called \n"
 104                               + sh.serviceType
 105                               + "\nis not a \nMultiple Sequence Alignment Service !",
 106                       "Internal Jalview Error", JOptionPane.WARNING_MESSAGE);
 107
 108       return;
 109     }
 110     server = sh.service;
 111     this.preset = preset;
 112     this.paramset = arguments;
 113     if (editParams)
 114     {
 115       WsJobParameters jobParams = new WsJobParameters(sh, preset);
 116       if (!jobParams.showRunDialog())
 117       {
 118         return;
 119       }
 120       preset = null;
 121       paramset = jobParams.getJobParams();
 122     }
 123
 124     if ((wsInfo = setWebService(sh, false)) == null)
 125     {
 126       JOptionPane.showMessageDialog(Desktop.desktop,
 127               "The Multiple Sequence Alignment Service named "
 128                       + sh.serviceType + " is unknown",
 129               "Internal Jalview Error", JOptionPane.WARNING_MESSAGE);
 130
 131       return;
 132     }
 133     startMsaWSClient(altitle, msa, submitGaps, preserveOrder, seqdataset);
 134
 135   }
 136
 137   public MsaWSClient()
 138   {
 139     super();
 140     // add a class reference to the list
 141   }
 142
 143   private void startMsaWSClient(String altitle, AlignmentView msa,
 144           boolean submitGaps, boolean preserveOrder, Alignment seqdataset)
 145   {
 146     // if (!locateWebService())
 147     // {
 148     // return;
 149     // }
 150
 151     wsInfo.setProgressText(((submitGaps) ? "Re-alignment" : "Alignment")
 152             + " of " + altitle + "\nJob details\n");
 153     String jobtitle = WebServiceName.toLowerCase();
 154     if (jobtitle.endsWith("alignment"))
 155     {
 156       if (submitGaps
 157               && (!jobtitle.endsWith("realignment") || jobtitle
 158                       .indexOf("profile") == -1))
 159       {
 160         int pos = jobtitle.indexOf("alignment");
 161         jobtitle = WebServiceName.substring(0, pos) + "re-alignment of "
 162                 + altitle;
 163       }
 164       else
 165       {
 166         jobtitle = WebServiceName + " of " + altitle;
 167       }
 168     }
 169     else
 170     {
 171       jobtitle = WebServiceName + (submitGaps ? " re" : " ")
 172               + "alignment of " + altitle;
 173     }
 174
 175     MsaWSThread msathread = new MsaWSThread(server, preset, paramset,
 176             WsURL, wsInfo, alignFrame, WebServiceName, jobtitle, msa,
 177             submitGaps, preserveOrder, seqdataset);
 178     wsInfo.setthisService(msathread);
 179     msathread.start();
 180   }
 181
 182   protected String getServiceActionKey()
 183   {
 184     return "MsaWS";
 185   }
 186
 187   protected String getServiceActionDescription()
 188   {
 189     return "Multiple Sequence Alignment";
 190   }
 191
 192   /**
 193    * look at ourselves and work out if we are a service that can take a profile
 194    * and align to it
 195    *
 196    * @return true if we can send gapped sequences to the alignment service
 197    */
 198   private boolean canSubmitGaps()
 199   {
 200     // TODO: query service or extract service handle props to check if we can
 201     // realign
 202     return (WebServiceName.indexOf("lustal") > -1); // cheat!
 203   }
 204
 205   public void attachWSMenuEntry(JMenu rmsawsmenu,
 206           final Jws2Instance service, final AlignFrame alignFrame)
 207   {
 208     setWebService(service, true); // headless
 209     boolean finished = true, submitGaps = false;
 210     JMenu msawsmenu = rmsawsmenu;
 211     String svcname = WebServiceName;
 212     if (svcname.endsWith("WS"))
 213     {
 214       svcname = svcname.substring(0,svcname.length()-2);
 215     }
 216     String calcName = svcname + " ";
 217     if (canSubmitGaps())
 218     {
 219       msawsmenu = new JMenu(svcname);
 220       rmsawsmenu.add(msawsmenu);
 221       calcName = "";
 222     }
 223
 224     do
 225     {
 226       if (submitGaps == true)
 227       {
 228         msawsmenu = new JMenu("profile " + svcname);
 229         rmsawsmenu.add(msawsmenu);
 230       }
 231       final boolean withGaps = submitGaps;
 232       JMenuItem method = new JMenuItem(calcName + "Defaults");
 233       method.setToolTipText("Align with default settings");
 234
 235       method.addActionListener(new ActionListener()
 236       {
 237         public void actionPerformed(ActionEvent e)
 238         {
 239           AlignmentView msa = alignFrame.gatherSequencesForAlignment();
 240           new MsaWSClient(service, alignFrame.getTitle(), msa, withGaps,
 241                   true, alignFrame.getViewport().getAlignment()
 242                           .getDataset(), alignFrame);
 243
 244         }
 245       });
 246       msawsmenu.add(method);
 247       method = new JMenuItem(calcName + "Edit and run ...");
 248       method.setToolTipText("View and change the parameters before alignment.");
 249
 250       method.addActionListener(new ActionListener()
 251       {
 252         public void actionPerformed(ActionEvent e)
 253         {
 254           AlignmentView msa = alignFrame.gatherSequencesForAlignment();
 255           new MsaWSClient(service, null, null, true, alignFrame.getTitle(),
 256                   msa, withGaps, true, alignFrame.getViewport()
 257                           .getAlignment().getDataset(), alignFrame);
 258
 259         }
 260       });
 261       msawsmenu.add(method);
 262       PresetManager presets = service.getPresets();
 263       if (presets != null && presets.getPresets().size() > 0)
 264       {
 265         JMenu presetlist = new JMenu(calcName + "Presets");
 266
 267         for (final Preset preset : (List<Preset>) presets.getPresets())
 268         {
 269           final JMenuItem methodR = new JMenuItem(preset.getName());
 270           methodR.setToolTipText("<html><p>"+preset.getDescription()+"</p></html>");
 271           methodR.addActionListener(new ActionListener()
 272           {
 273             public void actionPerformed(ActionEvent e)
 274             {
 275               AlignmentView msa = alignFrame.gatherSequencesForAlignment();
 276               new MsaWSClient(service, preset, alignFrame.getTitle(), msa,
 277                       false, true, alignFrame.getViewport().getAlignment()
 278                               .getDataset(), alignFrame);
 279
 280             }
 281
 282           });
 283           presetlist.add(methodR);
 284         }
 285         msawsmenu.add(presetlist);
 286       }
 287       if (!submitGaps && canSubmitGaps())
 288       {
 289         submitGaps = true;
 290         finished = false;
 291       }
 292       else
 293       {
 294         finished = true;
 295       }
 296     } while (!finished);
 297   }
 298 }