JAL-3438 spotless for 2.11.2.0
[jalview.git] / src / jalview / gui / Finder.java
index 244e6df..358d9a4 100755 (executable)
  */
 package jalview.gui;
 
-import jalview.datamodel.SearchResultMatchI;
-import jalview.datamodel.SearchResultsI;
-import jalview.datamodel.SequenceFeature;
-import jalview.datamodel.SequenceI;
-import jalview.jbgui.GFinder;
-import jalview.util.MessageManager;
-import jalview.viewmodel.AlignmentViewport;
+import java.util.Locale;
 
 import java.awt.Dimension;
 import java.awt.event.ActionEvent;
+import java.awt.event.FocusAdapter;
+import java.awt.event.FocusEvent;
 import java.awt.event.KeyEvent;
 import java.util.ArrayList;
+import java.util.HashMap;
 import java.util.List;
-import java.util.Vector;
+import java.util.Map;
 import java.util.regex.Pattern;
 import java.util.regex.PatternSyntaxException;
 
@@ -42,8 +39,18 @@ import javax.swing.JComponent;
 import javax.swing.JInternalFrame;
 import javax.swing.JLayeredPane;
 import javax.swing.KeyStroke;
+import javax.swing.event.InternalFrameAdapter;
 import javax.swing.event.InternalFrameEvent;
 
+import jalview.api.AlignViewportI;
+import jalview.api.FinderI;
+import jalview.datamodel.SearchResultMatchI;
+import jalview.datamodel.SearchResultsI;
+import jalview.datamodel.SequenceFeature;
+import jalview.datamodel.SequenceI;
+import jalview.jbgui.GFinder;
+import jalview.util.MessageManager;
+
 /**
  * Performs the menu option for searching the alignment, for the next or all
  * matches. If matches are found, they are highlighted, and the user has the
@@ -57,64 +64,84 @@ import javax.swing.event.InternalFrameEvent;
  */
 public class Finder extends GFinder
 {
-  private static final int MY_HEIGHT = 120;
-
-  private static final int MY_WIDTH = 400;
+  private static final int MIN_WIDTH = 350;
 
-  AlignmentViewport av;
+  private static final int MIN_HEIGHT = 120;
 
-  AlignmentPanel ap;
+  private static final int MY_HEIGHT = 150;
 
-  private static final int MIN_WIDTH = 350;
+  private static final int MY_WIDTH = 400;
 
-  private static final int MIN_HEIGHT = 120;
+  private AlignViewportI av;
 
-  JInternalFrame frame;
+  private AlignmentPanel ap;
 
-  int seqIndex = 0;
+  private JInternalFrame frame;
 
-  int resIndex = -1;
+  /*
+   * Finder agent per viewport searched
+   */
+  private Map<AlignViewportI, FinderI> finders;
 
-  SearchResultsI searchResults;
+  private SearchResultsI searchResults;
 
-  /**
-   * Creates a new Finder object with no associated viewport or panel.
+  /*
+   * true if Finder always acts on the same alignment,
+   * false if it acts on the alignment with focus
    */
-  public Finder()
-  {
-    this(null, null);
-    focusfixed = false;
-  }
+  private boolean focusFixed;
 
   /**
-   * Constructor given an associated viewport and alignment panel. Constructs
-   * and displays an internal frame where the user can enter a search string.
+   * Constructor given an associated alignment panel. Constructs and displays an
+   * internal frame where the user can enter a search string. The Finder may
+   * have 'fixed focus' (always act the panel for which it is constructed), or
+   * not (acts on the alignment that has focus). An optional 'scope' may be
+   * added to be shown in the title of the Finder frame.
    * 
-   * @param viewport
    * @param alignPanel
+   * @param fixedFocus
+   * @param scope
    */
-  public Finder(AlignmentViewport viewport, AlignmentPanel alignPanel)
+  public Finder(AlignmentPanel alignPanel, boolean fixedFocus, String scope)
   {
-    av = viewport;
+    av = alignPanel.getAlignViewport();
     ap = alignPanel;
-    focusfixed = true;
+    focusFixed = fixedFocus;
+    finders = new HashMap<>();
     frame = new JInternalFrame();
     frame.setContentPane(this);
     frame.setLayer(JLayeredPane.PALETTE_LAYER);
-    frame.addInternalFrameListener(
-            new javax.swing.event.InternalFrameAdapter()
-            {
-              @Override
-              public void internalFrameClosing(InternalFrameEvent e)
-              {
-                closeAction();
-              }
-            });
+    frame.addInternalFrameListener(new InternalFrameAdapter()
+    {
+      @Override
+      public void internalFrameClosing(InternalFrameEvent e)
+      {
+        closeAction();
+      }
+    });
+    frame.addFocusListener(new FocusAdapter()
+    {
+      @Override
+      public void focusGained(FocusEvent e)
+      {
+        /*
+         * ensure 'ignore hidden columns' is only enabled
+         * if the alignment with focus has hidden columns
+         */
+        getFocusedViewport();
+      }
+    });
+
     addEscapeHandler();
-    Desktop.addInternalFrame(frame, MessageManager.getString("label.find"),
-            MY_WIDTH, MY_HEIGHT);
+
+    String title = MessageManager.getString("label.find");
+    if (scope != null)
+    {
+      title += " " + scope;
+    }
+    Desktop.addInternalFrame(frame, title, MY_WIDTH, MY_HEIGHT);
     frame.setMinimumSize(new Dimension(MIN_WIDTH, MIN_HEIGHT));
-    searchBox.requestFocus();
+    searchBox.getComponent().requestFocus();
   }
 
   /**
@@ -135,12 +162,10 @@ public class Finder extends GFinder
   }
 
   /**
-   * Performs the 'Find Next' action.
-   * 
-   * @param e
+   * Performs the 'Find Next' action on the alignment panel with focus
    */
   @Override
-  public void findNext_actionPerformed(ActionEvent e)
+  public void findNext_actionPerformed()
   {
     if (getFocusedViewport())
     {
@@ -149,39 +174,32 @@ public class Finder extends GFinder
   }
 
   /**
-   * Performs the 'Find All' action.
-   * 
-   * @param e
+   * Performs the 'Find All' action on the alignment panel with focus
    */
   @Override
-  public void findAll_actionPerformed(ActionEvent e)
+  public void findAll_actionPerformed()
   {
     if (getFocusedViewport())
     {
-      resIndex = -1;
-      seqIndex = 0;
       doSearch(true);
     }
   }
 
   /**
-   * do we only search a given alignment view ?
-   */
-  private boolean focusfixed;
-
-  /**
    * if !focusfixed and not in a desktop environment, checks that av and ap are
    * valid. Otherwise, gets the topmost alignment window and sets av and ap
-   * accordingly
+   * accordingly. Also sets the 'ignore hidden' checkbox disabled if the
+   * viewport has no hidden columns.
    * 
    * @return false if no alignment window was found
    */
   boolean getFocusedViewport()
   {
-    if (focusfixed || Desktop.desktop == null)
+    if (focusFixed || Desktop.desktop == null)
     {
       if (ap != null && av != null)
       {
+        ignoreHidden.setEnabled(av.hasHiddenColumns());
         return true;
       }
       // we aren't in a desktop environment, so give up now.
@@ -193,10 +211,12 @@ public class Finder extends GFinder
     for (int f = 0; f < frames.length; f++)
     {
       JInternalFrame alignFrame = frames[f];
-      if (alignFrame != null && alignFrame instanceof AlignFrame)
+      if (alignFrame != null && alignFrame instanceof AlignFrame
+              && !alignFrame.isIcon())
       {
         av = ((AlignFrame) alignFrame).viewport;
         ap = ((AlignFrame) alignFrame).alignPanel;
+        ignoreHidden.setEnabled(av.hasHiddenColumns());
         return true;
       }
     }
@@ -205,15 +225,19 @@ public class Finder extends GFinder
 
   /**
    * Opens a dialog that allows the user to create sequence features for the
-   * find match results.
+   * find match results
    */
   @Override
   public void createFeatures_actionPerformed()
   {
-    List<SequenceI> seqs = new ArrayList<SequenceI>();
-    List<SequenceFeature> features = new ArrayList<SequenceFeature>();
+    if (searchResults.isEmpty())
+    {
+      return; // shouldn't happen
+    }
+    List<SequenceI> seqs = new ArrayList<>();
+    List<SequenceFeature> features = new ArrayList<>();
 
-    String searchString = searchBox.getEditor().getItem().toString().trim();
+    String searchString = searchBox.getUserInput();
     String desc = "Search Results";
 
     /*
@@ -227,21 +251,7 @@ public class Finder extends GFinder
               match.getEnd(), desc));
     }
 
-    new FeatureEditor(ap).amendFeatures(seqs, features, true, new Runnable()
-    {
-      @Override
-              public void run()
-              {
-
-                /*
-                 * ensure feature display is turned on to show the new features,
-                 * and remove them as highlighted regions
-                 */
-                ap.alignFrame.showSeqFeatures.setSelected(true);
-                av.setShowSequenceFeatures(true);
-                ap.highlightSearchResults(null);
-              }
-            });
+    new FeatureEditor(ap, seqs, features, true).showDialog();
   }
 
   /**
@@ -254,7 +264,7 @@ public class Finder extends GFinder
   {
     createFeatures.setEnabled(false);
 
-    String searchString = searchBox.getUserInput().trim();
+    String searchString = searchBox.getUserInput();
 
     if (isInvalidSearchString(searchString))
     {
@@ -264,79 +274,79 @@ public class Finder extends GFinder
     // other stuff
     // TODO: add switches to control what is searched - sequences, IDS,
     // descriptions, features
-    jalview.analysis.Finder finder = new jalview.analysis.Finder(
-            av.getAlignment(), av.getSelectionGroup(), seqIndex, resIndex);
-    finder.setCaseSensitive(caseSensitive.isSelected());
-    finder.setIncludeDescription(searchDescription.isSelected());
-
-    finder.setFindAll(doFindAll);
-
-    finder.find(searchString); // returns true if anything was actually found
-
-    seqIndex = finder.getSeqIndex();
-    resIndex = finder.getResIndex();
+    FinderI finder = finders.get(av);
+    if (finder == null)
+    {
+      /*
+       * first time we've searched this viewport
+       */
+      finder = new jalview.analysis.Finder(av);
+      finders.put(av, finder);
+    }
 
-    searchResults = finder.getSearchResults(); // find(regex,
-    // caseSensitive.isSelected(), )
-    Vector<SequenceI> idMatch = finder.getIdMatch();
-    boolean haveResults = false;
-    // set or reset the GUI
-    if ((idMatch.size() > 0))
+    boolean isCaseSensitive = caseSensitive.isSelected();
+    boolean doSearchDescription = searchDescription.isSelected();
+    boolean skipHidden = ignoreHidden.isSelected();
+    if (doFindAll)
     {
-      haveResults = true;
-      ap.getIdPanel().highlightSearchResults(idMatch);
+      finder.findAll(searchString, isCaseSensitive, doSearchDescription,
+              skipHidden);
     }
     else
     {
-      ap.getIdPanel().highlightSearchResults(null);
+      finder.findNext(searchString, isCaseSensitive, doSearchDescription,
+              skipHidden);
     }
 
-    if (searchResults.getSize() > 0)
+    searchResults = finder.getSearchResults();
+    List<SequenceI> idMatch = finder.getIdMatches();
+    ap.getIdPanel().highlightSearchResults(idMatch);
+
+    if (searchResults.isEmpty())
     {
-      haveResults = true;
-      createFeatures.setEnabled(true);
+      searchResults = null;
     }
     else
     {
-      searchResults = null;
+      createFeatures.setEnabled(true);
     }
 
-    // if allResults is null, this effectively switches displaySearch flag in
-    // seqCanvas
+    searchBox.updateCache();
+
     ap.highlightSearchResults(searchResults);
     // TODO: add enablers for 'SelectSequences' or 'SelectColumns' or
     // 'SelectRegion' selection
-    if (!haveResults)
+    if (idMatch.isEmpty() && searchResults == null)
     {
       JvOptionPane.showInternalMessageDialog(this,
               MessageManager.getString("label.finished_searching"), null,
-              JvOptionPane.INFORMATION_MESSAGE);
-      resIndex = -1;
-      seqIndex = 0;
+              JvOptionPane.PLAIN_MESSAGE);
     }
     else
     {
       if (doFindAll)
       {
         // then we report the matches that were found
-        String message = (idMatch.size() > 0) ? "" + idMatch.size() + " IDs"
-                : "";
+        StringBuilder message = new StringBuilder();
+        if (idMatch.size() > 0)
+        {
+          message.append(idMatch.size()).append(" IDs");
+        }
         if (searchResults != null)
         {
-          if (idMatch.size() > 0 && searchResults.getSize() > 0)
+          if (idMatch.size() > 0 && searchResults.getCount() > 0)
           {
-            message += " and ";
+            message.append(" ").append(MessageManager.getString("label.and")
+                    .toLowerCase(Locale.ROOT)).append(" ");
           }
-          message += searchResults.getSize()
-                  + " subsequence matches found.";
+          message.append(MessageManager.formatMessage(
+                  "label.subsequence_matches_found",
+                  searchResults.getCount()));
         }
-        JvOptionPane.showInternalMessageDialog(this, message, null,
-                JvOptionPane.INFORMATION_MESSAGE);
-        resIndex = -1;
-        seqIndex = 0;
+        JvOptionPane.showInternalMessageDialog(this, message.toString(),
+                null, JvOptionPane.INFORMATION_MESSAGE);
       }
     }
-    searchBox.updateCache();
   }
 
   /**