JAL-1807 Bob's JalviewJS prototype first commit
[jalviewjs.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 Alignment data
10  * 
11  *
12  */
13 public interface ComplexAlignFile
14 {
15   /**
16    * Determines if Sequence features should be shown
17    * 
18    * @return
19    */
20   public boolean isShowSeqFeatures();
21
22   /**
23    * Obtains the colour scheme from a complex file parser
24    * 
25    * @return
26    */
27   public ColourSchemeI getColourScheme();
28
29   /**
30    * Retrieves the Column selection/hidden column from a complex file parser
31    * 
32    * @return
33    */
34   public ColumnSelection getColumnSelection();
35
36   /**
37    * Retrieves hidden sequences from a complex file parser
38    * 
39    * @return
40    */
41   public SequenceI[] getHiddenSequences();
42
43   /**
44    * Retrieves displayed features from a complex file parser
45    * 
46    * @return
47    */
48   public FeaturesDisplayedI getDisplayedFeatures();
49 }