Merge branch 'feature/JAL-3187linkedFeatures' into feature/JAL-3251biotypedMappings
[jalview.git] / src / jalview / datamodel / AlignedCodonFrame.java
index a4b99bf..7845ddc 100644 (file)
@@ -34,88 +34,14 @@ import java.util.List;
 public class AlignedCodonFrame
 {
 
-  /*
-   * Data bean to hold mappings from one sequence to another
-   */
-  public class SequenceToSequenceMapping
-  {
-    private SequenceI fromSeq;
-
-    private Mapping mapping;
-
-    SequenceToSequenceMapping(SequenceI from, Mapping map)
-    {
-      this.fromSeq = from;
-      this.mapping = map;
-    }
-
-    /**
-     * Readable representation for debugging only, not guaranteed not to change
-     */
-    @Override
-    public String toString()
-    {
-      return String.format("From %s %s", fromSeq.getName(),
-              mapping.toString());
-    }
-
-    /**
-     * Returns a hashCode derived from the hashcodes of the mappings and fromSeq
-     * 
-     * @see SequenceToSequenceMapping#hashCode()
-     */
-    @Override
-    public int hashCode()
-    {
-      return (fromSeq == null ? 0 : fromSeq.hashCode() * 31)
-              + mapping.hashCode();
-    }
-
-    /**
-     * Answers true if the objects hold the same mapping between the same two
-     * sequences
-     * 
-     * @see Mapping#equals
-     */
-    @Override
-    public boolean equals(Object obj)
-    {
-      if (!(obj instanceof SequenceToSequenceMapping))
-      {
-        return false;
-      }
-      SequenceToSequenceMapping that = (SequenceToSequenceMapping) obj;
-      if (this.mapping == null)
-      {
-        return that.mapping == null;
-      }
-      // TODO: can simplify by asserting fromSeq is a dataset sequence
-      return (this.fromSeq == that.fromSeq || (this.fromSeq != null
-              && that.fromSeq != null
-              && this.fromSeq.getDatasetSequence() != null && this.fromSeq
-              .getDatasetSequence() == that.fromSeq
-              .getDatasetSequence())) && this.mapping.equals(that.mapping);
-    }
-
-    public SequenceI getFromSeq()
-    {
-      return fromSeq;
-    }
-
-    public Mapping getMapping()
-    {
-      return mapping;
-    }
-  }
-
-  private List<SequenceToSequenceMapping> mappings;
+  private List<SequenceMapping> mappings;
 
   /**
    * Constructor
    */
   public AlignedCodonFrame()
   {
-    mappings = new ArrayList<SequenceToSequenceMapping>();
+    mappings = new ArrayList<>();
   }
 
   /**
@@ -128,21 +54,36 @@ public class AlignedCodonFrame
    */
   public void addMap(SequenceI dnaseq, SequenceI aaseq, MapList map)
   {
+    addMap(dnaseq, aaseq, map, null);
+  }
+
+  /**
+   * Adds a mapping between the dataset sequences for the associated dna and
+   * protein sequence objects
+   * 
+   * @param dnaseq
+   * @param aaseq
+   * @param map
+   * @param mapFromId
+   */
+  public void addMap(SequenceI dnaseq, SequenceI aaseq, MapList map,
+          String mapFromId)
+  {
     // JBPNote DEBUG! THIS !
     // dnaseq.transferAnnotation(aaseq, mp);
     // aaseq.transferAnnotation(dnaseq, new Mapping(map.getInverse()));
 
     SequenceI fromSeq = (dnaseq.getDatasetSequence() == null) ? dnaseq
             : dnaseq.getDatasetSequence();
-    SequenceI toSeq = (aaseq.getDatasetSequence() == null) ? aaseq : aaseq
-            .getDatasetSequence();
+    SequenceI toSeq = (aaseq.getDatasetSequence() == null) ? aaseq
+            : aaseq.getDatasetSequence();
 
     /*
      * if we already hold a mapping between these sequences, just add to it 
      * note that 'adding' a duplicate map does nothing; this protects against
      * creating duplicate mappings in AlignedCodonFrame
      */
-    for (SequenceToSequenceMapping ssm : mappings)
+    for (SequenceMapping ssm : mappings)
     {
       if (ssm.fromSeq == fromSeq && ssm.mapping.to == toSeq)
       {
@@ -155,15 +96,16 @@ public class AlignedCodonFrame
      * otherwise, add a new sequence mapping
      */
     Mapping mp = new Mapping(toSeq, map);
-    mappings.add(new SequenceToSequenceMapping(fromSeq, mp));
+    mp.setMappedFromId(mapFromId);
+    mappings.add(new SequenceMapping(fromSeq, mp));
   }
 
   public SequenceI[] getdnaSeqs()
   {
     // TODO return a list instead?
     // return dnaSeqs;
-    List<SequenceI> seqs = new ArrayList<SequenceI>();
-    for (SequenceToSequenceMapping ssm : mappings)
+    List<SequenceI> seqs = new ArrayList<>();
+    for (SequenceMapping ssm : mappings)
     {
       seqs.add(ssm.fromSeq);
     }
@@ -173,8 +115,8 @@ public class AlignedCodonFrame
   public SequenceI[] getAaSeqs()
   {
     // TODO not used - remove?
-    List<SequenceI> seqs = new ArrayList<SequenceI>();
-    for (SequenceToSequenceMapping ssm : mappings)
+    List<SequenceI> seqs = new ArrayList<>();
+    for (SequenceMapping ssm : mappings)
     {
       seqs.add(ssm.mapping.to);
     }
@@ -183,8 +125,8 @@ public class AlignedCodonFrame
 
   public MapList[] getdnaToProt()
   {
-    List<MapList> maps = new ArrayList<MapList>();
-    for (SequenceToSequenceMapping ssm : mappings)
+    List<MapList> maps = new ArrayList<>();
+    for (SequenceMapping ssm : mappings)
     {
       maps.add(ssm.mapping.map);
     }
@@ -193,8 +135,8 @@ public class AlignedCodonFrame
 
   public Mapping[] getProtMappings()
   {
-    List<Mapping> maps = new ArrayList<Mapping>();
-    for (SequenceToSequenceMapping ssm : mappings)
+    List<Mapping> maps = new ArrayList<>();
+    for (SequenceMapping ssm : mappings)
     {
       maps.add(ssm.mapping);
     }
@@ -208,16 +150,20 @@ public class AlignedCodonFrame
    * @param seq
    * @return
    */
-  public Mapping getMappingForSequence(SequenceI seq)
+  public Mapping getMappingForSequence(SequenceI seq, boolean cdsOnly)
   {
     SequenceI seqDs = seq.getDatasetSequence();
     seqDs = seqDs != null ? seqDs : seq;
 
-    for (SequenceToSequenceMapping ssm : mappings)
+    for (SequenceMapping ssm : mappings)
     {
       if (ssm.fromSeq == seqDs || ssm.mapping.to == seqDs)
       {
-        return ssm.mapping;
+        if (!cdsOnly || ssm.fromSeq.getName().startsWith("CDS")
+                || ssm.mapping.to.getName().startsWith("CDS"))
+        {
+          return ssm.mapping;
+        }
       }
     }
     return null;
@@ -233,7 +179,7 @@ public class AlignedCodonFrame
   public SequenceI getAaForDnaSeq(SequenceI dnaSeqRef)
   {
     SequenceI dnads = dnaSeqRef.getDatasetSequence();
-    for (SequenceToSequenceMapping ssm : mappings)
+    for (SequenceMapping ssm : mappings)
     {
       if (ssm.fromSeq == dnaSeqRef || ssm.fromSeq == dnads)
       {
@@ -251,7 +197,7 @@ public class AlignedCodonFrame
   public SequenceI getDnaForAaSeq(SequenceI aaSeqRef)
   {
     SequenceI aads = aaSeqRef.getDatasetSequence();
-    for (SequenceToSequenceMapping ssm : mappings)
+    for (SequenceMapping ssm : mappings)
     {
       if (ssm.mapping.to == aaSeqRef || ssm.mapping.to == aads)
       {
@@ -285,11 +231,11 @@ public class AlignedCodonFrame
    *          where highlighted regions go
    */
   public void markMappedRegion(SequenceI seq, int index,
-          SearchResults results)
+          SearchResultsI results)
   {
     int[] codon;
     SequenceI ds = seq.getDatasetSequence();
-    for (SequenceToSequenceMapping ssm : mappings)
+    for (SequenceMapping ssm : mappings)
     {
       if (ssm.fromSeq == seq || ssm.fromSeq == ds)
       {
@@ -340,7 +286,7 @@ public class AlignedCodonFrame
      */
     MapList ml = null;
     int i = 0;
-    for (SequenceToSequenceMapping ssm : mappings)
+    for (SequenceMapping ssm : mappings)
     {
       if (ssm.fromSeq == seq)
       {
@@ -367,7 +313,7 @@ public class AlignedCodonFrame
     /*
      * Search mapped protein ('to') sequences first.
      */
-    for (SequenceToSequenceMapping ssm : mappings)
+    for (SequenceMapping ssm : mappings)
     {
       if (ssm.fromSeq == seq || ssm.fromSeq == seq.getDatasetSequence())
       {
@@ -385,7 +331,7 @@ public class AlignedCodonFrame
     /*
      * Then try mapped dna sequences.
      */
-    for (SequenceToSequenceMapping ssm : mappings)
+    for (SequenceMapping ssm : mappings)
     {
       if (ssm.mapping.to == seq
               || ssm.mapping.to == seq.getDatasetSequence())
@@ -418,13 +364,13 @@ public class AlignedCodonFrame
   {
     SequenceI targetDs = target.getDatasetSequence() == null ? target
             : target.getDatasetSequence();
-    SequenceI queryDs = query.getDatasetSequence() == null ? query : query
-            .getDatasetSequence();
+    SequenceI queryDs = query.getDatasetSequence() == null ? query
+            : query.getDatasetSequence();
     if (targetDs == null || queryDs == null /*|| dnaToProt == null*/)
     {
       return null;
     }
-    for (SequenceToSequenceMapping ssm : mappings)
+    for (SequenceMapping ssm : mappings)
     {
       /*
        * try mapping from target to query
@@ -468,11 +414,12 @@ public class AlignedCodonFrame
   {
     MapList ml = null;
     SequenceI dnaSeq = null;
-    List<char[]> result = new ArrayList<char[]>();
+    List<char[]> result = new ArrayList<>();
 
-    for (SequenceToSequenceMapping ssm : mappings)
+    for (SequenceMapping ssm : mappings)
     {
-      if (ssm.mapping.to == protein)
+      if (ssm.mapping.to == protein
+              && ssm.mapping.getMap().getFromRatio() == 3)
       {
         ml = ssm.mapping.map;
         dnaSeq = ssm.fromSeq;
@@ -487,10 +434,11 @@ public class AlignedCodonFrame
          * Read off the mapped nucleotides (converting to position base 0)
          */
         codonPos = MappingUtils.flattenRanges(codonPos);
-        char[] dna = dnaSeq.getSequence();
         int start = dnaSeq.getStart();
-        result.add(new char[] { dna[codonPos[0] - start],
-            dna[codonPos[1] - start], dna[codonPos[2] - start] });
+        char c1 = dnaSeq.getCharAt(codonPos[0] - start);
+        char c2 = dnaSeq.getCharAt(codonPos[1] - start);
+        char c3 = dnaSeq.getCharAt(codonPos[2] - start);
+        result.add(new char[] { c1, c2, c3 });
       }
     }
     return result.isEmpty() ? null : result;
@@ -505,12 +453,12 @@ public class AlignedCodonFrame
    */
   public List<Mapping> getMappingsFromSequence(SequenceI seq)
   {
-    List<Mapping> result = new ArrayList<Mapping>();
-    List<SequenceI> related = new ArrayList<SequenceI>();
+    List<Mapping> result = new ArrayList<>();
+    List<SequenceI> related = new ArrayList<>();
     SequenceI seqDs = seq.getDatasetSequence();
     seqDs = seqDs != null ? seqDs : seq;
 
-    for (SequenceToSequenceMapping ssm : mappings)
+    for (SequenceMapping ssm : mappings)
     {
       final Mapping mapping = ssm.mapping;
       if (ssm.fromSeq == seqDs)
@@ -562,14 +510,15 @@ public class AlignedCodonFrame
    */
   protected int realiseWith(SequenceI seq, boolean doUpdate)
   {
-    SequenceI ds = seq.getDatasetSequence() != null ? seq
-            .getDatasetSequence() : seq;
+    SequenceI ds = seq.getDatasetSequence() != null
+            ? seq.getDatasetSequence()
+            : seq;
     int count = 0;
 
     /*
      * check for replaceable DNA ('map from') sequences
      */
-    for (SequenceToSequenceMapping ssm : mappings)
+    for (SequenceMapping ssm : mappings)
     {
       SequenceI dna = ssm.fromSeq;
       if (dna instanceof SequenceDummy
@@ -637,8 +586,8 @@ public class AlignedCodonFrame
     {
       int start = replacement.getStart();
       int end = replacement.getEnd();
-      boolean mappingOverlapsSequence = (mapStart >= start && mapStart <= end)
-              || (mapEnd >= start && mapEnd <= end);
+      boolean mappingOverlapsSequence = (mapStart >= start
+              && mapStart <= end) || (mapEnd >= start && mapEnd <= end);
       if (mappingOverlapsSequence)
       {
         return true;
@@ -662,7 +611,7 @@ public class AlignedCodonFrame
     }
     SequenceI ds = seq.getDatasetSequence();
 
-    for (SequenceToSequenceMapping ssm : mappings)
+    for (SequenceMapping ssm : mappings)
     /*
      * 'from' sequences
      */
@@ -702,8 +651,8 @@ public class AlignedCodonFrame
   }
 
   /**
-   * Returns the first mapping found that is from 'fromSeq' to 'toSeq', or null
-   * if none found
+   * Returns the first mapping found that is between 'fromSeq' and 'toSeq', or
+   * null if none found
    * 
    * @param fromSeq
    *          aligned or dataset sequence
@@ -713,12 +662,17 @@ public class AlignedCodonFrame
    */
   public Mapping getMappingBetween(SequenceI fromSeq, SequenceI toSeq)
   {
-    for (SequenceToSequenceMapping mapping : mappings)
+    SequenceI dssFrom = fromSeq.getDatasetSequence() == null ? fromSeq
+            : fromSeq.getDatasetSequence();
+    SequenceI dssTo = toSeq.getDatasetSequence() == null ? toSeq
+            : toSeq.getDatasetSequence();
+
+    for (SequenceMapping mapping : mappings)
     {
       SequenceI from = mapping.fromSeq;
       SequenceI to = mapping.mapping.to;
-      if ((from == fromSeq || from == fromSeq.getDatasetSequence())
-              && (to == toSeq || to == toSeq.getDatasetSequence()))
+      if ((from == dssFrom && to == dssTo)
+              || (from == dssTo && to == dssFrom))
       {
         return mapping.mapping;
       }
@@ -729,7 +683,7 @@ public class AlignedCodonFrame
   /**
    * Returns a hashcode derived from the list of sequence mappings
    * 
-   * @see SequenceToSequenceMapping#hashCode()
+   * @see SequenceMapping#hashCode()
    * @see AbstractList#hashCode()
    */
   @Override
@@ -754,7 +708,7 @@ public class AlignedCodonFrame
     return this.mappings.equals(((AlignedCodonFrame) obj).mappings);
   }
 
-  public List<SequenceToSequenceMapping> getMappings()
+  public List<SequenceMapping> getMappings()
   {
     return mappings;
   }