X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FFinder.java;h=f526592d9bc53fbef053d4e44336c75163734660;hb=3d0101179759ef157b088ea135423cd909512d9f;hp=909ba1f39957075ebbecdf01ca16db114944ffde;hpb=587fef46179c0daf041e240c10b03ac5910718a8;p=jalview.git

diff --git a/src/jalview/gui/Finder.java b/src/jalview/gui/Finder.java
index 909ba1f..f526592 100755
--- a/src/jalview/gui/Finder.java
+++ b/src/jalview/gui/Finder.java
@@ -1,171 +1,398 @@
-package jalview.gui;
-
-import jalview.jbgui.GFinder;
-import jalview.datamodel.*;
-import java.awt.event.*;
-import javax.swing.*;
-import javax.swing.event.*;
-import java.util.*;
-
-
-public class Finder extends GFinder
-{
-  AlignViewport av;
-  AlignmentPanel ap;
-  JInternalFrame frame;
-  String searchString;
-
-  int seqIndex = 0;
-  int resIndex = 0;
-  public Finder(AlignViewport av, AlignmentPanel ap, JInternalFrame f)
-  {
-    this.av = av;
-    this.ap = ap;
-    frame = f;
-
-    // all a big pain, but we need to wait until the frame is visible before the textfield can
-    // obtain the focus/////////////////////////
-    frame.addInternalFrameListener(new InternalFrameAdapter()
-    {
-      public void internalFrameOpened(InternalFrameEvent evt)
-      {
-        SwingUtilities.invokeLater(new Runnable()
-        {
-          public void run()
-          {
-            textfield.requestFocus();
-          }
-       });
-   }
-});
-
-  }
-
-  public void textfield_actionPerformed(ActionEvent e)
-  {
-    doSearch(false);
-  }
-
-  public void findNext_actionPerformed(ActionEvent e)
-  {
-    doSearch(false);
-  }
-
-  public void findAll_actionPerformed(ActionEvent e)
-  {
-    resIndex=0;
-    seqIndex=0;
-    doSearch(true);
-  }
-
-  public void cancel_actionPerformed(ActionEvent e)
-  {
-    try{
-      // if allResults is null, this effectively switches displaySearch flag in seqCanvas
-      ap.highlightSearchResults( null );
-      frame.setClosed(true);
-    }catch(Exception ex){ }
-
-  }
-
-  void doSearch(boolean findAll)
-  {
-    searchString = textfield.getText().toUpperCase();
-
-    ArrayList searchResults = new ArrayList();
-    int [] allResults = null;
-
-    Sequence seq;
-    String item;
-    boolean found = false;
-
-    /// is the searchString a residue number?
-    try{
-      int res = Integer.parseInt(searchString);
-      found = true;
-
-      if(av.getSelection().size()>0)
-        seq = (Sequence)(av.getSelection().sequenceAt(0));
-      else
-        seq = (Sequence)av.getAlignment().getSequenceAt(0);
-
-      searchResults.add( Integer.toString( av.getAlignment().findIndex(seq) ) );
-      searchResults.add( Integer.toString( seq.findIndex(res)-1 ) );
-      searchResults.add( Integer.toString( seq.findIndex(res)-1 ) );
-
-
-      //av.getAlignment().getSequenceAt(seq).findPosition(res)
-    }catch(NumberFormatException ex){}
-
-
-    while( !found && seqIndex<av.getAlignment().getHeight())
-    {
-      seq = (Sequence)av.getAlignment().getSequenceAt(seqIndex);
-
-      if(av.getSelection().size()>0 && !av.getSelection().contains(seq))
-      {
-        // if a selection has been made, only search within that selection
-        seqIndex++;
-        resIndex=0;
-        continue;
-      }
-
-      item = seq.getSequence();
-
-      for(int r = resIndex; r<item.length(); r++)
-      {
-       if(item.indexOf(searchString,r)>-1)
-       {
-         resIndex = item.indexOf(searchString,r);
-
-         searchResults.add( Integer.toString(seqIndex) );
-         searchResults.add( Integer.toString( resIndex) );
-         searchResults.add( Integer.toString( (resIndex+searchString.length()-1) ) );
-         if(!findAll)
-         {
-           // thats enough, break and display the result
-           found = true;
-           resIndex++;
-           break;
-         }
-
-         r=resIndex+1;
-       }
-      }
-      if(!found)
-      {
-        seqIndex++;
-        resIndex = 0;
-      }
-    }
-
-    if(searchResults.size()>0)
-    {
-
-      allResults = new int[searchResults.size()];
-      for(int i=0; i<searchResults.size(); i++)
-        allResults[i] = Integer.parseInt(searchResults.get(i).toString());
-
-      if (findAll)
-      {
-        String message =  (searchResults.size()/3) + " matches found.";
-        JOptionPane.showInternalMessageDialog(this, message, null,
-                                              JOptionPane.INFORMATION_MESSAGE);
-      }
-
-
-    }
-    else
-    {
-      JOptionPane.showInternalMessageDialog(this, "Finished searching", null, JOptionPane.INFORMATION_MESSAGE);
-      resIndex=0;
-      seqIndex=0;
-    }
-
-    // if allResults is null, this effectively switches displaySearch flag in seqCanvas
-    ap.highlightSearchResults( allResults );
-
-
-  }
-
-}
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ 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.
+ *  
+ * 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/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
+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.awt.Dimension;
+import java.awt.event.ActionEvent;
+import java.awt.event.KeyEvent;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Vector;
+import java.util.regex.Pattern;
+import java.util.regex.PatternSyntaxException;
+
+import javax.swing.AbstractAction;
+import javax.swing.JComponent;
+import javax.swing.JInternalFrame;
+import javax.swing.JLayeredPane;
+import javax.swing.KeyStroke;
+import javax.swing.event.InternalFrameEvent;
+
+/**
+ * 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
+ * option to create a new feature on the alignment for the matched positions.
+ * 
+ * Searches can be for a simple base sequence, or may use a regular expression.
+ * Any gaps are ignored.
+ * 
+ * @author $author$
+ * @version $Revision$
+ */
+public class Finder extends GFinder
+{
+  private static final int MY_HEIGHT = 120;
+
+  private static final int MY_WIDTH = 400;
+
+  AlignmentViewport av;
+
+  AlignmentPanel ap;
+
+  private static final int MIN_WIDTH = 350;
+
+  private static final int MIN_HEIGHT = 120;
+
+  JInternalFrame frame;
+
+  int seqIndex = 0;
+
+  int resIndex = -1;
+
+  SearchResultsI searchResults;
+
+  /**
+   * Creates a new Finder object with no associated viewport or panel.
+   */
+  public Finder()
+  {
+    this(null, null);
+    focusfixed = false;
+  }
+
+  /**
+   * Constructor given an associated viewport and alignment panel. Constructs
+   * and displays an internal frame where the user can enter a search string.
+   * 
+   * @param viewport
+   * @param alignPanel
+   */
+  public Finder(AlignmentViewport viewport, AlignmentPanel alignPanel)
+  {
+    av = viewport;
+    ap = alignPanel;
+    focusfixed = true;
+    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();
+              }
+            });
+    addEscapeHandler();
+    Desktop.addInternalFrame(frame, MessageManager.getString("label.find"),
+            MY_WIDTH, MY_HEIGHT);
+    frame.setMinimumSize(new Dimension(MIN_WIDTH, MIN_HEIGHT));
+    searchBox.requestFocus();
+  }
+
+  /**
+   * Add a handler for the Escape key when the window has focus
+   */
+  private void addEscapeHandler()
+  {
+    getRootPane().getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW)
+            .put(KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0), "Cancel");
+    getRootPane().getActionMap().put("Cancel", new AbstractAction()
+    {
+      @Override
+      public void actionPerformed(ActionEvent e)
+      {
+        closeAction();
+      }
+    });
+  }
+
+  /**
+   * Performs the 'Find Next' action.
+   * 
+   * @param e
+   */
+  @Override
+  public void findNext_actionPerformed(ActionEvent e)
+  {
+    if (getFocusedViewport())
+    {
+      doSearch(false);
+    }
+  }
+
+  /**
+   * Performs the 'Find All' action.
+   * 
+   * @param e
+   */
+  @Override
+  public void findAll_actionPerformed(ActionEvent e)
+  {
+    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
+   * 
+   * @return false if no alignment window was found
+   */
+  boolean getFocusedViewport()
+  {
+    if (focusfixed || Desktop.desktop == null)
+    {
+      if (ap != null && av != null)
+      {
+        return true;
+      }
+      // we aren't in a desktop environment, so give up now.
+      return false;
+    }
+    // now checks further down the window stack to fix bug
+    // https://mantis.lifesci.dundee.ac.uk/view.php?id=36008
+    JInternalFrame[] frames = Desktop.desktop.getAllFrames();
+    for (int f = 0; f < frames.length; f++)
+    {
+      JInternalFrame alignFrame = frames[f];
+      if (alignFrame != null && alignFrame instanceof AlignFrame)
+      {
+        av = ((AlignFrame) alignFrame).viewport;
+        ap = ((AlignFrame) alignFrame).alignPanel;
+        return true;
+      }
+    }
+    return false;
+  }
+
+  /**
+   * Opens a dialog that allows the user to create sequence features for the
+   * find match results.
+   */
+  @Override
+  public void createFeatures_actionPerformed()
+  {
+    List<SequenceI> seqs = new ArrayList<SequenceI>();
+    List<SequenceFeature> features = new ArrayList<SequenceFeature>();
+
+    String searchString = searchBox.getEditor().getItem().toString().trim();
+    String desc = "Search Results";
+
+    /*
+     * assemble dataset sequences, and template new sequence features,
+     * for the amend features dialog
+     */
+    for (SearchResultMatchI match : searchResults.getResults())
+    {
+      seqs.add(match.getSequence().getDatasetSequence());
+      features.add(new SequenceFeature(searchString, desc, null,
+              match.getStart(), match.getEnd(), desc));
+    }
+
+    if (ap.getSeqPanel().seqCanvas.getFeatureRenderer().amendFeatures(seqs,
+            features, true, ap))
+    {
+      /*
+       * 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);
+    }
+  }
+
+  /**
+   * Search the alignment for the next or all matches. If 'all matches', a
+   * dialog is shown with the number of sequence ids and subsequences matched.
+   * 
+   * @param doFindAll
+   */
+  void doSearch(boolean doFindAll)
+  {
+    createFeatures.setEnabled(false);
+
+    String searchString = searchBox.getUserInput().trim();
+
+    if (isInvalidSearchString(searchString))
+    {
+      return;
+    }
+    // TODO: extend finder to match descriptions, features and annotation, and
+    // 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();
+
+    searchResults = finder.getSearchResults(); // find(regex,
+    // caseSensitive.isSelected(), )
+    Vector<SequenceI> idMatch = finder.getIdMatch();
+    boolean haveResults = false;
+    // set or reset the GUI
+    if ((idMatch.size() > 0))
+    {
+      haveResults = true;
+      ap.getIdPanel().highlightSearchResults(idMatch);
+    }
+    else
+    {
+      ap.getIdPanel().highlightSearchResults(null);
+    }
+
+    if (searchResults.getSize() > 0)
+    {
+      haveResults = true;
+      createFeatures.setEnabled(true);
+    }
+    else
+    {
+      searchResults = null;
+    }
+
+    // if allResults is null, this effectively switches displaySearch flag in
+    // seqCanvas
+    ap.highlightSearchResults(searchResults);
+    // TODO: add enablers for 'SelectSequences' or 'SelectColumns' or
+    // 'SelectRegion' selection
+    if (!haveResults)
+    {
+      JvOptionPane.showInternalMessageDialog(this,
+              MessageManager.getString("label.finished_searching"), null,
+              JvOptionPane.INFORMATION_MESSAGE);
+      resIndex = -1;
+      seqIndex = 0;
+    }
+    else
+    {
+      if (doFindAll)
+      {
+        // then we report the matches that were found
+        String message = (idMatch.size() > 0) ? "" + idMatch.size() + " IDs"
+                : "";
+        if (searchResults != null)
+        {
+          if (idMatch.size() > 0 && searchResults.getSize() > 0)
+          {
+            message += " and ";
+          }
+          message += searchResults.getSize()
+                  + " subsequence matches found.";
+        }
+        JvOptionPane.showInternalMessageDialog(this, message, null,
+                JvOptionPane.INFORMATION_MESSAGE);
+        resIndex = -1;
+        seqIndex = 0;
+      }
+    }
+    searchBox.updateCache();
+  }
+
+  /**
+   * Displays an error dialog, and answers false, if the search string is
+   * invalid, else answers true.
+   * 
+   * @param searchString
+   * @return
+   */
+  protected boolean isInvalidSearchString(String searchString)
+  {
+    String error = getSearchValidationError(searchString);
+    if (error == null)
+    {
+      return false;
+    }
+    JvOptionPane.showInternalMessageDialog(this, error,
+            MessageManager.getString("label.invalid_search"), // $NON-NLS-1$
+            JvOptionPane.ERROR_MESSAGE);
+    return true;
+  }
+
+  /**
+   * Returns an error message string if the search string is invalid, else
+   * returns null.
+   * 
+   * Currently validation is limited to checking the string is not empty, and is
+   * a valid regular expression (simple searches for base sub-sequences will
+   * pass this test). Additional validations may be added in future if the
+   * search syntax is expanded.
+   * 
+   * @param searchString
+   * @return
+   */
+  protected String getSearchValidationError(String searchString)
+  {
+    String error = null;
+    if (searchString == null || searchString.length() == 0)
+    {
+      error = MessageManager.getString("label.invalid_search");
+    }
+    try
+    {
+      Pattern.compile(searchString);
+    } catch (PatternSyntaxException e)
+    {
+      error = MessageManager.getString("error.invalid_regex") + ": "
+              + e.getDescription();
+    }
+    return error;
+  }
+
+  protected void closeAction()
+  {
+    frame.setVisible(false);
+    frame.dispose();
+    searchBox.persistCache();
+    if (getFocusedViewport())
+    {
+      ap.alignFrame.requestFocus();
+    }
+  }
+}