Merge branch 'documentation/JAL-2675_release2102b1' into releases/Release_2_10_2b1_Branch

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

diff --git a/src/jalview/datamodel/Mapping.java b/src/jalview/datamodel/Mapping.java
index bd83fe9..fe396ce 100644 (file)
--- a/src/jalview/datamodel/Mapping.java
+++ b/src/jalview/datamodel/Mapping.java
@@ -20,6 +20,7 @@
  */
 package jalview.datamodel;
 
+import jalview.util.Comparison;
 import jalview.util.MapList;
 
 import java.util.Iterator;
@@ -181,8 +182,8 @@ public class Mapping
       }
       if (!toRanges.hasNext())
       {
-        throw new NoSuchElementException("Ran out of peptide at position "
-                + toPosition);
+        throw new NoSuchElementException(
+                "Ran out of peptide at position " + toPosition);
       }
       currentToRange = toRanges.next();
       toPosition = currentToRange[0];
@@ -258,7 +259,8 @@ public class Mapping
       int truePos = sequencePos - (start - 1);
       while (alignedBases < truePos && alignedColumn < alignedSeq.length)
       {
-        if (alignedSeq[alignedColumn++] != gap)
+        char c = alignedSeq[alignedColumn++];
+        if (c != gap && !Comparison.isGap(c))
         {
           alignedBases++;
         }
@@ -274,18 +276,23 @@ public class Mapping
 
   }
 
-  /**
+  /*
    * Contains the start-end pairs mapping from the associated sequence to the
    * sequence in the database coordinate system. It also takes care of step
    * difference between coordinate systems.
    */
   MapList map = null;
 
-  /**
+  /*
    * The sequence that map maps the associated sequence to (if any).
    */
   SequenceI to = null;
 
+  /*
+   * optional sequence id for the 'from' ranges
+   */
+  private String mappedFromId;
+
   public Mapping(MapList map)
   {
     super();
@@ -333,6 +340,7 @@ public class Mapping
         map = new MapList(map2.map);
       }
       to = map2.to;
+      mappedFromId = map2.mappedFromId;
     }
   }
 
@@ -356,14 +364,13 @@ public class Mapping
   /**
    * Equals that compares both the to references and MapList mappings.
    * 
-   * @param other
+   * @param o
    * @return
+   * @see MapList#equals
    */
   @Override
   public boolean equals(Object o)
   {
-    // TODO should override Object.hashCode() to ensure that equal objects have
-    // equal hashcodes
     if (o == null || !(o instanceof Mapping))
     {
       return false;
@@ -390,6 +397,21 @@ public class Mapping
   }
 
   /**
+   * Returns a hashCode made from the sequence and maplist
+   */
+  @Override
+  public int hashCode()
+  {
+    int hashCode = (this.to == null ? 1 : this.to.hashCode());
+    if (this.map != null)
+    {
+      hashCode = hashCode * 31 + this.map.hashCode();
+    }
+
+    return hashCode;
+  }
+
+  /**
    * get the 'initial' position in the associated sequence for a position in the
    * mapped reference frame
    * 
@@ -665,8 +687,8 @@ public class Mapping
         to[f * 2] = r[0];
         to[f * 2 + 1] = r[1];
       }
-      copy.setMap(new MapList(from, to, map.getFromRatio(), map
-              .getToRatio()));
+      copy.setMap(
+              new MapList(from, to, map.getFromRatio(), map.getToRatio()));
     }
     return copy;
   }
@@ -713,7 +735,8 @@ public class Mapping
    * @param gapChar
    * @return
    */
-  public Iterator<AlignedCodon> getCodonIterator(SequenceI seq, char gapChar)
+  public Iterator<AlignedCodon> getCodonIterator(SequenceI seq,
+          char gapChar)
   {
     return new AlignedCodonIterator(seq, gapChar);
   }
@@ -724,8 +747,26 @@ public class Mapping
   @Override
   public String toString()
   {
-    return String.format("%s %s", this.map.toString(), this.to == null ? ""
-            : this.to.getName());
+    return String.format("%s %s", this.map.toString(),
+            this.to == null ? "" : this.to.getName());
+  }
+
+  /**
+   * Returns the identifier for the 'from' range sequence, or null if not set
+   * 
+   * @return
+   */
+  public String getMappedFromId()
+  {
+    return mappedFromId;
+  }
+
+  /**
+   * Sets the identifier for the 'from' range sequence
+   */
+  public void setMappedFromId(String mappedFromId)
+  {
+    this.mappedFromId = mappedFromId;
   }
 
 }