src/jalview/gui/Finder.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.gui;
  22
  23 import jalview.datamodel.SearchResultMatchI;
  24 import jalview.datamodel.SearchResultsI;
  25 import jalview.datamodel.SequenceFeature;
  26 import jalview.datamodel.SequenceI;
  27 import jalview.jbgui.GFinder;
  28 import jalview.util.MessageManager;
  29 import jalview.viewmodel.AlignmentViewport;
  30
  31 import java.awt.event.ActionEvent;
  32 import java.awt.event.KeyEvent;
  33 import java.util.Vector;
  34 import java.util.regex.Pattern;
  35 import java.util.regex.PatternSyntaxException;
  36
  37 import javax.swing.AbstractAction;
  38 import javax.swing.JComponent;
  39 import javax.swing.JInternalFrame;
  40 import javax.swing.JLayeredPane;
  41 import javax.swing.KeyStroke;
  42 import javax.swing.event.InternalFrameEvent;
  43
  44 /**
  45  * Performs the menu option for searching the alignment, for the next or all
  46  * matches. If matches are found, they are highlighted, and the user has the
  47  * option to create a new feature on the alignment for the matched positions.
  48  *
  49  * Searches can be for a simple base sequence, or may use a regular expression.
  50  * Any gaps are ignored.
  51  *
  52  * @author $author$
  53  * @version $Revision$
  54  */
  55 public class Finder extends GFinder
  56 {
  57   private static final int HEIGHT = 110;
  58
  59   private static final int WIDTH = 340;
  60
  61   AlignmentViewport av;
  62
  63   AlignmentPanel ap;
  64
  65   JInternalFrame frame;
  66
  67   int seqIndex = 0;
  68
  69   int resIndex = -1;
  70
  71   SearchResultsI searchResults;
  72
  73   /**
  74    * Creates a new Finder object with no associated viewport or panel.
  75    */
  76   public Finder()
  77   {
  78     this(null, null);
  79     focusfixed = false;
  80   }
  81
  82   /**
  83    * Constructor given an associated viewport and alignment panel. Constructs
  84    * and displays an internal frame where the user can enter a search string.
  85    *
  86    * @param viewport
  87    * @param alignPanel
  88    */
  89   public Finder(AlignmentViewport viewport, AlignmentPanel alignPanel)
  90   {
  91     av = viewport;
  92     ap = alignPanel;
  93     focusfixed = true;
  94     frame = new JInternalFrame();
  95     frame.setContentPane(this);
  96     frame.setLayer(JLayeredPane.PALETTE_LAYER);
  97     frame.addInternalFrameListener(new javax.swing.event.InternalFrameAdapter()
  98     {
  99       @Override
 100       public void internalFrameClosing(InternalFrameEvent e)
 101       {
 102         closeAction();
 103       }
 104     });
 105     addEscapeHandler();
 106     Desktop.addInternalFrame(frame, MessageManager.getString("label.find"),
 107             WIDTH, HEIGHT);
 108
 109     searchBox.requestFocus();
 110   }
 111
 112   /**
 113    * Add a handler for the Escape key when the window has focus
 114    */
 115   private void addEscapeHandler()
 116   {
 117     getRootPane().getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(
 118             KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0), "Cancel");
 119     getRootPane().getActionMap().put("Cancel", new AbstractAction()
 120     {
 121       @Override
 122       public void actionPerformed(ActionEvent e)
 123       {
 124         closeAction();
 125       }
 126     });
 127   }
 128
 129
 130   /**
 131    * Performs the 'Find Next' action.
 132    *
 133    * @param e
 134    */
 135   @Override
 136   public void findNext_actionPerformed(ActionEvent e)
 137   {
 138     if (getFocusedViewport())
 139     {
 140       doSearch(false);
 141     }
 142   }
 143
 144   /**
 145    * Performs the 'Find All' action.
 146    *
 147    * @param e
 148    */
 149   @Override
 150   public void findAll_actionPerformed(ActionEvent e)
 151   {
 152     if (getFocusedViewport())
 153     {
 154       resIndex = -1;
 155       seqIndex = 0;
 156       doSearch(true);
 157     }
 158   }
 159
 160   /**
 161    * do we only search a given alignment view ?
 162    */
 163   private boolean focusfixed;
 164
 165   /**
 166    * if !focusfixed and not in a desktop environment, checks that av and ap are
 167    * valid. Otherwise, gets the topmost alignment window and sets av and ap
 168    * accordingly
 169    *
 170    * @return false if no alignment window was found
 171    */
 172   boolean getFocusedViewport()
 173   {
 174     if (focusfixed || Desktop.desktop == null)
 175     {
 176       if (ap != null && av != null)
 177       {
 178         return true;
 179       }
 180       // we aren't in a desktop environment, so give up now.
 181       return false;
 182     }
 183     // now checks further down the window stack to fix bug
 184     // https://mantis.lifesci.dundee.ac.uk/view.php?id=36008
 185     JInternalFrame[] frames = Desktop.desktop.getAllFrames();
 186     for (int f = 0; f < frames.length; f++)
 187     {
 188       JInternalFrame frame = frames[f];
 189       if (frame != null && frame instanceof AlignFrame)
 190       {
 191         av = ((AlignFrame) frame).viewport;
 192         ap = ((AlignFrame) frame).alignPanel;
 193         return true;
 194       }
 195     }
 196     return false;
 197   }
 198
 199   /**
 200    * DOCUMENT ME!
 201    *
 202    * @param e
 203    *          DOCUMENT ME!
 204    */
 205   @Override
 206   public void createNewGroup_actionPerformed(ActionEvent e)
 207   {
 208     SequenceI[] seqs = new SequenceI[searchResults.getSize()];
 209     SequenceFeature[] features = new SequenceFeature[searchResults
 210             .getSize()];
 211
 212     int i = 0;
 213     for (SearchResultMatchI match : searchResults.getResults())
 214     {
 215       seqs[i] = match.getSequence().getDatasetSequence();
 216
 217       features[i] = new SequenceFeature(searchBox.getEditor().getItem()
 218               .toString().trim(),
 219               "Search Results", null, match.getStart(), match.getEnd(),
 220               "Search Results");
 221       i++;
 222     }
 223
 224     if (ap.getSeqPanel().seqCanvas.getFeatureRenderer().amendFeatures(seqs,
 225             features, true, ap))
 226     {
 227       ap.alignFrame.showSeqFeatures.setSelected(true);
 228       av.setShowSequenceFeatures(true);
 229       ap.highlightSearchResults(null);
 230     }
 231   }
 232
 233   /**
 234    * Search the alignment for the next or all matches. If 'all matches', a
 235    * dialog is shown with the number of sequence ids and subsequences matched.
 236    *
 237    * @param findAll
 238    */
 239   void doSearch(boolean findAll)
 240   {
 241     createNewGroup.setEnabled(false);
 242
 243     String searchString = searchBox.getUserInput().trim();
 244
 245     if (isInvalidSearchString(searchString))
 246     {
 247       return;
 248     }
 249     // TODO: extend finder to match descriptions, features and annotation, and
 250     // other stuff
 251     // TODO: add switches to control what is searched - sequences, IDS,
 252     // descriptions, features
 253     jalview.analysis.Finder finder = new jalview.analysis.Finder(
 254             av.getAlignment(), av.getSelectionGroup(), seqIndex, resIndex);
 255     finder.setCaseSensitive(caseSensitive.isSelected());
 256     finder.setIncludeDescription(searchDescription.isSelected());
 257
 258     finder.setFindAll(findAll);
 259
 260     finder.find(searchString); // returns true if anything was actually found
 261
 262     seqIndex = finder.getSeqIndex();
 263     resIndex = finder.getResIndex();
 264
 265     searchResults = finder.getSearchResults(); // find(regex,
 266     // caseSensitive.isSelected(), )
 267     Vector<SequenceI> idMatch = finder.getIdMatch();
 268     boolean haveResults = false;
 269     // set or reset the GUI
 270     if ((idMatch.size() > 0))
 271     {
 272       haveResults = true;
 273       ap.getIdPanel().highlightSearchResults(idMatch);
 274     }
 275     else
 276     {
 277       ap.getIdPanel().highlightSearchResults(null);
 278     }
 279
 280     if (searchResults.getSize() > 0)
 281     {
 282       haveResults = true;
 283       createNewGroup.setEnabled(true);
 284     }
 285     else
 286     {
 287       searchResults = null;
 288     }
 289
 290     // if allResults is null, this effectively switches displaySearch flag in
 291     // seqCanvas
 292     ap.highlightSearchResults(searchResults);
 293     // TODO: add enablers for 'SelectSequences' or 'SelectColumns' or
 294     // 'SelectRegion' selection
 295     if (!haveResults)
 296     {
 297       JvOptionPane.showInternalMessageDialog(this,
 298               MessageManager.getString("label.finished_searching"), null,
 299               JvOptionPane.INFORMATION_MESSAGE);
 300       resIndex = -1;
 301       seqIndex = 0;
 302     }
 303     else
 304     {
 305       if (findAll)
 306       {
 307         // then we report the matches that were found
 308         String message = (idMatch.size() > 0) ? "" + idMatch.size()
 309                 + " IDs" : "";
 310         if (searchResults != null)
 311         {
 312           if (idMatch.size() > 0 && searchResults.getSize() > 0)
 313           {
 314             message += " and ";
 315           }
 316           message += searchResults.getSize()
 317                   + " subsequence matches found.";
 318         }
 319         JvOptionPane.showInternalMessageDialog(this, message, null,
 320                 JvOptionPane.INFORMATION_MESSAGE);
 321         resIndex = -1;
 322         seqIndex = 0;
 323       }
 324     }
 325     searchBox.updateCache();
 326   }
 327
 328   /**
 329    * Displays an error dialog, and answers false, if the search string is
 330    * invalid, else answers true.
 331    *
 332    * @param searchString
 333    * @return
 334    */
 335   protected boolean isInvalidSearchString(String searchString)
 336   {
 337     String error = getSearchValidationError(searchString);
 338     if (error == null)
 339     {
 340       return false;
 341     }
 342     JvOptionPane.showInternalMessageDialog(this, error,
 343             MessageManager.getString("label.invalid_search"), // $NON-NLS-1$
 344             JvOptionPane.ERROR_MESSAGE);
 345     return true;
 346   }
 347
 348   /**
 349    * Returns an error message string if the search string is invalid, else
 350    * returns null.
 351    *
 352    * Currently validation is limited to checking the string is not empty, and is
 353    * a valid regular expression (simple searches for base sub-sequences will
 354    * pass this test). Additional validations may be added in future if the
 355    * search syntax is expanded.
 356    *
 357    * @param searchString
 358    * @return
 359    */
 360   protected String getSearchValidationError(String searchString)
 361   {
 362     String error = null;
 363     if (searchString == null || searchString.length() == 0)
 364     {
 365       error = MessageManager.getString("label.invalid_search");
 366     }
 367     try
 368     {
 369       Pattern.compile(searchString);
 370     } catch (PatternSyntaxException e)
 371     {
 372       error = MessageManager.getString("error.invalid_regex") + ": "
 373               + e.getDescription();
 374     }
 375     return error;
 376   }
 377
 378   protected void closeAction()
 379   {
 380     frame.setVisible(false);
 381     frame.dispose();
 382     searchBox.persistCache();
 383     if (getFocusedViewport())
 384     {
 385       ap.alignFrame.requestFocus();
 386     }
 387   }
 388 }