src/jalview/api/AlignViewControllerI.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;
  22
  23 import java.util.List;
  24
  25 /**
  26  * prototype abstract controller for a Jalview alignment view
  27  *
  28  * @author jimp
  29  *
  30  *         All operations should return true if the view has changed as a result
  31  *         of the operation
  32  *
  33  *         The controller holds methods that operate on an alignment view,
  34  *         modifying its state in some way that may result in side effects
  35  *         reflected in an associated GUI
  36  *
  37  */
  38 public interface AlignViewControllerI
  39 {
  40
  41   public boolean makeGroupsFromSelection();
  42
  43   public boolean createGroup();
  44
  45   public boolean unGroup();
  46
  47   public boolean deleteGroups();
  48
  49   public void setViewportAndAlignmentPanel(AlignViewportI viewport,
  50           AlignmentViewPanel alignPanel);
  51
  52   /**
  53    * Mark columns in the current column selection according to positions of
  54    * sequence features
  55    *
  56    * @param invert
  57    *          - when set, mark all but columns containing given type
  58    * @param extendCurrent
  59    *          - when set, do not clear existing column selection
  60    * @param toggle
  61    *          - rather than explicitly set, toggle selection state
  62    * @param featureType
  63    *          - feature type string
  64    * @return true if operation affected state
  65    */
  66   boolean markColumnsContainingFeatures(boolean invert,
  67           boolean extendCurrent, boolean toggle, String featureType);
  68
  69   /**
  70    * sort the alignment or current selection by average score over the given set
  71    * of features
  72    *
  73    * @param typ
  74    *          list of feature names or null to use currently displayed features
  75    */
  76   void sortAlignmentByFeatureScore(List<String> typ);
  77
  78   /**
  79    * sort the alignment or current selection by distribution of the given set of
  80    * features
  81    *
  82    * @param typ
  83    *          list of feature names or null to use currently displayed features
  84    */
  85   void sortAlignmentByFeatureDensity(List<String> typ);
  86
  87   /**
  88    * add a features file of some kind to the current view
  89    *
  90    * @param file
  91    * @param protocol
  92    * @param relaxedIdMatching
  93    *          if true, try harder to match up IDs with local sequence data
  94    * @return true if parsing resulted in something being imported to the view or
  95    *         dataset
  96    */
  97   public boolean parseFeaturesFile(String file, String protocol,
  98           boolean relaxedIdMatching);
  99
 100 }