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()\r
  58     {\r
  59       frame = new JInternalFrame();\r
  60       frame.setContentPane(this);\r
  61       frame.setLayer(JLayeredPane.PALETTE_LAYER);\r
  62       Desktop.addInternalFrame(frame, "Find", 340, 110);\r
  63 \r
  64 \r
  65         // all a big pain, but we need to wait until the frame is visible before the textfield can\r
  66         // obtain the focus/////////////////////////\r
  67         frame.addInternalFrameListener(new InternalFrameAdapter()\r
  68             {\r
  69                 public void internalFrameOpened(InternalFrameEvent evt)\r
  70                 {\r
  71                     SwingUtilities.invokeLater(new Runnable()\r
  72                         {\r
  73                             public void run()\r
  74                             {\r
  75                                 textfield.requestFocus();\r
  76                             }\r
  77                         });\r
  78                 }\r
  79             });\r
  80     }\r
  81 \r
  82 \r
  83     /**\r
  84      * DOCUMENT ME!\r
  85      *\r
  86      * @param e DOCUMENT ME!\r
  87      */\r
  88     public void findNext_actionPerformed(ActionEvent e)\r
  89     {\r
  90       if (getFocusedViewport())\r
  91         doSearch(false);\r
  92     }\r
  93 \r
  94     /**\r
  95      * DOCUMENT ME!\r
  96      *\r
  97      * @param e DOCUMENT ME!\r
  98      */\r
  99     public void findAll_actionPerformed(ActionEvent e)\r
 100     {\r
 101       if(getFocusedViewport())\r
 102       {\r
 103         resIndex = 0;\r
 104         seqIndex = 0;\r
 105         doSearch(true);\r
 106       }\r
 107     }\r
 108 \r
 109     boolean getFocusedViewport()\r
 110     {\r
 111       JInternalFrame frame = Desktop.desktop.getAllFrames()[1];\r
 112 \r
 113       if(frame!=null && frame instanceof AlignFrame)\r
 114       {\r
 115         av = ((AlignFrame)frame).viewport;\r
 116         ap = ((AlignFrame)frame).alignPanel;\r
 117         return true;\r
 118       }\r
 119       return false;\r
 120     }\r
 121 \r
 122 \r
 123     /**\r
 124      * DOCUMENT ME!\r
 125      *\r
 126      * @param e DOCUMENT ME!\r
 127      */\r
 128     public void createNewGroup_actionPerformed(ActionEvent e)\r
 129     {\r
 130         JLabel label = new JLabel("Enter name of new sequence feature");\r
 131         JTextField textinput = new JTextField(textfield.getText());\r
 132         JPanel panel = new JPanel(new BorderLayout());\r
 133         panel.add(label, BorderLayout.NORTH);\r
 134         panel.add(textinput, BorderLayout.SOUTH);\r
 135 \r
 136 \r
 137         SequenceI [] seqs = new SequenceI[searchResults.getSize()];\r
 138         SequenceFeature [] features = new SequenceFeature[searchResults.getSize()];\r
 139 \r
 140 \r
 141         for (int i = 0; i < searchResults.getSize(); i ++ )\r
 142         {\r
 143             seqs[i] = searchResults.getResultSequence(i).getDatasetSequence();\r
 144 \r
 145             features[i] = new SequenceFeature(textinput.getText(),\r
 146                 "Search Results", null,\r
 147                 searchResults.getResultStart(i),\r
 148                 searchResults.getResultEnd(i),\r
 149                "Search Results");\r
 150         }\r
 151 \r
 152         if( ap.seqPanel.seqCanvas.getFeatureRenderer()\r
 153             .createNewFeatures(seqs, features))\r
 154         {\r
 155           ap.alignFrame.showSeqFeatures.setSelected(true);\r
 156           av.setShowSequenceFeatures(true);\r
 157           ap.highlightSearchResults(null);\r
 158         }\r
 159     }\r
 160 \r
 161     /**\r
 162      * DOCUMENT ME!\r
 163      *\r
 164      * @param findAll DOCUMENT ME!\r
 165      */\r
 166     void doSearch(boolean findAll)\r
 167     {\r
 168         createNewGroup.setEnabled(false);\r
 169 \r
 170         String searchString = textfield.getText().trim();\r
 171         if(!caseSensitive.isSelected())\r
 172           searchString = searchString.toUpperCase();\r
 173 \r
 174         if(searchString.length()<1)\r
 175           return;\r
 176 \r
 177         com.stevesoft.pat.Regex regex = new com.stevesoft.pat.Regex(searchString);\r
 178 \r
 179         searchResults = new SearchResults();\r
 180 \r
 181         Sequence seq;\r
 182         String item = null;\r
 183         boolean found = false;\r
 184 \r
 185         ////// is the searchString a residue number?\r
 186         try\r
 187         {\r
 188             int res = Integer.parseInt(searchString);\r
 189             found = true;\r
 190             if (av.getSelectionGroup() == null || av.getSelectionGroup().getSize(false) < 1)\r
 191             {\r
 192               seq = (Sequence) av.getAlignment().getSequenceAt(0);\r
 193             }\r
 194             else\r
 195             {\r
 196               seq = (Sequence) (av.getSelectionGroup().getSequenceAt(0));\r
 197             }\r
 198 \r
 199             searchResults.addResult(seq, res, res);\r
 200         }\r
 201         catch (NumberFormatException ex)\r
 202         {\r
 203         }\r
 204 \r
 205         ///////////////////////////////////////////////\r
 206 \r
 207         int end = av.alignment.getHeight();\r
 208 \r
 209         SequenceGroup selection = av.getSelectionGroup();\r
 210 \r
 211         if (selection != null)\r
 212         {\r
 213             if ((selection.getSize(false) < 1) ||\r
 214                     ((selection.getEndRes() - selection.getStartRes()) < 2))\r
 215             {\r
 216                 selection = null;\r
 217             }\r
 218         }\r
 219 \r
 220         while (!found && (seqIndex < end))\r
 221         {\r
 222             seq = (Sequence) av.alignment.getSequenceAt(seqIndex);\r
 223 \r
 224             if ((selection != null) && !selection.getSequences(false).contains(seq))\r
 225             {\r
 226                 seqIndex++;\r
 227                 resIndex = 0;\r
 228 \r
 229                 continue;\r
 230             }\r
 231 \r
 232             item = seq.getSequence();\r
 233             if(!caseSensitive.isSelected())\r
 234               item = item.toUpperCase();\r
 235 \r
 236             if ((selection != null) &&\r
 237                     (selection.getEndRes() < av.alignment.getWidth()-1))\r
 238             {\r
 239                 item = item.substring(0, selection.getEndRes() + 1);\r
 240             }\r
 241 \r
 242             ///Shall we ignore gaps????\r
 243             StringBuffer noGapsSB = new StringBuffer();\r
 244             int insertCount = 0;\r
 245             Vector spaces = new Vector();\r
 246 \r
 247             for (int j = 0; j < item.length(); j++)\r
 248             {\r
 249                 if (!jalview.util.Comparison.isGap(item.charAt(j)))\r
 250                 {\r
 251                     noGapsSB.append(item.charAt(j));\r
 252                     spaces.add(new Integer(insertCount));\r
 253                 }\r
 254                 else\r
 255                 {\r
 256                     insertCount++;\r
 257                 }\r
 258             }\r
 259 \r
 260             String noGaps = noGapsSB.toString();\r
 261 \r
 262             for (int r = resIndex; r < noGaps.length(); r++)\r
 263             {\r
 264 \r
 265                 if (regex.searchFrom(noGaps, r))\r
 266                 {\r
 267                     resIndex = regex.matchedFrom();\r
 268 \r
 269                     if ((selection != null) &&\r
 270                             ((resIndex +\r
 271                             Integer.parseInt(spaces.get(resIndex).toString())) < selection.getStartRes()))\r
 272                     {\r
 273                         continue;\r
 274                     }\r
 275 \r
 276 \r
 277                     int sres = seq.findPosition(resIndex +\r
 278                             Integer.parseInt(spaces.elementAt(resIndex)\r
 279                                                    .toString()));\r
 280                     int eres = seq.findPosition(regex.matchedTo() - 1 +\r
 281                             Integer.parseInt(spaces.elementAt(regex.matchedTo() -\r
 282                                     1).toString()));\r
 283 \r
 284                     searchResults.addResult(seq, sres, eres);\r
 285 \r
 286                     if (!findAll)\r
 287                     {\r
 288                         // thats enough, break and display the result\r
 289                         found = true;\r
 290                         resIndex++;\r
 291 \r
 292                         break;\r
 293                     }\r
 294 \r
 295                     r = resIndex;\r
 296                 }\r
 297                 else\r
 298                 {\r
 299                   break;\r
 300                 }\r
 301             }\r
 302 \r
 303             if (!found)\r
 304             {\r
 305                 seqIndex++;\r
 306                 resIndex = 0;\r
 307             }\r
 308         }\r
 309 \r
 310         Vector idMatch = new Vector();\r
 311 \r
 312         for (int id = 0; id < av.alignment.getHeight(); id++)\r
 313         {\r
 314             if (regex.search(av.alignment.getSequenceAt(id).getName()))\r
 315             {\r
 316                 idMatch.add(av.alignment.getSequenceAt(id));\r
 317             }\r
 318         }\r
 319 \r
 320         if ((searchResults.getSize() == 0) && (idMatch.size() > 0))\r
 321         {\r
 322             ap.idPanel.highlightSearchResults(idMatch);\r
 323         }\r
 324 \r
 325 \r
 326         int resultSize = searchResults.getSize();\r
 327 \r
 328         if (searchResults.getSize() > 0)\r
 329           createNewGroup.setEnabled(true);\r
 330         else\r
 331           searchResults = null;\r
 332 \r
 333         // if allResults is null, this effectively switches displaySearch flag in seqCanvas\r
 334         ap.highlightSearchResults(searchResults);\r
 335 \r
 336         if(!findAll && resultSize==0)\r
 337         {\r
 338             JOptionPane.showInternalMessageDialog(this, "Finished searching",\r
 339                 null, JOptionPane.INFORMATION_MESSAGE);\r
 340             resIndex = 0;\r
 341             seqIndex = 0;\r
 342         }\r
 343 \r
 344         if (findAll)\r
 345         {\r
 346           String message = resultSize + " matches found.";\r
 347           JOptionPane.showInternalMessageDialog(this, message, null,\r
 348                                                 JOptionPane.INFORMATION_MESSAGE);\r
 349         }\r
 350 \r
 351     }\r
 352 }\r