JAL-2381 copy and paste sequence also copies contact matrix annotation

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

diff --git a/src/jalview/datamodel/SequenceI.java b/src/jalview/datamodel/SequenceI.java
index 15b61d2..2e1daa3 100755 (executable)
--- a/src/jalview/datamodel/SequenceI.java
+++ b/src/jalview/datamodel/SequenceI.java
@@ -20,15 +20,16 @@
  */
 package jalview.datamodel;
 
-import jalview.datamodel.features.SequenceFeaturesI;
-import jalview.util.MapList;
-
 import java.util.BitSet;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Vector;
 
 import fr.orsay.lri.varna.models.rna.RNA;
+import jalview.datamodel.Sequence.DBModList;
+import jalview.datamodel.features.SequenceFeaturesI;
+import jalview.util.MapList;
+import jalview.ws.params.InvalidArgumentException;
 
 /**
  * Methods for manipulating a sequence, its metadata and related annotation in
@@ -37,7 +38,7 @@ import fr.orsay.lri.varna.models.rna.RNA;
  * @author $author$
  * @version $Revision$
  */
-public interface SequenceI extends ASequenceI
+public interface SequenceI extends ASequenceI, ContactMapHolderI
 {
   /**
    * Set the display name for the sequence
@@ -355,14 +356,18 @@ 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
@@ -410,7 +415,7 @@ public interface SequenceI extends ASequenceI
   /**
    * Derive a sequence (using this one's dataset or as the dataset)
    * 
-   * @return duplicate sequence with valid dataset sequence
+   * @return duplicate sequence and any annotation present with valid dataset sequence
    */
   public SequenceI deriveSequence();
 
@@ -441,6 +446,18 @@ 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
@@ -514,7 +531,8 @@ public interface SequenceI extends ASequenceI
    *          optional feature types to restrict results to
    * @return
    */
-  List<SequenceFeature> findFeatures(int fromCol, int toCol, String... types);
+  List<SequenceFeature> findFeatures(int fromCol, int toCol,
+          String... types);
 
   /**
    * Method to call to indicate that the sequence (characters or alignment/gaps)
@@ -522,7 +540,7 @@ public interface SequenceI extends ASequenceI
    * positions to be invalidated.
    */
   void sequenceChanged();
-  
+
   /**
    * 
    * @return BitSet corresponding to index [0,length) where Comparison.isGap()
@@ -554,9 +572,8 @@ public interface SequenceI extends ASequenceI
    * @param chromosomeId
    * @param map
    */
-  void setGeneLoci(String speciesId, String assemblyId,
-          String chromosomeId, MapList map);
-
+  void setGeneLoci(String speciesId, String assemblyId, String chromosomeId,
+          MapList map);
 
   /**
    * Returns the sequence string constructed from the substrings of a sequence
@@ -578,4 +595,8 @@ public interface SequenceI extends ASequenceI
    * @return first residue not contained in regions
    */
   public int firstResidueOutsideIterator(Iterator<int[]> it);
+
+  public void addContactListFor(AlignmentAnnotation annotation,
+          ContactMatrixI cm);
+
 }