JAL-3187 basic first version for tooltips only (rendering yet to do)
[jalview.git] / src / jalview / viewmodel / seqfeatures / FeatureRendererModel.java
index 4797675..1f69776 100644 (file)
@@ -26,11 +26,11 @@ import jalview.api.FeaturesDisplayedI;
 import jalview.datamodel.AlignmentI;
 import jalview.datamodel.SequenceFeature;
 import jalview.datamodel.SequenceI;
+import jalview.datamodel.features.FeatureMatcherSetI;
 import jalview.datamodel.features.SequenceFeatures;
 import jalview.renderer.seqfeatures.FeatureRenderer;
 import jalview.schemes.FeatureColour;
 import jalview.util.ColorUtils;
-import jalview.util.matcher.KeyedMatcherSetI;
 
 import java.awt.Color;
 import java.beans.PropertyChangeListener;
@@ -50,16 +50,27 @@ public abstract class FeatureRendererModel
         implements jalview.api.FeatureRenderer
 {
   /*
-   * column indices of fields in Feature Settings table
-   * todo: transfer valuers as data beans instead of Object[][]
+   * a data bean to hold one row of feature settings from the gui
    */
-  public static final int TYPE_COLUMN = 0;
+  public static class FeatureSettingsBean
+  {
+    public final String featureType;
+
+    public final FeatureColourI featureColour;
 
-  public static final int COLOUR_COLUMN = 1;
+    public final FeatureMatcherSetI filter;
 
-  public static final int FILTER_COLUMN = 2;
+    public final Boolean show;
 
-  public static final int SHOW_COLUMN = 3;
+    public FeatureSettingsBean(String type, FeatureColourI colour,
+            FeatureMatcherSetI theFilter, Boolean isShown)
+    {
+      featureType = type;
+      featureColour = colour;
+      filter = theFilter;
+      show = isShown;
+    }
+  }
 
   /*
    * global transparency for feature
@@ -79,7 +90,7 @@ public abstract class FeatureRendererModel
   /*
    * filters for each feature type
    */
-  protected Map<String, KeyedMatcherSetI> featureFilters = new HashMap<>();
+  protected Map<String, FeatureMatcherSetI> featureFilters = new HashMap<>();
 
   protected String[] renderOrder;
 
@@ -309,12 +320,12 @@ public abstract class FeatureRendererModel
             visibleTypes);
 
     /*
-     * include features unless their feature group is not displayed, or
-     * they are hidden (have no colour) based on a filter or colour threshold
+     * include features unless they are hidden (have no colour), based on 
+     * feature group visibility, or a filter or colour threshold
      */
     for (SequenceFeature sf : features)
     {
-      if (!featureGroupNotShown(sf) && getColour(sf) != null)
+      if (getColour(sf) != null)
       {
         result.add(sf);
       }
@@ -673,26 +684,27 @@ public abstract class FeatureRendererModel
    * Replace current ordering with new ordering
    * 
    * @param data
-   *          { String(Type), Colour(Type), Boolean(Displayed) }
+   *          an array of { Type, Colour, Filter, Boolean }
    * @return true if any visible features have been reordered, else false
    */
-  public boolean setFeaturePriority(Object[][] data)
+  public boolean setFeaturePriority(FeatureSettingsBean[] data)
   {
     return setFeaturePriority(data, true);
   }
 
   /**
-   * Sets the priority order for features, with the highest priority (displayed
-   * on top) at the start of the data array
+   * Sets the priority order for features, with the highest priority (displayed on
+   * top) at the start of the data array
    * 
    * @param data
-   *          { String(Type), Colour(Type), Boolean(Displayed) }
+   *          an array of { Type, Colour, Filter, Boolean }
    * @param visibleNew
    *          when true current featureDisplay list will be cleared
-   * @return true if any visible features have been reordered or recoloured,
-   *         else false (i.e. no need to repaint)
+   * @return true if any visible features have been reordered or recoloured, else
+   *         false (i.e. no need to repaint)
    */
-  public boolean setFeaturePriority(Object[][] data, boolean visibleNew)
+  public boolean setFeaturePriority(FeatureSettingsBean[] data,
+          boolean visibleNew)
   {
     /*
      * note visible feature ordering and colours before update
@@ -731,9 +743,9 @@ public abstract class FeatureRendererModel
     {
       for (int i = 0; i < data.length; i++)
       {
-        String type = data[i][TYPE_COLUMN].toString();
-        setColour(type, (FeatureColourI) data[i][COLOUR_COLUMN]);
-        if (((Boolean) data[i][SHOW_COLUMN]).booleanValue())
+        String type = data[i].featureType;
+        setColour(type, data[i].featureColour);
+        if (data[i].show)
         {
           av_featuresdisplayed.setVisible(type);
         }
@@ -1020,16 +1032,24 @@ public abstract class FeatureRendererModel
    * Removes from the list of features any that duplicate the location of a
    * feature of the same type. Should be used only for features of the same,
    * simple, feature colour (which normally implies the same feature type). Does
-   * not check visibility settings for feature type or feature group.
+   * not check visibility settings for feature type or feature group. No
+   * filtering is done if transparency, or any feature filters, are in force.
    * 
    * @param features
    */
   public void filterFeaturesForDisplay(List<SequenceFeature> features)
   {
-    if (features.isEmpty())
+    /*
+     * don't remove 'redundant' features if 
+     * - transparency is applied (feature count affects depth of feature colour)
+     * - filters are applied (not all features may be displayable)
+     */
+    if (features.isEmpty() || transparency != 1f
+            || !featureFilters.isEmpty())
     {
       return;
     }
+
     SequenceFeatures.sortFeatures(features, true);
     SequenceFeature lastFeature = null;
 
@@ -1056,25 +1076,25 @@ public abstract class FeatureRendererModel
   }
 
   @Override
-  public Map<String, KeyedMatcherSetI> getFeatureFilters()
+  public Map<String, FeatureMatcherSetI> getFeatureFilters()
   {
-    return new HashMap<>(featureFilters);
+    return featureFilters;
   }
 
   @Override
-  public void setFeatureFilters(Map<String, KeyedMatcherSetI> filters)
+  public void setFeatureFilters(Map<String, FeatureMatcherSetI> filters)
   {
     featureFilters = filters;
   }
 
   @Override
-  public KeyedMatcherSetI getFeatureFilter(String featureType)
+  public FeatureMatcherSetI getFeatureFilter(String featureType)
   {
     return featureFilters.get(featureType);
   }
 
   @Override
-  public void setFeatureFilter(String featureType, KeyedMatcherSetI filter)
+  public void setFeatureFilter(String featureType, FeatureMatcherSetI filter)
   {
     if (filter == null || filter.isEmpty())
     {
@@ -1088,8 +1108,8 @@ public abstract class FeatureRendererModel
 
   /**
    * Answers the colour for the feature, or null if the feature is excluded by
-   * feature type or group visibility, by filters, or by colour threshold
-   * settings
+   * feature group visibility, by filters, or by colour threshold settings. This
+   * method does not take feature visibility into account.
    * 
    * @param sf
    * @param fc
@@ -1098,14 +1118,6 @@ public abstract class FeatureRendererModel
   public Color getColor(SequenceFeature sf, FeatureColourI fc)
   {
     /*
-     * is the feature type displayed?
-     */
-    if (!showFeatureOfType(sf.getType()))
-    {
-      return null;
-    }
-
-    /*
      * is the feature group displayed?
      */
     if (featureGroupNotShown(sf))
@@ -1134,14 +1146,8 @@ public abstract class FeatureRendererModel
    */
   protected boolean featureMatchesFilters(SequenceFeature sf)
   {
-    KeyedMatcherSetI filter = featureFilters.get(sf.getType());
-    // TODO temporary fudge for Score and Label
-    return filter == null ? true
-            : filter.matches(
-                    key -> "Label".equals(key[0]) ? sf.getDescription()
-                            : ("Score".equals(key[0])
-                                    ? String.valueOf(sf.getScore())
-                                    : sf.getValueAsString(key)));
+    FeatureMatcherSetI filter = featureFilters.get(sf.getType());
+    return filter == null ? true : filter.matches(sf);
   }
 
 }