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