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