Merge branch 'documentation/JAL-3407_2.11.1_release' into releases/Release_2_11_1_Branch
[jalview.git] / src / jalview / datamodel / features / FeatureSourceI.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.datamodel.features;
22
23 public interface FeatureSourceI
24 {
25   /**
26    * Answers a name for the feature source (not necessarily unique)
27    * 
28    * @return
29    */
30   String getName();
31
32   /**
33    * Answers the 'long name' of an attribute given its id (short name or
34    * abbreviation), or null if not known
35    * 
36    * @param attributeId
37    * @return
38    */
39   String getAttributeName(String attributeId);
40
41   /**
42    * Sets the 'long name' of an attribute given its id (short name or
43    * abbreviation).
44    * 
45    * @param id
46    * @param name
47    */
48   void setAttributeName(String id, String name);
49
50   /**
51    * Answers the datatype of the attribute with given id, or null if not known
52    * 
53    * @param attributeId
54    * @return
55    */
56   FeatureAttributeType getAttributeType(String attributeId);
57
58   /**
59    * Sets the datatype of the attribute with given id
60    * 
61    * @param id
62    * @param type
63    */
64   void setAttributeType(String id, FeatureAttributeType type);
65 }