src/jalview/analysis/Rna.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
   3  * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
   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 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 /* Author: Lauren Michelle Lui
  20  * Methods are based on RALEE methods http://personalpages.manchester.ac.uk/staff/sam.griffiths-jones/software/ralee/
  21  * */
  22
  23 package jalview.analysis;
  24
  25 import java.util.ArrayList;
  26 import java.util.Hashtable;
  27 import java.util.Vector;
  28
  29 import jalview.datamodel.SequenceFeature;
  30
  31 public class Rna
  32 {
  33         static Hashtable<Integer, Integer> pairHash = new Hashtable();
  34   /**
  35    * Based off of RALEE code ralee-get-base-pairs. Keeps track of open bracket
  36    * positions in "stack" vector. When a close bracket is reached, pair this
  37    * with the last element in the "stack" vector and store in "pairs" vector.
  38    * Remove last element in the "stack" vector. Continue in this manner until
  39    * the whole string is processed.
  40    *
  41    * @param line
  42    *          Secondary structure line of an RNA Stockholm file
  43    * @return Array of SequenceFeature; type = RNA helix, begin is open base
  44    *         pair, end is close base pair
  45    */
  46   public static SequenceFeature[] GetBasePairs(String line)
  47   public static SequenceFeature[] GetBasePairs(CharSequence line) throws WUSSParseException
  48   {
  49
  50     Vector stack = new Vector();
  51     Vector pairs = new Vector();
  52
  53     int i = 0;
  54     while (i < line.length())
  55     {
  56       char base = line.charAt(i);
  57
  58       if ((base == '<') || (base == '(') || (base == '{') || (base == '['))
  59       {
  60         stack.addElement(i);
  61       }
  62       else if ((base == '>') || (base == ')') || (base == '}')
  63               || (base == ']'))
  64       {
  65
  66         Object temp = stack.lastElement();
  67         stack.remove(stack.size() - 1);
  68         pairs.addElement(temp);
  69         pairs.addElement(i);
  70       }
  71
  72       i++;
  73     }
  74
  75     int numpairs = pairs.size() / 2;
  76     SequenceFeature[] outPairs = new SequenceFeature[numpairs];
  77
  78     // Convert pairs to array
  79     for (int p = 0; p < pairs.size(); p += 2)
  80     {
  81       int begin = Integer.parseInt(pairs.elementAt(p).toString());
  82       int end = Integer.parseInt(pairs.elementAt(p + 1).toString());
  83
  84        outPairs[p / 2] = new SequenceFeature("RNA helix", "", "", begin,
  85               end, "");
  86        //pairHash.put(begin, end);
  87
  88     }
  89
  90     return outPairs;
  91   }
  92
  93
  94   /**
  95    * Function to get the end position corresponding to a given start position
  96    * @param indice - start position of a base pair
  97    * @return - end position of a base pair
  98    */
  99   /*makes no sense at the moment :(
 100   public int findEnd(int indice){
 101           //TODO: Probably extend this to find the start to a given end?
 102           //could be done by putting everything twice to the hash
 103           ArrayList<Integer> pair = new ArrayList<Integer>();
 104           return pairHash.get(indice);
 105   }*/
 106
 107
 108   /**
 109    * Figures out which helix each position belongs to and stores the helix
 110    * number in the 'featureGroup' member of a SequenceFeature Based off of RALEE
 111    * code ralee-helix-map.
 112    *
 113    * @param pairs
 114    *          Array of SequenceFeature (output from Rna.GetBasePairs)
 115    */
 116   public static void HelixMap(SequenceFeature[] pairs)
 117   {
 118
 119     int helix = 0; // Number of helices/current helix
 120     int lastopen = 0; // Position of last open bracket reviewed
 121     int lastclose = 9999999; // Position of last close bracket reviewed
 122     int i = pairs.length; // Number of pairs
 123
 124     int open; // Position of an open bracket under review
 125     int close; // Position of a close bracket under review
 126     int j; // Counter
 127
 128     Hashtable helices = new Hashtable(); // Keep track of helix number for each
 129                                          // position
 130
 131     // Go through each base pair and assign positions a helix
 132     for (i = 0; i < pairs.length; i++)
 133     {
 134
 135       open = pairs[i].getBegin();
 136       close = pairs[i].getEnd();
 137
 138       // System.out.println("open " + open + " close " + close);
 139       // System.out.println("lastclose " + lastclose + " lastopen " + lastopen);
 140
 141       // we're moving from right to left based on closing pair
 142       /*
 143        * catch things like <<..>>..<<..>> |
 144        */
 145       if (open > lastclose)
 146       {
 147         helix++;
 148       }
 149
 150       /*
 151        * catch things like <<..<<..>>..<<..>>>> |
 152        */
 153       j = pairs.length - 1;
 154       while (j >= 0)
 155       {
 156         int popen = pairs[j].getBegin();
 157
 158         // System.out.println("j " + j + " popen " + popen + " lastopen "
 159         // +lastopen + " open " + open);
 160         if ((popen < lastopen) && (popen > open))
 161         {
 162           if (helices.containsValue(popen)
 163                   && (((Integer) helices.get(popen)) == helix))
 164           {
 165             continue;
 166           }
 167           else
 168           {
 169             helix++;
 170             break;
 171           }
 172         }
 173
 174         j -= 1;
 175       }
 176
 177       // Put positions and helix information into the hashtable
 178       helices.put(open, helix);
 179       helices.put(close, helix);
 180
 181       // Record helix as featuregroup
 182       pairs[i].setFeatureGroup(Integer.toString(helix));
 183
 184       lastopen = open;
 185       lastclose = close;
 186
 187     }
 188   }
 189 }