JAL-3438 spotless for 2.11.2.0

[jalview.git] / src / jalview / api / FeatureRenderer.java

diff --git a/src/jalview/api/FeatureRenderer.java b/src/jalview/api/FeatureRenderer.java
index 59e3e61..5430303 100644 (file)
--- a/src/jalview/api/FeatureRenderer.java
+++ b/src/jalview/api/FeatureRenderer.java
@@ -20,6 +20,7 @@
  */
 package jalview.api;
 
+import jalview.datamodel.MappedFeatures;
 import jalview.datamodel.SequenceFeature;
 import jalview.datamodel.SequenceI;
 import jalview.datamodel.features.FeatureMatcherSetI;
@@ -150,15 +151,16 @@ public interface FeatureRenderer
 
   /**
    * Returns visible features at the specified aligned column on the given
-   * sequence. Non-positional features are not included. If the column has a gap,
-   * then enclosing features are included (but not contact features).
+   * sequence. Non-positional features are not included. If the column has a
+   * gap, then enclosing features are included (but not contact features).
    * 
    * @param sequence
    * @param column
    *          aligned column position (1..)
    * @return
    */
-  List<SequenceFeature> findFeaturesAtColumn(SequenceI sequence, int column);
+  List<SequenceFeature> findFeaturesAtColumn(SequenceI sequence,
+          int column);
 
   /**
    * Returns features at the specified residue positions on the given sequence.
@@ -268,4 +270,40 @@ public interface FeatureRenderer
    * @return
    */
   Color getColour(SequenceFeature feature);
+
+  /**
+   * Answers true if feature would be shown, else false. A feature is shown if
+   * <ul>
+   * <li>its feature type is set to visible</li>
+   * <li>its feature group is either null, or set to visible</li>
+   * <li>it is not excluded by a colour threshold on score or other numeric
+   * attribute</li>
+   * <li>it is not excluded by a filter condition</li>
+   * </ul>
+   * 
+   * @param feature
+   * @return
+   */
+  boolean isVisible(SequenceFeature feature);
+
+  /**
+   * Answers a bean containing a mapping, and a list of visible features in this
+   * alignment at a position (or range) which is mappable from the given
+   * sequence residue position in a mapped alignment. Features are returned in
+   * render order of feature type (on top last), with order within feature type
+   * undefined. If no features or mapping are found, answers null.
+   * 
+   * @param sequence
+   * @param pos
+   * @return
+   */
+  MappedFeatures findComplementFeaturesAtResidue(SequenceI sequence,
+          int pos);
+
+  /**
+   * Sends a message to let any registered parties know that something about
+   * feature rendering has changed
+   */
+  void notifyFeaturesChanged();
+
 }