1b89cd1a1e26d058c5355147941808c8081a443f
[jalview.git] / Rna.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 /* Author: Lauren Michelle Lui 
22  * Methods are based on RALEE methods http://personalpages.manchester.ac.uk/staff/sam.griffiths-jones/software/ralee/
23  * Additional Author: Jan Engelhart (2011) - Structure consensus and bug fixing
24  * Additional Author: Anne Menard (2012) - Pseudoknot support and secondary structure consensus
25  * */
26
27 package jalview.analysis;
28
29 import jalview.analysis.SecStrConsensus.SimpleBP;
30 import jalview.datamodel.SequenceFeature;
31 import jalview.util.MessageManager;
32
33 import java.util.ArrayList;
34 import java.util.Arrays;
35 import java.util.HashSet;
36 import java.util.Hashtable;
37 import java.util.Stack;
38 import java.util.Vector;
39
40 public class Rna
41 {
42
43   static Hashtable<Integer, Integer> pairHash = new Hashtable();
44
45   private static final Character[] openingPars =
46   { '(', '[', '{', '<', 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J',
47       'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X',
48       'Y', 'Z' };
49
50   private static final Character[] closingPars =
51   { ')', ']', '}', '>', 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j',
52       'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x',
53       'y', 'z' };
54
55   private static HashSet<Character> openingParsSet = new HashSet<Character>(
56           Arrays.asList(openingPars));
57
58   private static HashSet<Character> closingParsSet = new HashSet<Character>(
59           Arrays.asList(closingPars));
60
61   private static Hashtable<Character, Character> closingToOpening = new Hashtable<Character, Character>()
62   // Initializing final data structure
63   {
64     private static final long serialVersionUID = 1L;
65     {
66       for (int i = 0; i < openingPars.length; i++)
67       {
68         // System.out.println(closingPars[i] + "->" + openingPars[i]);
69         put(closingPars[i], openingPars[i]);
70       }
71     }
72   };
73
74   private static boolean isOpeningParenthesis(char c)
75   {
76     return openingParsSet.contains(c);
77   }
78
79   private static boolean isClosingParenthesis(char c)
80   {
81     return closingParsSet.contains(c);
82   }
83
84   private static char matchingOpeningParenthesis(char closingParenthesis)
85           throws WUSSParseException
86   {
87     if (!isClosingParenthesis(closingParenthesis))
88     {
89       throw new WUSSParseException(MessageManager.formatMessage("exception.querying_matching_opening_parenthesis_for_non_closing_parenthesis", new String[]{new StringBuffer(closingParenthesis).toString()}), -1);
90     }
91
92     return closingToOpening.get(closingParenthesis);
93   }
94
95   /**
96    * Based off of RALEE code ralee-get-base-pairs. Keeps track of open bracket
97    * positions in "stack" vector. When a close bracket is reached, pair this
98    * with the last element in the "stack" vector and store in "pairs" vector.
99    * Remove last element in the "stack" vector. Continue in this manner until
100    * the whole string is processed.
101    * 
102    * @param line
103    *          Secondary structure line of an RNA Stockholm file
104    * @return Array of SequenceFeature; type = RNA helix, begin is open base
105    *         pair, end is close base pair
106    */
107   public static Vector<SimpleBP> GetSimpleBPs(CharSequence line)
108           throws WUSSParseException
109   {
110     Hashtable<Character, Stack<Integer>> stacks = new Hashtable<Character, Stack<Integer>>();
111     Vector<SimpleBP> pairs = new Vector<SimpleBP>();
112     int i = 0;
113     while (i < line.length())
114     {
115       char base = line.charAt(i);
116
117       if (isOpeningParenthesis(base))
118       {
119         if (!stacks.containsKey(base))
120         {
121           stacks.put(base, new Stack<Integer>());
122         }
123         stacks.get(base).push(i);
124
125       }
126       else if (isClosingParenthesis(base))
127       {
128
129         char opening = matchingOpeningParenthesis(base);
130
131         if (!stacks.containsKey(opening))
132         {
133           throw new WUSSParseException(MessageManager.formatMessage("exception.mismatched_unseen_closing_char", new String[]{new StringBuffer(base).toString()}), i);
134         }
135
136         Stack<Integer> stack = stacks.get(opening);
137         if (stack.isEmpty())
138         {
139           // error whilst parsing i'th position. pass back
140           throw new WUSSParseException(MessageManager.formatMessage("exception.mismatched_closing_char", new String[]{new StringBuffer(base).toString()}), i);
141         }
142         int temp = stack.pop();
143
144         pairs.add(new SimpleBP(temp, i));
145       }
146       i++;
147     }
148     for (char opening : stacks.keySet())
149     {
150       Stack<Integer> stack = stacks.get(opening);
151       if (!stack.empty())
152       {
153         throw new WUSSParseException(MessageManager.formatMessage("exception.mismatched_opening_char", new String[]{new StringBuffer(opening).toString(),Integer.valueOf(stack.pop()).toString()}), i);
154       }
155     }
156     return pairs;
157   }
158
159   public static SequenceFeature[] GetBasePairs(CharSequence line)
160           throws WUSSParseException
161   {
162     Vector<SimpleBP> bps = GetSimpleBPs(line);
163     SequenceFeature[] outPairs = new SequenceFeature[bps.size()];
164     for (int p = 0; p < bps.size(); p++)
165     {
166       SimpleBP bp = bps.elementAt(p);
167       outPairs[p] = new SequenceFeature("RNA helix", "", "", bp.getBP5(),
168               bp.getBP3(), "");
169     }
170     return outPairs;
171   }
172
173   public static ArrayList<SimpleBP> GetModeleBP(CharSequence line)
174           throws WUSSParseException
175   {
176     Vector<SimpleBP> bps = GetSimpleBPs(line);
177     return new ArrayList<SimpleBP>(bps);
178   }
179
180   /**
181    * Function to get the end position corresponding to a given start position
182    * 
183    * @param indice
184    *          - start position of a base pair
185    * @return - end position of a base pair
186    */
187   /*
188    * makes no sense at the moment :( public int findEnd(int indice){ //TODO:
189    * Probably extend this to find the start to a given end? //could be done by
190    * putting everything twice to the hash ArrayList<Integer> pair = new
191    * ArrayList<Integer>(); return pairHash.get(indice); }
192    */
193
194   /**
195    * Figures out which helix each position belongs to and stores the helix
196    * number in the 'featureGroup' member of a SequenceFeature Based off of RALEE
197    * code ralee-helix-map.
198    * 
199    * @param pairs
200    *          Array of SequenceFeature (output from Rna.GetBasePairs)
201    */
202   public static void HelixMap(SequenceFeature[] pairs)
203   {
204
205     int helix = 0; // Number of helices/current helix
206     int lastopen = 0; // Position of last open bracket reviewed
207     int lastclose = 9999999; // Position of last close bracket reviewed
208     int i = pairs.length; // Number of pairs
209
210     int open; // Position of an open bracket under review
211     int close; // Position of a close bracket under review
212     int j; // Counter
213
214     Hashtable helices = new Hashtable(); // Keep track of helix number for each
215                                          // position
216
217     // Go through each base pair and assign positions a helix
218     for (i = 0; i < pairs.length; i++)
219     {
220
221       open = pairs[i].getBegin();
222       close = pairs[i].getEnd();
223
224       // System.out.println("open " + open + " close " + close);
225       // System.out.println("lastclose " + lastclose + " lastopen " + lastopen);
226
227       // we're moving from right to left based on closing pair
228       /*
229        * catch things like <<..>>..<<..>> |
230        */
231       if (open > lastclose)
232       {
233         helix++;
234       }
235
236       /*
237        * catch things like <<..<<..>>..<<..>>>> |
238        */
239       j = pairs.length - 1;
240       while (j >= 0)
241       {
242         int popen = pairs[j].getBegin();
243
244         // System.out.println("j " + j + " popen " + popen + " lastopen "
245         // +lastopen + " open " + open);
246         if ((popen < lastopen) && (popen > open))
247         {
248           if (helices.containsValue(popen)
249                   && (((Integer) helices.get(popen)) == helix))
250           {
251             continue;
252           }
253           else
254           {
255             helix++;
256             break;
257           }
258         }
259
260         j -= 1;
261       }
262
263       // Put positions and helix information into the hashtable
264       helices.put(open, helix);
265       helices.put(close, helix);
266
267       // Record helix as featuregroup
268       pairs[i].setFeatureGroup(Integer.toString(helix));
269
270       lastopen = open;
271       lastclose = close;
272
273     }
274   }
275 }