src/jalview/datamodel/CigarArray.java

   1 /*\r
   2  * Jalview - A Sequence Alignment Editor and Viewer (Development Version 2.4.1)\r
   3  * Copyright (C) 2009 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
   4  * \r
   5  * This program is free software; you can redistribute it and/or\r
   6  * modify it under the terms of the GNU General Public License\r
   7  * as published by the Free Software Foundation; either version 2\r
   8  * of the License, or (at your option) any later version.\r
   9  * \r
  10  * This program is distributed in the hope that it will be useful,\r
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  13  * GNU General Public License for more details.\r
  14  * \r
  15  * You should have received a copy of the GNU General Public License\r
  16  * along with this program; if not, write to the Free Software\r
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
  18  */\r
  19 package jalview.datamodel;\r
  20 \r
  21 public class CigarArray extends CigarBase\r
  22 {\r
  23   /**\r
  24    * Do CIGAR operations on a set of sequences from many other cigars BAD THINGS\r
  25    * WILL HAPPEN IF A CIGARARRAY IS PASSED TO A CIGARARRAY or a CIGARCIGAR is\r
  26    * given a CIGARARRAY to insert gaps into.\r
  27    */\r
  28   /**\r
  29    * array of subject cigars\r
  30    */\r
  31   public CigarSimple refCigars[] = null;\r
  32 \r
  33   private boolean seqcigararray = false;\r
  34 \r
  35   private CigarArray()\r
  36   {\r
  37     super();\r
  38   }\r
  39 \r
  40   /**\r
  41    * isSeqCigarArray()\r
  42    * \r
  43    * @return boolean true if all refCigars resolve to a SeqCigar or a CigarCigar\r
  44    */\r
  45   public boolean isSeqCigarArray()\r
  46   {\r
  47     return seqcigararray;\r
  48   }\r
  49 \r
  50   /**\r
  51    * Apply CIGAR operations to several cigars in parallel will throw an error if\r
  52    * any of cigar are actually CigarArrays.\r
  53    * \r
  54    * @param cigar\r
  55    *                Cigar[]\r
  56    */\r
  57   public CigarArray(CigarSimple[] cigars)\r
  58   {\r
  59     super();\r
  60     seqcigararray = true;\r
  61     if (cigars != null && cigars.length > 0)\r
  62     {\r
  63       refCigars = new CigarSimple[cigars.length];\r
  64       for (int c = 0; c < cigars.length; c++)\r
  65       {\r
  66         refCigars[c] = cigars[c];\r
  67         if (!((cigars[c] instanceof SeqCigar) || cigars[c] instanceof CigarCigar))\r
  68         {\r
  69           seqcigararray = false;\r
  70         }\r
  71       }\r
  72     }\r
  73   }\r
  74 \r
  75   /**\r
  76    * @see Cigar.getSequenceAndDeletions\r
  77    * @param GapChar\r
  78    *                char\r
  79    * @return Object[][]\r
  80    */\r
  81   protected Object[][] getArrayofSequenceAndDeletions(char GapChar)\r
  82   {\r
  83     if (refCigars == null || refCigars.length == 0 || length == 0)\r
  84     {\r
  85       return null;\r
  86     }\r
  87     Object[][] sqanddels = new Object[refCigars.length][];\r
  88     for (int c = 0; c < refCigars.length; c++)\r
  89     {\r
  90       String refString = refCigars[c].getSequenceString(GapChar);\r
  91       if (refString != null)\r
  92       {\r
  93         sqanddels[c] = getSequenceAndDeletions(refString, GapChar);\r
  94       }\r
  95       else\r
  96       {\r
  97         sqanddels[c] = null;\r
  98       }\r
  99     }\r
 100     return sqanddels;\r
 101   }\r
 102 \r
 103   /**\r
 104    * NOTE: this is an improper sequence string function\r
 105    * \r
 106    * @return String formed by newline concatenated results of applying CIGAR\r
 107    *         operations to each reference object in turn.\r
 108    * @param GapChar\r
 109    *                char\r
 110    * @return '\n' separated strings (empty results included as \n\n)\r
 111    */\r
 112   public String getSequenceString(char GapChar)\r
 113   {\r
 114     if (length == 0 || refCigars == null)\r
 115     {\r
 116       return "";\r
 117     }\r
 118     StringBuffer seqStrings = new StringBuffer();\r
 119     Object[][] sqanddels = getArrayofSequenceAndDeletions(GapChar);\r
 120     for (int c = 0; c < refCigars.length; c++)\r
 121     {\r
 122       if (sqanddels[c] != null)\r
 123       {\r
 124         seqStrings.append((String) sqanddels[c][0]);\r
 125         sqanddels[c][0] = null;\r
 126       }\r
 127       seqStrings.append('\n');\r
 128     }\r
 129     return seqStrings.toString();\r
 130   }\r
 131 \r
 132   /**\r
 133    * return string results of applying cigar string to all reference cigars\r
 134    * \r
 135    * @param GapChar\r
 136    *                char\r
 137    * @return String[]\r
 138    */\r
 139   public String[] getSequenceStrings(char GapChar)\r
 140   {\r
 141 \r
 142     if (length == 0 || refCigars == null || refCigars.length == 0)\r
 143     {\r
 144       return null;\r
 145     }\r
 146     Object[][] sqanddels = getArrayofSequenceAndDeletions(GapChar);\r
 147     String[] seqs = new String[sqanddels.length];\r
 148     for (int c = 0; c < refCigars.length; c++)\r
 149     {\r
 150       seqs[c] = (String) sqanddels[c][0];\r
 151     }\r
 152     return seqs;\r
 153   }\r
 154 \r
 155   /**\r
 156    * Combines the CigarArray cigar operations with the operations in each\r
 157    * reference cigar - creating a new reference cigar\r
 158    * \r
 159    * @return Cigar[]\r
 160    * \r
 161    * public CigarBase[] getEditedCigars() {\r
 162    * \r
 163    * return new CigarBase[] {}; }\r
 164    */\r
 165   /**\r
 166    * applyDeletions edits underlying refCigars to propagate deleted regions, and\r
 167    * removes deletion operations from CigarArray operation list.\r
 168    * \r
 169    * @return int[] position after deletion occured and range of deletion in\r
 170    *         cigarArray or null if none occured\r
 171    */\r
 172   public int[] applyDeletions()\r
 173   {\r
 174     java.util.Vector delpos = null;\r
 175     if (length == 0)\r
 176     {\r
 177       return null;\r
 178     }\r
 179     int cursor = 0; // range counter for deletions\r
 180     int vcursor = 0; // visible column index\r
 181     int offset = 0; // shift in visible column index as deletions are made\r
 182     int i = 0;\r
 183     while (i < length)\r
 184     {\r
 185       if (operation[i] != D)\r
 186       {\r
 187         if (operation[i] == M)\r
 188         {\r
 189           cursor += range[i];\r
 190         }\r
 191         vcursor += range[i++];\r
 192       }\r
 193       else\r
 194       {\r
 195         if (delpos == null)\r
 196         {\r
 197           delpos = new java.util.Vector();\r
 198         }\r
 199         int delstart = cursor, delend = cursor + range[i] - 1; // inclusive\r
 200         delpos.addElement(new int[]\r
 201         { vcursor + offset, range[i] }); // index of right hand column after\r
 202                                           // hidden region boundary\r
 203         offset += range[i] - 1; // shift in visible column coordinates\r
 204         System.arraycopy(operation, i + 1, operation, i, length - i);\r
 205         System.arraycopy(range, i + 1, range, i, length - i);\r
 206         length--;\r
 207         /*\r
 208          * int dmax=0; for (int s=0; s<refCigars.length; s++) { int d =\r
 209          * refCigars[s].deleteRange(delstart, delend); if (d>dmax) dmax=d; }\r
 210          * offset+=dmax; // shift in visible column coordinates\r
 211          */\r
 212         for (int s = 0; s < refCigars.length; s++)\r
 213         {\r
 214           int d = refCigars[s].deleteRange(delstart, delend);\r
 215         }\r
 216 \r
 217       }\r
 218     }\r
 219     if (delpos != null)\r
 220     {\r
 221       int[] pos = new int[delpos.size() * 2];\r
 222       for (int k = 0, l = delpos.size(); k < l; k++)\r
 223       {\r
 224         int[] dr = ((int[]) delpos.elementAt(k));\r
 225         pos[k * 2] = dr[0];\r
 226         pos[k * 2 + 1] = dr[1];\r
 227         delpos.setElementAt(null, k);\r
 228       }\r
 229       delpos = null;\r
 230       return pos;\r
 231     }\r
 232     return null;\r
 233   }\r
 234 \r
 235   /**\r
 236    * \r
 237    * @return SeqCigar[] or null if CigarArray is not a SeqCigarArray (ie it does\r
 238    *         not resolve to set of seqCigars)\r
 239    */\r
 240   public SeqCigar[] getSeqCigarArray()\r
 241   {\r
 242     if (!isSeqCigarArray())\r
 243     {\r
 244       return null;\r
 245     }\r
 246     SeqCigar[] sa = new SeqCigar[refCigars.length];\r
 247     for (int i = 0; i < refCigars.length; i++)\r
 248     {\r
 249       sa[i] = (SeqCigar) refCigars[i];\r
 250     }\r
 251     return sa;\r
 252   }\r
 253 }\r