src/jalview/api/analysis/DistanceModelI.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.api.analysis;
  22
  23 import jalview.datamodel.AlignmentView;
  24
  25 /**
  26  * An interface that describes classes that can compute distances between pairs
  27  * of sequences in an alignment
  28  */
  29 public interface DistanceModelI
  30 {
  31
  32   float[][] findDistances(AlignmentView seqData);
  33
  34   String getName();
  35
  36   /**
  37    * Answers true if this model is applicable for nucleotide data (so should be
  38    * shown in menus in that context)
  39    *
  40    * @return
  41    */
  42   boolean isDNA();
  43
  44   /**
  45    * Answers true if this model is applicable for peptide data (so should be
  46    * shown in menus in that context)
  47    *
  48    * @return
  49    */
  50   boolean isProtein();
  51
  52 }