JAL-345 javadoc and note about JAL-2300
authorJim Procter <jprocter@issues.jalview.org>
Wed, 2 Nov 2016 14:53:03 +0000 (14:53 +0000)
committerJim Procter <jprocter@issues.jalview.org>
Wed, 2 Nov 2016 14:53:03 +0000 (14:53 +0000)
src/jalview/datamodel/SearchResults.java

index 8cdf446..2ba1612 100755 (executable)
@@ -56,7 +56,10 @@ public class SearchResults implements SearchResultsI
     int end;
 
     /**
-     * Constructor
+     * 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
@@ -81,6 +84,9 @@ public class SearchResults implements SearchResultsI
       }
       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;
       }