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