X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fdatamodel%2FSearchResults.java;h=5c929fc314c1f1a3493d158d2699f8c765949672;hb=27aed96d1aeae689818bd0a0028553186e3c3839;hp=329f447fcc6eb6de89434be8bfdb6776ce6eefd9;hpb=5c212e384ee48b37d899cc88fc3d12c5028cc3b4;p=jalview.git
diff --git a/src/jalview/datamodel/SearchResults.java b/src/jalview/datamodel/SearchResults.java
index 329f447..5c929fc 100755
--- a/src/jalview/datamodel/SearchResults.java
+++ b/src/jalview/datamodel/SearchResults.java
@@ -1,93 +1,220 @@
/*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.4)
- * Copyright (C) 2008 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
*
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
+ * This file is part of Jalview.
*
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *
+ * Jalview is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ * PURPOSE. See the GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
+ * along with Jalview. If not, see .
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
*/
package jalview.datamodel;
-public class SearchResults
+import java.util.ArrayList;
+import java.util.BitSet;
+import java.util.List;
+
+/**
+ * Holds a list of search result matches, where each match is a contiguous
+ * stretch of a single sequence.
+ *
+ * @author gmcarstairs amwaterhouse
+ *
+ */
+public class SearchResults implements SearchResultsI
{
+ private int count;
- Match[] matches;
+ private List matches = new ArrayList<>();
/**
- * This method replaces the old search results which merely held an alignment
- * index of search matches. This broke when sequences were moved around the
- * alignment
- *
- * @param seq
- * Sequence
- * @param start
- * int
- * @param end
- * int
+ * One match consists of a sequence reference, start and end positions.
+ * Discontiguous ranges in a sequence require two or more Match objects.
*/
- public void addResult(SequenceI seq, int start, int end)
+ public class Match implements SearchResultMatchI
{
- if (matches == null)
+ final SequenceI sequence;
+
+ /**
+ * Start position of match in sequence (base 1)
+ */
+ final int start;
+
+ /**
+ * End position (inclusive) (base 1)
+ */
+ final int end;
+
+ /**
+ * create a Match on a range of sequence. Match always holds region in
+ * forwards order, even if given in reverse order (such as from a mapping to
+ * a reverse strand); this avoids trouble for routines that highlight search
+ * results etc
+ *
+ * @param seq
+ * a sequence
+ * @param start
+ * start position of matched range (base 1)
+ * @param end
+ * end of matched range (inclusive, base 1)
+ */
+ public Match(SequenceI seq, int start, int end)
{
- matches = new Match[]
- { new Match(seq, start, end) };
- return;
+ sequence = seq;
+
+ /*
+ * always hold in forwards order, even if given in reverse order
+ * (such as from a mapping to a reverse strand); this avoids
+ * trouble for routines that highlight search results etc
+ */
+ if (start <= end)
+ {
+ this.start = start;
+ this.end = end;
+ }
+ else
+ {
+ // TODO: JBP could mark match as being specified in reverse direction
+ // for use
+ // by caller ? e.g. visualizing reverse strand highlight
+ this.start = end;
+ this.end = start;
+ }
}
- int mSize = matches.length;
+ @Override
+ public SequenceI getSequence()
+ {
+ return sequence;
+ }
- Match[] tmp = new Match[mSize + 1];
- int m;
- for (m = 0; m < mSize; m++)
+ @Override
+ public int getStart()
{
- tmp[m] = matches[m];
+ return start;
}
- tmp[m] = new Match(seq, start, end);
+ @Override
+ public int getEnd()
+ {
+ return end;
+ }
- matches = tmp;
+ /**
+ * Returns a representation as "seqid/start-end"
+ */
+ @Override
+ public String toString()
+ {
+ StringBuilder sb = new StringBuilder();
+ if (sequence != null)
+ {
+ sb.append(sequence.getName()).append("/");
+ }
+ sb.append(start).append("-").append(end);
+ return sb.toString();
+ }
+
+ /**
+ * Hashcode is the hashcode of the matched sequence plus a hash of start and
+ * end positions. Match objects that pass the test for equals are guaranteed
+ * to have the same hashcode.
+ */
+ @Override
+ public int hashCode()
+ {
+ int hash = sequence == null ? 0 : sequence.hashCode();
+ hash += 31 * start;
+ hash += 67 * end;
+ return hash;
+ }
+
+ /**
+ * Two Match objects are equal if they are for the same sequence, start and
+ * end positions
+ */
+ @Override
+ public boolean equals(Object obj)
+ {
+ if (obj == null || !(obj instanceof SearchResultMatchI))
+ {
+ return false;
+ }
+ SearchResultMatchI m = (SearchResultMatchI) obj;
+ return (sequence == m.getSequence() && start == m.getStart()
+ && end == m.getEnd());
+ }
+
+ @Override
+ public boolean contains(SequenceI seq, int from, int to)
+ {
+ return (sequence == seq && start <= from && end >= to);
+ }
}
- /**
- * Quickly check if the given sequence is referred to in the search results
- * @param sequence (specific alignment sequence or a dataset sequence)
- * @return true if the results involve sequence
- */
- public boolean involvesSequence(SequenceI sequence)
+
+ @Override
+ public SearchResultMatchI addResult(SequenceI seq, int start, int end)
{
- if (matches==null || matches.length==0)
+ Match m = new Match(seq, start, end);
+ if (!matches.contains(m))
{
- return false;
+ matches.add(m);
+ count++;
+ }
+ return m;
+ }
+
+ @Override
+ public void addResult(SequenceI seq, int[] positions)
+ {
+ /*
+ * we only increment the match count by 1 - or not at all,
+ * if the matches are all duplicates of existing
+ */
+ int beforeCount = count;
+ for (int i = 0; i < positions.length - 1; i += 2)
+ {
+ addResult(seq, positions[i], positions[i + 1]);
}
+ if (count > beforeCount)
+ {
+ count = beforeCount + 1;
+ }
+ }
+
+ @Override
+ public boolean involvesSequence(SequenceI sequence)
+ {
+ final int start = sequence.getStart();
+ final int end = sequence.getEnd();
+
SequenceI ds = sequence.getDatasetSequence();
- for (int m=0; m= start) && (m.getStart() <= end))
{
return true;
}
}
return false;
}
- /**
- * This Method returns the search matches which lie between the start and end
- * points of the sequence in question. It is optimised for returning objects
- * for drawing on SequenceCanvas
- */
+
+ @Override
public int[] getResults(SequenceI sequence, int start, int end)
{
- if (matches == null)
+ if (matches.isEmpty())
{
return null;
}
@@ -96,23 +223,21 @@ public class SearchResults
int[] tmp = null;
int resultLength, matchStart = 0, matchEnd = 0;
boolean mfound;
- for (int m = 0; m < matches.length; m++)
+ Match m;
+ for (SearchResultMatchI _m : matches)
{
+ m = (Match) _m;
+
mfound = false;
- if (matches[m].sequence == sequence)
+ if (m.sequence == sequence
+ || m.sequence == sequence.getDatasetSequence())
{
mfound = true;
- // locate aligned position
- matchStart = sequence.findIndex(matches[m].start) - 1;
- matchEnd = sequence.findIndex(matches[m].end) - 1;
- }
- else if (matches[m].sequence == sequence.getDatasetSequence())
- {
- mfound = true;
- // locate region in local context
- matchStart = sequence.findIndex(matches[m].start) - 1;
- matchEnd = sequence.findIndex(matches[m].end) - 1;
+ matchStart = sequence.findIndex(m.start) - 1;
+ matchEnd = m.start == m.end ? matchStart : sequence
+ .findIndex(m.end) - 1;
}
+
if (mfound)
{
if (matchStart <= end && matchEnd >= start)
@@ -129,8 +254,7 @@ public class SearchResults
if (result == null)
{
- result = new int[]
- { matchStart, matchEnd };
+ result = new int[] { matchStart, matchEnd };
}
else
{
@@ -142,44 +266,108 @@ public class SearchResults
result[resultLength + 1] = matchEnd;
}
}
+ else
+ {
+ // debug
+ // System.err.println("Outwith bounds!" + matchStart+">"+end +" or "
+ // + matchEnd+"<"+start);
+ }
}
}
return result;
}
- public int getSize()
+ @Override
+ public int markColumns(SequenceCollectionI sqcol, BitSet bs)
{
- return matches == null ? 0 : matches.length;
+ int count = 0;
+ BitSet mask = new BitSet();
+ int startRes = sqcol.getStartRes();
+ int endRes = sqcol.getEndRes();
+
+ for (SequenceI s : sqcol.getSequences())
+ {
+ int[] cols = getResults(s, startRes, endRes);
+ if (cols != null)
+ {
+ for (int pair = 0; pair < cols.length; pair += 2)
+ {
+ mask.set(cols[pair], cols[pair + 1] + 1);
+ }
+ }
+ }
+ // compute columns that were newly selected
+ BitSet original = (BitSet) bs.clone();
+ original.and(mask);
+ count = mask.cardinality() - original.cardinality();
+ // and mark ranges not already marked
+ bs.or(mask);
+ return count;
}
- public SequenceI getResultSequence(int index)
+ @Override
+ public int getCount()
{
- return matches[index].sequence;
+ return count;
}
- public int getResultStart(int index)
+ @Override
+ public boolean isEmpty()
{
- return matches[index].start;
+ return matches.isEmpty();
}
- public int getResultEnd(int index)
+ @Override
+ public List getResults()
{
- return matches[index].end;
+ return matches;
}
- class Match
+ /**
+ * Return the results as a list of matches [seq1/from-to, seq2/from-to, ...]
+ *
+ * @return
+ */
+ @Override
+ public String toString()
{
- SequenceI sequence;
-
- int start;
+ return matches == null ? "" : matches.toString();
+ }
- int end;
+ /**
+ * Hashcode is derived from the list of matches. This ensures that when two
+ * SearchResults objects satisfy the test for equals(), then they have the
+ * same hashcode.
+ *
+ * @see Match#hashCode()
+ * @see java.util.AbstractList#hashCode()
+ */
+ @Override
+ public int hashCode()
+ {
+ return matches.hashCode();
+ }
- public Match(SequenceI seq, int start, int end)
+ /**
+ * Two SearchResults are considered equal if they contain the same matches
+ * (Sequence, start position, end position) in the same order
+ *
+ * @see Match#equals(Object)
+ */
+ @Override
+ public boolean equals(Object obj)
+ {
+ if (obj == null || !(obj instanceof SearchResultsI))
{
- sequence = seq;
- this.start = start;
- this.end = end;
+ return false;
}
+ SearchResultsI sr = (SearchResultsI) obj;
+ return matches.equals(sr.getResults());
+ }
+
+ @Override
+ public void addSearchResults(SearchResultsI toAdd)
+ {
+ matches.addAll(toAdd.getResults());
}
}