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