store chainid on pdbentry
[jalview.git] / 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 javax.xml.parsers.ParserConfigurationException;
26
27 import org.xml.sax.SAXException;
28
29 import fr.orsay.lri.varna.exceptions.ExceptionFileFormatOrSyntax;
30 import fr.orsay.lri.varna.exceptions.ExceptionLoadingFailed;
31 import fr.orsay.lri.varna.exceptions.ExceptionPermissionDenied;
32 import fr.orsay.lri.varna.exceptions.ExceptionUnmatchedClosingParentheses;
33
34 import jalview.datamodel.*;
35 import jalview.io.FileParse;
36 import jalview.io.RnamlFile;
37 import jalview.ws.jws1.Annotate3D;
38
39 public class PDBfile extends jalview.io.AlignFile
40 {
41   public Vector chains;
42
43   public String id;
44
45   /**
46    * set to true to add chain alignment annotation as visible annotation.
47    */
48   boolean VisibleChainAnnotation = false;
49
50   public PDBfile(String inFile, String inType) throws IOException, ExceptionFileFormatOrSyntax, ParserConfigurationException, SAXException, ExceptionPermissionDenied, ExceptionLoadingFailed, InterruptedException, ExceptionUnmatchedClosingParentheses
51   {
52     super(inFile, inType);
53   }
54
55   public PDBfile(FileParse source) throws IOException, ExceptionFileFormatOrSyntax, ParserConfigurationException, SAXException, ExceptionPermissionDenied, ExceptionLoadingFailed, InterruptedException, ExceptionUnmatchedClosingParentheses
56   {
57     super(source);
58   }
59
60   public String print()
61   {
62     return null;
63   }
64
65   public void parse() throws IOException, ExceptionFileFormatOrSyntax, ParserConfigurationException, SAXException, ExceptionPermissionDenied, ExceptionLoadingFailed, InterruptedException
66   {
67     // TODO set the filename sensibly - try using data source name.
68     id = safeName(getDataName());
69
70     chains = new Vector();
71
72     PDBChain tmpchain;
73     String line = null;
74     boolean modelFlag = false;
75     boolean terFlag = false;
76     String lastID = "";
77
78     int index = 0;
79     String atomnam = null;
80     try
81     {
82       while ((line = nextLine()) != null)
83       {
84         if (line.indexOf("HEADER") == 0)
85         {
86           if (line.length() > 62)
87           {
88             String tid;
89             if (line.length() > 67)
90             {
91               tid = line.substring(62, 67).trim();
92             }
93             else
94             {
95               tid = line.substring(62).trim();
96             }
97             if (tid.length() > 0)
98             {
99               id = tid;
100             }
101             continue;
102           }
103         }
104         // Were we to do anything with SEQRES - we start it here
105         if (line.indexOf("SEQRES") == 0)
106         {
107         }
108
109         if (line.indexOf("MODEL") == 0)
110         {
111           modelFlag = true;
112         }
113
114         if (line.indexOf("TER") == 0)
115         {
116           terFlag = true;
117         }
118
119         if (modelFlag && line.indexOf("ENDMDL") == 0)
120         {
121           break;
122         }
123         if (line.indexOf("ATOM") == 0
124                 || (line.indexOf("HETATM") == 0 && !terFlag))
125         {
126           terFlag = false;
127
128           // Jalview is only interested in CA bonds????
129           atomnam = line.substring(12, 15).trim();
130           if (!atomnam.equals("CA") && !atomnam.equals("P"))
131           {
132             continue;
133           }
134
135           Atom tmpatom = new Atom(line);
136           tmpchain = findChain(tmpatom.chain);
137           if (tmpchain != null)
138           {
139             if (tmpatom.resNumIns.trim().equals(lastID))
140             {
141               // phosphorylated protein - seen both CA and P..
142               continue;
143             }
144             tmpchain.atoms.addElement(tmpatom);
145           }
146           else
147           {
148             tmpchain = new PDBChain(id, tmpatom.chain);
149             chains.addElement(tmpchain);
150             tmpchain.atoms.addElement(tmpatom);
151           }
152           lastID = tmpatom.resNumIns.trim();
153         }
154         index++;
155       }
156
157       makeResidueList();
158       makeCaBondList();
159
160       if (id == null)
161       {
162         id = inFile.getName();
163       }
164       for (int i = 0; i < chains.size(); i++)
165       {
166         SequenceI dataset = ((PDBChain) chains.elementAt(i)).sequence;
167         dataset.setName(id + "|" + dataset.getName());
168         PDBEntry entry = new PDBEntry();
169         entry.setId(id);
170         entry.setProperty(new Hashtable());
171         entry.getProperty().put("CHAIN", ((PDBChain)chains.elementAt(i)).id);
172         if (inFile != null)
173         {
174           entry.setFile(inFile.getAbsolutePath());
175         }
176         else
177         {
178           // TODO: decide if we should dump the datasource to disk
179           entry.setFile(getDataName());
180         }
181         dataset.addPDBId(entry);
182         SequenceI chainseq = dataset.deriveSequence(); // PDBChain objects
183         // maintain reference to
184         // dataset
185         seqs.addElement(chainseq);
186        if(isRNA(chainseq)==true)
187        {
188            String path =inFile.getPath();
189            System.out.println("this is a PDB format and RNA sequence");
190            Annotate3D an3d = new Annotate3D(path);
191            System.out.println(id);
192            //BufferedWriter r = an3d.getReader();
193            
194           // BufferedReader in = new BufferedReader(new FileReader("temp.rnaml"));
195            
196            //String str;
197           // while ((str = in.readLine()) != null) {
198                     // System.out.println(str);
199                     // System.out.println("toto");
200
201                     // }
202            //String type = "File";
203            //RnamlFile rnaml =new RnamlFile("temp.rnaml",type);
204            System.out.println("Create rnamfile object");
205            //rnaml.parse("temp");
206            //this.annotations =rnaml.getAnnot();
207            
208        }
209         
210         AlignmentAnnotation[] chainannot = chainseq.getAnnotation();
211         
212         if (chainannot != null)
213         {
214           for (int ai = 0; ai < chainannot.length; ai++)
215           {
216         
217             chainannot[ai].visible = VisibleChainAnnotation;
218             annotations.addElement(chainannot[ai]);
219           }
220         }
221       }
222     } catch (OutOfMemoryError er)
223     {
224       System.out.println("OUT OF MEMORY LOADING PDB FILE");
225       throw new IOException("Out of memory loading PDB File");
226     } catch (NumberFormatException ex)
227     {
228       if (line != null)
229       {
230         System.err.println("Couldn't read number from line:");
231         System.err.println(line);
232       }
233     }
234   }
235
236   /**
237    * make a friendly ID string.
238    * 
239    * @param dataName
240    * @return truncated dataName to after last '/'
241    */
242   private String safeName(String dataName)
243   {
244     int p = 0;
245     while ((p = dataName.indexOf("/")) > -1 && p < dataName.length())
246     {
247       dataName = dataName.substring(p + 1);
248     }
249     return dataName;
250   }
251
252   public void makeResidueList()
253   {
254     for (int i = 0; i < chains.size(); i++)
255     {
256       ((PDBChain) chains.elementAt(i)).makeResidueList();
257     }
258   }
259
260   public void makeCaBondList()
261   {
262     for (int i = 0; i < chains.size(); i++)
263     {
264       ((PDBChain) chains.elementAt(i)).makeCaBondList();
265     }
266   }
267
268   public PDBChain findChain(String id)
269   {
270     for (int i = 0; i < chains.size(); i++)
271     {
272       if (((PDBChain) chains.elementAt(i)).id.equals(id))
273       {
274         return (PDBChain) chains.elementAt(i);
275       }
276     }
277
278     return null;
279   }
280
281   public void setChargeColours()
282   {
283     for (int i = 0; i < chains.size(); i++)
284     {
285       ((PDBChain) chains.elementAt(i)).setChargeColours();
286     }
287   }
288
289   public void setColours(jalview.schemes.ColourSchemeI cs)
290   {
291     for (int i = 0; i < chains.size(); i++)
292     {
293       ((PDBChain) chains.elementAt(i)).setChainColours(cs);
294     }
295   }
296
297   public void setChainColours()
298   {
299     for (int i = 0; i < chains.size(); i++)
300     {
301       ((PDBChain) chains.elementAt(i)).setChainColours(Color.getHSBColor(
302               1.0f / (float) i, .4f, 1.0f));
303     }
304   }
305   public boolean isRNA(SequenceI seqs)
306   {
307           for (int i=0;i<seqs.getLength();i++){
308                   if((seqs.getCharAt(i)!='A') &&(seqs.getCharAt(i)!='C')&&(seqs.getCharAt(i)!='G')&&(seqs.getCharAt(i)!='U'))
309                   {
310                           return false;
311                   }
312           }
313          
314                   return true;
315           
316           
317   }
318 }