JAL-3621 corrected sequence feature sort and test
[jalview.git] / src / jalview / datamodel / features / SequenceFeatures.java
index 8d5ba58..8ac4991 100644 (file)
@@ -1,14 +1,27 @@
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ * 
+ * This file is part of Jalview.
+ * 
+ * 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 Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
 package jalview.datamodel.features;
 
-import jalview.datamodel.ContiguousI;
-import jalview.datamodel.SequenceFeature;
-import jalview.io.gff.SequenceOntologyFactory;
-import jalview.io.gff.SequenceOntologyI;
-
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.Collections;
-import java.util.Comparator;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
@@ -16,6 +29,11 @@ import java.util.Map.Entry;
 import java.util.Set;
 import java.util.TreeMap;
 
+import intervalstore.api.IntervalI;
+import jalview.datamodel.SequenceFeature;
+import jalview.io.gff.SequenceOntologyFactory;
+import jalview.io.gff.SequenceOntologyI;
+
 /**
  * A class that stores sequence features in a way that supports efficient
  * querying by type and location (overlap). Intended for (but not limited to)
@@ -26,30 +44,6 @@ import java.util.TreeMap;
  */
 public class SequenceFeatures implements SequenceFeaturesI
 {
-  /**
-   * a comparator for sorting features by start position ascending
-   */
-  private static Comparator<ContiguousI> FORWARD_STRAND = new Comparator<ContiguousI>()
-  {
-    @Override
-    public int compare(ContiguousI o1, ContiguousI o2)
-    {
-      return Integer.compare(o1.getBegin(), o2.getBegin());
-    }
-  };
-
-  /**
-   * a comparator for sorting features by end position descending
-   */
-  private static Comparator<ContiguousI> REVERSE_STRAND = new Comparator<ContiguousI>()
-  {
-    @Override
-    public int compare(ContiguousI o1, ContiguousI o2)
-    {
-      return Integer.compare(o2.getEnd(), o1.getEnd());
-    }
-  };
-
   /*
    * map from feature type to structured store of features for that type
    * null types are permitted (but not a good idea!)
@@ -67,7 +61,7 @@ public class SequenceFeatures implements SequenceFeaturesI
      */
     // featureStore = Collections
     // .synchronizedSortedMap(new TreeMap<String, FeatureStore>());
-    featureStore = new TreeMap<String, FeatureStore>();
+    featureStore = new TreeMap<>();
   }
 
   /**
@@ -208,7 +202,9 @@ public class SequenceFeatures implements SequenceFeaturesI
 
   /**
    * A convenience method that converts a vararg for feature types to an
-   * Iterable over matched feature sets in key order
+   * Iterable over matched feature sets. If no types are specified, all feature
+   * sets are returned. If one or more types are specified, feature sets for
+   * those types are returned, preserving the order of the types.
    * 
    * @param type
    * @return
@@ -224,12 +220,11 @@ public class SequenceFeatures implements SequenceFeaturesI
     }
 
     List<FeatureStore> types = new ArrayList<>();
-    List<String> args = Arrays.asList(type);
-    for (Entry<String, FeatureStore> featureType : featureStore.entrySet())
+    for (String theType : type)
     {
-      if (args.contains(featureType.getKey()))
+      if (theType != null && featureStore.containsKey(theType))
       {
-        types.add(featureType.getValue());
+        types.add(featureStore.get(theType));
       }
     }
     return types;
@@ -362,9 +357,10 @@ public class SequenceFeatures implements SequenceFeaturesI
   }
 
   /**
-   * Answers true if the given type is one of the specified sequence ontology
-   * terms (or a sub-type of one), or if no terms are supplied. Answers false if
-   * filter terms are specified and the given term does not match any of them.
+   * Answers true if the given type matches one of the specified terms (or is a
+   * sub-type of one in the Sequence Ontology), or if no terms are supplied.
+   * Answers false if filter terms are specified and the given term does not
+   * match any of them.
    * 
    * @param type
    * @param soTerm
@@ -379,7 +375,7 @@ public class SequenceFeatures implements SequenceFeaturesI
     SequenceOntologyI so = SequenceOntologyFactory.getInstance();
     for (String term : soTerm)
     {
-      if (so.isA(type, term))
+      if (type.equals(term) || so.isA(type, term))
       {
         return true;
       }
@@ -414,11 +410,13 @@ public class SequenceFeatures implements SequenceFeaturesI
    * @param features
    * @param forwardStrand
    */
-  public static void sortFeatures(List<SequenceFeature> features,
+  public static void sortFeatures(List<? extends IntervalI> features,
           final boolean forwardStrand)
   {
-    Collections.sort(features, forwardStrand ? FORWARD_STRAND
-            : REVERSE_STRAND);
+    Collections.sort(features,
+            forwardStrand
+                    ? IntervalI.COMPARE_BEGIN_ASC_END_DESC
+                    : IntervalI.COMPARE_END_DESC);
   }
 
   /**
@@ -451,13 +449,22 @@ public class SequenceFeatures implements SequenceFeaturesI
    * {@inheritDoc}
    */
   @Override
-  public boolean shiftFeatures(int shift)
+  public boolean shiftFeatures(int fromPosition, int shiftBy)
   {
     boolean modified = false;
     for (FeatureStore fs : featureStore.values())
     {
-      modified |= fs.shiftFeatures(shift);
+      modified |= fs.shiftFeatures(fromPosition, shiftBy);
     }
     return modified;
   }
-}
\ No newline at end of file
+
+  /**
+   * {@inheritDoc}
+   */
+  @Override
+  public void deleteAll()
+  {
+    featureStore.clear();
+  }
+}