JAL-3070 pull up sequence anonymisation hash, presets and params list.
[jalview.git] / src / jalview / ws / jws2 / MsaWSThread.java
index d0d0a6e..b1d6452 100644 (file)
@@ -26,7 +26,7 @@ import jalview.datamodel.Alignment;
 import jalview.datamodel.AlignmentI;
 import jalview.datamodel.AlignmentOrder;
 import jalview.datamodel.AlignmentView;
-import jalview.datamodel.ColumnSelection;
+import jalview.datamodel.HiddenColumns;
 import jalview.datamodel.Sequence;
 import jalview.datamodel.SequenceI;
 import jalview.gui.AlignFrame;
@@ -38,12 +38,11 @@ import jalview.ws.AWsJob;
 import jalview.ws.JobStateSummary;
 import jalview.ws.WSClientI;
 import jalview.ws.jws2.dm.JabaWsParamSet;
+import jalview.ws.params.ArgumentI;
 import jalview.ws.params.WsParamSetI;
 
 import java.util.ArrayList;
-import java.util.Hashtable;
 import java.util.List;
-import java.util.Map;
 import java.util.Vector;
 
 import javax.swing.JInternalFrame;
@@ -68,14 +67,10 @@ class MsaWSThread extends AWS2Thread implements WSClientI
   {
     long lastChunk = 0;
 
-    WsParamSetI preset = null;
-
-    List<Argument> arguments = null;
-
     /**
      * input
      */
-    ArrayList<compbio.data.sequence.FastaSequence> seqs = new ArrayList<compbio.data.sequence.FastaSequence>();
+    ArrayList<compbio.data.sequence.FastaSequence> seqs = new ArrayList<>();
 
     /**
      * output
@@ -106,8 +101,6 @@ class MsaWSThread extends AWS2Thread implements WSClientI
 
     }
 
-    Hashtable<String, Map> SeqNames = new Hashtable();
-
     Vector<String[]> emptySeqs = new Vector();
 
     /**
@@ -125,7 +118,8 @@ class MsaWSThread extends AWS2Thread implements WSClientI
       int nseqs = 0;
       if (minlen < 0)
       {
-        throw new Error(MessageManager.getString("error.implementation_error_minlen_must_be_greater_zero"));
+        throw new Error(MessageManager.getString(
+                "error.implementation_error_minlen_must_be_greater_zero"));
       }
       for (int i = 0; i < seqs.length; i++)
       {
@@ -138,7 +132,6 @@ class MsaWSThread extends AWS2Thread implements WSClientI
       compbio.data.sequence.FastaSequence seq;
       for (int i = 0, n = 0; i < seqs.length; i++)
       {
-
         String newname = jalview.analysis.SeqsetUtils.unique_name(i); // same
         // for
         // any
@@ -160,12 +153,11 @@ class MsaWSThread extends AWS2Thread implements WSClientI
           String empty = null;
           if (seqs[i].getEnd() >= seqs[i].getStart())
           {
-            empty = (submitGaps) ? seqs[i].getSequenceAsString() : AlignSeq
-                    .extractGaps(jalview.util.Comparison.GapChars,
+            empty = (submitGaps) ? seqs[i].getSequenceAsString()
+                    : AlignSeq.extractGaps(jalview.util.Comparison.GapChars,
                             seqs[i].getSequenceAsString());
           }
-          emptySeqs.add(new String[]
-          { newname, empty });
+          emptySeqs.add(new String[] { newname, empty });
         }
       }
       return valid;
@@ -175,12 +167,11 @@ class MsaWSThread extends AWS2Thread implements WSClientI
      * 
      * @return true if getAlignment will return a valid alignment result.
      */
+    @Override
     public boolean hasResults()
     {
-      if (subjobComplete
-              && isFinished()
-              && (alignment != null || (emptySeqs != null && emptySeqs
-                      .size() > 0)))
+      if (subjobComplete && isFinished() && (alignment != null
+              || (emptySeqs != null && emptySeqs.size() > 0)))
       {
         return true;
       }
@@ -209,7 +200,8 @@ class MsaWSThread extends AWS2Thread implements WSClientI
           for (compbio.data.sequence.FastaSequence seq : alignment
                   .getSequences())
           {
-            alseqs[alseq_l++] = new Sequence(seq.getId(), seq.getSequence());
+            alseqs[alseq_l++] = new Sequence(seq.getId(),
+                    seq.getSequence());
           }
           alseq_gapchar = alignment.getMetadata().getGapchar();
 
@@ -296,8 +288,7 @@ class MsaWSThread extends AWS2Thread implements WSClientI
         jalview.analysis.AlignmentSorter.recoverOrder(alseqs);
         // account for any missing sequences
         jalview.analysis.SeqsetUtils.deuniquify(SeqNames, alseqs);
-        return new Object[]
-        { alseqs, msaorder };
+        return new Object[] { alseqs, msaorder };
       }
       return null;
     }
@@ -316,6 +307,7 @@ class MsaWSThread extends AWS2Thread implements WSClientI
      * 
      * @return boolean true if job can be submitted.
      */
+    @Override
     public boolean hasValidInput()
     {
       // TODO: get attributes for this MsaWS instance to check if it can do two
@@ -379,14 +371,14 @@ class MsaWSThread extends AWS2Thread implements WSClientI
 
     public List<Argument> getJabaArguments()
     {
-      List<Argument> newargs = new ArrayList<Argument>();
+      List<Argument> newargs = new ArrayList<>();
       if (preset != null && preset instanceof JabaWsParamSet)
       {
         newargs.addAll(((JabaWsParamSet) preset).getjabaArguments());
       }
       if (arguments != null && arguments.size() > 0)
       {
-        newargs.addAll(arguments);
+        newargs.addAll(JabaParamStore.getJabafromJwsArgs(arguments));
       }
       return newargs;
     }
@@ -403,10 +395,10 @@ class MsaWSThread extends AWS2Thread implements WSClientI
                 + "Preset: " + preset.getName());
         if (preset instanceof JabaWsParamSet)
         {
-          for (Argument opt : ((JabaWsParamSet) preset).getjabaArguments())
+          for (Argument opt : getJabaArguments())
           {
-            jobProgress.append(opt.getName() + " " + opt.getDefaultValue()
-                    + "\n");
+            jobProgress.append(
+                    opt.getName() + " " + opt.getDefaultValue() + "\n");
           }
         }
       }
@@ -414,10 +406,10 @@ class MsaWSThread extends AWS2Thread implements WSClientI
       {
         jobProgress.append("With custom parameters : \n");
         // merge arguments with preset's own arguments.
-        for (Argument opt : arguments)
+        for (Argument opt : getJabaArguments())
         {
-          jobProgress.append(opt.getName() + " " + opt.getDefaultValue()
-                  + "\n");
+          jobProgress.append(
+                  opt.getName() + " " + opt.getDefaultValue() + "\n");
         }
       }
       jobProgress.append("\nJob Output:\n");
@@ -436,7 +428,7 @@ class MsaWSThread extends AWS2Thread implements WSClientI
 
   String alTitle; // name which will be used to form new alignment window.
 
-  Alignment dataset; // dataset to which the new alignment will be
+  AlignmentI dataset; // dataset to which the new alignment will be
 
   // associated.
 
@@ -475,11 +467,11 @@ class MsaWSThread extends AWS2Thread implements WSClientI
    * @param seqset
    *          Alignment
    */
-  MsaWSThread(MsaWS server2, WsParamSetI preset, List<Argument> paramset,
+  MsaWSThread(MsaWS server2, WsParamSetI preset, List<ArgumentI> paramset,
           String wsUrl, WebserviceInfo wsinfo,
           jalview.gui.AlignFrame alFrame, String wsname, String title,
           AlignmentView _msa, boolean subgaps, boolean presorder,
-          Alignment seqset)
+          AlignmentI seqset)
   {
     this(server2, wsUrl, wsinfo, alFrame, _msa, wsname, subgaps, presorder);
     OutputHeader = wsInfo.getProgressText();
@@ -490,7 +482,7 @@ class MsaWSThread extends AWS2Thread implements WSClientI
     if (conmsa != null)
     {
       int nvalid = 0, njobs = conmsa.length;
-      jobs = new MsaWSJob[njobs];
+      jobs = new AWsJob[njobs];
       for (int j = 0; j < njobs; j++)
       {
         if (j != 0)
@@ -501,12 +493,12 @@ class MsaWSThread extends AWS2Thread implements WSClientI
         {
           jobs[j] = new MsaWSJob(0, conmsa[j]);
         }
-        if (((MsaWSJob) jobs[j]).hasValidInput())
+        if (jobs[j].hasValidInput())
         {
           nvalid++;
         }
-        ((MsaWSJob) jobs[j]).preset = preset;
-        ((MsaWSJob) jobs[j]).arguments = paramset;
+        jobs[j].setPreset(preset);
+        jobs[j].setArguments(paramset);
         ((MsaWSJob) jobs[j]).alignmentProgram = wsname;
         if (njobs > 0)
         {
@@ -529,11 +521,14 @@ class MsaWSThread extends AWS2Thread implements WSClientI
   {
     return validInput;
   }
+
+  @Override
   public boolean isCancellable()
   {
     return true;
   }
 
+  @Override
   public void cancelJob()
   {
     if (!jobComplete && jobs != null)
@@ -575,8 +570,8 @@ class MsaWSThread extends AWS2Thread implements WSClientI
                     "Exception whilst cancelling " + jobs[job].getJobId(),
                     exc);
           }
-          wsInfo.setProgressText(jobs[job].getJobnum(), OutputHeader
-                  + cancelledMessage + "\n");
+          wsInfo.setProgressText(jobs[job].getJobnum(),
+                  OutputHeader + cancelledMessage + "\n");
         }
         else
         {
@@ -604,6 +599,7 @@ class MsaWSThread extends AWS2Thread implements WSClientI
     }
   }
 
+  @Override
   public void pollJob(AWsJob job) throws Exception
   {
     // TODO: investigate if we still need to cast here in J1.6
@@ -629,8 +625,8 @@ class MsaWSThread extends AWS2Thread implements WSClientI
     do
     {
       j.setLastChunk(lastchunk);
-      ChunkHolder chunk = server
-              .pullExecStatistics(j.getJobId(), lastchunk);
+      ChunkHolder chunk = server.pullExecStatistics(j.getJobId(),
+              lastchunk);
       if (chunk != null)
       {
         changed |= chunk.getChunk().length() > 0;
@@ -649,21 +645,24 @@ class MsaWSThread extends AWS2Thread implements WSClientI
     return changed;
   }
 
+  @Override
   public void StartJob(AWsJob job)
   {
     Exception lex = null;
     // boiler plate template
     if (!(job instanceof MsaWSJob))
     {
-      throw new Error(MessageManager.formatMessage("error.implementation_error_msawbjob_called", new String[]{job.getClass().toString()}));
+      throw new Error(MessageManager.formatMessage(
+              "error.implementation_error_msawbjob_called", new String[]
+              { job.getClass().toString() }));
     }
     MsaWSJob j = (MsaWSJob) job;
     if (j.isSubmitted())
     {
       if (Cache.log.isDebugEnabled())
       {
-        Cache.log.debug("Tried to submit an already submitted job "
-                + j.getJobId());
+        Cache.log.debug(
+                "Tried to submit an already submitted job " + j.getJobId());
       }
       return;
     }
@@ -701,37 +700,50 @@ class MsaWSThread extends AWS2Thread implements WSClientI
       }
       else
       {
-        throw new Exception(MessageManager.formatMessage("exception.web_service_returned_null_try_later", new String[]{WsUrl}));
+        throw new Exception(MessageManager.formatMessage(
+                "exception.web_service_returned_null_try_later",
+                new String[]
+                { WsUrl }));
       }
     } catch (compbio.metadata.UnsupportedRuntimeException _lex)
     {
       lex = _lex;
-      wsInfo.appendProgressText(MessageManager.formatMessage("info.job_couldnt_be_run_server_doesnt_support_program", new String[]{_lex.getMessage()}));
-      wsInfo.warnUser(_lex.getMessage(), MessageManager.getString("warn.service_not_supported"));
+      wsInfo.appendProgressText(MessageManager.formatMessage(
+              "info.job_couldnt_be_run_server_doesnt_support_program",
+              new String[]
+              { _lex.getMessage() }));
+      wsInfo.warnUser(_lex.getMessage(),
+              MessageManager.getString("warn.service_not_supported"));
       wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_SERVERERROR);
       wsInfo.setStatus(j.getJobnum(),
               WebserviceInfo.STATE_STOPPED_SERVERERROR);
     } catch (compbio.metadata.LimitExceededException _lex)
     {
       lex = _lex;
-      wsInfo.appendProgressText(MessageManager.formatMessage("info.job_couldnt_be_run_exceeded_hard_limit", new String[]{_lex.getMessage()}));
-      wsInfo.warnUser(_lex.getMessage(), MessageManager.getString("warn.input_is_too_big"));
+      wsInfo.appendProgressText(MessageManager.formatMessage(
+              "info.job_couldnt_be_run_exceeded_hard_limit", new String[]
+              { _lex.getMessage() }));
+      wsInfo.warnUser(_lex.getMessage(),
+              MessageManager.getString("warn.input_is_too_big"));
       wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_ERROR);
       wsInfo.setStatus(j.getJobnum(), WebserviceInfo.STATE_STOPPED_ERROR);
     } catch (compbio.metadata.WrongParameterException _lex)
     {
       lex = _lex;
-      wsInfo.warnUser(_lex.getMessage(), MessageManager.getString("warn.invalid_job_param_set"));
-      wsInfo.appendProgressText(MessageManager.formatMessage("info.job_couldnt_be_run_incorrect_param_setting", new String[]{_lex.getMessage()}));
+      wsInfo.warnUser(_lex.getMessage(),
+              MessageManager.getString("warn.invalid_job_param_set"));
+      wsInfo.appendProgressText(MessageManager.formatMessage(
+              "info.job_couldnt_be_run_incorrect_param_setting",
+              new String[]
+              { _lex.getMessage() }));
       wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_ERROR);
       wsInfo.setStatus(j.getJobnum(), WebserviceInfo.STATE_STOPPED_ERROR);
     } catch (Error e)
     {
       // For unexpected errors
-      System.err
-              .println(WebServiceName
-                      + "Client: Failed to submit the sequences for alignment (probably a server side problem)\n"
-                      + "When contacting Server:" + WsUrl + "\n");
+      System.err.println(WebServiceName
+              + "Client: Failed to submit the sequences for alignment (probably a server side problem)\n"
+              + "When contacting Server:" + WsUrl + "\n");
       e.printStackTrace(System.err);
       wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_SERVERERROR);
       wsInfo.setStatus(j.getJobnum(),
@@ -739,10 +751,9 @@ class MsaWSThread extends AWS2Thread implements WSClientI
     } catch (Exception e)
     {
       // For unexpected errors
-      System.err
-              .println(WebServiceName
-                      + "Client: Failed to submit the sequences for alignment (probably a server side problem)\n"
-                      + "When contacting Server:" + WsUrl + "\n");
+      System.err.println(WebServiceName
+              + "Client: Failed to submit the sequences for alignment (probably a server side problem)\n"
+              + "When contacting Server:" + WsUrl + "\n");
       e.printStackTrace(System.err);
       wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_SERVERERROR);
       wsInfo.setStatus(j.getJobnum(),
@@ -755,16 +766,19 @@ class MsaWSThread extends AWS2Thread implements WSClientI
         // TODO: JBPNote catch timeout or other fault types explicitly
 
         j.setAllowedServerExceptions(0);
-        wsInfo.appendProgressText(j.getJobnum(),
-                MessageManager.getString("info.failed_to_submit_sequences_for_alignment"));
+        wsInfo.appendProgressText(j.getJobnum(), MessageManager.getString(
+                "info.failed_to_submit_sequences_for_alignment"));
       }
     }
   }
 
+  @Override
   public void parseResult()
   {
     long progbar = System.currentTimeMillis();
-    wsInfo.setProgressBar(MessageManager.getString("status.collecting_job_results"), progbar);
+    wsInfo.setProgressBar(
+            MessageManager.getString("status.collecting_job_results"),
+            progbar);
     int results = 0; // number of result sets received
     JobStateSummary finalState = new JobStateSummary();
     try
@@ -789,8 +803,8 @@ class MsaWSThread extends AWS2Thread implements WSClientI
             } catch (Exception e)
             {
 
-              Cache.log
-                      .warn("Exception when retrieving remaining Job progress data for job "
+              Cache.log.warn(
+                      "Exception when retrieving remaining Job progress data for job "
                               + msjob.getJobId() + " on server " + WsUrl);
               e.printStackTrace();
               nexcept--;
@@ -828,11 +842,11 @@ class MsaWSThread extends AWS2Thread implements WSClientI
           {
             // job has failed for some reason - probably due to invalid
             // parameters
-            Cache.log
-                    .debug("Results not available for finished job - marking as broken job.",
-                            e);
-            msjob.jobProgress
-                    .append("\nResult not available. Probably due to invalid input or parameter settings. Server error message below:\n\n"
+            Cache.log.debug(
+                    "Results not available for finished job - marking as broken job.",
+                    e);
+            msjob.jobProgress.append(
+                    "\nResult not available. Probably due to invalid input or parameter settings. Server error message below:\n\n"
                             + e.getLocalizedMessage());
             msjob.setjobStatus(JobStatus.FAILED);
           } catch (Exception e)
@@ -854,7 +868,8 @@ class MsaWSThread extends AWS2Thread implements WSClientI
             // wsInfo.appendProgressText(jobs[j].getJobnum(),
             // "\nAlignment Object Method Notes\n");
             // wsInfo.appendProgressText(jobs[j].getJobnum(),
-            // "Calculated with "+alignment.getMetadata().getProgram().toString());
+            // "Calculated with
+            // "+alignment.getMetadata().getProgram().toString());
             // JBPNote The returned files from a webservice could be
             // hidden behind icons in the monitor window that,
             // when clicked, pop up their corresponding data
@@ -864,8 +879,9 @@ class MsaWSThread extends AWS2Thread implements WSClientI
     } catch (Exception ex)
     {
 
-      Cache.log.error("Unexpected exception when processing results for "
-              + alTitle, ex);
+      Cache.log.error(
+              "Unexpected exception when processing results for " + alTitle,
+              ex);
       wsInfo.setStatus(WebserviceInfo.STATE_STOPPED_ERROR);
     }
     if (results > 0)
@@ -873,6 +889,7 @@ class MsaWSThread extends AWS2Thread implements WSClientI
       wsInfo.showResultsNewFrame
               .addActionListener(new java.awt.event.ActionListener()
               {
+                @Override
                 public void actionPerformed(java.awt.event.ActionEvent evt)
                 {
                   displayResults(true);
@@ -881,6 +898,7 @@ class MsaWSThread extends AWS2Thread implements WSClientI
       wsInfo.mergeResults
               .addActionListener(new java.awt.event.ActionListener()
               {
+                @Override
                 public void actionPerformed(java.awt.event.ActionEvent evt)
                 {
                   displayResults(false);
@@ -905,7 +923,7 @@ class MsaWSThread extends AWS2Thread implements WSClientI
   void displayResults(boolean newFrame)
   {
     // view input or result data for each block
-    List<AlignmentOrder> alorders = new ArrayList<AlignmentOrder>();
+    List<AlignmentOrder> alorders = new ArrayList<>();
     SequenceI[][] results = new SequenceI[jobs.length][];
     AlignmentOrder[] orders = new AlignmentOrder[jobs.length];
     String lastProgram = null;
@@ -936,7 +954,7 @@ class MsaWSThread extends AWS2Thread implements WSClientI
       orders[j] = null;
     }
     SequenceI[] alignment = (SequenceI[]) newview[0];
-    ColumnSelection columnselection = (ColumnSelection) newview[1];
+    HiddenColumns hidden = (HiddenColumns) newview[1];
     Alignment al = new Alignment(alignment);
     // TODO: add 'provenance' property to alignment from the method notes
     if (lastProgram != null)
@@ -954,11 +972,11 @@ class MsaWSThread extends AWS2Thread implements WSClientI
 
     if (newFrame)
     {
-      displayInNewFrame(al, alorders, columnselection);
-
+      displayInNewFrame(al, alorders, hidden);
     }
     else
     {
+      // TODO 2.9.x feature
       System.out.println("MERGE WITH OLD FRAME");
       // TODO: modify alignment in original frame, replacing old for new
       // alignment using the commands.EditCommand model to ensure the update can
@@ -974,10 +992,10 @@ class MsaWSThread extends AWS2Thread implements WSClientI
    * @param columnselection
    */
   protected void displayInNewFrame(AlignmentI al,
-          List<AlignmentOrder> alorders, ColumnSelection columnselection)
+          List<AlignmentOrder> alorders, HiddenColumns hidden)
   {
-    AlignFrame af = new AlignFrame(al, columnselection,
-            AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
+    AlignFrame af = new AlignFrame(al, hidden, AlignFrame.DEFAULT_WIDTH,
+            AlignFrame.DEFAULT_HEIGHT);
 
     // initialise with same renderer settings as in parent alignframe.
     af.getFeatureRenderer().transferSettings(this.featureSettings);
@@ -987,18 +1005,28 @@ class MsaWSThread extends AWS2Thread implements WSClientI
       addSortByMenuItems(af, alorders);
     }
 
+    // TODO: refactor retrieve and show as new splitFrame as Desktop method
+
     /*
      * If alignment was requested from one half of a SplitFrame, show in a
      * SplitFrame with the other pane similarly aligned.
      */
     AlignFrame requestedBy = getRequestingAlignFrame();
-    if (requestedBy != null && requestedBy.getSplitViewContainer() != null)
+    if (requestedBy != null && requestedBy.getSplitViewContainer() != null
+            && requestedBy.getSplitViewContainer()
+                    .getComplement(requestedBy) != null)
     {
       AlignmentI complement = requestedBy.getSplitViewContainer()
               .getComplement(requestedBy);
       String complementTitle = requestedBy.getSplitViewContainer()
               .getComplementTitle(requestedBy);
+      // becomes null if the alignment window was closed before the alignment
+      // job finished.
       AlignmentI copyComplement = new Alignment(complement);
+      // todo should this be done by copy constructor?
+      copyComplement.setGapCharacter(complement.getGapCharacter());
+      // share the same dataset (and the mappings it holds)
+      copyComplement.setDataset(complement.getDataset());
       copyComplement.alignAs(al);
       if (copyComplement.getHeight() > 0)
       {
@@ -1008,8 +1036,8 @@ class MsaWSThread extends AWS2Thread implements WSClientI
         af2.setTitle(complementTitle);
         String linkedTitle = MessageManager
                 .getString("label.linked_view_title");
-        JInternalFrame splitFrame = new SplitFrame(al.isNucleotide() ? af
-                : af2, al.isNucleotide() ? af2 : af);
+        JInternalFrame splitFrame = new SplitFrame(
+                al.isNucleotide() ? af : af2, al.isNucleotide() ? af2 : af);
         Desktop.addInternalFrame(splitFrame, linkedTitle, -1, -1);
         return;
       }
@@ -1040,7 +1068,7 @@ class MsaWSThread extends AWS2Thread implements WSClientI
     else
     {
       // construct a non-redundant ordering set
-      List<String> names = new ArrayList<String>();
+      List<String> names = new ArrayList<>();
       for (int i = 0, l = alorders.size(); i < l; i++)
       {
         String orderName = " Region " + i;
@@ -1071,12 +1099,14 @@ class MsaWSThread extends AWS2Thread implements WSClientI
       }
       for (int i = 0, l = alorders.size(); i < l; i++)
       {
-        af.addSortByOrderMenuItem(WebServiceName + (names.get(i))
-                + " Ordering", alorders.get(i));
+        af.addSortByOrderMenuItem(
+                WebServiceName + (names.get(i)) + " Ordering",
+                alorders.get(i));
       }
     }
   }
 
+  @Override
   public boolean canMergeResults()
   {
     return false;