JAL-2403 JAL-1483 changes to ScoreModelI hierarchy and signatures to

[jalview.git] / src / jalview / api / analysis / ScoreModelI.java

diff --git a/src/jalview/api/analysis/ScoreModelI.java b/src/jalview/api/analysis/ScoreModelI.java
new file mode 100644 (file)
index 0000000..42f978c
--- /dev/null
+++ b/src/jalview/api/analysis/ScoreModelI.java
@@ -0,0 +1,33 @@
+package jalview.api.analysis;
+
+import jalview.datamodel.AlignmentView;
+import jalview.math.MatrixI;
+
+public interface ScoreModelI
+{
+  /**
+   * Answers a name for the score model, suitable for display in menus. Names
+   * should be unique across score models in use.
+   * 
+   * @return
+   * @see jalview.analysis.scoremodels.ScoreModels#forName(String)
+   */
+  String getName();
+
+  /**
+   * Answers true if this model is applicable for nucleotide data (so should be
+   * shown in menus in that context)
+   * 
+   * @return
+   */
+  boolean isDNA();
+
+  /**
+   * Answers true if this model is applicable for peptide data (so should be
+   * shown in menus in that context)
+   * 
+   * @return
+   */
+  boolean isProtein();
+
+}