JAL-2418 source formatting

[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 07840fc..ea7b30e 100644 (file)
--- a/src/jalview/analysis/scoremodels/ScoreModels.java
+++ b/src/jalview/analysis/scoremodels/ScoreModels.java
@@ -1,5 +1,6 @@
 package jalview.analysis.scoremodels;
 
+import jalview.api.AlignmentViewPanel;
 import jalview.api.analysis.ScoreModelI;
 import jalview.io.DataSourceType;
 import jalview.io.FileParse;
@@ -14,17 +15,14 @@ import java.util.Map;
  */
 public class ScoreModels
 {
-  /*
-   * constants for built-in score model names
-   * NB! these have to match names in loaded score matrix files
-   */
-  public static final String BLOSUM62 = "BLOSUM62";
+  private final ScoreMatrix BLOSUM62;
 
-  public static final String PAM250 = "PAM250";
+  private final ScoreMatrix PAM250;
 
-  public static final String DNA = "DNA";
+  private final ScoreMatrix DNA;
 
   private static ScoreModels instance = new ScoreModels();
+
   private Map<String, ScoreModelI> models;
 
   public static ScoreModels getInstance()
@@ -38,10 +36,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()
@@ -50,37 +47,38 @@ public class ScoreModels
      * using LinkedHashMap keeps models ordered as added
      */
     models = new LinkedHashMap<String, ScoreModelI>();
-    loadScoreMatrix("scoreModel/blosum62.scm");
-    loadScoreMatrix("scoreModel/pam250.scm");
-    loadScoreMatrix("scoreModel/seqspace.scm");
-    loadScoreMatrix("scoreModel/dna.scm");
-    registerScoreModel(new FeatureScoreModel());
-    registerScoreModel(new PIDScoreModel());
+    BLOSUM62 = loadScoreMatrix("scoreModel/blosum62.scm");
+    PAM250 = loadScoreMatrix("scoreModel/pam250.scm");
+    registerScoreModel(new PIDModel());
+    DNA = loadScoreMatrix("scoreModel/dna.scm");
+    registerScoreModel(new FeatureDistanceModel());
   }
 
   /**
-   * Try to load a score matrix from the given resource file, and if successful,
-   * register it. Answers true if successful, else false.
+   * Tries to load a score matrix from the given resource file, and if
+   * successful, registers it.
    * 
    * @param string
+   * @return
    */
-  boolean loadScoreMatrix(String resourcePath)
+  ScoreMatrix loadScoreMatrix(String resourcePath)
   {
     try
     {
       /*
        * 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 true;
+      return sm;
     } catch (IOException e)
     {
-      System.err.println("Error reading " + resourcePath + ": "
-              + e.getMessage());
+      System.err.println(
+              "Error reading " + resourcePath + ": " + e.getMessage());
     }
-    return false;
+    return null;
   }
 
   /**
@@ -94,9 +92,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)
@@ -116,9 +125,18 @@ public class ScoreModels
    * @param forPeptide
    * @return
    */
-  public PairwiseSeqScoreModel getDefaultModel(boolean forPeptide)
+  public ScoreMatrix getDefaultModel(boolean forPeptide)
+  {
+    return forPeptide ? BLOSUM62 : DNA;
+  }
+
+  public ScoreMatrix getBlosum62()
+  {
+    return BLOSUM62;
+  }
+
+  public ScoreMatrix getPam250()
   {
-    return (PairwiseSeqScoreModel) (forPeptide ? forName("BLOSUM62")
-            : forName("DNA"));
+    return PAM250;
   }
 }