src/jalview/datamodel/AlignedCodonFrame.java

   1 package jalview.datamodel;\r
   2 \r
   3 import java.util.Enumeration;\r
   4 import java.util.Vector;\r
   5 \r
   6 import jalview.util.MapList;\r
   7 \r
   8 /**\r
   9  * Stores mapping between the columns of a protein alignment and a DNA alignment\r
  10  * and a list of individual codon to amino acid mappings between sequences.\r
  11  */\r
  12 \r
  13 public class AlignedCodonFrame\r
  14 {\r
  15   /**\r
  16    * array of nucleotide positions for aligned codons at column of aligned proteins.\r
  17    */\r
  18   public int[][] codons = null;\r
  19   /**\r
  20    * width of protein sequence alignement\r
  21    * implicit assertion that codons.length >= aaWidth\r
  22    */\r
  23   public int aaWidth=0;\r
  24   /**\r
  25    * initialise codon frame with a nominal alignment width\r
  26    * @param aWidth\r
  27    */\r
  28   public AlignedCodonFrame(int aWidth)\r
  29   {\r
  30     if (aWidth<=0)\r
  31    {\r
  32       codons=null;\r
  33       return;\r
  34    }\r
  35     codons = new int[aWidth][];\r
  36     for (int res = 0; res < aWidth; res++)\r
  37       codons[res] = null;\r
  38   }\r
  39 \r
  40   /**\r
  41    * ensure that codons array is at least as wide as aslen residues\r
  42    * @param aslen\r
  43    * @return (possibly newly expanded) codon array\r
  44    */\r
  45   public int[][] checkCodonFrameWidth(int aslen)\r
  46   {\r
  47     if (codons.length <= aslen + 1)\r
  48     {\r
  49       // probably never have to do this ?\r
  50       int[][] c = new int[codons.length + 10][];\r
  51       for (int i = 0; i < codons.length; i++)\r
  52       {\r
  53         c[i] = codons[i];\r
  54         codons[i] = null;\r
  55       }\r
  56       codons = c;\r
  57     }\r
  58     return codons;\r
  59   }\r
  60   /**\r
  61    * @return width of aligned translated amino acid residues \r
  62    */\r
  63   public int getaaWidth()\r
  64   {\r
  65     return aaWidth;\r
  66   }\r
  67   /**\r
  68    * TODO: not an ideal solution - we reference the aligned amino acid sequences in order to make insertions on them\r
  69    * Better would be dnaAlignment and aaAlignment reference....\r
  70    */\r
  71   Vector a_aaSeqs=new Vector();\r
  72   /**\r
  73    * increase aaWidth by one and insert a new aligned codon position space at aspos.\r
  74    * @param aspos\r
  75    */\r
  76   public void insertAAGap(int aspos, char gapCharacter)\r
  77   {            \r
  78     // this aa appears before the aligned codons at aspos - so shift them in each pair of mapped sequences\r
  79     aaWidth++;\r
  80     if (a_aaSeqs!=null)\r
  81     {\r
  82       // we actually have to modify the aligned sequences here, so use the a_aaSeqs vector\r
  83       Enumeration sq = a_aaSeqs.elements();\r
  84       while (sq.hasMoreElements())\r
  85       {\r
  86         ((SequenceI) sq.nextElement()).insertCharAt(aspos, gapCharacter);\r
  87       }\r
  88     }\r
  89     checkCodonFrameWidth(aspos);\r
  90     if (aspos<aaWidth)\r
  91     {\r
  92       aaWidth++;\r
  93       System.arraycopy(codons, aspos, codons, aspos+1, aaWidth-aspos);\r
  94       codons[aspos]=null; // clear so new codon position can be marked.\r
  95     }\r
  96   }\r
  97 \r
  98   public void setAaWidth(int aapos)\r
  99   {\r
 100     aaWidth = aapos;\r
 101   }\r
 102   /**\r
 103    * tied array of na Sequence objects.\r
 104    */\r
 105   SequenceI[] dnaSeqs=null;\r
 106   /**\r
 107    * tied array of Mappings to protein sequence Objects and \r
 108      SequenceI[] aaSeqs=null;\r
 109    * MapLists where eac maps from the corresponding dnaSeqs element to corresponding aaSeqs element  \r
 110    */\r
 111   Mapping[] dnaToProt=null;\r
 112   /**\r
 113    * add a mapping between the dataset sequences for the associated dna and protein sequence objects\r
 114    * @param dnaseq\r
 115    * @param aaseq\r
 116    * @param map\r
 117    */\r
 118   public void addMap(SequenceI dnaseq, SequenceI aaseq, MapList map)\r
 119   { \r
 120     int nlen=1;\r
 121     if (dnaSeqs!=null)\r
 122     {\r
 123       nlen = dnaSeqs.length+1;\r
 124     }\r
 125     SequenceI[] ndna = new SequenceI[nlen];\r
 126     Mapping[] ndtp = new Mapping[nlen];\r
 127     if (dnaSeqs!=null)\r
 128     {\r
 129       System.arraycopy(dnaSeqs,0,ndna, 0, dnaSeqs.length);\r
 130       System.arraycopy(dnaToProt,0,ndtp, 0, dnaSeqs.length);\r
 131     }\r
 132     dnaSeqs = ndna;\r
 133     dnaToProt = ndtp;\r
 134     nlen--;\r
 135     dnaSeqs[nlen] = (dnaseq.getDatasetSequence()==null) ? dnaseq : dnaseq.getDatasetSequence();\r
 136     Mapping mp = new Mapping(map);\r
 137     mp.to = (aaseq.getDatasetSequence()==null) ? aaseq : aaseq.getDatasetSequence();\r
 138     a_aaSeqs.addElement(aaseq);\r
 139     dnaToProt[nlen] = mp;\r
 140   }\r
 141 \r
 142 \r
 143   public SequenceI[] getdnaSeqs()\r
 144   {\r
 145     return dnaSeqs;\r
 146   }\r
 147   public SequenceI[] getAaSeqs()\r
 148   {\r
 149     if (dnaToProt==null)\r
 150       return null;\r
 151     SequenceI[] sqs = new SequenceI[dnaToProt.length];\r
 152     for (int sz=0; sz<dnaToProt.length; sz++)\r
 153     {\r
 154       sqs[sz]  = dnaToProt[sz].to;\r
 155     }\r
 156     return sqs;\r
 157   }\r
 158   public MapList[] getdnaToProt()\r
 159   {\r
 160     if (dnaToProt==null)\r
 161       return null;\r
 162     MapList[] sqs = new MapList[dnaToProt.length];\r
 163     for (int sz=0; sz<dnaToProt.length; sz++)\r
 164     {\r
 165       sqs[sz]  = dnaToProt[sz].map;\r
 166     }\r
 167     return sqs;\r
 168   }\r
 169   public Mapping[] getProtMappings()\r
 170   {\r
 171     return dnaToProt;\r
 172   }\r
 173   /**\r
 174    * \r
 175    * @param sequenceRef\r
 176    * @return null or corresponding aaSeq entry for dnaSeq entry\r
 177    */\r
 178   public SequenceI getAaForDnaSeq(SequenceI dnaSeqRef)\r
 179   {\r
 180     if (dnaSeqs==null)\r
 181     {\r
 182       return null;\r
 183     }\r
 184     SequenceI dnads = dnaSeqRef.getDatasetSequence();\r
 185     for (int ds=0;ds<dnaSeqs.length; ds++)\r
 186     {\r
 187       if (dnaSeqs[ds]==dnaSeqRef || dnaSeqs[ds]==dnads)\r
 188         return dnaToProt[ds].to;\r
 189     }\r
 190     return null;\r
 191   }\r
 192   /**\r
 193    * \r
 194    * @param sequenceRef\r
 195    * @return null or corresponding aaSeq entry for dnaSeq entry\r
 196    */\r
 197   public SequenceI getDnaForAaSeq(SequenceI aaSeqRef)\r
 198   {\r
 199     if (dnaToProt==null)\r
 200     {\r
 201       return null;\r
 202     }\r
 203     SequenceI aads = aaSeqRef.getDatasetSequence();\r
 204     for (int as=0;as<dnaToProt.length; as++)\r
 205     {\r
 206       if (dnaToProt[as].to==aaSeqRef || dnaToProt[as].to==aads)\r
 207         return dnaSeqs[as];\r
 208     }\r
 209     return null;\r
 210   }\r
 211   /**\r
 212    * test to see if codon frame involves seq in any way\r
 213    * @param seq a nucleotide or protein sequence\r
 214    * @return true if a mapping exists to or from this sequence to any translated sequence\r
 215    */\r
 216   public boolean involvesSequence(SequenceI seq)\r
 217   {\r
 218     return getAaForDnaSeq(seq)!=null || getDnaForAaSeq(seq)!=null;\r
 219   }\r
 220   /**\r
 221    * Add search results for regions in other sequences that translate or are translated from a particular position in seq \r
 222    * @param seq\r
 223    * @param index position in seq\r
 224    * @param results where highlighted regions go\r
 225    */\r
 226   public void markMappedRegion(SequenceI seq, int index, SearchResults results)\r
 227   {\r
 228     int[] codon;\r
 229     SequenceI ds = seq.getDatasetSequence();\r
 230     for (int mi = 0; mi<dnaToProt.length; mi++)\r
 231     {\r
 232       if (dnaSeqs[mi]==seq || dnaSeqs[mi]==ds)\r
 233       {\r
 234         // DEBUG System.err.println("dna pos "+index);\r
 235         codon = dnaToProt[mi].map.locateInTo(index,index);\r
 236         if (codon!=null)\r
 237         {\r
 238           for (int i=0; i<codon.length; i+=2)\r
 239             {\r
 240               results.addResult(dnaToProt[mi].to, codon[i], codon[i+1]);\r
 241             }\r
 242         }\r
 243       } else\r
 244         if (dnaToProt[mi].to==seq || dnaToProt[mi].to==ds)\r
 245         {\r
 246           // DEBUG System.err.println("aa pos "+index);\r
 247           {\r
 248             codon = dnaToProt[mi].map.locateInFrom(index, index);\r
 249             if (codon!=null)\r
 250             {\r
 251             for (int i=0; i<codon.length; i+=2)\r
 252               {\r
 253                 results.addResult(dnaSeqs[mi], codon[i], codon[i+1]);\r
 254               }\r
 255           }\r
 256         }\r
 257         }\r
 258     }\r
 259   }\r
 260 }\r