src/jalview/api/FinderI.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.api;
  22
  23 import jalview.datamodel.SearchResultsI;
  24 import jalview.datamodel.SequenceI;
  25
  26 import java.util.List;
  27
  28 /**
  29  * An interface for searching for a pattern in an aligment
  30  */
  31 public interface FinderI
  32 {
  33
  34   /**
  35    * Performs a find for the given search string (interpreted as a regular
  36    * expression). Search may optionally be case-sensitive, and may optionally
  37    * including match in sequence description (sequence id is always searched). If
  38    * the viewport has an active selection, then the find is restricted to the
  39    * selection region. Sequences matched by id or description can be retrieved by
  40    * getIdMatches(), and matched residue patterns by getSearchResults().
  41    * <p>
  42    * If {@code ignoreHidden} is true, then any residues in hidden columns are
  43    * ignored (skipped) when matching, so for example pattern {@code KRT} would
  44    * match sequence {@code KRqmT} (where {@code qm} are in hidden columns).
  45    * <p>
  46    * Matches of entirely hidden patterns are not returned. Matches that span
  47    * hidden regions on one or both sides may be returned.
  48    *
  49    * @param theSearchString
  50    * @param caseSensitive
  51    * @param searchDescription
  52    * @param ignoreHidden
  53    * @return
  54    */
  55   void findAll(String theSearchString, boolean caseSensitive,
  56           boolean searchDescription, boolean ignoreHidden);
  57
  58   /**
  59    * Finds the next match for the given search string (interpreted as a regular
  60    * expression), starting from the position after the last match found. Search
  61    * may optionally be case-sensitive, and may optionally including match in
  62    * sequence description (sequence id is always searched). If the viewport has an
  63    * active selection, then the find is restricted to the selection region.
  64    * Sequences matched by id or description can be retrieved by getIdMatches(),
  65    * and matched residue patterns by getSearchResults().
  66    * <p>
  67    * If {@code ignoreHidden} is true, any hidden residues are skipped (matches may
  68    * span them). If false, they are included for matching purposes. In either
  69    * cases, entirely hidden matches are not returned.
  70    *
  71    * @param theSearchString
  72    * @param caseSensitive
  73    * @param searchDescription
  74    * @param ignoreHidden
  75    * @return
  76    */
  77   void findNext(String theSearchString, boolean caseSensitive,
  78           boolean searchDescription, boolean ignoreHidden);
  79
  80   /**
  81    * Returns the (possibly empty) list of sequences matched on sequence name or
  82    * description
  83    *
  84    * @return
  85    */
  86   List<SequenceI> getIdMatches();
  87
  88   /**
  89    * Answers the search results (possibly empty) from the last search
  90    *
  91    * @return
  92    */
  93   SearchResultsI getSearchResults();
  94
  95 }