src/jalview/analysis/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.analysis;
  22
  23 import java.util.Locale;
  24
  25 import jalview.api.AlignViewportI;
  26 import jalview.api.FinderI;
  27 import jalview.datamodel.AlignmentI;
  28 import jalview.datamodel.SearchResultMatchI;
  29 import jalview.datamodel.SearchResults;
  30 import jalview.datamodel.SearchResultsI;
  31 import jalview.datamodel.SequenceGroup;
  32 import jalview.datamodel.SequenceI;
  33 import jalview.util.Comparison;
  34 import jalview.util.MapList;
  35
  36 import java.util.ArrayList;
  37 import java.util.Arrays;
  38 import java.util.Iterator;
  39 import java.util.List;
  40
  41 import com.stevesoft.pat.Regex;
  42
  43 /**
  44  * Implements the search algorithm for the Find dialog
  45  */
  46 public class Finder implements FinderI
  47 {
  48   /*
  49    * matched residue locations
  50    */
  51   private SearchResultsI searchResults;
  52
  53   /*
  54    * sequences matched by id or description
  55    */
  56   private List<SequenceI> idMatches;
  57
  58   /*
  59    * the viewport to search over
  60    */
  61   private AlignViewportI viewport;
  62
  63   /*
  64    * sequence index in alignment to search from
  65    */
  66   private int sequenceIndex;
  67
  68   /*
  69    * position offset in sequence to search from, base 0
  70    * (position after start of last match for a 'find next')
  71    */
  72   private int residueIndex;
  73
  74   /*
  75    * the true sequence position of the start of the
  76    * last sequence searched (when 'ignore hidden regions' does not apply)
  77    */
  78   private int searchedSequenceStartPosition;
  79
  80   /*
  81    * when 'ignore hidden regions' applies, this holds the mapping from
  82    * the visible sequence positions (1, 2, ...) to true sequence positions
  83    */
  84   private MapList searchedSequenceMap;
  85
  86   private String seqToSearch;
  87
  88   /**
  89    * Constructor for searching a viewport
  90    *
  91    * @param av
  92    */
  93   public Finder(AlignViewportI av)
  94   {
  95     this.viewport = av;
  96     this.sequenceIndex = 0;
  97     this.residueIndex = -1;
  98   }
  99
 100   @Override
 101   public void findAll(String theSearchString, boolean matchCase,
 102           boolean searchDescription, boolean ignoreHidden)
 103   {
 104     /*
 105      * search from the start
 106      */
 107     sequenceIndex = 0;
 108     residueIndex = -1;
 109
 110     doFind(theSearchString, matchCase, searchDescription, true,
 111             ignoreHidden);
 112
 113     /*
 114      * reset to start for next search
 115      */
 116     sequenceIndex = 0;
 117     residueIndex = -1;
 118   }
 119
 120   @Override
 121   public void findNext(String theSearchString, boolean matchCase,
 122           boolean searchDescription, boolean ignoreHidden)
 123   {
 124     doFind(theSearchString, matchCase, searchDescription, false,
 125             ignoreHidden);
 126
 127     if (searchResults.isEmpty() && idMatches.isEmpty())
 128     {
 129       /*
 130        * search failed - reset to start for next search
 131        */
 132       sequenceIndex = 0;
 133       residueIndex = -1;
 134     }
 135   }
 136
 137   /**
 138    * Performs a 'find next' or 'find all'
 139    *
 140    * @param theSearchString
 141    * @param matchCase
 142    * @param searchDescription
 143    * @param findAll
 144    * @param ignoreHidden
 145    */
 146   protected void doFind(String theSearchString, boolean matchCase,
 147           boolean searchDescription, boolean findAll, boolean ignoreHidden)
 148   {
 149     searchResults = new SearchResults();
 150     idMatches = new ArrayList<>();
 151
 152     String searchString = matchCase ? theSearchString
 153             : theSearchString.toUpperCase(Locale.ROOT);
 154     Regex searchPattern = new Regex(searchString);
 155     searchPattern.setIgnoreCase(!matchCase);
 156
 157     SequenceGroup selection = viewport.getSelectionGroup();
 158     if (selection != null && selection.getSize() < 1)
 159     {
 160       selection = null; // ? ignore column-only selection
 161     }
 162
 163     AlignmentI alignment = viewport.getAlignment();
 164     int end = alignment.getHeight();
 165
 166     getSequence(ignoreHidden);
 167
 168     boolean found = false;
 169     while ((!found || findAll) && sequenceIndex < end)
 170     {
 171       found = findNextMatch(searchString, searchPattern, searchDescription,
 172               ignoreHidden);
 173     }
 174   }
 175
 176   /**
 177    * Calculates and saves the sequence string to search. The string is restricted
 178    * to the current selection region if there is one, and is saved with all gaps
 179    * removed.
 180    * <p>
 181    * If there are hidden columns, and option {@ignoreHidden} is selected, then
 182    * only visible positions of the sequence are included, and a mapping is also
 183    * constructed from the returned string positions to the true sequence
 184    * positions.
 185    * <p>
 186    * Note we have to do this each time {@code findNext} or {@code findAll} is
 187    * called, in case the alignment, selection group or hidden columns have
 188    * changed. In particular, if the sequence at offset {@code sequenceIndex} in
 189    * the alignment is (no longer) in the selection group, search is advanced to
 190    * the next sequence that is.
 191    * <p>
 192    * Sets sequence string to the empty string if there are no more sequences (in
 193    * selection group if any) at or after {@code sequenceIndex}.
 194    * <p>
 195    * Returns true if a sequence could be found, false if end of alignment was
 196    * reached
 197    *
 198    * @param ignoreHidden
 199    * @return
 200    */
 201   private boolean getSequence(boolean ignoreHidden)
 202   {
 203     AlignmentI alignment = viewport.getAlignment();
 204     if (sequenceIndex >= alignment.getHeight())
 205     {
 206       seqToSearch = "";
 207       return false;
 208     }
 209     SequenceI seq = alignment.getSequenceAt(sequenceIndex);
 210     SequenceGroup selection = viewport.getSelectionGroup();
 211     if (selection != null && !selection.contains(seq))
 212     {
 213       if (!nextSequence(ignoreHidden))
 214       {
 215         return false;
 216       }
 217       seq = alignment.getSequenceAt(sequenceIndex);
 218     }
 219
 220     String seqString = null;
 221     if (ignoreHidden)
 222     {
 223       seqString = getVisibleSequence(seq);
 224       this.searchedSequenceStartPosition = 1;
 225     }
 226     else
 227     {
 228       int startCol = 0;
 229       int endCol = seq.getLength() - 1;
 230       this.searchedSequenceStartPosition = seq.getStart();
 231       if (selection != null)
 232       {
 233         startCol = selection.getStartRes();
 234         endCol = Math.min(endCol, selection.getEndRes());
 235         this.searchedSequenceStartPosition = seq.findPosition(startCol);
 236       }
 237       seqString = seq.getSequenceAsString(startCol, endCol + 1);
 238     }
 239
 240     /*
 241      * remove gaps; note that even if this leaves an empty string, we 'search'
 242      * the sequence anyway (for possible match on name or description)
 243      */
 244     String ungapped = AlignSeq.extractGaps(Comparison.GapChars, seqString);
 245     this.seqToSearch = ungapped;
 246
 247     return true;
 248   }
 249
 250   /**
 251    * Returns a string consisting of only the visible residues of {@code seq} from
 252    * alignment column {@ fromColumn}, restricted to the current selection region
 253    * if there is one.
 254    * <p>
 255    * As a side-effect, also computes the mapping from the true sequence positions
 256    * to the positions (1, 2, ...) of the returned sequence. This is to allow
 257    * search matches in the visible sequence to be converted to sequence positions.
 258    *
 259    * @param seq
 260    * @return
 261    */
 262   private String getVisibleSequence(SequenceI seq)
 263   {
 264     /*
 265      * get start / end columns of sequence and convert to base 0
 266      * (so as to match the visible column ranges)
 267      */
 268     int seqStartCol = seq.findIndex(seq.getStart()) - 1;
 269     int seqEndCol = seq.findIndex(seq.getStart() + seq.getLength() - 1) - 1;
 270     Iterator<int[]> visibleColumns = viewport.getViewAsVisibleContigs(true);
 271     StringBuilder visibleSeq = new StringBuilder(seqEndCol - seqStartCol);
 272     List<int[]> fromRanges = new ArrayList<>();
 273
 274     while (visibleColumns.hasNext())
 275     {
 276       int[] range = visibleColumns.next();
 277       if (range[0] > seqEndCol)
 278       {
 279         // beyond the end of the sequence
 280         break;
 281       }
 282       if (range[1] < seqStartCol)
 283       {
 284         // before the start of the sequence
 285         continue;
 286       }
 287       String subseq = seq.getSequenceAsString(range[0], range[1] + 1);
 288       String ungapped = AlignSeq.extractGaps(Comparison.GapChars, subseq);
 289       visibleSeq.append(ungapped);
 290       if (!ungapped.isEmpty())
 291       {
 292         /*
 293          * visible region includes at least one non-gap character,
 294          * so add the range to the mapping being constructed
 295          */
 296         int seqResFrom = seq.findPosition(range[0]);
 297         int seqResTo = seqResFrom + ungapped.length() - 1;
 298         fromRanges.add(new int[] { seqResFrom, seqResTo });
 299       }
 300     }
 301
 302     /*
 303      * construct the mapping
 304      * from: visible sequence positions 1..length
 305      * to:   true residue positions of the alignment sequence
 306      */
 307     List<int[]> toRange = Arrays
 308             .asList(new int[]
 309             { 1, visibleSeq.length() });
 310     searchedSequenceMap = new MapList(fromRanges, toRange, 1, 1);
 311
 312     return visibleSeq.toString();
 313   }
 314
 315   /**
 316    * Advances the search to the next sequence in the alignment. Sequences not in
 317    * the current selection group (if there is one) are skipped. The (sub-)sequence
 318    * to be searched is extracted, gaps removed, and saved, or set to null if there
 319    * are no more sequences to search.
 320    * <p>
 321    * Returns true if a sequence could be found, false if end of alignment was
 322    * reached
 323    *
 324    * @param ignoreHidden
 325    */
 326   private boolean nextSequence(boolean ignoreHidden)
 327   {
 328     sequenceIndex++;
 329     residueIndex = -1;
 330
 331     return getSequence(ignoreHidden);
 332   }
 333
 334   /**
 335    * Finds the next match in the given sequence, starting at offset
 336    * {@code residueIndex}. Answers true if a match is found, else false.
 337    * <p>
 338    * If a match is found, {@code residueIndex} is advanced to the position after
 339    * the start of the matched region, ready for the next search.
 340    * <p>
 341    * If no match is found, {@code sequenceIndex} is advanced ready to search the
 342    * next sequence.
 343    *
 344    * @param seqToSearch
 345    * @param searchString
 346    * @param searchPattern
 347    * @param matchDescription
 348    * @param ignoreHidden
 349    * @return
 350    */
 351   protected boolean findNextMatch(String searchString,
 352           Regex searchPattern, boolean matchDescription,
 353           boolean ignoreHidden)
 354   {
 355     if (residueIndex < 0)
 356     {
 357       /*
 358        * at start of sequence; try find by residue number, in sequence id,
 359        * or (optionally) in sequence description
 360        */
 361       if (doNonMotifSearches(searchString, searchPattern,
 362               matchDescription))
 363       {
 364         return true;
 365       }
 366     }
 367
 368     /*
 369      * search for next match in sequence string
 370      */
 371     int end = seqToSearch.length();
 372     while (residueIndex < end)
 373     {
 374       boolean matched = searchPattern.searchFrom(seqToSearch, residueIndex);
 375       if (matched)
 376       {
 377         if (recordMatch(searchPattern, ignoreHidden))
 378         {
 379           return true;
 380         }
 381       }
 382       else
 383       {
 384         residueIndex = Integer.MAX_VALUE;
 385       }
 386     }
 387
 388     nextSequence(ignoreHidden);
 389     return false;
 390   }
 391
 392   /**
 393    * Adds the match held in the <code>searchPattern</code> Regex to the
 394    * <code>searchResults</code>, unless it is a subregion of the last match
 395    * recorded. <code>residueIndex</code> is advanced to the position after the
 396    * start of the matched region, ready for the next search. Answers true if a
 397    * match was added, else false.
 398    * <p>
 399    * Matches that lie entirely within hidden regions of the alignment are not
 400    * added.
 401    *
 402    * @param searchPattern
 403    * @param ignoreHidden
 404    * @return
 405    */
 406   protected boolean recordMatch(Regex searchPattern, boolean ignoreHidden)
 407   {
 408     SequenceI seq = viewport.getAlignment().getSequenceAt(sequenceIndex);
 409
 410     /*
 411      * convert start/end of the match to sequence coordinates
 412      */
 413     int offset = searchPattern.matchedFrom();
 414     int matchStartPosition = this.searchedSequenceStartPosition + offset;
 415     int matchEndPosition = matchStartPosition
 416             + searchPattern.charsMatched() - 1;
 417
 418     /*
 419      * update residueIndex to next position after the start of the match
 420      * (findIndex returns a value base 1, columnIndex is held base 0)
 421      */
 422     residueIndex = searchPattern.matchedFrom()+1;
 423
 424     /*
 425      * return false if the match is entirely in a hidden region
 426      */
 427     if (allHidden(seq, matchStartPosition, matchEndPosition))
 428     {
 429       return false;
 430     }
 431
 432     /*
 433      * check that this match is not a subset of the previous one (JAL-2302)
 434      */
 435     List<SearchResultMatchI> matches = searchResults.getResults();
 436     SearchResultMatchI lastMatch = matches.isEmpty() ? null
 437             : matches.get(matches.size() - 1);
 438
 439     if (lastMatch == null || !lastMatch.contains(seq, matchStartPosition,
 440             matchEndPosition))
 441     {
 442       addMatch(seq, matchStartPosition, matchEndPosition, ignoreHidden);
 443       return true;
 444     }
 445
 446     return false;
 447   }
 448
 449   /**
 450    * Adds one match to the stored list. If hidden residues are being skipped, then
 451    * the match may need to be split into contiguous positions of the sequence (so
 452    * it does not include skipped residues).
 453    *
 454    * @param seq
 455    * @param matchStartPosition
 456    * @param matchEndPosition
 457    * @param ignoreHidden
 458    */
 459   private void addMatch(SequenceI seq, int matchStartPosition,
 460           int matchEndPosition, boolean ignoreHidden)
 461   {
 462     if (!ignoreHidden)
 463     {
 464       /*
 465        * simple case
 466        */
 467       searchResults.addResult(seq, matchStartPosition, matchEndPosition);
 468       return;
 469     }
 470
 471     /*
 472      *  get start-end contiguous ranges in underlying sequence
 473      */
 474     int[] truePositions = searchedSequenceMap
 475             .locateInFrom(matchStartPosition, matchEndPosition);
 476     searchResults.addResult(seq, truePositions);
 477   }
 478
 479   /**
 480    * Returns true if all residues are hidden, else false
 481    *
 482    * @param seq
 483    * @param fromPos
 484    * @param toPos
 485    * @return
 486    */
 487   private boolean allHidden(SequenceI seq, int fromPos, int toPos)
 488   {
 489     if (!viewport.hasHiddenColumns())
 490     {
 491       return false;
 492     }
 493     for (int res = fromPos; res <= toPos; res++)
 494     {
 495       if (isVisible(seq, res))
 496       {
 497         return false;
 498       }
 499     }
 500     return true;
 501   }
 502
 503   /**
 504    * Does searches other than for residue patterns. Currently this includes
 505    * <ul>
 506    * <li>find residue by position (if search string is a number)</li>
 507    * <li>match search string to sequence id</li>
 508    * <li>match search string to sequence description (optional)</li>
 509    * </ul>
 510    * Answers true if a match is found, else false.
 511    *
 512    * @param searchString
 513    * @param searchPattern
 514    * @param includeDescription
 515    * @return
 516    */
 517   protected boolean doNonMotifSearches(String searchString,
 518           Regex searchPattern, boolean includeDescription)
 519   {
 520     SequenceI seq = viewport.getAlignment().getSequenceAt(sequenceIndex);
 521
 522     /*
 523      * position sequence search to start of sequence
 524      */
 525     residueIndex = 0;
 526     try
 527     {
 528       int res = Integer.parseInt(searchString);
 529       return searchForResidueNumber(seq, res);
 530     } catch (NumberFormatException ex)
 531     {
 532       // search pattern is not a number
 533     }
 534
 535     if (searchSequenceName(seq, searchPattern))
 536     {
 537       return true;
 538     }
 539     if (includeDescription && searchSequenceDescription(seq, searchPattern))
 540     {
 541       return true;
 542     }
 543     return false;
 544   }
 545
 546   /**
 547    * Searches for a match with the sequence description, and if found, adds the
 548    * sequence to the list of match ids (but not as a duplicate). Answers true if
 549    * a match was added, else false.
 550    *
 551    * @param seq
 552    * @param searchPattern
 553    * @return
 554    */
 555   protected boolean searchSequenceDescription(SequenceI seq, Regex searchPattern)
 556   {
 557     String desc = seq.getDescription();
 558     if (desc != null && searchPattern.search(desc) && !idMatches.contains(seq))
 559     {
 560       idMatches.add(seq);
 561       return true;
 562     }
 563     return false;
 564   }
 565
 566   /**
 567    * Searches for a match with the sequence name, and if found, adds the
 568    * sequence to the list of match ids (but not as a duplicate). Answers true if
 569    * a match was added, else false.
 570    *
 571    * @param seq
 572    * @param searchPattern
 573    * @return
 574    */
 575   protected boolean searchSequenceName(SequenceI seq, Regex searchPattern)
 576   {
 577     if (searchPattern.search(seq.getName()) && !idMatches.contains(seq))
 578     {
 579       idMatches.add(seq);
 580       return true;
 581     }
 582     return false;
 583   }
 584
 585   /**
 586    * If the residue position is valid for the sequence, and in a visible column,
 587    * adds the position to the search results and returns true, else answers false.
 588    *
 589    * @param seq
 590    * @param resNo
 591    * @return
 592    */
 593   protected boolean searchForResidueNumber(SequenceI seq, int resNo)
 594   {
 595     if (seq.getStart() <= resNo && seq.getEnd() >= resNo)
 596     {
 597       if (isVisible(seq, resNo))
 598       {
 599         searchResults.addResult(seq, resNo, resNo);
 600         return true;
 601       }
 602     }
 603     return false;
 604   }
 605
 606   /**
 607    * Returns true if the residue is in a visible column, else false
 608    *
 609    * @param seq
 610    * @param res
 611    * @return
 612    */
 613   private boolean isVisible(SequenceI seq, int res)
 614   {
 615     if (!viewport.hasHiddenColumns())
 616     {
 617       return true;
 618     }
 619     int col = seq.findIndex(res); // base 1
 620     return viewport.getAlignment().getHiddenColumns().isVisible(col - 1); // base 0
 621   }
 622
 623   @Override
 624   public List<SequenceI> getIdMatches()
 625   {
 626     return idMatches;
 627   }
 628
 629   @Override
 630   public SearchResultsI getSearchResults()
 631   {
 632     return searchResults;
 633   }
 634 }