src/jalview/datamodel/SearchResults.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.datamodel;
  22
  23 import java.util.ArrayList;
  24 import java.util.BitSet;
  25 import java.util.List;
  26
  27 /**
  28  * Holds a list of search result matches, where each match is a contiguous
  29  * stretch of a single sequence.
  30  *
  31  * @author gmcarstairs amwaterhouse
  32  *
  33  */
  34 public class SearchResults implements SearchResultsI
  35 {
  36
  37   private List<SearchResultMatchI> matches = new ArrayList<>();
  38
  39   /**
  40    * One match consists of a sequence reference, start and end positions.
  41    * Discontiguous ranges in a sequence require two or more Match objects.
  42    */
  43   public class Match implements SearchResultMatchI
  44   {
  45     final SequenceI sequence;
  46
  47     /**
  48      * Start position of match in sequence (base 1)
  49      */
  50     final int start;
  51
  52     /**
  53      * End position (inclusive) (base 1)
  54      */
  55     final int end;
  56
  57     /**
  58      * create a Match on a range of sequence. Match always holds region in
  59      * forwards order, even if given in reverse order (such as from a mapping to
  60      * a reverse strand); this avoids trouble for routines that highlight search
  61      * results etc
  62      *
  63      * @param seq
  64      *          a sequence
  65      * @param start
  66      *          start position of matched range (base 1)
  67      * @param end
  68      *          end of matched range (inclusive, base 1)
  69      */
  70     public Match(SequenceI seq, int start, int end)
  71     {
  72       sequence = seq;
  73
  74       /*
  75        * always hold in forwards order, even if given in reverse order
  76        * (such as from a mapping to a reverse strand); this avoids
  77        * trouble for routines that highlight search results etc
  78        */
  79       if (start <= end)
  80       {
  81         this.start = start;
  82         this.end = end;
  83       }
  84       else
  85       {
  86         // TODO: JBP could mark match as being specified in reverse direction
  87         // for use
  88         // by caller ? e.g. visualizing reverse strand highlight
  89         this.start = end;
  90         this.end = start;
  91       }
  92     }
  93
  94     /* (non-Javadoc)
  95      * @see jalview.datamodel.SearchResultMatchI#getSequence()
  96      */
  97     @Override
  98     public SequenceI getSequence()
  99     {
 100       return sequence;
 101     }
 102
 103     /* (non-Javadoc)
 104      * @see jalview.datamodel.SearchResultMatchI#getStart()
 105      */
 106     @Override
 107     public int getStart()
 108     {
 109       return start;
 110     }
 111
 112     /* (non-Javadoc)
 113      * @see jalview.datamodel.SearchResultMatchI#getEnd()
 114      */
 115     @Override
 116     public int getEnd()
 117     {
 118       return end;
 119     }
 120
 121     /**
 122      * Returns a representation as "seqid/start-end"
 123      */
 124     @Override
 125     public String toString()
 126     {
 127       StringBuilder sb = new StringBuilder();
 128       if (sequence != null)
 129       {
 130         sb.append(sequence.getName()).append("/");
 131       }
 132       sb.append(start).append("-").append(end);
 133       return sb.toString();
 134     }
 135
 136     /**
 137      * Hashcode is the hashcode of the matched sequence plus a hash of start and
 138      * end positions. Match objects that pass the test for equals are guaranteed
 139      * to have the same hashcode.
 140      */
 141     @Override
 142     public int hashCode()
 143     {
 144       int hash = sequence == null ? 0 : sequence.hashCode();
 145       hash += 31 * start;
 146       hash += 67 * end;
 147       return hash;
 148     }
 149
 150     /**
 151      * Two Match objects are equal if they are for the same sequence, start and
 152      * end positions
 153      */
 154     @Override
 155     public boolean equals(Object obj)
 156     {
 157       if (obj == null || !(obj instanceof SearchResultMatchI))
 158       {
 159         return false;
 160       }
 161       SearchResultMatchI m = (SearchResultMatchI) obj;
 162       return (sequence == m.getSequence() && start == m.getStart()
 163               && end == m.getEnd());
 164     }
 165   }
 166
 167   /* (non-Javadoc)
 168    * @see jalview.datamodel.SearchResultsI#addResult(jalview.datamodel.SequenceI, int, int)
 169    */
 170   @Override
 171   public SearchResultMatchI addResult(SequenceI seq, int start, int end)
 172   {
 173     Match m = new Match(seq, start, end);
 174     matches.add(m);
 175     return m;
 176   }
 177
 178   /* (non-Javadoc)
 179    * @see jalview.datamodel.SearchResultsI#involvesSequence(jalview.datamodel.SequenceI)
 180    */
 181   @Override
 182   public boolean involvesSequence(SequenceI sequence)
 183   {
 184     SequenceI ds = sequence.getDatasetSequence();
 185     for (SearchResultMatchI _m : matches)
 186     {
 187       SequenceI matched = _m.getSequence();
 188       if (matched != null && (matched == sequence || matched == ds))
 189       {
 190         return true;
 191       }
 192     }
 193     return false;
 194   }
 195
 196   /* (non-Javadoc)
 197    * @see jalview.datamodel.SearchResultsI#getResults(jalview.datamodel.SequenceI, int, int)
 198    */
 199   @Override
 200   public int[] getResults(SequenceI sequence, int start, int end)
 201   {
 202     if (matches.isEmpty())
 203     {
 204       return null;
 205     }
 206
 207     int[] result = null;
 208     int[] tmp = null;
 209     int resultLength, matchStart = 0, matchEnd = 0;
 210     boolean mfound;
 211     Match m;
 212     for (SearchResultMatchI _m : matches)
 213     {
 214       m = (Match) _m;
 215
 216       mfound = false;
 217       if (m.sequence == sequence
 218               || m.sequence == sequence.getDatasetSequence())
 219       {
 220         mfound = true;
 221         matchStart = sequence.findIndex(m.start) - 1;
 222         matchEnd = m.start == m.end ? matchStart : sequence
 223                 .findIndex(m.end) - 1;
 224       }
 225
 226       if (mfound)
 227       {
 228         if (matchStart <= end && matchEnd >= start)
 229         {
 230           if (matchStart < start)
 231           {
 232             matchStart = start;
 233           }
 234
 235           if (matchEnd > end)
 236           {
 237             matchEnd = end;
 238           }
 239
 240           if (result == null)
 241           {
 242             result = new int[] { matchStart, matchEnd };
 243           }
 244           else
 245           {
 246             resultLength = result.length;
 247             tmp = new int[resultLength + 2];
 248             System.arraycopy(result, 0, tmp, 0, resultLength);
 249             result = tmp;
 250             result[resultLength] = matchStart;
 251             result[resultLength + 1] = matchEnd;
 252           }
 253         }
 254         else
 255         {
 256           // debug
 257           // System.err.println("Outwith bounds!" + matchStart+">"+end +" or "
 258           // + matchEnd+"<"+start);
 259         }
 260       }
 261     }
 262     return result;
 263   }
 264
 265   @Override
 266   public int markColumns(SequenceCollectionI sqcol, BitSet bs)
 267   {
 268     int count = 0;
 269     BitSet mask = new BitSet();
 270     for (SequenceI s : sqcol.getSequences())
 271     {
 272       int[] cols = getResults(s, sqcol.getStartRes(), sqcol.getEndRes());
 273       if (cols != null)
 274       {
 275         for (int pair = 0; pair < cols.length; pair += 2)
 276         {
 277           mask.set(cols[pair], cols[pair + 1] + 1);
 278         }
 279       }
 280     }
 281     // compute columns that were newly selected
 282     BitSet original = (BitSet) bs.clone();
 283     original.and(mask);
 284     count = mask.cardinality() - original.cardinality();
 285     // and mark ranges not already marked
 286     bs.or(mask);
 287     return count;
 288   }
 289
 290   /* (non-Javadoc)
 291    * @see jalview.datamodel.SearchResultsI#getSize()
 292    */
 293   @Override
 294   public int getSize()
 295   {
 296     return matches.size();
 297   }
 298
 299   /* (non-Javadoc)
 300    * @see jalview.datamodel.SearchResultsI#isEmpty()
 301    */
 302   @Override
 303   public boolean isEmpty()
 304   {
 305     return matches.isEmpty();
 306   }
 307
 308   /* (non-Javadoc)
 309    * @see jalview.datamodel.SearchResultsI#getResults()
 310    */
 311   @Override
 312   public List<SearchResultMatchI> getResults()
 313   {
 314     return matches;
 315   }
 316
 317   /**
 318    * Return the results as a list of matches [seq1/from-to, seq2/from-to, ...]
 319    *
 320    * @return
 321    */
 322   @Override
 323   public String toString()
 324   {
 325     return matches == null ? "" : matches.toString();
 326   }
 327
 328   /**
 329    * Hashcode is derived from the list of matches. This ensures that when two
 330    * SearchResults objects satisfy the test for equals(), then they have the
 331    * same hashcode.
 332    *
 333    * @see Match#hashCode()
 334    * @see java.util.AbstractList#hashCode()
 335    */
 336   @Override
 337   public int hashCode()
 338   {
 339     return matches.hashCode();
 340   }
 341
 342   /**
 343    * Two SearchResults are considered equal if they contain the same matches in
 344    * the same order.
 345    */
 346   @Override
 347   public boolean equals(Object obj)
 348   {
 349     if (obj == null || !(obj instanceof SearchResultsI))
 350     {
 351       return false;
 352     }
 353     SearchResultsI sr = (SearchResultsI) obj;
 354     return matches.equals(sr.getResults());
 355   }
 356
 357   @Override
 358   public void addSearchResults(SearchResultsI toAdd)
 359   {
 360     matches.addAll(toAdd.getResults());
 361   }
 362 }