src/jalview/ws/MsaWSClient.java

   1 package jalview.ws;
   2
   3 import org.apache.axis.client.*;
   4 import javax.xml.namespace.QName;
   5 import java.util.*;
   6 import jalview.datamodel.*;
   7 import jalview.gui.*;
   8 import javax.swing.*;
   9 import java.util.*;
  10 import java.awt.*;
  11 import jalview.analysis.AlignSeq;
  12 import ext.vamsas.*;
  13 import vamsas.objects.*;
  14
  15
  16
  17
  18 public class MsaWSClient
  19 {
  20   int jobsRunning = 0;
  21   ext.vamsas.MuscleWS server;
  22   WebserviceInfo wsInfo;
  23   /**
  24    * MsaWSClient
  25    *
  26    * @param msa SequenceI[]
  27    */
  28
  29   String WebServiceName;
  30   String WebServiceJobTitle;
  31   String WebServiceReference;
  32   String WsURL;
  33   private boolean setWebService(String MsaWSName) {
  34     if (MsaWServices.info.containsKey(MsaWSName)) {
  35       WebServiceName = MsaWSName;
  36       String[] wsinfo = (String[]) MsaWServices.info.get(MsaWSName);
  37       WsURL = wsinfo[0];
  38       WebServiceJobTitle = wsinfo[1];
  39       WebServiceReference = wsinfo[2];
  40       return true;
  41     } else {
  42       return false;
  43     }
  44   }
  45
  46 //  public MsaWSClient(String MsaWSName, SequenceI[] msa) {
  47 //    MsaWSClient(MsaWSName, msa, true);
  48 //  }
  49
  50   public MsaWSClient(String MsaWSName, String altitle, SequenceI[] msa, boolean submitGaps, boolean preserveOrder)
  51   {
  52     if (setWebService(MsaWSName)==false) {
  53       JOptionPane.showMessageDialog(Desktop.desktop, "The Multiple Sequence Alignment Service named "+MsaWSName+" is unknown",
  54                                     "Internal Jalview Error", JOptionPane.WARNING_MESSAGE);
  55       return;
  56     }
  57
  58     wsInfo = new jalview.gui.WebserviceInfo(WebServiceJobTitle, WebServiceReference);
  59
  60     wsInfo.setProgressText("Alignment of "+altitle+"\nJob details\n");
  61
  62     // TODO: MuscleWS transmuted to generic MsaWS client
  63     MuscleWSServiceLocator loc = new MuscleWSServiceLocator(); // Default
  64     try {
  65       this.server = (MuscleWS) loc.getMuscleWS(// JBPNote will be set from properties
  66       new java.net.URL(WsURL));
  67     }
  68     catch (Exception ex) {
  69       wsInfo.setProgressText("Serious! "+WebServiceName+" Service location failed\nfor URL :"
  70                      +WsURL+"\n"+ex.getMessage());
  71       wsInfo.setStatus(wsInfo.ERROR);
  72       ex.printStackTrace();
  73     }
  74
  75     MsaWSThread musclethread = new MsaWSThread(WebServiceName+" alignment of "+altitle, msa, submitGaps, preserveOrder);
  76     wsInfo.setthisService(musclethread);
  77     musclethread.start();
  78   }
  79
  80
  81   protected class MsaWSThread extends Thread implements WSClientI
  82   {
  83     String ServiceName = WebServiceName;
  84
  85     public boolean isCancellable()
  86     {
  87       return true;
  88     }
  89
  90     String OutputHeader;
  91     vamsas.objects.simple.MsaResult result = null;
  92
  93     vamsas.objects.simple.SequenceSet seqs = new vamsas.objects.simple.
  94         SequenceSet();
  95
  96     Hashtable SeqNames = null;
  97     boolean submitGaps = false,// default is to strip gaps from sequences
  98         preserveOrder = true; // and always store and recover sequence order
  99
 100     String jobId;
 101     String alTitle; // name which will be used to form new alignment window.
 102     int allowedServerExceptions = 3; // thread dies if too many exceptions.
 103     MsaWSThread(String title, SequenceI[] msa, boolean subgaps, boolean presorder)
 104     {
 105       alTitle = title;
 106       submitGaps = subgaps;
 107       preserveOrder = presorder;
 108
 109       OutputHeader = wsInfo.getProgressText();
 110       SeqNames = new Hashtable();
 111       vamsas.objects.simple.Sequence[] seqarray = new vamsas.objects.simple.
 112           Sequence[msa.length];
 113
 114       for (int i = 0; i < msa.length; i++)
 115       {
 116         String newname = jalview.analysis.SeqsetUtils.unique_name(i);
 117         // uniquify as we go
 118         // TODO: JBPNote: this is a ubiquitous transformation - set of jalview seq objects to vamsas sequences with name preservation
 119         SeqNames.put(newname, jalview.analysis.SeqsetUtils.SeqCharacterHash(msa[i]));
 120         seqarray[i] = new vamsas.objects.simple.Sequence();
 121         seqarray[i].setId(newname);
 122         seqarray[i].setSeq((submitGaps) ? msa[i].getSequence()
 123                            : AlignSeq.extractGaps("-. ", msa[i].getSequence()));
 124       }
 125
 126       this.seqs = new vamsas.objects.simple.SequenceSet();
 127       this.seqs.setSeqs(seqarray);
 128     }
 129
 130     boolean jobComplete = false;
 131
 132     public void cancelJob() {
 133       if (!jobComplete) {
 134         String cancelledMessage="";
 135         try {
 136           vamsas.objects.simple.WsJobId cancelledJob = server.cancel(jobId);
 137           if (cancelledJob.getStatus() == 2)
 138           {
 139             // CANCELLED_JOB
 140             cancelledMessage = "Job cancelled.";
 141             wsInfo.setStatus(WebserviceInfo.STATE_CANCELLED_OK);
 142             jobComplete = true;
 143             jobsRunning--;
 144             result = null;
 145           }
 146           else
 147           if (cancelledJob.getStatus() == 3)
 148           {
 149             // VALID UNSTOPPABLE JOB
 150             cancelledMessage +=
 151                 "Server cannot cancel this job. just close the window.\n";
 152           }
 153           if (cancelledJob.getJobId() != null)
 154             cancelledMessage += "[" + cancelledJob.getJobId() + "]";
 155           cancelledMessage +="\n";
 156         } catch (Exception exc) {
 157           cancelledMessage +="\nProblems cancelling the job : Exception received...\n"+exc+"\n";
 158           exc.printStackTrace();
 159         }
 160         wsInfo.setProgressText(OutputHeader + cancelledMessage+"\n");
 161       }
 162     }
 163
 164     public void run()
 165     {
 166
 167       StartJob();
 168
 169       while (!jobComplete && (allowedServerExceptions > 0))
 170       {
 171         try
 172         {
 173           result = server.getResult(jobId);
 174
 175          if( result.isRunning() )
 176            wsInfo.setStatus(WebserviceInfo.STATE_RUNNING);
 177          else if( result.isQueued() )
 178            wsInfo.setStatus(WebserviceInfo.STATE_QUEUING);
 179
 180           if (result.isFinished())
 181           {
 182             parseResult();
 183             jobComplete = true;
 184             jobsRunning--;
 185           }
 186           else
 187           {
 188             wsInfo.setProgressText(OutputHeader + "\n" + result.getStatus());
 189             if (! (result.isJobFailed() || result.isServerError()))
 190             {
 191               Thread.sleep(5000);
 192               //  System.out.println("I'm alive "+seqid+" "+jobid);
 193             }
 194           }
 195         }
 196         catch (Exception ex)
 197         {
 198           allowedServerExceptions--;
 199           wsInfo.appendProgressText("\n"+ServiceName+" Server exception!\n" + ex.getMessage());
 200           ex.printStackTrace();
 201         }
 202       }
 203
 204       if (! (result!=null && (result.isJobFailed() || result.isServerError())))
 205         wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_OK);
 206       else
 207         wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_ERROR);
 208     }
 209
 210     void StartJob()
 211     {
 212       try
 213       {
 214         vamsas.objects.simple.WsJobId jobsubmit = server.align(seqs);
 215         if (jobsubmit.getStatus()==1) {
 216           System.out.println(jobId=jobsubmit.getJobId());
 217         } else {
 218           throw new Exception(jobsubmit.getJobId());
 219         }
 220       }
 221       catch (Exception e)
 222       {
 223         System.out.println(ServiceName + " Client: Failed to submit the prediction\n" +
 224                            e.toString() + "\n");
 225         e.printStackTrace();
 226       }
 227     }
 228
 229     private void addFloatAnnotations(Alignment al, int[] gapmap, Vector values, String Symname, String Visname, float min, float max, int winLength) {
 230
 231       Annotation[] annotations = new Annotation[al.getWidth()];
 232       for (int j = 0; j < values.size(); j++)
 233       {
 234         float value = Float.parseFloat(values.get(j).toString());
 235         annotations[gapmap[j]] = new Annotation("", value+"",' ',value);
 236       }
 237       al.addAnnotation(new AlignmentAnnotation(Symname, Visname, annotations, min, max, winLength));
 238     }
 239     private jalview.datamodel.Sequence[] getVamsasAlignment(vamsas.objects.simple.Alignment valign) {
 240       vamsas.objects.simple.Sequence[] seqs = valign.getSeqs().getSeqs();
 241       jalview.datamodel.Sequence[] msa = new jalview.datamodel.Sequence[seqs.length];
 242       for (int i=0, j=seqs.length; i<j;i++)
 243         msa[i] = new jalview.datamodel.Sequence(seqs[i].getId(), seqs[i].getSeq());
 244       return msa;
 245     }
 246     void parseResult()
 247     {
 248       SequenceI[] seqs=null;
 249       try {
 250         // OutputHeader = output.getText();
 251         if (result.isFailed()) {
 252           OutputHeader +="Job failed.\n";
 253         }
 254         if (result.getStatus()!=null) {
 255           OutputHeader += "\n"+result.getStatus();
 256         }
 257         if (result.getMsa()!=null) {
 258           OutputHeader += "\nAlignment Object Method Notes\n";
 259           String lines[] = result.getMsa().getMethod();
 260           for (int line=0;line<lines.length; line++)
 261             OutputHeader+=lines[line]+"\n";
 262
 263           // JBPNote The returned files from a webservice could be hidden behind icons in the monitor window that, when clicked, pop up their corresponding data
 264           seqs = getVamsasAlignment(result.getMsa());
 265         }
 266
 267         wsInfo.setProgressText(OutputHeader);
 268         if (seqs!=null) {
 269           AlignmentOrder msaorder = new AlignmentOrder(seqs);
 270
 271           if (preserveOrder) {
 272             jalview.analysis.AlignmentSorter.recoverOrder(seqs);
 273           }
 274
 275           jalview.analysis.SeqsetUtils.deuniquify(SeqNames, seqs);
 276
 277           Alignment al = new Alignment(seqs);
 278
 279           // TODO: JBPNote Should also rename the query sequence sometime...
 280           AlignFrame af = new AlignFrame(al);
 281           af.addSortByOrderMenuItem(ServiceName+" Ordering", msaorder);
 282
 283           Desktop.addInternalFrame(af,
 284                                    alTitle,
 285                                    AlignFrame.NEW_WINDOW_WIDTH,
 286                                    AlignFrame.NEW_WINDOW_HEIGHT);
 287         }
 288       }catch(Exception ex){ex.printStackTrace();}
 289
 290     }
 291
 292   }
 293 }
 294
 295