From: jprocter <Jim Procter>
Date: Wed, 12 Nov 2008 11:03:07 +0000 (+0000)
Subject: javadoc and new method to get alignment sequence index using a SearchResults object
X-Git-Tag: Release_2_5~427
X-Git-Url: http://source.jalview.org/gitweb/?a=commitdiff_plain;h=961b10e4c895aadb7fc9df82a641c6c53c0d5c70;p=jalview.git

javadoc and new method to get alignment sequence index using a SearchResults object
---

diff --git a/src/jalview/datamodel/Alignment.java b/src/jalview/datamodel/Alignment.java
index 1312e22..08c04f5 100755
--- a/src/jalview/datamodel/Alignment.java
+++ b/src/jalview/datamodel/Alignment.java
@@ -441,8 +441,9 @@ public class Alignment implements AlignmentI
     return result;
 
   }
-
-  /**    */
+  /* (non-Javadoc)
+   * @see jalview.datamodel.AlignmentI#findIndex(jalview.datamodel.SequenceI)
+   */
   public int findIndex(SequenceI s)
   {
     int i = 0;
@@ -459,6 +460,23 @@ public class Alignment implements AlignmentI
 
     return -1;
   }
+  /* (non-Javadoc)
+   * @see jalview.datamodel.AlignmentI#findIndex(jalview.datamodel.SearchResults)
+   */
+  public int findIndex(SearchResults results)
+  {
+    int i=0;
+    
+    while (i<sequences.size())
+    {
+      if (results.involvesSequence(getSequenceAt(i)))
+      {
+        return i;
+      }
+      i++;
+    }
+    return -1;
+  }
 
   /**
    * DOCUMENT ME!
@@ -904,4 +922,5 @@ public class Alignment implements AlignmentI
     }
     return removed;
   }
+
 }
diff --git a/src/jalview/datamodel/AlignmentI.java b/src/jalview/datamodel/AlignmentI.java
index b4075a0..af5b7c4 100755
--- a/src/jalview/datamodel/AlignmentI.java
+++ b/src/jalview/datamodel/AlignmentI.java
@@ -122,7 +122,7 @@ public interface AlignmentI
    * @param s
    *                Sequence to look for.
    * 
-   * @return Index of sequence within the alignment.
+   * @return Index of sequence within the alignment or -1 if not found
    */
   public int findIndex(SequenceI s);
 
@@ -359,4 +359,11 @@ public interface AlignmentI
    */
   public SequenceI findName(SequenceI startAfter, String token, boolean b);
 
+  /**
+   * find first sequence in alignment which is involved in the given search result object
+   * @param results
+   * @return -1 or index of sequence in alignment
+   */
+  public int findIndex(SearchResults results);
+
 }