Merge branch 'releases/Release_2_11_3_Branch'
[jalview.git] / src / jalview / datamodel / MappingType.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;
22
23 /**
24  * An enumeration of the kinds of mapping (from nucleotide or peptide, to
25  * nucleotide or peptide), and the corresponding word lengths
26  */
27 public enum MappingType
28 {
29   NucleotideToPeptide(3, 1)
30   {
31     @Override
32     public MappingType getInverse()
33     {
34       return PeptideToNucleotide;
35     }
36   },
37   PeptideToNucleotide(1, 3)
38   {
39     @Override
40     public MappingType getInverse()
41     {
42       return NucleotideToPeptide;
43     }
44   },
45   NucleotideToNucleotide(1, 1)
46   {
47     @Override
48     public MappingType getInverse()
49     {
50       return NucleotideToNucleotide;
51     }
52   },
53   PeptideToPeptide(1, 1)
54   {
55     @Override
56     public MappingType getInverse()
57     {
58       return PeptideToPeptide;
59     }
60   };
61
62   private int fromRatio;
63
64   private int toRatio;
65
66   private MappingType(int fromSize, int toSize)
67   {
68     fromRatio = fromSize;
69     toRatio = toSize;
70   }
71
72   public abstract MappingType getInverse();
73
74   public int getFromRatio()
75   {
76     return fromRatio;
77   }
78
79   public int getToRatio()
80   {
81     return toRatio;
82   }
83 }