X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2Fjalview%2Fanalysis%2Fscoremodels%2FScoreModels.java;h=ebc9a26d0a0c9260f9f7b9ee16a2122aec2b886a;hb=7723baa88fa4f365c01e9f0ee9551e278219d2e5;hp=9af68d09b1a3eff6d9d3bcfab1e9e3ae62c2e67c;hpb=45e015aabe8f35a4a13be26e7630641ef8c94fbb;p=jalview.git
diff --git a/src/jalview/analysis/scoremodels/ScoreModels.java b/src/jalview/analysis/scoremodels/ScoreModels.java
index 9af68d0..ebc9a26 100644
--- a/src/jalview/analysis/scoremodels/ScoreModels.java
+++ b/src/jalview/analysis/scoremodels/ScoreModels.java
@@ -1,25 +1,62 @@
+/*
+ * 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 .
+ * 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;
import jalview.io.ScoreMatrixFile;
import java.io.IOException;
+import java.util.LinkedHashMap;
import java.util.Map;
-import java.util.TreeMap;
/**
* A class that can register and serve instances of ScoreModelI
*/
public class ScoreModels
{
- private static ScoreModels instance = new ScoreModels();
+ private final ScoreMatrix BLOSUM62;
+
+ private final ScoreMatrix PAM250;
+
+ private final ScoreMatrix DNA;
+
+ private static ScoreModels instance;
private Map models;
+ /**
+ * Answers the singleton instance of this class, with lazy initialisation
+ * (built-in score models are loaded on the first call to this method)
+ *
+ * @return
+ */
public static ScoreModels getInstance()
{
+ if (instance == null)
+ {
+ instance = new ScoreModels();
+ }
return instance;
}
@@ -29,52 +66,54 @@ public class ScoreModels
*
* - BLOSUM62
* - PAM250
+ * - PID
* - DNA
* - Sequence Feature Similarity
- * - Percentage Identity
*
*/
private ScoreModels()
{
/*
- * using TreeMap keeps models ordered alphabetically by name
+ * using LinkedHashMap keeps models ordered as added
*/
- models = new TreeMap(String.CASE_INSENSITIVE_ORDER);
- loadScoreMatrix("scoreModel/blosum62.scm");
- loadScoreMatrix("scoreModel/pam250.scm");
- loadScoreMatrix("scoreModel/dna.scm");
- registerScoreModel(new FeatureScoreModel());
- registerScoreModel(new PIDScoreModel());
+ models = new LinkedHashMap<>();
+ BLOSUM62 = loadScoreMatrix("scoreModel/blosum62.scm");
+ PAM250 = loadScoreMatrix("scoreModel/pam250.scm");
+ DNA = loadScoreMatrix("scoreModel/dna.scm");
+ registerScoreModel(new PIDModel());
+ 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;
}
/**
* Answers an iterable set of the registered score models. Currently these are
- * ordered by name (not case sensitive).
+ * returned in the order in which they were registered.
*
* @return
*/
@@ -83,9 +122,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)
@@ -97,4 +147,34 @@ public class ScoreModels
}
models.put(sm.getName(), sm);
}
+
+ /**
+ * Resets to just the built-in score models
+ */
+ public void reset()
+ {
+ instance = new ScoreModels();
+ }
+
+ /**
+ * Returns the default peptide or nucleotide score model, currently BLOSUM62
+ * or DNA
+ *
+ * @param forPeptide
+ * @return
+ */
+ public ScoreMatrix getDefaultModel(boolean forPeptide)
+ {
+ return forPeptide ? BLOSUM62 : DNA;
+ }
+
+ public ScoreMatrix getBlosum62()
+ {
+ return BLOSUM62;
+ }
+
+ public ScoreMatrix getPam250()
+ {
+ return PAM250;
+ }
}