JAL-2050 make SequenceFeature.score final, adjust constructor calls

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

diff --git a/src/jalview/datamodel/SequenceFeature.java b/src/jalview/datamodel/SequenceFeature.java
index 627e1ae..045bbbd 100755 (executable)
--- a/src/jalview/datamodel/SequenceFeature.java
+++ b/src/jalview/datamodel/SequenceFeature.java
@@ -24,6 +24,7 @@ import jalview.datamodel.features.FeatureLocationI;
 
 import java.util.HashMap;
 import java.util.Map;
+import java.util.Map.Entry;
 import java.util.Vector;
 
 /**
@@ -34,6 +35,12 @@ import java.util.Vector;
  */
 public class SequenceFeature implements FeatureLocationI
 {
+  /*
+   * score value if none is set; preferably Float.Nan, but see
+   * JAL-2060 and JAL-2554 for a couple of blockers to that
+   */
+  private static final float NO_SCORE = 0f;
+
   private static final String STATUS = "status";
 
   private static final String STRAND = "STRAND";
@@ -63,7 +70,7 @@ public class SequenceFeature implements FeatureLocationI
 
   public final String featureGroup;
 
-  public float score;
+  public final float score;
 
   public String description;
 
@@ -84,114 +91,82 @@ public class SequenceFeature implements FeatureLocationI
    */
   public SequenceFeature(SequenceFeature cpy)
   {
-    this(cpy, cpy.getBegin(), cpy.getEnd(), cpy.getFeatureGroup());
-
-    score = cpy.score;
-    description = cpy.description;
-    if (cpy.otherDetails != null)
-    {
-      try
-      {
-        otherDetails = (Map<String, Object>) ((HashMap<String, Object>) cpy.otherDetails)
-                .clone();
-      } catch (Exception e)
-      {
-        // ignore
-      }
-    }
-    if (cpy.links != null && cpy.links.size() > 0)
-    {
-      links = new Vector<String>();
-      for (int i = 0, iSize = cpy.links.size(); i < iSize; i++)
-      {
-        links.addElement(cpy.links.elementAt(i));
-      }
-    }
-  }
-
-  /**
-   * Constructor including a Status value
-   * 
-   * @param type
-   * @param desc
-   * @param status
-   * @param begin
-   * @param end
-   * @param featureGroup
-   */
-  public SequenceFeature(String type, String desc, String status,
-          int begin, int end, String featureGroup)
-  {
-    this(type, desc, begin, end, featureGroup);
-    setStatus(status);
+    this(cpy, cpy.getBegin(), cpy.getEnd(), cpy.getFeatureGroup(), cpy
+            .getScore());
   }
 
   /**
    * Constructor
    * 
-   * @param type
-   * @param desc
-   * @param begin
-   * @param end
-   * @param featureGroup
+   * @param theType
+   * @param theDesc
+   * @param theBegin
+   * @param theEnd
+   * @param group
    */
-  SequenceFeature(String type, String desc, int begin, int end,
-          String featureGroup)
+  public SequenceFeature(String theType, String theDesc, int theBegin,
+          int theEnd, String group)
   {
-    this.type = type;
-    this.description = desc;
-    this.begin = begin;
-    this.end = end;
-    this.featureGroup = featureGroup;
+    this.type = theType;
+    this.description = theDesc;
+    this.begin = theBegin;
+    this.end = theEnd;
+    this.featureGroup = group;
+    this.score = NO_SCORE;
   }
 
   /**
    * Constructor including a score value
    * 
-   * @param type
-   * @param desc
-   * @param begin
-   * @param end
-   * @param score
-   * @param featureGroup
+   * @param theType
+   * @param theDesc
+   * @param theBegin
+   * @param theEnd
+   * @param theScore
+   * @param group
    */
-  public SequenceFeature(String type, String desc, int begin, int end,
-          float score, String featureGroup)
+  public SequenceFeature(String theType, String theDesc, int theBegin,
+          int theEnd, float theScore, String group)
   {
-    this(type, desc, begin, end, featureGroup);
-    this.score = score;
+    this.type = theType;
+    this.description = theDesc;
+    this.begin = theBegin;
+    this.end = theEnd;
+    this.featureGroup = group;
+    this.score = theScore;
   }
 
   /**
-   * A copy constructor that allows the begin and end positions and group to be
-   * modified
+   * A copy constructor that allows the value of final fields to be 'modified'
    * 
    * @param sf
    * @param newBegin
    * @param newEnd
    * @param newGroup
+   * @param newScore
    */
   public SequenceFeature(SequenceFeature sf, int newBegin, int newEnd,
-          String newGroup)
+          String newGroup, float newScore)
   {
-    this(sf.getType(), newBegin, newEnd, newGroup);
-  }
+    this(sf.getType(), sf.getDescription(), newBegin, newEnd, newScore,
+            newGroup);
 
-  /**
-   * Constructor that sets the final fields type, begin, end, group
-   * 
-   * @param theType
-   * @param theBegin
-   * @param theEnd
-   * @param theGroup
-   */
-  private SequenceFeature(String theType, int theBegin, int theEnd,
-          String theGroup)
-  {
-    type = theType;
-    begin = theBegin;
-    end = theEnd;
-    featureGroup = theGroup;
+    if (sf.otherDetails != null)
+    {
+      otherDetails = new HashMap<String, Object>();
+      for (Entry<String, Object> entry : sf.otherDetails.entrySet())
+      {
+        otherDetails.put(entry.getKey(), entry.getValue());
+      }
+    }
+    if (sf.links != null && sf.links.size() > 0)
+    {
+      links = new Vector<String>();
+      for (int i = 0, iSize = sf.links.size(); i < iSize; i++)
+      {
+        links.addElement(sf.links.elementAt(i));
+      }
+    }
   }
 
   /**
@@ -352,11 +327,6 @@ public class SequenceFeature implements FeatureLocationI
     return score;
   }
 
-  public void setScore(float value)
-  {
-    score = value;
-  }
-
   /**
    * Used for getting values which are not in the basic set. eg STRAND, PHASE
    * for GFF file