src/jalview/gui/Finder.java

   1 /*\r
   2  * Jalview - A Sequence Alignment Editor and Viewer\r
   3  * Copyright (C) 2006 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
   4  *\r
   5  * This program is free software; you can redistribute it and/or\r
   6  * modify it under the terms of the GNU General Public License\r
   7  * as published by the Free Software Foundation; either version 2\r
   8  * of the License, or (at your option) any later version.\r
   9  *\r
  10  * This program is distributed in the hope that it will be useful,\r
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  13  * GNU General Public License for more details.\r
  14  *\r
  15  * You should have received a copy of the GNU General Public License\r
  16  * along with this program; if not, write to the Free Software\r
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
  18  */\r
  19 package jalview.gui;\r
  20 \r
  21 import jalview.datamodel.*;\r
  22 \r
  23 import jalview.jbgui.*;\r
  24 \r
  25 import java.awt.*;\r
  26 import java.awt.event.*;\r
  27 \r
  28 import java.util.*;\r
  29 \r
  30 import javax.swing.*;\r
  31 import javax.swing.event.*;\r
  32 \r
  33 \r
  34 /**\r
  35  * DOCUMENT ME!\r
  36  *\r
  37  * @author $author$\r
  38  * @version $Revision$\r
  39  */\r
  40 public class Finder extends GFinder\r
  41 {\r
  42     AlignViewport av;\r
  43     AlignmentPanel ap;\r
  44     JInternalFrame frame;\r
  45     int seqIndex = 0;\r
  46     int resIndex = 0;\r
  47 \r
  48     SearchResults searchResults;\r
  49 \r
  50     /**\r
  51      * Creates a new Finder object.\r
  52      *\r
  53      * @param av DOCUMENT ME!\r
  54      * @param ap DOCUMENT ME!\r
  55      * @param f DOCUMENT ME!\r
  56      */\r
  57     public Finder(AlignViewport av, AlignmentPanel ap, JInternalFrame f)\r
  58     {\r
  59         this.av = av;\r
  60         this.ap = ap;\r
  61         frame = f;\r
  62 \r
  63         // all a big pain, but we need to wait until the frame is visible before the textfield can\r
  64         // obtain the focus/////////////////////////\r
  65         frame.addInternalFrameListener(new InternalFrameAdapter()\r
  66             {\r
  67                 public void internalFrameOpened(InternalFrameEvent evt)\r
  68                 {\r
  69                     SwingUtilities.invokeLater(new Runnable()\r
  70                         {\r
  71                             public void run()\r
  72                             {\r
  73                                 textfield.requestFocus();\r
  74                             }\r
  75                         });\r
  76                 }\r
  77             });\r
  78     }\r
  79 \r
  80 \r
  81     /**\r
  82      * DOCUMENT ME!\r
  83      *\r
  84      * @param e DOCUMENT ME!\r
  85      */\r
  86     public void findNext_actionPerformed(ActionEvent e)\r
  87     {\r
  88         doSearch(false);\r
  89     }\r
  90 \r
  91     /**\r
  92      * DOCUMENT ME!\r
  93      *\r
  94      * @param e DOCUMENT ME!\r
  95      */\r
  96     public void findAll_actionPerformed(ActionEvent e)\r
  97     {\r
  98         resIndex = 0;\r
  99         seqIndex = 0;\r
 100         doSearch(true);\r
 101     }\r
 102 \r
 103 \r
 104     /**\r
 105      * DOCUMENT ME!\r
 106      *\r
 107      * @param e DOCUMENT ME!\r
 108      */\r
 109     public void createNewGroup_actionPerformed(ActionEvent e)\r
 110     {\r
 111         JLabel label = new JLabel("Enter name of new sequence feature");\r
 112         JTextField textinput = new JTextField(textfield.getText());\r
 113         JPanel panel = new JPanel(new BorderLayout());\r
 114         panel.add(label, BorderLayout.NORTH);\r
 115         panel.add(textinput, BorderLayout.SOUTH);\r
 116 \r
 117 \r
 118         SequenceI [] seqs = new SequenceI[searchResults.getSize()];\r
 119         SequenceFeature [] features = new SequenceFeature[searchResults.getSize()];\r
 120 \r
 121 \r
 122         for (int i = 0; i < searchResults.getSize(); i ++ )\r
 123         {\r
 124             seqs[i] = searchResults.getResultSequence(i).getDatasetSequence();\r
 125 \r
 126             features[i] = new SequenceFeature(textinput.getText(),\r
 127                 "Search Results", null,\r
 128                 searchResults.getResultStart(i),\r
 129                 searchResults.getResultEnd(i),\r
 130                "Search Results");\r
 131         }\r
 132 \r
 133         if( ap.seqPanel.seqCanvas.getFeatureRenderer()\r
 134             .createNewFeatures(seqs, features))\r
 135         {\r
 136           ap.alignFrame.showSeqFeatures.setSelected(true);\r
 137           av.setShowSequenceFeatures(true);\r
 138           ap.highlightSearchResults(null);\r
 139         }\r
 140     }\r
 141 \r
 142     /**\r
 143      * DOCUMENT ME!\r
 144      *\r
 145      * @param findAll DOCUMENT ME!\r
 146      */\r
 147     void doSearch(boolean findAll)\r
 148     {\r
 149         createNewGroup.setEnabled(false);\r
 150 \r
 151         String searchString = textfield.getText().trim();\r
 152         if(!caseSensitive.isSelected())\r
 153           searchString = searchString.toUpperCase();\r
 154 \r
 155         if(searchString.length()<1)\r
 156           return;\r
 157 \r
 158         com.stevesoft.pat.Regex regex = new com.stevesoft.pat.Regex(searchString);\r
 159 \r
 160         searchResults = new SearchResults();\r
 161 \r
 162         Sequence seq;\r
 163         String item = null;\r
 164         boolean found = false;\r
 165 \r
 166         ////// is the searchString a residue number?\r
 167         try\r
 168         {\r
 169             int res = Integer.parseInt(searchString);\r
 170             found = true;\r
 171             if (av.getSelectionGroup() == null || av.getSelectionGroup().getSize(false) < 1)\r
 172             {\r
 173               seq = (Sequence) av.getAlignment().getSequenceAt(0);\r
 174             }\r
 175             else\r
 176             {\r
 177               seq = (Sequence) (av.getSelectionGroup().getSequenceAt(0));\r
 178             }\r
 179 \r
 180             searchResults.addResult(seq, res, res);\r
 181         }\r
 182         catch (NumberFormatException ex)\r
 183         {\r
 184         }\r
 185 \r
 186         ///////////////////////////////////////////////\r
 187 \r
 188         int end = av.alignment.getHeight();\r
 189 \r
 190         SequenceGroup selection = av.getSelectionGroup();\r
 191 \r
 192         if (selection != null)\r
 193         {\r
 194             if ((selection.getSize(false) < 1) ||\r
 195                     ((selection.getEndRes() - selection.getStartRes()) < 2))\r
 196             {\r
 197                 selection = null;\r
 198             }\r
 199         }\r
 200 \r
 201         while (!found && (seqIndex < end))\r
 202         {\r
 203             seq = (Sequence) av.alignment.getSequenceAt(seqIndex);\r
 204 \r
 205             if ((selection != null) && !selection.getSequences(false).contains(seq))\r
 206             {\r
 207                 seqIndex++;\r
 208                 resIndex = 0;\r
 209 \r
 210                 continue;\r
 211             }\r
 212 \r
 213             item = seq.getSequence();\r
 214             if(!caseSensitive.isSelected())\r
 215               item = item.toUpperCase();\r
 216 \r
 217             if ((selection != null) &&\r
 218                     (selection.getEndRes() < av.alignment.getWidth()-1))\r
 219             {\r
 220                 item = item.substring(0, selection.getEndRes() + 1);\r
 221             }\r
 222 \r
 223             ///Shall we ignore gaps????\r
 224             StringBuffer noGapsSB = new StringBuffer();\r
 225             int insertCount = 0;\r
 226             Vector spaces = new Vector();\r
 227 \r
 228             for (int j = 0; j < item.length(); j++)\r
 229             {\r
 230                 if (!jalview.util.Comparison.isGap(item.charAt(j)))\r
 231                 {\r
 232                     noGapsSB.append(item.charAt(j));\r
 233                     spaces.add(new Integer(insertCount));\r
 234                 }\r
 235                 else\r
 236                 {\r
 237                     insertCount++;\r
 238                 }\r
 239             }\r
 240 \r
 241             String noGaps = noGapsSB.toString();\r
 242 \r
 243             for (int r = resIndex; r < noGaps.length(); r++)\r
 244             {\r
 245 \r
 246                 if (regex.searchFrom(noGaps, r))\r
 247                 {\r
 248                     resIndex = regex.matchedFrom();\r
 249 \r
 250                     if ((selection != null) &&\r
 251                             ((resIndex +\r
 252                             Integer.parseInt(spaces.get(resIndex).toString())) < selection.getStartRes()))\r
 253                     {\r
 254                         continue;\r
 255                     }\r
 256 \r
 257 \r
 258                     int sres = seq.findPosition(resIndex +\r
 259                             Integer.parseInt(spaces.elementAt(resIndex)\r
 260                                                    .toString()));\r
 261                     int eres = seq.findPosition(regex.matchedTo() - 1 +\r
 262                             Integer.parseInt(spaces.elementAt(regex.matchedTo() -\r
 263                                     1).toString()));\r
 264 \r
 265                     searchResults.addResult(seq, sres, eres);\r
 266 \r
 267                     if (!findAll)\r
 268                     {\r
 269                         // thats enough, break and display the result\r
 270                         found = true;\r
 271                         resIndex++;\r
 272 \r
 273                         break;\r
 274                     }\r
 275 \r
 276                     r = resIndex;\r
 277                 }\r
 278                 else\r
 279                 {\r
 280                   break;\r
 281                 }\r
 282             }\r
 283 \r
 284             if (!found)\r
 285             {\r
 286                 seqIndex++;\r
 287                 resIndex = 0;\r
 288             }\r
 289         }\r
 290 \r
 291         Vector idMatch = new Vector();\r
 292 \r
 293         for (int id = 0; id < av.alignment.getHeight(); id++)\r
 294         {\r
 295             if (regex.search(av.alignment.getSequenceAt(id).getName()))\r
 296             {\r
 297                 idMatch.add(av.alignment.getSequenceAt(id));\r
 298             }\r
 299         }\r
 300 \r
 301         if ((searchResults.getSize() == 0) && (idMatch.size() > 0))\r
 302         {\r
 303             ap.idPanel.highlightSearchResults(idMatch);\r
 304         }\r
 305 \r
 306 \r
 307         int resultSize = searchResults.getSize();\r
 308 \r
 309         if (searchResults.getSize() > 0)\r
 310           createNewGroup.setEnabled(true);\r
 311         else\r
 312           searchResults = null;\r
 313 \r
 314         // if allResults is null, this effectively switches displaySearch flag in seqCanvas\r
 315         ap.highlightSearchResults(searchResults);\r
 316 \r
 317         if(!findAll && resultSize==0)\r
 318         {\r
 319             JOptionPane.showInternalMessageDialog(this, "Finished searching",\r
 320                 null, JOptionPane.INFORMATION_MESSAGE);\r
 321             resIndex = 0;\r
 322             seqIndex = 0;\r
 323         }\r
 324 \r
 325         if (findAll)\r
 326         {\r
 327           String message = resultSize + " matches found.";\r
 328           JOptionPane.showInternalMessageDialog(this, message, null,\r
 329                                                 JOptionPane.INFORMATION_MESSAGE);\r
 330         }\r
 331 \r
 332     }\r
 333 }\r