JAL-1264 exclude score-only from 'Add Reference Annotations'
[jalview.git] / src / jalview / gui / AlignFrame.java
index 834f4c8..3f74327 100644 (file)
@@ -54,7 +54,6 @@ import jalview.datamodel.AlignmentOrder;
 import jalview.datamodel.AlignmentView;
 import jalview.datamodel.ColumnSelection;
 import jalview.datamodel.HiddenColumns;
-import jalview.datamodel.HiddenMarkovModel;
 import jalview.datamodel.HiddenSequences;
 import jalview.datamodel.PDBEntry;
 import jalview.datamodel.SeqCigar;
@@ -63,11 +62,11 @@ import jalview.datamodel.SequenceGroup;
 import jalview.datamodel.SequenceI;
 import jalview.gui.ColourMenuHelper.ColourChangeListener;
 import jalview.gui.ViewSelectionMenu.ViewSetProvider;
-import jalview.hmmer.HMMAlignThread;
-import jalview.hmmer.HMMBuildThread;
+import jalview.hmmer.HMMAlign;
+import jalview.hmmer.HMMBuild;
 import jalview.hmmer.HMMERParamStore;
 import jalview.hmmer.HMMERPreset;
-import jalview.hmmer.HMMSearchThread;
+import jalview.hmmer.HMMSearch;
 import jalview.hmmer.HmmerCommand;
 import jalview.io.AlignmentProperties;
 import jalview.io.AnnotationFile;
@@ -95,7 +94,6 @@ import jalview.schemes.ColourSchemes;
 import jalview.schemes.ResidueColourScheme;
 import jalview.schemes.TCoffeeColourScheme;
 import jalview.util.MessageManager;
-import jalview.util.StringUtils;
 import jalview.viewmodel.AlignmentViewport;
 import jalview.viewmodel.ViewportRanges;
 import jalview.ws.DBRefFetcher;
@@ -141,18 +139,14 @@ import java.net.URL;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Deque;
-import java.util.Enumeration;
-import java.util.HashMap;
-import java.util.Hashtable;
+import java.util.HashSet;
 import java.util.List;
-import java.util.Map;
-import java.util.Scanner;
+import java.util.Set;
 import java.util.Vector;
 
 import javax.swing.JCheckBoxMenuItem;
 import javax.swing.JEditorPane;
 import javax.swing.JFileChooser;
-import javax.swing.JFrame;
 import javax.swing.JInternalFrame;
 import javax.swing.JLayeredPane;
 import javax.swing.JMenu;
@@ -170,9 +164,6 @@ import javax.swing.SwingUtilities;
 public class AlignFrame extends GAlignFrame implements DropTargetListener,
         IProgressIndicator, AlignViewControllerGuiI, ColourChangeListener
 {
-
-  Map<String, Float> distribution = new HashMap<>(); // temporary
-
   public static final int DEFAULT_WIDTH = 700;
 
   public static final int DEFAULT_HEIGHT = 500;
@@ -185,10 +176,6 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
   AlignViewport viewport;
 
   public AlignViewControllerI avc;
-  /*
-   * The selected HMM for this align frame
-   */
-  SequenceI selectedHMMSequence;
 
   List<AlignmentPanel> alignPanels = new ArrayList<>();
 
@@ -787,7 +774,7 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
       ap.av.updateConservation(ap);
       ap.av.updateConsensus(ap);
       ap.av.updateStrucConsensus(ap);
-      ap.av.updateInformation(ap);
+      ap.av.initInformationWorker(ap);
     }
   }
 
@@ -1024,109 +1011,111 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
   }
 
   @Override
-  public void hmmBuildSettings_actionPerformed()
+  public void hmmBuild_actionPerformed(boolean withDefaults)
   {
-    if (!(alignmentIsSufficient(1)))
+    if (!alignmentIsSufficient(1))
     {
       return;
     }
-    WsParamSetI set = new HMMERPreset();
-    List<ArgumentI> args = new ArrayList<>();
-    ParamDatastoreI store = new HMMERParamStore("hmmbuild");
-    WsJobParameters params = new WsJobParameters(new JFrame(), store, set,
-            args);
-    if (params.showRunDialog())
-    {
-      new Thread(new HMMBuildThread(this, params.getJobParams())).start();
-    }
-    alignPanel.repaint();
 
-  }
+    /*
+     * get default parameters, and optionally show a dialog
+     * to allow them to be modified
+     */
+    ParamDatastoreI store = HMMERParamStore.forBuild(viewport);
+    List<ArgumentI> args = store.getServiceParameters();
 
-  @Override
-  public void hmmAlignSettings_actionPerformed()
-  {
-    if (!(checkForHMM() && alignmentIsSufficient(2)))
-    {
-      return;
-    }
-    WsParamSetI set = new HMMERPreset();
-    List<ArgumentI> args = new ArrayList<>();
-    ParamDatastoreI store = new HMMERParamStore("hmmalign");
-    WsJobParameters params = new WsJobParameters(new JFrame(), store, set,
-            args);
-    if (params.showRunDialog())
+    if (!withDefaults)
     {
-      new Thread(new HMMAlignThread(this, true, params.getJobParams()))
-            .start();
+      WsParamSetI set = new HMMERPreset();
+      WsJobParameters params = new WsJobParameters(store, set, args);
+      if (params.showRunDialog())
+      {
+        args = params.getJobParams();
+      }
+      else
+      {
+        return; // user cancelled
+      }
     }
-    alignPanel.repaint();
+    new Thread(new HMMBuild(this, args)).start();
   }
 
   @Override
-  public void hmmSearchSettings_actionPerformed()
+  public void hmmAlign_actionPerformed(boolean withDefaults)
   {
-    if (!checkForHMM())
+    if (!(checkForHMM() && alignmentIsSufficient(2)))
     {
       return;
     }
-    WsParamSetI set = new HMMERPreset();
-    List<ArgumentI> args = new ArrayList<>();
-    ParamDatastoreI store = new HMMERParamStore("hmmsearch");
-    WsJobParameters params = new WsJobParameters(new JFrame(), store, set,
-            args);
-    if (params.showRunDialog())
-    {
-      new Thread(new HMMSearchThread(this, true, params.getJobParams()))
-            .start();
-    }
-    alignPanel.repaint();
-  }
 
-  @Override
-  public void hmmBuildRun_actionPerformed()
-  {
-    if (!alignmentIsSufficient(1))
+    /*
+     * get default parameters, and optionally show a dialog
+     * to allow them to be modified
+     */
+    ParamDatastoreI store = HMMERParamStore.forAlign(viewport);
+    List<ArgumentI> args = store.getServiceParameters();
+
+    if (!withDefaults)
     {
-      return;
+      WsParamSetI set = new HMMERPreset();
+      WsJobParameters params = new WsJobParameters(store, set, args);
+      if (params.showRunDialog())
+      {
+        args = params.getJobParams();
+      }
+      else
+      {
+        return; // user cancelled
+      }
     }
-    new Thread(new HMMBuildThread(this, null))
-            .start();
+    new Thread(new HMMAlign(this, args)).start();
   }
 
   @Override
-  public void hmmAlignRun_actionPerformed()
+  public void hmmSearch_actionPerformed(boolean withDefaults)
   {
-    if (!(checkForHMM() && alignmentIsSufficient(2)))
+    if (!checkForHMM())
     {
       return;
     }
-    new Thread(new HMMAlignThread(this, true, null))
-            .start();
-  }
 
-  @Override
-  public void hmmSearchRun_actionPerformed()
-  {
-    if (!checkForHMM())
+    /*
+     * get default parameters, and (if requested) show 
+     * dialog to allow modification
+     */
+    ParamDatastoreI store = HMMERParamStore.forSearch(viewport);
+    List<ArgumentI> args = store.getServiceParameters();
+
+    if (!withDefaults)
     {
-      return;
+      WsParamSetI set = new HMMERPreset();
+      WsJobParameters params = new WsJobParameters(store, set, args);
+      if (params.showRunDialog())
+      {
+        args = params.getJobParams();
+      }
+      else
+      {
+        return; // user cancelled
+      }
     }
-    new Thread(new HMMSearchThread(this, true, null))
-            .start();
+    new Thread(new HMMSearch(this, args)).start();
+    alignPanel.repaint();
   }
 
   /**
-   * Checks if the frame has a selected hidden Markov model
+   * Checks if the alignment has at least one hidden Markov model, if not shows
+   * a dialog advising to run hmmbuild or load an HMM profile
    * 
    * @return
    */
   private boolean checkForHMM()
   {
-    if (getSelectedHMM() == null)
+    if (viewport.getAlignment().getHmmSequences().isEmpty())
     {
       JOptionPane.showMessageDialog(this,
-              MessageManager.getString("warn.no_selected_hmm"));
+              MessageManager.getString("warn.no_hmm"));
       return false;
     }
     return true;
@@ -1143,42 +1132,36 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
     if (getViewport().getAlignment().getSequences().size() < required)
     {
       JOptionPane.showMessageDialog(this,
-              MessageManager.getString("warn.not_enough_sequences"));
+              MessageManager.getString("label.not_enough_sequences"));
       return false;
     }
     return true;
   }
 
+  /**
+   * Opens a file browser and adds the selected file, if in Fasta, Stockholm or
+   * Pfam format, to the list held under preference key "HMMSEARCH_DBS" (as a
+   * comma-separated list)
+   */
   @Override
   public void addDatabase_actionPerformed() throws IOException
   {
-    if (Cache.getProperty(Preferences.HMMSEARCH_DB_PATHS) == null)
+    if (Cache.getProperty(Preferences.HMMSEARCH_DBS) == null)
     {
       Cache.setProperty(Preferences.HMMSEARCH_DBS, "");
-      Cache.setProperty(Preferences.HMMSEARCH_DB_PATHS, "");
     }
 
     String path = openFileChooser(false);
-    if (new File(path).exists())
+    if (path != null && new File(path).exists())
     {
       IdentifyFile identifier = new IdentifyFile();
       FileFormatI format = identifier.identify(path, DataSourceType.FILE);
       if (format == FileFormat.Fasta || format == FileFormat.Stockholm
               || format == FileFormat.Pfam)
       {
-        String currentDbs = Cache.getProperty(Preferences.HMMSEARCH_DBS);
         String currentDbPaths = Cache
-                .getProperty(Preferences.HMMSEARCH_DB_PATHS);
-        currentDbPaths += " " + path;
-
-        String fileName = StringUtils.getLastToken(path, File.separator);
-        Scanner scanner = new Scanner(fileName).useDelimiter(".");
-        String name = scanner.next();
-        scanner.close();
-        currentDbs += " " + path; // TODO remove path from file name
-        scanner.close();
-
-        Cache.setProperty(Preferences.HMMSEARCH_DB_PATHS, currentDbPaths);
+                .getProperty(Preferences.HMMSEARCH_DBS);
+        currentDbPaths += Preferences.COMMA + path;
         Cache.setProperty(Preferences.HMMSEARCH_DBS, currentDbPaths);
       }
       else
@@ -1187,21 +1170,19 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
                 MessageManager.getString("warn.invalid_format"));
       }
     }
-    else
-    {
-      JOptionPane.showMessageDialog(this,
-              MessageManager.getString("warn.not_enough_sequences"));
-    }
   }
 
   /**
-   * Opens a file chooser
+   * Opens a file chooser, optionally restricted to selecting folders
+   * (directories) only. Answers the path to the selected file or folder, or
+   * null if none is chosen.
    * 
-   * @param forFolder
+   * @param
    * @return
    */
   protected String openFileChooser(boolean forFolder)
   {
+    // TODO duplicates GPreferences method - relocate to JalviewFileChooser?
     String choice = null;
     JFileChooser chooser = new JFileChooser();
     if (forFolder)
@@ -2056,7 +2037,6 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
   @Override
   protected void copy_actionPerformed(ActionEvent e)
   {
-    System.gc();
     if (viewport.getSelectionGroup() == null)
     {
       return;
@@ -2092,25 +2072,17 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
       return;
     }
 
-    ArrayList<int[]> hiddenColumns = null;
+    HiddenColumns hiddenColumns = null;
     if (viewport.hasHiddenColumns())
     {
-      hiddenColumns = new ArrayList<>();
-
       int hiddenOffset = viewport.getSelectionGroup().getStartRes();
       int hiddenCutoff = viewport.getSelectionGroup().getEndRes();
-      ArrayList<int[]> hiddenRegions = viewport.getAlignment()
-              .getHiddenColumns().getHiddenColumnsCopy();
-      for (int[] region : hiddenRegions)
 
-      {
-        if (region[0] >= hiddenOffset && region[1] <= hiddenCutoff)
-        {
-          hiddenColumns
-                  .add(new int[]
-                  { region[0] - hiddenOffset, region[1] - hiddenOffset });
-        }
-      }
+      // create new HiddenColumns object with copy of hidden regions
+      // between startRes and endRes, offset by startRes
+      hiddenColumns = new HiddenColumns(
+              viewport.getAlignment().getHiddenColumns(), hiddenOffset,
+              hiddenCutoff, hiddenOffset);
     }
 
     Desktop.jalviewClipboard = new Object[] { seqs,
@@ -2447,11 +2419,8 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
         if (Desktop.jalviewClipboard != null
                 && Desktop.jalviewClipboard[2] != null)
         {
-          List<int[]> hc = (List<int[]>) Desktop.jalviewClipboard[2];
-          for (int[] region : hc)
-          {
-            af.viewport.hideColumns(region[0], region[1]);
-          }
+          HiddenColumns hc = (HiddenColumns) Desktop.jalviewClipboard[2];
+          af.viewport.setHiddenColumns(hc);
         }
 
         // >>>This is a fix for the moment, until a better solution is
@@ -2505,11 +2474,8 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
       if (Desktop.jalviewClipboard != null
               && Desktop.jalviewClipboard[2] != null)
       {
-        List<int[]> hc = (List<int[]>) Desktop.jalviewClipboard[2];
-        for (int region[] : hc)
-        {
-          af.viewport.hideColumns(region[0], region[1]);
-        }
+        HiddenColumns hc = (HiddenColumns) Desktop.jalviewClipboard[2];
+        af.viewport.setHiddenColumns(hc);
       }
 
       // >>>This is a fix for the moment, until a better solution is
@@ -3937,35 +3903,33 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
     }
 
     if (viewport.getAlignment().getAlignmentAnnotation()
-            .hashCode() != _annotationScoreVectorHash)
+            .hashCode() == _annotationScoreVectorHash)
+    {
+      return;
+    }
+
+    sortByAnnotScore.removeAll();
+    Set<String> scoreSorts = new HashSet<>();
+    for (SequenceI sqa : viewport.getAlignment().getSequences())
     {
-      sortByAnnotScore.removeAll();
-      // almost certainly a quicker way to do this - but we keep it simple
-      Hashtable scoreSorts = new Hashtable();
-      AlignmentAnnotation aann[];
-      for (SequenceI sqa : viewport.getAlignment().getSequences())
+      AlignmentAnnotation[] anns = sqa.getAnnotation();
+      for (int i = 0; anns != null && i < anns.length; i++)
       {
-        aann = sqa.getAnnotation();
-        for (int i = 0; aann != null && i < aann.length; i++)
+        AlignmentAnnotation aa = anns[i];
+        if (aa != null && aa.hasScore() && aa.sequenceRef != null)
         {
-          if (aann[i].hasScore() && aann[i].sequenceRef != null)
-          {
-            scoreSorts.put(aann[i].label, aann[i].label);
-          }
+          scoreSorts.add(aa.label);
         }
       }
-      Enumeration labels = scoreSorts.keys();
-      while (labels.hasMoreElements())
-      {
-        addSortByAnnotScoreMenuItem(sortByAnnotScore,
-                (String) labels.nextElement());
-      }
-      sortByAnnotScore.setVisible(scoreSorts.size() > 0);
-      scoreSorts.clear();
-
-      _annotationScoreVectorHash = viewport.getAlignment()
-              .getAlignmentAnnotation().hashCode();
     }
+    for (String label : scoreSorts)
+    {
+      addSortByAnnotScoreMenuItem(sortByAnnotScore, label);
+    }
+    sortByAnnotScore.setVisible(!scoreSorts.isEmpty());
+
+    _annotationScoreVectorHash = viewport.getAlignment()
+            .getAlignmentAnnotation().hashCode();
   }
 
   /**
@@ -4880,11 +4844,7 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
             new JnetAnnotationMaker();
             JnetAnnotationMaker.add_annotation(predictions,
                     viewport.getAlignment(), 0, false);
-            SequenceI repseq = viewport.getAlignment().getSequenceAt(0);
-            viewport.getAlignment().setSeqrep(repseq);
-            HiddenColumns cs = new HiddenColumns();
-            cs.hideInsertionsFor(repseq);
-            viewport.getAlignment().setHiddenColumns(cs);
+            viewport.getAlignment().setupJPredAlignment();
             isAnnotation = true;
           }
           // else if (IdentifyFile.FeaturesFile.equals(format))
@@ -5105,14 +5065,15 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
             MessageManager.getString("option.trim_retrieved_seqs"));
     trimrs.setToolTipText(
             MessageManager.getString("label.trim_retrieved_sequences"));
-    trimrs.setSelected(Cache.getDefault("TRIM_FETCHED_DATASET_SEQS", true));
+    trimrs.setSelected(
+            Cache.getDefault(DBRefFetcher.TRIM_RETRIEVED_SEQUENCES, true));
     trimrs.addActionListener(new ActionListener()
     {
       @Override
       public void actionPerformed(ActionEvent e)
       {
         trimrs.setSelected(trimrs.isSelected());
-        Cache.setProperty("TRIM_FETCHED_DATASET_SEQS",
+        Cache.setProperty(DBRefFetcher.TRIM_RETRIEVED_SEQUENCES,
                 Boolean.valueOf(trimrs.isSelected()).toString());
       };
     });
@@ -5501,30 +5462,6 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
   }
 
   @Override
-  protected void showInformationHistogram_actionPerformed(ActionEvent e)
-  {
-    viewport.setShowInformationHistogram(
-            showInformationHistogram.getState());
-    alignPanel.updateAnnotation(applyAutoAnnotationSettings.getState());
-  }
-
-  @Override
-  protected void showHMMSequenceLogo_actionPerformed(ActionEvent e)
-  {
-    viewport.setShowHMMSequenceLogo(showHMMSequenceLogo.getState());
-    alignPanel.updateAnnotation(applyAutoAnnotationSettings.getState());
-  }
-
-  @Override
-  protected void normaliseHMMSequenceLogo_actionPerformed(ActionEvent e)
-  {
-    showHMMSequenceLogo.setState(true);
-    viewport.setShowHMMSequenceLogo(true);
-    viewport.setNormaliseHMMSequenceLogo(normaliseSequenceLogo.getState());
-    alignPanel.updateAnnotation(applyAutoAnnotationSettings.getState());
-  }
-
-  @Override
   protected void applyAutoAnnotationSettings_actionPerformed(ActionEvent e)
   {
     alignPanel.updateAnnotation(applyAutoAnnotationSettings.getState());
@@ -5858,44 +5795,6 @@ public class AlignFrame extends GAlignFrame implements DropTargetListener,
     hmmerMenu.setEnabled(HmmerCommand.isHmmerAvailable());
   }
 
-  /**
-   * Returns the selected hidden Markov model.
-   * 
-   * @return
-   */
-  public HiddenMarkovModel getSelectedHMM()
-  {
-    if (selectedHMMSequence == null)
-    {
-      return null;
-    }
-    return selectedHMMSequence.getHMM();
-  }
-
-  /**
-   * Returns the selected hidden Markov model.
-   * 
-   * @return
-   */
-  public SequenceI getSelectedHMMSequence()
-  {
-    return selectedHMMSequence;
-  }
-
-  /**
-   * Sets the selected hidden Markov model
-   * 
-   * @param selectedHMM
-   */
-  public void setSelectedHMMSequence(SequenceI selectedHMM)
-  {
-    this.selectedHMMSequence = selectedHMM;
-    hmmAlign.setText(MessageManager.getString("label.hmmalign") + " to "
-            + selectedHMM.getHMM().getName());
-    hmmSearch.setText(MessageManager.getString("label.hmmsearch") + " with "
-            + selectedHMM.getHMM().getName());
-  }
-
   @Override
   public void hmmerMenu_actionPerformed(ActionEvent e)
   {