JAL-1645 Version-Rel Version 2.9 Year-Rel 2015 Licensing glob
[jalview.git] / src / jalview / ws / jws1 / JPredThread.java
index a0036fe..79c39b4 100644 (file)
@@ -1,33 +1,46 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)
- * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9)
+ * Copyright (C) 2015 The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
  * Jalview is free software: you can redistribute it and/or
  * modify it under the terms of the GNU General Public License 
- * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
- * 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
  * Jalview is distributed in the hope that it will be useful, but 
  * WITHOUT ANY WARRANTY; without even the implied warranty 
  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
  * PURPOSE.  See the GNU General Public License for more details.
  * 
- * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
 package jalview.ws.jws1;
 
-import java.util.*;
-
-import jalview.analysis.*;
-import jalview.bin.*;
-import jalview.datamodel.*;
-import jalview.gui.*;
-import jalview.io.*;
-import jalview.util.*;
+import jalview.analysis.AlignSeq;
+import jalview.bin.Cache;
+import jalview.datamodel.Alignment;
+import jalview.datamodel.AlignmentAnnotation;
+import jalview.datamodel.AlignmentI;
+import jalview.datamodel.AlignmentView;
+import jalview.datamodel.ColumnSelection;
+import jalview.datamodel.SequenceI;
+import jalview.gui.AlignFrame;
+import jalview.gui.Desktop;
+import jalview.gui.WebserviceInfo;
+import jalview.io.FormatAdapter;
+import jalview.util.Comparison;
+import jalview.util.MessageManager;
 import jalview.ws.AWsJob;
 import jalview.ws.JobStateSummary;
 import jalview.ws.WSClientI;
+
+import java.util.Hashtable;
+import java.util.List;
+
 import vamsas.objects.simple.JpredResult;
 
 class JPredThread extends JWS1Thread implements WSClientI
@@ -91,7 +104,7 @@ class JPredThread extends JWS1Thread implements WSClientI
       {
         return null;
       }
-      Alignment al = null;
+      AlignmentI al = null;
       ColumnSelection alcsel = null;
       int FirstSeq = -1; // the position of the query sequence in Alignment al
 
@@ -100,8 +113,8 @@ class JPredThread extends JWS1Thread implements WSClientI
       jalview.bin.Cache.log.debug("Parsing output from JNet job.");
       // JPredFile prediction = new JPredFile("C:/JalviewX/files/jpred.txt",
       // "File");
-      jalview.io.JPredFile prediction = new jalview.io.JPredFile(result
-              .getPredfile(), "Paste");
+      jalview.io.JPredFile prediction = new jalview.io.JPredFile(
+              result.getPredfile(), "Paste");
       SequenceI[] preds = prediction.getSeqsAsArray();
       jalview.bin.Cache.log.debug("Got prediction profile.");
 
@@ -110,8 +123,8 @@ class JPredThread extends JWS1Thread implements WSClientI
         jalview.bin.Cache.log.debug("Getting associated alignment.");
         // we ignore the returned alignment if we only predicted on a single
         // sequence
-        String format = new jalview.io.IdentifyFile().Identify(result
-                .getAligfile(), "Paste");
+        String format = new jalview.io.IdentifyFile().Identify(
+                result.getAligfile(), "Paste");
 
         if (jalview.io.FormatAdapter.isValidFormat(format))
         {
@@ -134,24 +147,32 @@ class JPredThread extends JWS1Thread implements WSClientI
             {
               sqs[i] = al.getSequenceAt(i);
             }
-            if (!jalview.analysis.SeqsetUtils.deuniquify(
-                    (Hashtable) SequenceInfo, sqs))
+            if (!jalview.analysis.SeqsetUtils.deuniquify(SequenceInfo, sqs))
             {
               throw (new Exception(
-                      "Couldn't recover sequence properties for alignment."));
+                      MessageManager
+                              .getString("exception.couldnt_recover_sequence_properties_for_alignment")));
             }
           }
           FirstSeq = 0;
-          al.setDataset(null);
+          if (currentView.getDataset() != null)
+          {
+            al.setDataset(currentView.getDataset());
 
+          }
+          else
+          {
+            al.setDataset(null);
+          }
           jalview.io.JnetAnnotationMaker.add_annotation(prediction, al,
                   FirstSeq, false, predMap);
 
         }
         else
         {
-          throw (new Exception("Unknown format " + format
-                  + " for file : \n" + result.getAligfile()));
+          throw (new Exception(MessageManager.formatMessage(
+                  "exception.unknown_format_for_file", new String[] {
+                      format, result.getAligfile() })));
         }
       }
       else
@@ -161,34 +182,44 @@ class JPredThread extends JWS1Thread implements WSClientI
         if (predMap != null)
         {
           char gc = getGapChar();
-          SequenceI[] sqs = (SequenceI[]) ((java.lang.Object[]) input
-                  .getAlignmentAndColumnSelection(gc))[0];
+          SequenceI[] sqs = (SequenceI[]) input
+                  .getAlignmentAndColumnSelection(gc)[0];
           if (this.msaIndex >= sqs.length)
           {
             throw new Error(
-                    "Implementation Error! Invalid msaIndex for JPredJob on parent MSA input object!");
+                    MessageManager
+                            .getString("error.implementation_error_invalid_msa_index_for_job"));
           }
 
           // ///
           // Uses RemoveGapsCommand
           // ///
-          new jalview.commands.RemoveGapsCommand("Remove Gaps",
-                  new SequenceI[]
-                  { sqs[msaIndex] }, currentView);
+          new jalview.commands.RemoveGapsCommand(
+                  MessageManager.getString("label.remove_gaps"),
+                  new SequenceI[] { sqs[msaIndex] }, currentView);
 
           SequenceI profileseq = al.getSequenceAt(FirstSeq);
           profileseq.setSequence(sqs[msaIndex].getSequenceAsString());
         }
 
-        if (!jalview.analysis.SeqsetUtils.SeqCharacterUnhash(al
-                .getSequenceAt(FirstSeq), SequenceInfo))
+        if (!jalview.analysis.SeqsetUtils.SeqCharacterUnhash(
+                al.getSequenceAt(FirstSeq), SequenceInfo))
         {
           throw (new Exception(
-                  "Couldn't recover sequence properties for JNet Query sequence!"));
+                  MessageManager
+                          .getString("exception.couldnt_recover_sequence_props_for_jnet_query")));
         }
         else
         {
-          al.setDataset(null);
+          if (currentView.getDataset() != null)
+          {
+            al.setDataset(currentView.getDataset());
+
+          }
+          else
+          {
+            al.setDataset(null);
+          }
           jalview.io.JnetAnnotationMaker.add_annotation(prediction, al,
                   FirstSeq, true, predMap);
           SequenceI profileseq = al.getSequenceAt(0); // this includes any gaps.
@@ -197,12 +228,54 @@ class JPredThread extends JWS1Thread implements WSClientI
           {
             // Adjust input view for gaps
             // propagate insertions into profile
-            alcsel = propagateInsertions(profileseq, al, input);
+            alcsel = ColumnSelection.propagateInsertions(profileseq, al,
+                    input);
           }
         }
       }
-      return new Object[]
-      { al, alcsel }; // , FirstSeq, noMsa};
+      // transfer to dataset
+      for (AlignmentAnnotation alant : al.getAlignmentAnnotation())
+      {
+        if (alant.sequenceRef != null)
+        {
+          replaceAnnotationOnAlignmentWith(alant, alant.label,
+                  "jalview.jws1.Jpred" + (this.msa == null ? "" : "MSA"),
+                  alant.sequenceRef);
+        }
+      }
+      return new Object[] { al, alcsel }; // , FirstSeq, noMsa};
+    }
+
+    /**
+     * copied from JabawsCalcWorker
+     * 
+     * @param newAnnot
+     * @param typeName
+     * @param calcId
+     * @param aSeq
+     */
+    protected void replaceAnnotationOnAlignmentWith(
+            AlignmentAnnotation newAnnot, String typeName, String calcId,
+            SequenceI aSeq)
+    {
+      SequenceI dsseq = aSeq.getDatasetSequence();
+      while (dsseq.getDatasetSequence() != null)
+      {
+        dsseq = dsseq.getDatasetSequence();
+      }
+      // look for same annotation on dataset and lift this one over
+      List<AlignmentAnnotation> dsan = dsseq.getAlignmentAnnotations(
+              calcId, typeName);
+      if (dsan != null && dsan.size() > 0)
+      {
+        for (AlignmentAnnotation dssan : dsan)
+        {
+          dsseq.removeAlignmentAnnotation(dssan);
+        }
+      }
+      AlignmentAnnotation dssan = new AlignmentAnnotation(newAnnot);
+      dsseq.addAlignmentAnnotation(dssan);
+      dssan.adjustForAlignment();
     }
 
     /**
@@ -213,7 +286,7 @@ class JPredThread extends JWS1Thread implements WSClientI
      * @param al
      * @param profileseq
      */
-    private void alignToProfileSeq(Alignment al, SequenceI profileseq)
+    private void alignToProfileSeq(AlignmentI al, SequenceI profileseq)
     {
       char gc = al.getGapCharacter();
       int[] gapMap = profileseq.gapMap();
@@ -255,105 +328,12 @@ class JPredThread extends JWS1Thread implements WSClientI
       }
     }
 
-    /**
-     * Add gaps into the sequences aligned to profileseq under the given
-     * AlignmentView
-     * 
-     * @param profileseq
-     * @param al
-     * @param input
-     */
-    private ColumnSelection propagateInsertions(SequenceI profileseq,
-            Alignment al, AlignmentView input)
-    {
-      char gc = al.getGapCharacter();
-      Object[] alandcolsel = input.getAlignmentAndColumnSelection(gc);
-      ColumnSelection nview = (ColumnSelection) alandcolsel[1];
-      SequenceI origseq;
-      nview.pruneDeletions(ShiftList
-              .parseMap((origseq = ((SequenceI[]) alandcolsel[0])[0])
-                      .gapMap())); // recover original prediction sequence's
-      // mapping to view.
-      int[] viscontigs = nview.getVisibleContigs(0, profileseq.getLength());
-      int spos = 0;
-      int offset = 0;
-      // input.pruneDeletions(ShiftList.parseMap(((SequenceI[])
-      // alandcolsel[0])[0].gapMap()))
-      // add profile to visible contigs
-      for (int v = 0; v < viscontigs.length; v += 2)
-      {
-        if (viscontigs[v] > spos)
-        {
-          StringBuffer sb = new StringBuffer();
-          for (int s = 0, ns = viscontigs[v] - spos; s < ns; s++)
-          {
-            sb.append(gc);
-          }
-          for (int s = 0, ns = al.getHeight(); s < ns; s++)
-          {
-            SequenceI sqobj = al.getSequenceAt(s);
-            if (sqobj != profileseq)
-            {
-              String sq = al.getSequenceAt(s).getSequenceAsString();
-              if (sq.length() <= spos + offset)
-              {
-                // pad sequence
-                int diff = spos + offset - sq.length() - 1;
-                if (diff > 0)
-                {
-                  // pad gaps
-                  sq = sq + sb;
-                  while ((diff = spos + offset - sq.length() - 1) > 0)
-                  {
-                    sq = sq
-                            + ((diff >= sb.length()) ? sb.toString() : sb
-                                    .substring(0, diff));
-                  }
-                }
-                sq += sb.toString();
-              }
-              else
-              {
-                al.getSequenceAt(s).setSequence(
-                        sq.substring(0, spos + offset) + sb.toString()
-                                + sq.substring(spos + offset));
-              }
-            }
-          }
-          // offset+=sb.length();
-        }
-        spos = viscontigs[v + 1] + 1;
-      }
-      if ((offset + spos) < profileseq.getLength())
-      {
-        StringBuffer sb = new StringBuffer();
-        for (int s = 0, ns = profileseq.getLength() - spos - offset; s < ns; s++)
-        {
-          sb.append(gc);
-        }
-        for (int s = 1, ns = al.getHeight(); s < ns; s++)
-        {
-          String sq = al.getSequenceAt(s).getSequenceAsString();
-          // pad sequence
-          int diff = origseq.getLength() - sq.length();
-          while (diff > 0)
-          {
-            sq = sq
-                    + ((diff >= sb.length()) ? sb.toString() : sb
-                            .substring(0, diff));
-            diff = origseq.getLength() - sq.length();
-          }
-        }
-      }
-      return nview;
-    }
-
     public JPredJob(Hashtable SequenceInfo, SequenceI seq, int[] delMap)
     {
       super();
       this.predMap = delMap;
-      String sq = AlignSeq.extractGaps(Comparison.GapChars, seq
-              .getSequenceAsString());
+      String sq = AlignSeq.extractGaps(Comparison.GapChars,
+              seq.getSequenceAsString());
       if (sq.length() >= 20)
       {
         this.SequenceInfo = SequenceInfo;
@@ -361,6 +341,10 @@ class JPredThread extends JWS1Thread implements WSClientI
         sequence.setId(seq.getName());
         sequence.setSeq(sq);
       }
+      else
+      {
+        errorMessage = "Sequence is too short to predict with JPred - need at least 20 amino acids.";
+      }
     }
 
     public JPredJob(Hashtable SequenceInfo, SequenceI[] msf, int[] delMap)
@@ -376,6 +360,13 @@ class JPredThread extends JWS1Thread implements WSClientI
         }
       }
     }
+
+    String errorMessage = "";
+
+    public String getValidationMessages()
+    {
+      return errorMessage + "\n";
+    }
   }
 
   ext.vamsas.Jpred server;
@@ -401,10 +392,13 @@ class JPredThread extends JWS1Thread implements WSClientI
     if (job.hasValidInput())
     {
       OutputHeader = wsInfo.getProgressText();
-      jobs = new WSJob[]
-      { job };
+      jobs = new WSJob[] { job };
       job.setJobnum(0);
     }
+    else
+    {
+      wsInfo.appendProgressText(job.getValidationMessages());
+    }
   }
 
   JPredThread(WebserviceInfo wsinfo, String altitle,
@@ -416,20 +410,23 @@ class JPredThread extends JWS1Thread implements WSClientI
     JPredJob job = new JPredJob(SequenceInfo, msf, delMap);
     if (job.hasValidInput())
     {
-      jobs = new WSJob[]
-      { job };
+      jobs = new WSJob[] { job };
       OutputHeader = wsInfo.getProgressText();
       job.setJobnum(0);
     }
+    else
+    {
+      wsInfo.appendProgressText(job.getValidationMessages());
+    }
   }
 
   public void StartJob(AWsJob j)
   {
     if (!(j instanceof JPredJob))
     {
-      throw new Error(
-              "Implementation error - StartJob(JpredJob) called on "
-                      + j.getClass());
+      throw new Error(MessageManager.formatMessage(
+              "error.implementation_error_startjob_called",
+              new String[] { j.getClass().toString() }));
     }
     try
     {
@@ -448,9 +445,11 @@ class JPredThread extends JWS1Thread implements WSClientI
       {
         if (job.getJobId().startsWith("Broken"))
         {
-          job.result = (vamsas.objects.simple.Result) new JpredResult();
+          job.result = new JpredResult();
           job.result.setInvalid(true);
-          job.result.setStatus("Submission " + job.getJobId());
+          job.result.setStatus(MessageManager.formatMessage(
+                  "label.submission_params", new String[] { job.getJobId()
+                          .toString() }));
           throw new Exception(job.getJobId());
         }
         else
@@ -462,7 +461,9 @@ class JPredThread extends JWS1Thread implements WSClientI
       }
       else
       {
-        throw new Exception("Server timed out - try again later\n");
+        throw new Exception(
+                MessageManager
+                        .getString("exception.server_timeout_try_later"));
       }
     } catch (Exception e)
     {
@@ -470,14 +471,12 @@ class JPredThread extends JWS1Thread implements WSClientI
       wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_SERVERERROR);
       if (e.getMessage().indexOf("Exception") > -1)
       {
-        wsInfo
-                .setStatus(j.getJobnum(),
-                        WebserviceInfo.STATE_STOPPED_SERVERERROR);
-        wsInfo
-                .setProgressText(
-                        j.getJobnum(),
-                        "Failed to submit the prediction. (Just close the window)\n"
-                                + "It is most likely that there is a problem with the server.\n");
+        wsInfo.setStatus(j.getJobnum(),
+                WebserviceInfo.STATE_STOPPED_SERVERERROR);
+        wsInfo.setProgressText(
+                j.getJobnum(),
+                "Failed to submit the prediction. (Just close the window)\n"
+                        + "It is most likely that there is a problem with the server.\n");
         System.err
                 .println("JPredWS Client: Failed to submit the prediction. Quite possibly because of a server error - see below)\n"
                         + e.getMessage() + "\n");
@@ -488,12 +487,14 @@ class JPredThread extends JWS1Thread implements WSClientI
       {
         wsInfo.setStatus(j.getJobnum(), WebserviceInfo.STATE_STOPPED_ERROR);
         // JBPNote - this could be a popup informing the user of the problem.
-        wsInfo.appendProgressText(j.getJobnum(),
-                "Failed to submit the prediction:\n" + e.getMessage()
-                        + wsInfo.getProgressText());
+        wsInfo.appendProgressText(j.getJobnum(), MessageManager
+                .formatMessage(
+                        "info.failed_to_submit_prediction",
+                        new String[] { e.getMessage(),
+                            wsInfo.getProgressText() }));
 
-        jalview.bin.Cache.log.debug("Failed Submission of job " + j.getJobnum(),
-                e);
+        jalview.bin.Cache.log.debug(
+                "Failed Submission of job " + j.getJobnum(), e);
 
       }
       j.setAllowedServerExceptions(-1);
@@ -545,6 +546,8 @@ class JPredThread extends JWS1Thread implements WSClientI
     }
     else
     {
+      wsInfo.setStatus(wsInfo.STATE_STOPPED_ERROR);
+      wsInfo.appendInfoText("No jobs ran.");
       wsInfo.setFinishedNoResults();
     }
   }
@@ -579,16 +582,19 @@ class JPredThread extends JWS1Thread implements WSClientI
             {
               // do merge with other job results
               throw new Error(
-                      "Multiple JNet subjob merging not yet implemented.");
+                      MessageManager
+                              .getString("error.multiple_jnet_subjob_merge_not_implemented"));
             }
           } catch (Exception e)
           {
             jalview.bin.Cache.log.error(
                     "JNet Client: JPred Annotation Parse Error", e);
-            wsInfo.setStatus(j.getJobnum(), WebserviceInfo.STATE_STOPPED_ERROR);
-            wsInfo.appendProgressText(j.getJobnum(), OutputHeader + "\n"
-                    + j.result.getStatus()
-                    + "\nInvalid JNet job result data!\n" + e.getMessage());
+            wsInfo.setStatus(j.getJobnum(),
+                    WebserviceInfo.STATE_STOPPED_ERROR);
+            wsInfo.appendProgressText(j.getJobnum(), MessageManager
+                    .formatMessage("info.invalid_jnet_job_result_data",
+                            new String[] { OutputHeader.toString(),
+                                j.result.getStatus(), e.getMessage() }));
             j.result.setBroken(true);
           }
         }
@@ -599,6 +605,8 @@ class JPredThread extends JWS1Thread implements WSClientI
         if (newWindow)
         {
           AlignFrame af;
+          ((AlignmentI) res[0]).setSeqrep(((AlignmentI) res[0])
+                  .getSequenceAt(0));
           if (input == null)
           {
             if (res[1] != null)
@@ -646,7 +654,7 @@ class JPredThread extends JWS1Thread implements WSClientI
 
   public void pollJob(AWsJob job) throws Exception
   {
-    ((JPredJob)job).result = server.getresult(job.getJobId());
+    ((JPredJob) job).result = server.getresult(job.getJobId());
   }
 
   public boolean isCancellable()
@@ -656,7 +664,7 @@ class JPredThread extends JWS1Thread implements WSClientI
 
   public void cancelJob()
   {
-    throw new Error("Implementation error!");
+    throw new Error(MessageManager.getString("error.implementation_error"));
   }
 
   public boolean canMergeResults()