-/*\r
- * Jalview - A Sequence Alignment Editor and Viewer\r
- * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
- *\r
- * This program is free software; you can redistribute it and/or\r
- * modify it under the terms of the GNU General Public License\r
- * as published by the Free Software Foundation; either version 2\r
- * of the License, or (at your option) any later version.\r
- *\r
- * This program is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
- * GNU General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU General Public License\r
- * along with this program; if not, write to the Free Software\r
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA\r
- */\r
-package jalview.gui;\r
-\r
-import java.util.*;\r
-\r
-import java.awt.*;\r
-import java.awt.event.*;\r
-import javax.swing.*;\r
-import javax.swing.event.*;\r
-\r
-import jalview.datamodel.*;\r
-import jalview.jbgui.*;\r
-\r
-public class Finder\r
- extends GFinder\r
-{\r
- AlignViewport av;\r
- AlignmentPanel ap;\r
- JInternalFrame frame;\r
- SuperGroup searchGroup;\r
- Vector searchResults;\r
- int seqIndex = 0;\r
- int resIndex = 0;\r
-\r
- public Finder(AlignViewport av, AlignmentPanel ap, JInternalFrame f)\r
- {\r
- this.av = av;\r
- this.ap = ap;\r
- frame = f;\r
-\r
- // all a big pain, but we need to wait until the frame is visible before the textfield can\r
- // obtain the focus/////////////////////////\r
- frame.addInternalFrameListener(new InternalFrameAdapter()\r
- {\r
- public void internalFrameOpened(InternalFrameEvent evt)\r
- {\r
- SwingUtilities.invokeLater(new Runnable()\r
- {\r
- public void run()\r
- {\r
- textfield.requestFocus();\r
- }\r
- });\r
- }\r
-\r
- public void internalFrameClosing(InternalFrameEvent evt)\r
- {\r
- cancel_actionPerformed(null);\r
- }\r
- });\r
- }\r
-\r
- public void textfield_actionPerformed(ActionEvent e)\r
- {\r
- doSearch(false);\r
- }\r
-\r
- public void findNext_actionPerformed(ActionEvent e)\r
- {\r
- doSearch(false);\r
- }\r
-\r
- public void findAll_actionPerformed(ActionEvent e)\r
- {\r
- resIndex = 0;\r
- seqIndex = 0;\r
- doSearch(true);\r
- }\r
-\r
- public void cancel_actionPerformed(ActionEvent e)\r
- {\r
- try\r
- {\r
- // if allResults is null, this effectively switches displaySearch flag in seqCanvas\r
- ap.highlightSearchResults(null);\r
- ap.idPanel.highlightSearchResults(null);\r
-\r
- // frame.setClosed(true);\r
- }\r
- catch (Exception ex)\r
- {\r
- }\r
- }\r
-\r
- public void createNewGroup_actionPerformed(ActionEvent e)\r
- {\r
- Color[] newColors = new Color[24];\r
-\r
- for (int i = 0; i < 24; i++)\r
- {\r
- newColors[i] = new Color(60, 160, 115);\r
- }\r
-\r
- jalview.schemes.UserColourScheme ucs = new jalview.schemes.UserColourScheme(\r
- newColors);\r
- String searchString = textfield.getText();\r
-\r
- searchGroup = new SuperGroup(searchString, ucs, true, true, false);\r
-\r
- for (int i = 0; i < searchResults.size(); i += 3)\r
- {\r
- // its possible edits may have occurred since search was performed\r
- // account for this here\r
- SequenceI seq = av.alignment.getSequenceAt(Integer.parseInt(\r
- searchResults.elementAt(i).toString()));\r
- int startRes = seq.findIndex(Integer.parseInt(\r
- searchResults.elementAt(i + 1).toString())) - 1;\r
- int endRes = seq.findIndex(Integer.parseInt(\r
- searchResults.elementAt(i + 2).toString())) - 1;\r
-\r
- SequenceGroup sg = new SequenceGroup(searchString, ucs, true, true,\r
- false, startRes, endRes);\r
- sg.addSequence(seq);\r
- av.alignment.addGroup(sg);\r
- searchGroup.addGroup(sg);\r
- }\r
-\r
- ap.av.alignment.addSuperGroup(searchGroup);\r
- ap.highlightSearchResults(null);\r
- }\r
-\r
- void doSearch(boolean findAll)\r
- {\r
- createNewGroup.setEnabled(false);\r
-\r
- String searchString = textfield.getText().toUpperCase();\r
-\r
- com.stevesoft.pat.Regex regex = new com.stevesoft.pat.Regex(searchString);\r
-\r
- searchResults = new Vector();\r
-\r
- int[] allResults = null;\r
-\r
- Sequence seq;\r
- String item = null;\r
- boolean found = false;\r
-\r
- ////// is the searchString a residue number?\r
- try\r
- {\r
- int res = Integer.parseInt(searchString);\r
- found = true;\r
-\r
- if (av.getSelectionGroup().getSize() > 0)\r
- {\r
- seq = (Sequence) (av.getSelectionGroup().getSequenceAt(0));\r
- }\r
- else\r
- {\r
- seq = (Sequence) av.getAlignment().getSequenceAt(0);\r
- }\r
-\r
- searchResults.add(Integer.toString(av.getAlignment().findIndex(seq)));\r
- searchResults.add(Integer.toString(seq.findIndex(res) - 1));\r
- searchResults.add(Integer.toString(seq.findIndex(res) - 1));\r
- }\r
- catch (NumberFormatException ex)\r
- {\r
- }\r
-\r
- ///////////////////////////////////////////////\r
- Color[] newColors = new Color[24];\r
-\r
- for (int i = 0; i < 24; i++)\r
- {\r
- newColors[i] = new Color(60, 160, 115);\r
- }\r
-\r
- jalview.schemes.UserColourScheme ucs = new jalview.schemes.UserColourScheme(\r
- newColors);\r
-\r
- searchGroup = new SuperGroup(searchString, ucs, true, true, false);\r
-\r
- int end = av.alignment.getHeight();\r
-\r
- SequenceGroup selection = av.getSelectionGroup();\r
-\r
- if (selection != null)\r
- {\r
- if ( (selection.getSize() < 1) ||\r
- ( (selection.getEndRes() - selection.getStartRes()) < 2))\r
- {\r
- selection = null;\r
- }\r
- }\r
-\r
- while (!found && (seqIndex < end))\r
- {\r
- seq = (Sequence) av.alignment.getSequenceAt(seqIndex);\r
-\r
- if ( (selection != null) && !selection.sequences.contains(seq))\r
- {\r
- seqIndex++;\r
- resIndex = 0;\r
-\r
- continue;\r
- }\r
-\r
- item = seq.getSequence().toUpperCase();\r
-\r
- if ( (selection != null) &&\r
- (selection.getEndRes() < av.alignment.getWidth()))\r
- {\r
- item = item.substring(0, selection.getEndRes() + 1);\r
- }\r
-\r
- ///Shall we ignore gaps????\r
- StringBuffer noGaps = new StringBuffer();\r
- int insertCount = 0;\r
- Vector spaces = new Vector();\r
-\r
- for (int j = 0; j < item.length(); j++)\r
- {\r
- if (!jalview.util.Comparison.isGap(item.charAt(j)))\r
- {\r
- noGaps.append(item.charAt(j));\r
- spaces.add(new Integer(insertCount));\r
- }\r
- else\r
- {\r
- insertCount++;\r
- }\r
- }\r
-\r
- for (int r = resIndex; r < noGaps.length(); r++)\r
- {\r
- if (regex.searchFrom(noGaps.toString(), r))\r
- {\r
- resIndex = regex.matchedFrom();\r
-\r
- if ( (selection != null) &&\r
- ( (resIndex +\r
- Integer.parseInt(spaces.get(resIndex).toString())) <\r
- selection.getStartRes()))\r
- {\r
- continue;\r
- }\r
-\r
- searchResults.add(Integer.toString(seqIndex));\r
-\r
- int sres = seq.findPosition(resIndex +\r
- Integer.parseInt(spaces.elementAt(\r
- resIndex)\r
- .toString()));\r
- int eres = seq.findPosition(regex.matchedTo() - 1 +\r
- Integer.parseInt(spaces.elementAt(regex.\r
- matchedTo() -\r
- 1).toString()));\r
-\r
- searchResults.addElement(sres + "");\r
- searchResults.addElement(eres + "");\r
-\r
- if (!findAll)\r
- {\r
- // thats enough, break and display the result\r
- found = true;\r
- resIndex++;\r
-\r
- break;\r
- }\r
-\r
- r = resIndex;\r
- }\r
- }\r
-\r
- if (!found)\r
- {\r
- seqIndex++;\r
- resIndex = 0;\r
- }\r
- }\r
-\r
- Vector idMatch = new Vector();\r
-\r
- for (int id = 0; id < av.alignment.getHeight(); id++)\r
- {\r
- if (regex.search(av.alignment.getSequenceAt(id).getName()))\r
- {\r
- idMatch.add(av.alignment.getSequenceAt(id));\r
- }\r
- }\r
-\r
- if ( (searchResults.size() == 0) && (idMatch.size() > 0))\r
- {\r
- ap.idPanel.highlightSearchResults(idMatch);\r
- }\r
-\r
- if (searchResults.size() > 0)\r
- {\r
- allResults = new int[searchResults.size()];\r
-\r
- for (int i = 0; i < searchResults.size(); i++)\r
- {\r
- allResults[i] = Integer.parseInt(searchResults.get(i).toString());\r
- }\r
-\r
- createNewGroup.setEnabled(true);\r
- }\r
- else\r
- {\r
- JOptionPane.showInternalMessageDialog(this, "Finished searching",\r
- null,\r
- JOptionPane.INFORMATION_MESSAGE);\r
- resIndex = 0;\r
- seqIndex = 0;\r
- }\r
-\r
- // if allResults is null, this effectively switches displaySearch flag in seqCanvas\r
- ap.highlightSearchResults(allResults);\r
-\r
- if (findAll)\r
- {\r
- String message = (searchResults.size() / 3) + " matches found.";\r
- JOptionPane.showInternalMessageDialog(this, message, null,\r
- JOptionPane.INFORMATION_MESSAGE);\r
- }\r
- }\r
-}\r
+/*
+ * 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.SearchResults;
+import jalview.datamodel.SequenceFeature;
+import jalview.datamodel.SequenceI;
+import jalview.jbgui.GFinder;
+import jalview.util.MessageManager;
+import jalview.viewmodel.AlignmentViewport;
+
+import java.awt.event.ActionEvent;
+import java.awt.event.KeyEvent;
+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.JOptionPane;
+import javax.swing.KeyStroke;
+
+/**
+ * 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 HEIGHT = 110;
+
+ private static final int WIDTH = 340;
+
+ AlignmentViewport av;
+
+ AlignmentPanel ap;
+
+ JInternalFrame frame;
+
+ int seqIndex = 0;
+
+ int resIndex = -1;
+
+ SearchResults 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);
+ addEscapeHandler();
+ Desktop.addInternalFrame(frame, MessageManager.getString("label.find"),
+ WIDTH, HEIGHT);
+
+ textfield.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()
+ {
+ public void actionPerformed(ActionEvent e)
+ {
+ escapeActionPerformed();
+ }
+ });
+ }
+
+ /**
+ * Close the panel on Escape key press
+ */
+ protected void escapeActionPerformed()
+ {
+ setVisible(false);
+ frame.dispose();
+ }
+
+ /**
+ * Performs the 'Find Next' action.
+ *
+ * @param e
+ */
+ public void findNext_actionPerformed(ActionEvent e)
+ {
+ if (getFocusedViewport())
+ {
+ doSearch(false);
+ }
+ }
+
+ /**
+ * Performs the 'Find All' action.
+ *
+ * @param e
+ */
+ 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 frame = frames[f];
+ if (frame != null && frame instanceof AlignFrame)
+ {
+ av = ((AlignFrame) frame).viewport;
+ ap = ((AlignFrame) frame).alignPanel;
+ return true;
+ }
+ }
+ return false;
+ }
+
+ /**
+ * DOCUMENT ME!
+ *
+ * @param e
+ * DOCUMENT ME!
+ */
+ public void createNewGroup_actionPerformed(ActionEvent e)
+ {
+ SequenceI[] seqs = new SequenceI[searchResults.getSize()];
+ SequenceFeature[] features = new SequenceFeature[searchResults
+ .getSize()];
+
+ for (int i = 0; i < searchResults.getSize(); i++)
+ {
+ seqs[i] = searchResults.getResultSequence(i).getDatasetSequence();
+
+ features[i] = new SequenceFeature(textfield.getText().trim(),
+ "Search Results", null, searchResults.getResultStart(i),
+ searchResults.getResultEnd(i), "Search Results");
+ }
+
+ if (ap.getSeqPanel().seqCanvas.getFeatureRenderer().amendFeatures(seqs,
+ features, true, ap))
+ {
+ 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 findAll
+ */
+ void doSearch(boolean findAll)
+ {
+ createNewGroup.setEnabled(false);
+
+ String searchString = textfield.getText().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(findAll);
+
+ finder.find(searchString); // returns true if anything was actually found
+
+ seqIndex = finder.getSeqIndex();
+ resIndex = finder.getResIndex();
+
+ searchResults = finder.getSearchResults(); // find(regex,
+ // caseSensitive.isSelected(), )
+ Vector 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;
+ createNewGroup.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)
+ {
+ JOptionPane.showInternalMessageDialog(this,
+ MessageManager.getString("label.finished_searching"), null,
+ JOptionPane.INFORMATION_MESSAGE);
+ resIndex = -1;
+ seqIndex = 0;
+ }
+ else
+ {
+ if (findAll)
+ {
+ // 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.";
+ }
+ JOptionPane.showInternalMessageDialog(this, message, null,
+ JOptionPane.INFORMATION_MESSAGE);
+ resIndex = -1;
+ seqIndex = 0;
+ }
+ }
+
+ }
+
+ /**
+ * 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;
+ }
+ JOptionPane.showInternalMessageDialog(this, error,
+ MessageManager.getString("label.invalid_search"), // $NON-NLS-1$
+ JOptionPane.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;
+ }
+}
git://source.jalview.org / jalview.git / blobdiff