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.Stack;
  28 import java.util.Vector;
  29
  30 import jalview.datamodel.SequenceFeature;
  31
  32 public class Rna
  33 {
  34         static Hashtable<Integer, Integer> pairHash = new Hashtable();
  35   /**
  36    * Based off of RALEE code ralee-get-base-pairs. Keeps track of open bracket
  37    * positions in "stack" vector. When a close bracket is reached, pair this
  38    * with the last element in the "stack" vector and store in "pairs" vector.
  39    * Remove last element in the "stack" vector. Continue in this manner until
  40    * the whole string is processed.
  41    *
  42    * @param line
  43    *          Secondary structure line of an RNA Stockholm file
  44    * @return Array of SequenceFeature; type = RNA helix, begin is open base
  45    *         pair, end is close base pair
  46    */
  47   public static SequenceFeature[] GetBasePairs(CharSequence line) throws WUSSParseException
  48   {
  49     Stack stack = new Stack();
  50     Vector pairs = new Vector();
  51
  52     int i = 0;
  53     while (i < line.length())
  54     {
  55       char base = line.charAt(i);
  56
  57       if ((base == '<') || (base == '(') || (base == '{') || (base == '[')|| (base == 'A')|| (base == 'B')|| (base == 'C')|| (base == 'D')|| (base == '1')|| (base == 'F')|| (base == 'G')|| (base == '2')|| (base == 'I')|| (base == 'J')|| (base == 'K')|| (base == 'L')|| (base == 'M')|| (base == 'N')|| (base == 'O')|| (base == 'P')|| (base == 'Q')|| (base == 'R')|| (base == 'S')|| (base == 'T')|| (base == 'U')|| (base == 'V')|| (base == 'W')|| (base == 'X')|| (base == 'Y')|| (base == 'Z'))
  58       {
  59         stack.push(i);
  60       }
  61       else if ((base == '>') || (base == ')') || (base == '}')|| (base == ']')|| (base == 'a')|| (base == 'b')|| (base == 'c')|| (base == 'd')|| (base == 'e')|| (base == 'f')|| (base == 'g')|| (base == 'h')|| (base == 'i')|| (base == 'j')|| (base == 'k')|| (base == 'l')|| (base == 'm')|| (base == 'n')|| (base == 'o')|| (base == 'p')|| (base == 'q')|| (base == 'r')|| (base == 's')|| (base == 't')|| (base == 'u')|| (base == 'v')|| (base == 'w')|| (base == 'x')|| (base == 'y')|| (base == 'z'))
  62
  63       {
  64
  65         if (stack.isEmpty())
  66         {
  67           // error whilst parsing i'th position. pass back
  68           throw new WUSSParseException("Mismatched closing bracket", i);
  69         }
  70         Object temp = stack.pop();
  71         pairs.addElement(temp);
  72         pairs.addElement(i);
  73         //System.out.println(pairs);
  74       }
  75
  76       i++;
  77     }
  78
  79     int numpairs = pairs.size() / 2;
  80     SequenceFeature[] outPairs = new SequenceFeature[numpairs];
  81
  82     // Convert pairs to array
  83     for (int p = 0; p < pairs.size(); p += 2)
  84     {
  85       int begin = Integer.parseInt(pairs.elementAt(p).toString());
  86       int end = Integer.parseInt(pairs.elementAt(p + 1).toString());
  87
  88        outPairs[p / 2] = new SequenceFeature("RNA helix", "", "", begin,
  89               end, "");
  90        //pairHash.put(begin, end);
  91
  92     }
  93
  94     return outPairs;
  95   }
  96
  97
  98   /**
  99    * Function to get the end position corresponding to a given start position
 100    * @param indice - start position of a base pair
 101    * @return - end position of a base pair
 102    */
 103   /*makes no sense at the moment :(
 104   public int findEnd(int indice){
 105           //TODO: Probably extend this to find the start to a given end?
 106           //could be done by putting everything twice to the hash
 107           ArrayList<Integer> pair = new ArrayList<Integer>();
 108           return pairHash.get(indice);
 109   }*/
 110
 111
 112   /**
 113    * Figures out which helix each position belongs to and stores the helix
 114    * number in the 'featureGroup' member of a SequenceFeature Based off of RALEE
 115    * code ralee-helix-map.
 116    *
 117    * @param pairs
 118    *          Array of SequenceFeature (output from Rna.GetBasePairs)
 119    */
 120   public static void HelixMap(SequenceFeature[] pairs)
 121   {
 122
 123     int helix = 0; // Number of helices/current helix
 124     int lastopen = 0; // Position of last open bracket reviewed
 125     int lastclose = 9999999; // Position of last close bracket reviewed
 126     int i = pairs.length; // Number of pairs
 127
 128     int open; // Position of an open bracket under review
 129     int close; // Position of a close bracket under review
 130     int j; // Counter
 131
 132     Hashtable helices = new Hashtable(); // Keep track of helix number for each
 133                                          // position
 134
 135     // Go through each base pair and assign positions a helix
 136     for (i = 0; i < pairs.length; i++)
 137     {
 138
 139       open = pairs[i].getBegin();
 140       close = pairs[i].getEnd();
 141
 142       // System.out.println("open " + open + " close " + close);
 143       // System.out.println("lastclose " + lastclose + " lastopen " + lastopen);
 144
 145       // we're moving from right to left based on closing pair
 146       /*
 147        * catch things like <<..>>..<<..>> |
 148        */
 149       if (open > lastclose)
 150       {
 151         helix++;
 152       }
 153
 154       /*
 155        * catch things like <<..<<..>>..<<..>>>> |
 156        */
 157       j = pairs.length - 1;
 158       while (j >= 0)
 159       {
 160         int popen = pairs[j].getBegin();
 161
 162         // System.out.println("j " + j + " popen " + popen + " lastopen "
 163         // +lastopen + " open " + open);
 164         if ((popen < lastopen) && (popen > open))
 165         {
 166           if (helices.containsValue(popen)
 167                   && (((Integer) helices.get(popen)) == helix))
 168           {
 169             continue;
 170           }
 171           else
 172           {
 173             helix++;
 174             break;
 175           }
 176         }
 177
 178         j -= 1;
 179       }
 180
 181       // Put positions and helix information into the hashtable
 182       helices.put(open, helix);
 183       helices.put(close, helix);
 184
 185       // Record helix as featuregroup
 186       pairs[i].setFeatureGroup(Integer.toString(helix));
 187
 188       lastopen = open;
 189       lastclose = close;
 190
 191     }
 192   }
 193 }
 194