src/MCview/PDBfile.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
   3  * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, 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 package MCview;
  19
  20 import java.io.*;
  21 import java.util.*;
  22
  23 import java.awt.*;
  24
  25
  26 import jalview.analysis.AlignSeq;
  27 import jalview.datamodel.*;
  28 import jalview.io.FileParse;
  29 import jalview.ws.jws1.Annotate3D;
  30
  31 public class PDBfile extends jalview.io.AlignFile
  32 {
  33   public Vector chains;
  34
  35   public String id;
  36
  37   /**
  38    * set to true to add chain alignment annotation as visible annotation.
  39    */
  40   boolean VisibleChainAnnotation = false;
  41
  42   public PDBfile(String inFile, String inType) throws Exception
  43   {
  44     super(inFile, inType);
  45   }
  46
  47   public PDBfile(FileParse source) throws Exception
  48   {
  49     super(source);
  50   }
  51
  52   public String print()
  53   {
  54     return null;
  55   }
  56
  57   public void parse() throws Exception
  58   {
  59     // TODO set the filename sensibly - try using data source name.
  60     id = safeName(getDataName());
  61
  62     chains = new Vector();
  63     ArrayList<SequenceI> rna=new ArrayList<SequenceI>(), prot=new ArrayList<SequenceI>();
  64     PDBChain tmpchain;
  65     String line = null;
  66     boolean modelFlag = false;
  67     boolean terFlag = false;
  68     String lastID = "";
  69
  70     int index = 0;
  71     String atomnam = null;
  72     try
  73     {
  74       while ((line = nextLine()) != null)
  75       {
  76         if (line.indexOf("HEADER") == 0)
  77         {
  78           if (line.length() > 62)
  79           {
  80             String tid;
  81             if (line.length() > 67)
  82             {
  83               tid = line.substring(62, 67).trim();
  84             }
  85             else
  86             {
  87               tid = line.substring(62).trim();
  88             }
  89             if (tid.length() > 0)
  90             {
  91               id = tid;
  92             }
  93             continue;
  94           }
  95         }
  96         // Were we to do anything with SEQRES - we start it here
  97         if (line.indexOf("SEQRES") == 0)
  98         {
  99         }
 100
 101         if (line.indexOf("MODEL") == 0)
 102         {
 103           modelFlag = true;
 104         }
 105
 106         if (line.indexOf("TER") == 0)
 107         {
 108           terFlag = true;
 109         }
 110
 111         if (modelFlag && line.indexOf("ENDMDL") == 0)
 112         {
 113           break;
 114         }
 115         if (line.indexOf("ATOM") == 0
 116                 || (line.indexOf("HETATM") == 0 && !terFlag))
 117         {
 118           terFlag = false;
 119
 120           // Jalview is only interested in CA bonds????
 121           atomnam = line.substring(12, 15).trim();
 122           if (!atomnam.equals("CA") && !atomnam.equals("P"))
 123           {
 124             continue;
 125           }
 126
 127           Atom tmpatom = new Atom(line);
 128           tmpchain = findChain(tmpatom.chain);
 129           if (tmpchain != null)
 130           {
 131             if (tmpatom.resNumIns.trim().equals(lastID))
 132             {
 133               // phosphorylated protein - seen both CA and P..
 134               continue;
 135             }
 136             tmpchain.atoms.addElement(tmpatom);
 137           }
 138           else
 139           {
 140             tmpchain = new PDBChain(id, tmpatom.chain);
 141             chains.addElement(tmpchain);
 142             tmpchain.atoms.addElement(tmpatom);
 143           }
 144           lastID = tmpatom.resNumIns.trim();
 145         }
 146         index++;
 147       }
 148
 149       makeResidueList();
 150       makeCaBondList();
 151
 152       if (id == null)
 153       {
 154         id = inFile.getName();
 155       }
 156       for (int i = 0; i < chains.size(); i++)
 157       {
 158         SequenceI dataset = ((PDBChain) chains.elementAt(i)).sequence;
 159         dataset.setName(id + "|" + dataset.getName());
 160         PDBEntry entry = new PDBEntry();
 161         entry.setId(id);
 162         entry.setProperty(new Hashtable());
 163         entry.getProperty().put("CHAIN", ((PDBChain)chains.elementAt(i)).id);
 164         if (inFile != null)
 165         {
 166           entry.setFile(inFile.getAbsolutePath());
 167         }
 168         else
 169         {
 170           // TODO: decide if we should dump the datasource to disk
 171           entry.setFile(getDataName());
 172         }
 173         dataset.addPDBId(entry);
 174         SequenceI chainseq = dataset.deriveSequence(); // PDBChain objects
 175         // maintain reference to
 176         // dataset
 177         seqs.addElement(chainseq);
 178        if(isRNA(chainseq)==true)
 179        {
 180          rna.add(chainseq);
 181        } else {
 182          prot.add(chainseq);
 183        }
 184
 185         AlignmentAnnotation[] chainannot = chainseq.getAnnotation();
 186
 187         if (chainannot != null)
 188         {
 189           for (int ai = 0; ai < chainannot.length; ai++)
 190           {
 191
 192             chainannot[ai].visible = VisibleChainAnnotation;
 193             annotations.addElement(chainannot[ai]);
 194           }
 195         }
 196       }
 197       if (rna.size()>0)
 198       try {
 199         processPdbFileWithAnnotate3d(rna);
 200       } catch (Exception x)
 201       {
 202         System.err.println("Exceptions when dealing with RNA in pdb file");
 203         x.printStackTrace();
 204
 205       };
 206       if (prot.size()>0)
 207       try {
 208         processPdbFileWithJmol(prot);
 209       } catch (Exception x)
 210       {
 211         System.err.println("Exceptions when dealing with RNA in pdb file");
 212         x.printStackTrace();
 213
 214       };
 215     } catch (OutOfMemoryError er)
 216     {
 217       System.out.println("OUT OF MEMORY LOADING PDB FILE");
 218       throw new IOException("Out of memory loading PDB File");
 219     } catch (NumberFormatException ex)
 220     {
 221       if (line != null)
 222       {
 223         System.err.println("Couldn't read number from line:");
 224         System.err.println(line);
 225       }
 226     }
 227   }
 228   private void processPdbFileWithJmol(ArrayList<SequenceI> prot) throws Exception
 229   {
 230     // process prot sequence with Jmol to get annotated alignment.
 231     // replaceMatchingSeqsWith(prot, al, AlignSeq.PEP);
 232   }
 233   private void processPdbFileWithAnnotate3d(ArrayList<SequenceI> rna) throws Exception {
 234 //    System.out.println("this is a PDB format and RNA sequence");
 235     Annotate3D an3d = new Annotate3D();
 236     // TODO: use the PDB ID of the structure if one is available, to save bandwidth and avoid uploading the whole structure to the service
 237     AlignmentI al = an3d.getRNAMLFor(new FileParse(getDataName(),type));
 238     replaceMatchingSeqsWith(rna, al, AlignSeq.DNA);
 239   }
 240   private void replaceMatchingSeqsWith(ArrayList<SequenceI> ochains, AlignmentI al, String dnaOrProtein)
 241   {
 242     if (al!=null && al.getHeight()>0)
 243     {
 244       ArrayList<SequenceI> matches=new ArrayList<SequenceI>();
 245       ArrayList<AlignSeq> aligns=new ArrayList<AlignSeq>();
 246
 247       for (SequenceI sq:ochains)
 248       {
 249         SequenceI bestm=null;
 250         AlignSeq bestaseq=null;
 251         int bestscore=0;
 252         for (SequenceI msq:al.getSequences())
 253         {
 254           AlignSeq aseq = AlignSeq.doGlobalNWAlignment(msq, sq, dnaOrProtein);
 255           if (bestm==null || aseq.getMaxScore()>bestscore)
 256           {
 257             bestscore=aseq.getMaxScore();
 258             bestaseq= aseq;
 259             bestm=msq;
 260           }
 261         }
 262         System.out.println("Best Score for "+(matches.size()+1)+" :"+bestscore);
 263         matches.add(bestm);
 264         aligns.add(bestaseq);
 265         al.deleteSequence(bestm);
 266       }
 267       for (int p=0,pSize=seqs.size();p<pSize;p++)
 268       {
 269         SequenceI sq,sp=seqs.get(p);
 270         int q;
 271         if ((q=ochains.indexOf(sp))>-1)
 272         {
 273           seqs.set(p, sq=matches.get(q));
 274           sq.setName(sp.getName());
 275           sq.setDescription(sp.getDescription());
 276           sq.transferAnnotation(sp, aligns.get(q).getMappingFromS1(false));
 277           int inspos=-1;
 278           for (int ap=0;ap<annotations.size();)
 279           {
 280             if (((AlignmentAnnotation)annotations.get(ap)).sequenceRef==sp) {
 281               if (inspos==-1)
 282               {
 283                 inspos=ap;
 284               }
 285               annotations.remove(ap);
 286             } else {
 287               ap++;
 288             }
 289           }
 290           annotations.addAll(inspos, Arrays.asList(sq.getAnnotation()));
 291         }
 292       }
 293     }
 294   }
 295   /**
 296    * make a friendly ID string.
 297    *
 298    * @param dataName
 299    * @return truncated dataName to after last '/'
 300    */
 301   private String safeName(String dataName)
 302   {
 303     int p = 0;
 304     while ((p = dataName.indexOf("/")) > -1 && p < dataName.length())
 305     {
 306       dataName = dataName.substring(p + 1);
 307     }
 308     return dataName;
 309   }
 310
 311   public void makeResidueList()
 312   {
 313     for (int i = 0; i < chains.size(); i++)
 314     {
 315       ((PDBChain) chains.elementAt(i)).makeResidueList();
 316     }
 317   }
 318
 319   public void makeCaBondList()
 320   {
 321     for (int i = 0; i < chains.size(); i++)
 322     {
 323       ((PDBChain) chains.elementAt(i)).makeCaBondList();
 324     }
 325   }
 326
 327   public PDBChain findChain(String id)
 328   {
 329     for (int i = 0; i < chains.size(); i++)
 330     {
 331       if (((PDBChain) chains.elementAt(i)).id.equals(id))
 332       {
 333         return (PDBChain) chains.elementAt(i);
 334       }
 335     }
 336
 337     return null;
 338   }
 339
 340   public void setChargeColours()
 341   {
 342     for (int i = 0; i < chains.size(); i++)
 343     {
 344       ((PDBChain) chains.elementAt(i)).setChargeColours();
 345     }
 346   }
 347
 348   public void setColours(jalview.schemes.ColourSchemeI cs)
 349   {
 350     for (int i = 0; i < chains.size(); i++)
 351     {
 352       ((PDBChain) chains.elementAt(i)).setChainColours(cs);
 353     }
 354   }
 355
 356   public void setChainColours()
 357   {
 358     for (int i = 0; i < chains.size(); i++)
 359     {
 360       ((PDBChain) chains.elementAt(i)).setChainColours(Color.getHSBColor(
 361               1.0f / (float) i, .4f, 1.0f));
 362     }
 363   }
 364   public boolean isRNA(SequenceI seqs)
 365   {
 366           for (int i=0;i<seqs.getLength();i++){
 367                   if((seqs.getCharAt(i)!='A') &&(seqs.getCharAt(i)!='C')&&(seqs.getCharAt(i)!='G')&&(seqs.getCharAt(i)!='U'))
 368                   {
 369                           return false;
 370                   }
 371           }
 372
 373                   return true;
 374
 375
 376   }
 377 }