src/jalview/api/analysis/ScoreModelI.java

   1 package jalview.api.analysis;
   2
   3 public interface ScoreModelI
   4 {
   5   /**
   6    * Answers a name for the score model, suitable for display in menus. Names
   7    * should be unique across score models in use.
   8    *
   9    * @return
  10    * @see jalview.analysis.scoremodels.ScoreModels#forName(String)
  11    */
  12   String getName();
  13
  14   /**
  15    * Answers an informative description of the model, suitable for use in
  16    * tooltips. Descriptions may be internationalised, and need not be unique
  17    * (but should be).
  18    *
  19    * @return
  20    */
  21   String getDescription();
  22
  23   /**
  24    * Answers true if this model is applicable for nucleotide data (so should be
  25    * shown in menus in that context)
  26    *
  27    * @return
  28    */
  29   boolean isDNA();
  30
  31   /**
  32    * Answers true if this model is applicable for peptide data (so should be
  33    * shown in menus in that context)
  34    *
  35    * @return
  36    */
  37   boolean isProtein();
  38
  39   // TODO getName, isDNA, isProtein can be static methods in Java 8
  40 }