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