JAL-2480 cache min-max score values per sequence and feature type
[jalview.git] / src / jalview / datamodel / features / SequenceFeatures.java
index a61eff2..c825761 100644 (file)
@@ -3,11 +3,12 @@ package jalview.datamodel.features;
 import jalview.datamodel.SequenceFeature;
 
 import java.util.ArrayList;
-import java.util.Collections;
+import java.util.Arrays;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
+import java.util.Map.Entry;
 import java.util.Set;
 
 /**
@@ -18,7 +19,7 @@ import java.util.Set;
  * @author gmcarstairs
  *
  */
-public class SequenceFeatures
+public class SequenceFeatures implements SequenceFeaturesI
 {
 
   /*
@@ -36,13 +37,9 @@ public class SequenceFeatures
   }
 
   /**
-   * 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
+   * {@inheritDoc}
    */
+  @Override
   public boolean add(SequenceFeature sf)
   {
     String type = sf.getType();
@@ -55,132 +52,155 @@ public class SequenceFeatures
   }
 
   /**
-   * Returns a (possibly empty) list of features of the given type which overlap
-   * the (inclusive) sequence position range
-   * 
-   * @param type
-   * @param from
-   * @param to
-   * @return
+   * {@inheritDoc}
    */
-  public List<SequenceFeature> findFeatures(String type, int from,
-          int to)
+  @Override
+  public List<SequenceFeature> findFeatures(int from, int to,
+          String... type)
   {
-    FeatureStore features = featureStore.get(type);
-    if (features == null)
+    List<SequenceFeature> result = new ArrayList<SequenceFeature>();
+
+    for (String featureType : varargToTypes(type))
     {
-      return Collections.emptyList();
+      FeatureStore features = featureStore.get(featureType);
+      if (features != null)
+      {
+        result.addAll(features.findOverlappingFeatures(from, to));
+      }
     }
-    return features.findOverlappingFeatures(from, to);
+
+    return result;
   }
 
   /**
-   * Answers a list of all features stored (including non-positional), in no
-   * particular guaranteed order
-   * 
-   * @return
+   * {@inheritDoc}
    */
-  public List<SequenceFeature> getFeatures()
+  @Override
+  public List<SequenceFeature> getAllFeatures(String... type)
   {
     List<SequenceFeature> result = new ArrayList<SequenceFeature>();
-    for (FeatureStore featureSet : featureStore.values())
-    {
-      result.addAll(featureSet.getFeatures());
-    }
+
+    result.addAll(getPositionalFeatures(type));
+
+    result.addAll(getNonPositionalFeatures(type));
+
     return result;
   }
 
   /**
-   * Answers a list of all non-positional features stored, in no particular
-   * guaranteed order
-   * 
-   * @return
+   * {@inheritDoc}
    */
-  public List<SequenceFeature> getNonPositionalFeatures()
+  @Override
+  public int getFeatureCount(boolean positional, String... type)
   {
-    List<SequenceFeature> result = new ArrayList<SequenceFeature>();
-    for (FeatureStore featureSet : featureStore.values())
+    int result = 0;
+
+    for (String featureType : varargToTypes(type))
     {
-      result.addAll(featureSet.getNonPositionalFeatures());
+      FeatureStore featureSet = featureStore.get(featureType);
+      if (featureSet != null)
+      {
+        result += featureSet.getFeatureCount(positional);
+      }
     }
     return result;
   }
 
   /**
-   * Answers a list of all contact features stored, in no particular guaranteed
-   * order
-   * 
-   * @return
+   * {@inheritDoc}
    */
-  public List<SequenceFeature> getContactFeatures()
+  @Override
+  public int getTotalFeatureLength(String... type)
   {
-    List<SequenceFeature> result = new ArrayList<SequenceFeature>();
-    for (FeatureStore featureSet : featureStore.values())
+    int result = 0;
+
+    for (String featureType : varargToTypes(type))
     {
-      result.addAll(featureSet.getContactFeatures());
+      FeatureStore featureSet = featureStore.get(featureType);
+      if (featureSet != null)
+      {
+        result += featureSet.getTotalFeatureLength();
+      }
     }
     return result;
+
   }
 
   /**
-   * Answers a list of all features of the given type (including
-   * non-positional), in no particular guaranteed order
-   * 
-   * @return
+   * {@inheritDoc}
    */
-  public List<SequenceFeature> getFeatures(String type)
+  @Override
+  public List<SequenceFeature> getPositionalFeatures(String... type)
   {
     List<SequenceFeature> result = new ArrayList<SequenceFeature>();
-    FeatureStore featureSet = featureStore.get(type);
-    if (featureSet != null)
+
+    for (String featureType : varargToTypes(type))
     {
-      result.addAll(featureSet.getFeatures());
+      FeatureStore featureSet = featureStore.get(featureType);
+      if (featureSet != null)
+      {
+        result.addAll(featureSet.getPositionalFeatures());
+      }
     }
     return result;
   }
 
   /**
-   * Answers a list of all contact features of the given type, in no particular
-   * guaranteed order
+   * A convenience method that converts a vararg for feature types to an
+   * Iterable, replacing the value with the stored feature types if it is null
+   * or empty
    * 
+   * @param type
    * @return
    */
-  public List<SequenceFeature> getContactFeatures(String type)
+  protected Iterable<String> varargToTypes(String... type)
+  {
+    return type == null || type.length == 0 ? featureStore
+            .keySet() : Arrays.asList(type);
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  @Override
+  public List<SequenceFeature> getContactFeatures(String... type)
   {
     List<SequenceFeature> result = new ArrayList<SequenceFeature>();
-    FeatureStore featureSet = featureStore.get(type);
-    if (featureSet != null)
+
+    for (String featureType : varargToTypes(type))
     {
-      result.addAll(featureSet.getContactFeatures());
+      FeatureStore featureSet = featureStore.get(featureType);
+      if (featureSet != null)
+      {
+        result.addAll(featureSet.getContactFeatures());
+      }
     }
     return result;
   }
 
   /**
-   * Answers a list of all non-positional features of the given type, in no
-   * particular guaranteed order
-   * 
-   * @return
+   * {@inheritDoc}
    */
-  public List<SequenceFeature> getNonPositionalFeatures(String type)
+  @Override
+  public List<SequenceFeature> getNonPositionalFeatures(String... type)
   {
     List<SequenceFeature> result = new ArrayList<SequenceFeature>();
-    FeatureStore featureSet = featureStore.get(type);
-    if (featureSet != null)
+
+    for (String featureType : varargToTypes(type))
     {
-      result.addAll(featureSet.getNonPositionalFeatures());
+      FeatureStore featureSet = featureStore.get(featureType);
+      if (featureSet != null)
+      {
+        result.addAll(featureSet.getNonPositionalFeatures());
+      }
     }
     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
+   * {@inheritDoc}
    */
+  @Override
   public boolean delete(SequenceFeature sf)
   {
     for (FeatureStore featureSet : featureStore.values())
@@ -194,10 +214,9 @@ public class SequenceFeatures
   }
 
   /**
-   * Answers true if this store contains at least one feature, else false
-   * 
-   * @return
+   * {@inheritDoc}
    */
+  @Override
   public boolean hasFeatures()
   {
     for (FeatureStore featureSet : featureStore.values())
@@ -211,18 +230,101 @@ public class SequenceFeatures
   }
 
   /**
-   * Returns a set of the distinct feature groups present in the collection. The
-   * set may include null.
-   * 
-   * @return
+   * {@inheritDoc}
    */
-  public Set<String> getFeatureGroups()
+  @Override
+  public Set<String> getFeatureGroups(boolean positionalFeatures,
+          String... type)
   {
     Set<String> groups = new HashSet<String>();
-    for (FeatureStore featureSet : featureStore.values())
+
+    Iterable<String> types = varargToTypes(type);
+
+    for (String featureType : types)
     {
-      groups.addAll(featureSet.getFeatureGroups());
+      FeatureStore featureSet = featureStore.get(featureType);
+      if (featureSet != null)
+      {
+        groups.addAll(featureSet.getFeatureGroups(positionalFeatures));
+      }
     }
+
     return groups;
   }
+
+  /**
+   * {@inheritDoc}
+   */
+  @Override
+  public Set<String> getFeatureTypesForGroups(boolean positionalFeatures,
+          String... groups)
+  {
+    Set<String> result = new HashSet<String>();
+
+    for (Entry<String, FeatureStore> featureType : featureStore.entrySet())
+    {
+      Set<String> featureGroups = featureType.getValue().getFeatureGroups(
+              positionalFeatures);
+      for (String group : groups)
+      {
+        if (featureGroups.contains(group))
+        {
+          /*
+           * yes this feature type includes one of the query groups
+           */
+          result.add(featureType.getKey());
+          break;
+        }
+      }
+    }
+
+    return result;
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  @Override
+  public Set<String> getFeatureTypes()
+  {
+    Set<String> types = new HashSet<String>();
+    for (Entry<String, FeatureStore> entry : featureStore.entrySet())
+    {
+      if (!entry.getValue().isEmpty())
+      {
+        types.add(entry.getKey());
+      }
+    }
+    return types;
+  }
+
+  /**
+   * Answers the minimum score held for positional or non-positional features
+   * for the specified type. This may be Float.NaN if there are no features, or
+   * none has a non-NaN score.
+   * 
+   * @param type
+   * @param positional
+   * @return
+   */
+  public float getMinimumScore(String type, boolean positional)
+  {
+    return featureStore.containsKey(type) ? featureStore.get(type)
+            .getMinimumScore(positional) : Float.NaN;
+  }
+
+  /**
+   * Answers the maximum score held for positional or non-positional features
+   * for the specified type. This may be Float.NaN if there are no features, or
+   * none has a non-NaN score.
+   * 
+   * @param type
+   * @param positional
+   * @return
+   */
+  public float getMaximumScore(String type, boolean positional)
+  {
+    return featureStore.containsKey(type) ? featureStore.get(type)
+            .getMaximumScore(positional) : Float.NaN;
+  }
 }