JAL-2480 inline one method, improve comments
[jalview.git] / src / jalview / datamodel / features / FeatureStore.java
index 84e7736..51bee57 100644 (file)
@@ -33,6 +33,13 @@ public class FeatureStore
      */
     abstract boolean compare(SequenceFeature entry);
 
+    /**
+     * serves a search condition for finding the first feature whose start
+     * position follows a given target location
+     * 
+     * @param target
+     * @return
+     */
     static SearchCriterion byStart(final long target)
     {
       return new SearchCriterion() {
@@ -45,6 +52,13 @@ public class FeatureStore
       };
     }
 
+    /**
+     * serves a search condition for finding the first feature whose end
+     * position is at or follows a given target location
+     * 
+     * @param target
+     * @return
+     */
     static SearchCriterion byEnd(final long target)
     {
       return new SearchCriterion()
@@ -58,6 +72,13 @@ public class FeatureStore
       };
     }
 
+    /**
+     * serves a search condition for finding the first feature which follows the
+     * given range as determined by a supplied comparator
+     * 
+     * @param target
+     * @return
+     */
     static SearchCriterion byFeature(final ContiguousI to,
             final Comparator<ContiguousI> rc)
     {
@@ -159,6 +180,11 @@ public class FeatureStore
    */
   public boolean addFeature(SequenceFeature feature)
   {
+    if (contains(feature))
+    {
+      return false;
+    }
+
     /*
      * keep a record of feature groups
      */
@@ -179,16 +205,13 @@ public class FeatureStore
     }
     else
     {
-      if (!contains(nonNestedFeatures, feature))
+      added = addNonNestedFeature(feature);
+      if (!added)
       {
-        added = addNonNestedFeature(feature);
-        if (!added)
-        {
-          /*
-           * detected a nested feature - put it in the NCList structure
-           */
-          added = addNestedFeature(feature);
-        }
+        /*
+         * detected a nested feature - put it in the NCList structure
+         */
+        added = addNestedFeature(feature);
       }
     }
 
@@ -225,6 +248,36 @@ public class FeatureStore
   }
 
   /**
+   * Answers true if this store contains the given feature (testing by
+   * SequenceFeature.equals), else false
+   * 
+   * @param feature
+   * @return
+   */
+  public boolean contains(SequenceFeature feature)
+  {
+    if (feature.isNonPositional())
+    {
+      return nonPositionalFeatures == null ? false : nonPositionalFeatures
+              .contains(feature);
+    }
+
+    if (feature.isContactFeature())
+    {
+      return contactFeatureStarts == null ? false : listContains(
+              contactFeatureStarts, feature);
+    }
+
+    if (listContains(nonNestedFeatures, feature))
+    {
+      return true;
+    }
+
+    return nestedFeatures == null ? false : nestedFeatures
+            .contains(feature);
+  }
+
+  /**
    * Answers the 'length' of the feature, counting 0 for non-positional features
    * and 1 for contact features
    * 
@@ -246,10 +299,10 @@ public class FeatureStore
 
   /**
    * Adds the feature to the list of non-positional features (with lazy
-   * instantiation of the list if it is null), and returns true. If the
-   * non-positional features already include the new feature (by equality test),
-   * then it is not added, and this method returns false. The feature group is
-   * added to the set of distinct feature groups for non-positional features.
+   * instantiation of the list if it is null), and returns true. The feature
+   * group is added to the set of distinct feature groups for non-positional
+   * features. This method allows duplicate features, so test before calling to
+   * prevent this.
    * 
    * @param feature
    */
@@ -259,10 +312,6 @@ public class FeatureStore
     {
       nonPositionalFeatures = new ArrayList<SequenceFeature>();
     }
-    if (nonPositionalFeatures.contains(feature))
-    {
-      return false;
-    }
 
     nonPositionalFeatures.add(feature);
 
@@ -362,8 +411,8 @@ public class FeatureStore
   /**
    * Add a contact feature to the lists that hold them ordered by start (first
    * contact) and by end (second contact) position, ensuring the lists remain
-   * ordered, and returns true. If the contact feature lists already contain the
-   * given feature (by test for equality), does not add it and returns false.
+   * ordered, and returns true. This method allows duplicate features to be
+   * added, so test before calling to avoid this.
    * 
    * @param feature
    * @return
@@ -379,11 +428,6 @@ public class FeatureStore
       contactFeatureEnds = new ArrayList<SequenceFeature>();
     }
 
-    if (contains(contactFeatureStarts, feature))
-    {
-      return false;
-    }
-
     /*
      * binary search the sorted list to find the insertion point
      */
@@ -412,7 +456,7 @@ public class FeatureStore
    * @param feature
    * @return
    */
-  protected static boolean contains(List<SequenceFeature> features,
+  protected static boolean listContains(List<SequenceFeature> features,
           SequenceFeature feature)
   {
     if (features == null || feature == null)
@@ -552,28 +596,15 @@ public class FeatureStore
   protected void findNonNestedFeatures(long from, long to,
           List<SequenceFeature> result)
   {
+    /*
+     * find the first feature whose end position is
+     * after the target range start
+     */
     int startIndex = binarySearch(nonNestedFeatures,
             SearchCriterion.byEnd(from));
 
-    findNonNestedFeatures(startIndex, from, to, result);
-  }
-
-  /**
-   * Scans the list of non-nested features, starting from startIndex, to find
-   * those that overlap the from-to range, and adds them to the result list.
-   * Returns the index of the first feature whose start position is after the
-   * target range (or the length of the whole list if none such feature exists).
-   * 
-   * @param startIndex
-   * @param from
-   * @param to
-   * @param result
-   * @return
-   */
-  protected int findNonNestedFeatures(final int startIndex, long from,
-          long to, List<SequenceFeature> result)
-  {
-    int i = startIndex;
+    final int startIndex1 = startIndex;
+    int i = startIndex1;
     while (i < nonNestedFeatures.size())
     {
       SequenceFeature sf = nonNestedFeatures.get(i);
@@ -581,15 +612,12 @@ public class FeatureStore
       {
         break;
       }
-      int start = sf.getBegin();
-      int end = sf.getEnd();
-      if (start <= to && end >= from)
+      if (sf.getBegin() <= to && sf.getEnd() >= from)
       {
         result.add(sf);
       }
       i++;
     }
-    return i;
   }
 
   /**