JAL-2416 add score model description field for tooltip in PCA panel

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

diff --git a/src/jalview/api/analysis/ScoreModelI.java b/src/jalview/api/analysis/ScoreModelI.java
index 4433cea..7352a71 100644 (file)
--- a/src/jalview/api/analysis/ScoreModelI.java
+++ b/src/jalview/api/analysis/ScoreModelI.java
@@ -12,6 +12,15 @@ public interface ScoreModelI
   String getName();
 
   /**
+   * Answers an informative description of the model, suitable for use in
+   * tooltips. Descriptions may be internationalised, and need not be unique
+   * (but should be).
+   * 
+   * @return
+   */
+  String getDescription();
+
+  /**
    * Answers true if this model is applicable for nucleotide data (so should be
    * shown in menus in that context)
    *