JAL-2189 apply license
[jalview.git] / src / jalview / io / PDBFeatureSettings.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.io;
22
23 import jalview.api.FeatureColourI;
24 import jalview.schemes.FeatureColour;
25 import jalview.schemes.FeatureSettingsAdapter;
26
27 import java.awt.Color;
28
29 public class PDBFeatureSettings extends FeatureSettingsAdapter
30 {
31   // TODO find one central place to define feature names
32   private static final String FEATURE_INSERTION = "INSERTION";
33
34   private static final String FEATURE_RES_NUM = "RESNUM";
35
36   @Override
37   public boolean isFeatureDisplayed(String type)
38   {
39     return type.equalsIgnoreCase(FEATURE_INSERTION)
40             || type.equalsIgnoreCase(FEATURE_RES_NUM);
41   }
42
43   @Override
44   public FeatureColourI getFeatureColour(String type)
45   {
46     if (type.equalsIgnoreCase(FEATURE_INSERTION))
47     {
48       return new FeatureColour()
49       {
50
51         @Override
52         public Color getColour()
53         {
54           return Color.RED;
55         }
56       };
57     }
58     return null;
59   }
60
61   /**
62    * Order to render insertion after ResNum
63    */
64   @Override
65   public int compare(String feature1, String feature2)
66   {
67     if (feature1.equalsIgnoreCase(FEATURE_INSERTION))
68     {
69       return +1;
70     }
71     if (feature2.equalsIgnoreCase(FEATURE_INSERTION))
72     {
73       return -1;
74     }
75     if (feature1.equalsIgnoreCase(FEATURE_RES_NUM))
76     {
77       return +1;
78     }
79     if (feature2.equalsIgnoreCase(FEATURE_RES_NUM))
80     {
81       return -1;
82     }
83     return 0;
84   }
85 }