JAL-1641 docs for ComplexAlignFile interface
[jalview.git] / src / jalview / api / ComplexAlignFile.java
1 package jalview.api;
2
3 import jalview.datamodel.ColumnSelection;
4 import jalview.datamodel.SequenceI;
5 import jalview.schemes.ColourSchemeI;
6
7 /**
8  * This interface should be implemented by complex file parser with the ability
9  * to store linked data and complex view states in addition to alingment data
10  * 
11  * @author tcnofoegbu
12  *
13  */
14 public interface ComplexAlignFile
15 {
16   /**
17    * Determines if Sequence features should be shown
18    * 
19    * @return
20    */
21   public boolean isShowSeqFeatures();
22
23   /**
24    * Obtains the colour scheme from a complex file parser
25    * 
26    * @return
27    */
28   public ColourSchemeI getColourScheme();
29
30   /**
31    * Retrieves the Column selection/hidden column from a complex file parser
32    * 
33    * @return
34    */
35   public ColumnSelection getColumnSelection();
36
37   /**
38    * Retrieves hidden sequences from a complex file parser
39    * 
40    * @return
41    */
42   public SequenceI[] getHiddenSequences();
43
44 }