Merge branch 'features/pca_jaxb_datasetrefs_JAL-3171_JAL-3063_JAL-1767' into develop

[jalview.git] / src / jalview / analysis / scoremodels / ScoreModels.java

diff --git a/src/jalview/analysis/scoremodels/ScoreModels.java b/src/jalview/analysis/scoremodels/ScoreModels.java
index 41b99e2..3cbd5f1 100644 (file)
--- a/src/jalview/analysis/scoremodels/ScoreModels.java
+++ b/src/jalview/analysis/scoremodels/ScoreModels.java
@@ -1,5 +1,26 @@
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
 package jalview.analysis.scoremodels;
 
+import jalview.api.AlignmentViewPanel;
 import jalview.api.analysis.ScoreModelI;
 import jalview.io.DataSourceType;
 import jalview.io.FileParse;
@@ -35,10 +56,9 @@ public class ScoreModels
    * <ul>
    * <li>BLOSUM62</li>
    * <li>PAM250</li>
-   * <li>SeqSpace (identity matrix)</li>
+   * <li>PID</li>
    * <li>DNA</li>
    * <li>Sequence Feature Similarity</li>
-   * <li>Percentage Identity</li>
    * </ul>
    */
   private ScoreModels()
@@ -46,15 +66,12 @@ public class ScoreModels
     /*
      * using LinkedHashMap keeps models ordered as added
      */
-    models = new LinkedHashMap<String, ScoreModelI>();
+    models = new LinkedHashMap<>();
     BLOSUM62 = loadScoreMatrix("scoreModel/blosum62.scm");
     PAM250 = loadScoreMatrix("scoreModel/pam250.scm");
-    // loadScoreMatrix("scoreModel/seqspace.scm");
-    // drop seqspace.scm for IdentityScoreModel once JAL-2379 merged in?
-    registerScoreModel(new PIDModel());
     DNA = loadScoreMatrix("scoreModel/dna.scm");
+    registerScoreModel(new PIDModel());
     registerScoreModel(new FeatureDistanceModel());
-    registerScoreModel(new PIDDistanceModel());
   }
 
   /**
@@ -71,14 +88,15 @@ public class ScoreModels
       /*
        * delegate parsing to ScoreMatrixFile
        */
-      FileParse fp = new FileParse(resourcePath, DataSourceType.CLASSLOADER);
+      FileParse fp = new FileParse(resourcePath,
+              DataSourceType.CLASSLOADER);
       ScoreMatrix sm = new ScoreMatrixFile(fp).parseMatrix();
       registerScoreModel(sm);
       return sm;
     } catch (IOException e)
     {
-      System.err.println("Error reading " + resourcePath + ": "
-              + e.getMessage());
+      System.err.println(
+              "Error reading " + resourcePath + ": " + e.getMessage());
     }
     return null;
   }
@@ -94,9 +112,20 @@ public class ScoreModels
     return models.values();
   }
 
-  public ScoreModelI forName(String s)
+  /**
+   * Returns an instance of a score model for the given name. If the model is of
+   * 'view dependent' type (e.g. feature similarity), instantiates a new
+   * instance configured for the given view. Otherwise returns a cached instance
+   * of the score model.
+   * 
+   * @param name
+   * @param avp
+   * @return
+   */
+  public ScoreModelI getScoreModel(String name, AlignmentViewPanel avp)
   {
-    return models.get(s);
+    ScoreModelI model = models.get(name);
+    return model == null ? null : model.getInstance(avp);
   }
 
   public void registerScoreModel(ScoreModelI sm)