src/jalview/api/ComplexAlignFile.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 jalview.datamodel.ColumnSelection;
  24 import jalview.datamodel.SequenceI;
  25 import jalview.schemes.ColourSchemeI;
  26
  27 /**
  28  * This interface should be implemented by complex file parser with the ability
  29  * to store linked data and complex view states in addition to Alignment data
  30  *
  31  *
  32  */
  33 public interface ComplexAlignFile
  34 {
  35   /**
  36    * Determines if Sequence features should be shown
  37    *
  38    * @return
  39    */
  40   public boolean isShowSeqFeatures();
  41
  42   /**
  43    * Obtains the colour scheme from a complex file parser
  44    *
  45    * @return
  46    */
  47   public ColourSchemeI getColourScheme();
  48
  49   /**
  50    * Retrieves the Column selection/hidden column from a complex file parser
  51    *
  52    * @return
  53    */
  54   public ColumnSelection getColumnSelection();
  55
  56   /**
  57    * Retrieves hidden sequences from a complex file parser
  58    *
  59    * @return
  60    */
  61   public SequenceI[] getHiddenSequences();
  62
  63   /**
  64    * Retrieves displayed features from a complex file parser
  65    *
  66    * @return
  67    */
  68   public FeaturesDisplayedI getDisplayedFeatures();
  69 }