JAL-3397 impl.IntervalStore and nonc.IntervalStore unified api

[jalview.git] / src / jalview / datamodel / SequenceI.java

diff --git a/src/jalview/datamodel/SequenceI.java b/src/jalview/datamodel/SequenceI.java
index 57e4525..ca12c83 100755 (executable)
--- a/src/jalview/datamodel/SequenceI.java
+++ b/src/jalview/datamodel/SequenceI.java
@@ -20,8 +20,10 @@
  */
 package jalview.datamodel;
 
+import jalview.datamodel.Sequence.DBModList;
 import jalview.datamodel.features.SequenceFeaturesI;
 import jalview.util.MapList;
+import jalview.ws.params.InvalidArgumentException;
 
 import java.util.BitSet;
 import java.util.Iterator;
@@ -208,14 +210,17 @@ public interface SequenceI extends ASequenceI
   public int findPosition(int i);
 
   /**
-   * Returns the from-to sequence positions (start..) for the given column
-   * positions (1..), or null if no residues are included in the range
+   * Returns the sequence positions for first and last residues lying within the
+   * given column positions [fromColum,toColumn] (where columns are numbered
+   * from 1), or null if no residues are included in the range
    * 
    * @param fromColum
+   *          - first column base 1
    * @param toColumn
+   *          - last column, base 1
    * @return
    */
-  public Range findPositions(int fromColum, int toColumn);
+  public ContiguousI findPositions(int fromColum, int toColumn);
 
   /**
    * Returns an int array where indices correspond to each residue in the
@@ -352,14 +357,17 @@ public interface SequenceI extends ASequenceI
   /**
    * set the array of Database references for the sequence.
    * 
+   * BH 2019.02.04 changes param to DBModlist 
+   * 
    * @param dbs
    * @deprecated - use is discouraged since side-effects may occur if DBRefEntry
    *             set are not normalised.
+   * @throws InvalidArgumentException if the is not one created by Sequence itself
    */
   @Deprecated
-  public void setDBRefs(DBRefEntry[] dbs);
+  public void setDBRefs(DBModList<DBRefEntry> dbs);
 
-  public DBRefEntry[] getDBRefs();
+  public DBModList<DBRefEntry> getDBRefs();
 
   /**
    * add the given entry to the list of DBRefs for this sequence, or replace a
@@ -378,6 +386,12 @@ public interface SequenceI extends ASequenceI
    */
   public boolean addSequenceFeature(SequenceFeature sf);
 
+  /**
+   * Deletes the feature from the sequence (if found). To be precise, deletes
+   * the first feature {@code f} found where {@code f.equals(sf)}.
+   * 
+   * @param sf
+   */
   public void deleteFeature(SequenceFeature sf);
 
   public void setDatasetSequence(SequenceI seq);
@@ -575,4 +589,46 @@ public interface SequenceI extends ASequenceI
    * @return first residue not contained in regions
    */
   public int firstResidueOutsideIterator(Iterator<int[]> it);
+
+  /**
+   * @author Bob Hanson 2019.07.30
+   * 
+   * get a 4-byte color, with caching
+   * 
+   */
+  public int getColor(int i);
+
+  /**
+   * @author Bob Hanson 2019.07.30
+   * 
+   * set a 4-byte color, with caching
+   * 
+   */
+  public int setColor(int i, int argb);
+
+  /**
+   * @author Bob Hanson 2019.07.30
+   * 
+   * allows resetting the color cache
+   * 
+   */
+  public void resetColors();
+
+  /**
+   * Answers a (possibly empty) list of features of the specified type that
+   * overlap the specified column position. If parameter {@code result} is not
+   * null, features are appended to it and the (possibly extended) list is
+   * returned.
+   */
+  List<SequenceFeature> findFeatures(int column, String type,
+          List<SequenceFeature> result);
+
+  /**
+   * Answers true if this store contains at least one feature, else false
+   * 
+   * @return
+   */
+  public boolean hasFeatures(String type);
+
 }
+