JAL-2446 added contains, delete, checks for inclusion on add + tests

[jalview.git] / src / jalview / datamodel / features / SequenceFeatures.java

diff --git a/src/jalview/datamodel/features/SequenceFeatures.java b/src/jalview/datamodel/features/SequenceFeatures.java
index c947407..64aa63e 100644 (file)
--- a/src/jalview/datamodel/features/SequenceFeatures.java
+++ b/src/jalview/datamodel/features/SequenceFeatures.java
@@ -34,11 +34,14 @@ public class SequenceFeatures
   }
 
   /**
-   * Add one sequence feature to the store
+   * Adds one sequence feature to the store, and returns true, unless the
+   * feature is already contained in the store, in which case this method
+   * returns false. Containment is determined by SequenceFeature.equals()
+   * comparison.
    * 
    * @param sf
    */
-  public void add(SequenceFeature sf)
+  public boolean add(SequenceFeature sf)
   {
     String type = sf.getType();
 
@@ -46,7 +49,7 @@ public class SequenceFeatures
     {
       featureStore.put(type, new FeatureStore());
     }
-    featureStore.get(type).addFeature(sf);
+    return featureStore.get(type).addFeature(sf);
   }
 
   /**
@@ -167,4 +170,24 @@ public class SequenceFeatures
     }
     return result;
   }
+
+  /**
+   * Deletes the given feature from the store, returning true if it was found
+   * (and deleted), else false. This method makes no assumption that the feature
+   * is in the 'expected' place in the store, in case it has been modified since
+   * it was added.
+   * 
+   * @param sf
+   */
+  public boolean delete(SequenceFeature sf)
+  {
+    for (FeatureStore featureSet : featureStore.values())
+    {
+      if (featureSet.delete(sf))
+      {
+        return true;
+      }
+    }
+    return false;
+  }
 }