src/jalview/gui/Finder.java

   1 /*\r
   2  * Jalview - A Sequence Alignment Editor and Viewer\r
   3  * Copyright (C) 2005 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     SuperGroup searchGroup;\r
  46     Vector searchResults;\r
  47     int seqIndex = 0;\r
  48     int resIndex = 0;\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                  * DOCUMENT ME!\r
  80                  *\r
  81                  * @param evt DOCUMENT ME!\r
  82                  */\r
  83                 public void internalFrameClosing(InternalFrameEvent evt)\r
  84                 {\r
  85                     cancel_actionPerformed(null);\r
  86                 }\r
  87             });\r
  88     }\r
  89 \r
  90 \r
  91     /**\r
  92      * DOCUMENT ME!\r
  93      *\r
  94      * @param e DOCUMENT ME!\r
  95      */\r
  96     public void findNext_actionPerformed(ActionEvent e)\r
  97     {\r
  98         doSearch(false);\r
  99     }\r
 100 \r
 101     /**\r
 102      * DOCUMENT ME!\r
 103      *\r
 104      * @param e DOCUMENT ME!\r
 105      */\r
 106     public void findAll_actionPerformed(ActionEvent e)\r
 107     {\r
 108         resIndex = 0;\r
 109         seqIndex = 0;\r
 110         doSearch(true);\r
 111     }\r
 112 \r
 113     /**\r
 114      * DOCUMENT ME!\r
 115      *\r
 116      * @param e DOCUMENT ME!\r
 117      */\r
 118     public void cancel_actionPerformed(ActionEvent e)\r
 119     {\r
 120         try\r
 121         {\r
 122             // if allResults is null, this effectively switches displaySearch flag in seqCanvas\r
 123             ap.highlightSearchResults(null);\r
 124             ap.idPanel.highlightSearchResults(null);\r
 125 \r
 126             // frame.setClosed(true);\r
 127         }\r
 128         catch (Exception ex)\r
 129         {\r
 130         }\r
 131     }\r
 132 \r
 133     /**\r
 134      * DOCUMENT ME!\r
 135      *\r
 136      * @param e DOCUMENT ME!\r
 137      */\r
 138     public void createNewGroup_actionPerformed(ActionEvent e)\r
 139     {\r
 140         Color[] newColors = new Color[24];\r
 141 \r
 142         for (int i = 0; i < 24; i++)\r
 143         {\r
 144             newColors[i] = new Color(60, 160, 115);\r
 145         }\r
 146 \r
 147         jalview.schemes.UserColourScheme ucs = new jalview.schemes.UserColourScheme(newColors);\r
 148         String searchString = textfield.getText();\r
 149 \r
 150         searchGroup = new SuperGroup(searchString, ucs, true, true, false);\r
 151 \r
 152         for (int i = 0; i < searchResults.size(); i += 3)\r
 153         {\r
 154             // its possible edits may have occurred since search was performed\r
 155             // account for this here\r
 156             SequenceI seq = av.alignment.getSequenceAt(Integer.parseInt(\r
 157                         searchResults.elementAt(i).toString()));\r
 158             int startRes = seq.findIndex(Integer.parseInt(\r
 159                         searchResults.elementAt(i + 1).toString())) - 1;\r
 160             int endRes = seq.findIndex(Integer.parseInt(\r
 161                         searchResults.elementAt(i + 2).toString())) - 1;\r
 162 \r
 163             SequenceGroup sg = new SequenceGroup(searchString, ucs, true, true,\r
 164                     false, startRes, endRes);\r
 165             sg.addSequence(seq, false);\r
 166             av.alignment.addGroup(sg);\r
 167             searchGroup.addGroup(sg);\r
 168         }\r
 169 \r
 170         ap.av.alignment.addSuperGroup(searchGroup);\r
 171         ap.highlightSearchResults(null);\r
 172     }\r
 173 \r
 174     /**\r
 175      * DOCUMENT ME!\r
 176      *\r
 177      * @param findAll DOCUMENT ME!\r
 178      */\r
 179     void doSearch(boolean findAll)\r
 180     {\r
 181         createNewGroup.setEnabled(false);\r
 182 \r
 183         String searchString = textfield.getText().toUpperCase().trim();\r
 184         if(searchString.length()<1)\r
 185           return;\r
 186 \r
 187         com.stevesoft.pat.Regex regex = new com.stevesoft.pat.Regex(searchString);\r
 188 \r
 189         searchResults = new Vector();\r
 190 \r
 191         int[] allResults = null;\r
 192 \r
 193         Sequence seq;\r
 194         String item = null;\r
 195         boolean found = false;\r
 196 \r
 197         ////// is the searchString a residue number?\r
 198         try\r
 199         {\r
 200             int res = Integer.parseInt(searchString);\r
 201             found = true;\r
 202             if (av.getSelectionGroup() == null || av.getSelectionGroup().getSize() < 1)\r
 203             {\r
 204               seq = (Sequence) av.getAlignment().getSequenceAt(0);\r
 205             }\r
 206             else\r
 207             {\r
 208               seq = (Sequence) (av.getSelectionGroup().getSequenceAt(0));\r
 209             }\r
 210 \r
 211             searchResults.add(Integer.toString(av.getAlignment().findIndex(seq)));\r
 212             searchResults.add(res+"");\r
 213             searchResults.add(res+"");\r
 214         }\r
 215         catch (NumberFormatException ex)\r
 216         {\r
 217         }\r
 218 \r
 219         ///////////////////////////////////////////////\r
 220         Color[] newColors = new Color[24];\r
 221 \r
 222         for (int i = 0; i < 24; i++)\r
 223         {\r
 224             newColors[i] = new Color(60, 160, 115);\r
 225         }\r
 226 \r
 227         jalview.schemes.UserColourScheme ucs = new jalview.schemes.UserColourScheme(newColors);\r
 228 \r
 229         searchGroup = new SuperGroup(searchString, ucs, true, true, false);\r
 230 \r
 231         int end = av.alignment.getHeight();\r
 232 \r
 233         SequenceGroup selection = av.getSelectionGroup();\r
 234 \r
 235         if (selection != null)\r
 236         {\r
 237             if ((selection.getSize() < 1) ||\r
 238                     ((selection.getEndRes() - selection.getStartRes()) < 2))\r
 239             {\r
 240                 selection = null;\r
 241             }\r
 242         }\r
 243 \r
 244         while (!found && (seqIndex < end))\r
 245         {\r
 246             seq = (Sequence) av.alignment.getSequenceAt(seqIndex);\r
 247 \r
 248             if ((selection != null) && !selection.sequences.contains(seq))\r
 249             {\r
 250                 seqIndex++;\r
 251                 resIndex = 0;\r
 252 \r
 253                 continue;\r
 254             }\r
 255 \r
 256             item = seq.getSequence().toUpperCase();\r
 257 \r
 258             if ((selection != null) &&\r
 259                     (selection.getEndRes() < av.alignment.getWidth()))\r
 260             {\r
 261                 item = item.substring(0, selection.getEndRes() + 1);\r
 262             }\r
 263 \r
 264             ///Shall we ignore gaps????\r
 265             StringBuffer noGapsSB = new StringBuffer();\r
 266             int insertCount = 0;\r
 267             Vector spaces = new Vector();\r
 268 \r
 269             for (int j = 0; j < item.length(); j++)\r
 270             {\r
 271                 if (!jalview.util.Comparison.isGap(item.charAt(j)))\r
 272                 {\r
 273                     noGapsSB.append(item.charAt(j));\r
 274                     spaces.add(new Integer(insertCount));\r
 275                 }\r
 276                 else\r
 277                 {\r
 278                     insertCount++;\r
 279                 }\r
 280             }\r
 281 \r
 282             String noGaps = noGapsSB.toString();\r
 283 \r
 284             for (int r = resIndex; r < noGaps.length(); r++)\r
 285             {\r
 286 \r
 287                 if (regex.searchFrom(noGaps, r))\r
 288                 {\r
 289                     resIndex = regex.matchedFrom();\r
 290 \r
 291                     if ((selection != null) &&\r
 292                             ((resIndex +\r
 293                             Integer.parseInt(spaces.get(resIndex).toString())) < selection.getStartRes()))\r
 294                     {\r
 295                         continue;\r
 296                     }\r
 297 \r
 298                     searchResults.add(Integer.toString(seqIndex));\r
 299 \r
 300                     int sres = seq.findPosition(resIndex +\r
 301                             Integer.parseInt(spaces.elementAt(resIndex)\r
 302                                                    .toString()));\r
 303                     int eres = seq.findPosition(regex.matchedTo() - 1 +\r
 304                             Integer.parseInt(spaces.elementAt(regex.matchedTo() -\r
 305                                     1).toString()));\r
 306 \r
 307                     searchResults.addElement(sres + "");\r
 308                     searchResults.addElement(eres + "");\r
 309 \r
 310                     if (!findAll)\r
 311                     {\r
 312                         // thats enough, break and display the result\r
 313                         found = true;\r
 314                         resIndex++;\r
 315 \r
 316                         break;\r
 317                     }\r
 318 \r
 319                     r = resIndex;\r
 320                 }\r
 321                 else\r
 322                 {\r
 323                   break;\r
 324                 }\r
 325             }\r
 326 \r
 327             if (!found)\r
 328             {\r
 329                 seqIndex++;\r
 330                 resIndex = 0;\r
 331             }\r
 332         }\r
 333 \r
 334         Vector idMatch = new Vector();\r
 335 \r
 336         for (int id = 0; id < av.alignment.getHeight(); id++)\r
 337         {\r
 338             if (regex.search(av.alignment.getSequenceAt(id).getName()))\r
 339             {\r
 340                 idMatch.add(av.alignment.getSequenceAt(id));\r
 341             }\r
 342         }\r
 343 \r
 344         if ((searchResults.size() == 0) && (idMatch.size() > 0))\r
 345         {\r
 346             ap.idPanel.highlightSearchResults(idMatch);\r
 347         }\r
 348 \r
 349         if (searchResults.size() > 0)\r
 350         {\r
 351             allResults = new int[searchResults.size()];\r
 352 \r
 353             for (int i = 0; i < searchResults.size(); i++)\r
 354             {\r
 355                 allResults[i] = Integer.parseInt(searchResults.get(i).toString());\r
 356             }\r
 357 \r
 358             createNewGroup.setEnabled(true);\r
 359         }\r
 360         else\r
 361         {\r
 362             JOptionPane.showInternalMessageDialog(this, "Finished searching",\r
 363                 null, JOptionPane.INFORMATION_MESSAGE);\r
 364             resIndex = 0;\r
 365             seqIndex = 0;\r
 366         }\r
 367 \r
 368         // if allResults is null, this effectively switches displaySearch flag in seqCanvas\r
 369         ap.highlightSearchResults(allResults);\r
 370 \r
 371         if (findAll)\r
 372         {\r
 373             String message = (searchResults.size() / 3) + " matches found.";\r
 374             JOptionPane.showInternalMessageDialog(this, message, null,\r
 375                 JOptionPane.INFORMATION_MESSAGE);\r
 376         }\r
 377     }\r
 378 }\r