Merge branch 'mmw/bug/JAL-4241-annotation-alignment-fix-slivka' into development...

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

diff --git a/src/jalview/datamodel/SequenceI.java b/src/jalview/datamodel/SequenceI.java
index 15b61d2..82575ec 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;
@@ -46,6 +48,9 @@ public interface SequenceI extends ASequenceI
    */
   public void setName(String name);
 
+  public HiddenMarkovModel getHMM();
+
+  public void setHMM(HiddenMarkovModel hmm);
   /**
    * Get the display name
    */
@@ -96,6 +101,14 @@ public interface SequenceI extends ASequenceI
   public int getLength();
 
   /**
+   * Replace the sequence with the given characters
+   * 
+   * @param sequence
+   *          new sequence characters
+   */
+  public void setSequence(char[] sequence);
+
+  /**
    * Replace the sequence with the given string
    * 
    * @param sequence
@@ -213,10 +226,10 @@ public interface SequenceI extends ASequenceI
    * from 1), or null if no residues are included in the range
    * 
    * @param fromColum
-   *          - first column base 1
+   *          - first column base 1. (0 and negative positions are rounded up)
    * @param toColumn
    *          - last column, base 1
-   * @return
+   * @return null if fromColum>toColumn
    */
   public ContiguousI findPositions(int fromColum, int toColumn);
 
@@ -355,14 +368,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
@@ -388,6 +404,24 @@ public interface SequenceI extends ASequenceI
   public SequenceI getDatasetSequence();
 
   /**
+   * Returns the top grandparent in the dataset sequences hierarchy
+   * or null if there is no dataset associated with this sequence.
+   */
+  public default SequenceI getRootDatasetSequence()
+  {
+    if (getDatasetSequence() == null)
+    {
+      return null;
+    }
+    var sequence = getDatasetSequence();
+    while (sequence.getDatasetSequence() != null)
+    {
+      sequence = sequence.getDatasetSequence();
+    }
+    return sequence;
+  }
+
+  /**
    * Returns a new array containing this sequence's annotations, or null.
    */
   public AlignmentAnnotation[] getAnnotation();
@@ -441,6 +475,17 @@ public interface SequenceI extends ASequenceI
           String label);
 
   /**
+   * Returns a (possibly empty) list of any annotations that match on given
+   * calcId (source), label (type) and description (observation instance).
+   * Null values do not match.
+   * 
+   * @param calcId
+   * @param label
+   * @param description
+   */
+  public List<AlignmentAnnotation> getAlignmentAnnotations(String calcId,
+          String label, String description);
+  /**
    * create a new dataset sequence (if necessary) for this sequence and sets
    * this sequence to refer to it. This call will move any features or
    * references on the sequence onto the dataset. It will also make a duplicate
@@ -499,6 +544,11 @@ public interface SequenceI extends ASequenceI
    *         list
    */
   public List<DBRefEntry> getPrimaryDBRefs();
+  /**
+   * Answers true if the sequence has annotation for Hidden Markov Model
+   * information content, else false
+   */
+  boolean hasHMMAnnotation();
 
   /**
    * Returns a (possibly empty) list of sequence features that overlap the given
@@ -578,4 +628,13 @@ public interface SequenceI extends ASequenceI
    * @return first residue not contained in regions
    */
   public int firstResidueOutsideIterator(Iterator<int[]> it);
+
+
+  /**
+   * Answers true if this sequence has an associated Hidden Markov Model
+   * 
+   * @return
+   */
+  boolean hasHMMProfile();
 }
+