JAL-2738 use GeneLocus extends DBRefEntry to hold chromosomal mappings
[jalview.git] / src / jalview / datamodel / GeneLociI.java
1 package jalview.datamodel;
2
3 import jalview.util.MapList;
4
5 /**
6  * An interface to model one or more contiguous regions on one chromosome
7  */
8 public interface GeneLociI
9 {
10   /**
11    * Answers the species identifier
12    * 
13    * @return
14    */
15   String getSpeciesId();
16
17   /**
18    * Answers the reference assembly identifier
19    * 
20    * @return
21    */
22   String getAssemblyId();
23
24   /**
25    * Answers the chromosome identifier e.g. "2", "Y", "II"
26    * 
27    * @return
28    */
29   String getChromosomeId();
30
31   /**
32    * Answers the mapping from sequence to chromosome loci. For a reverse strand
33    * mapping, the chromosomal ranges will have start > end.
34    * 
35    * @return
36    */
37   MapList getMapping();
38 }