src/mc_view/PDBfile.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   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
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package mc_view;
  22
  23 import jalview.datamodel.AlignmentAnnotation;
  24 import jalview.datamodel.DBRefSource;
  25 import jalview.datamodel.SequenceI;
  26 import jalview.io.DataSourceType;
  27 import jalview.io.FileParse;
  28 import jalview.io.StructureFile;
  29 import jalview.util.MessageManager;
  30
  31 import java.io.IOException;
  32 import java.util.ArrayList;
  33 import java.util.Hashtable;
  34 import java.util.List;
  35 import java.util.Vector;
  36
  37 public class PDBfile extends StructureFile
  38 {
  39   private static String CALC_ID_PREFIX = "JalviewPDB";
  40
  41   public PDBfile(boolean addAlignmentAnnotations,
  42           boolean predictSecondaryStructure, boolean externalSecStr)
  43   {
  44     super();
  45     addSettings(addAlignmentAnnotations, predictSecondaryStructure,
  46             externalSecStr);
  47   }
  48
  49   public PDBfile(boolean addAlignmentAnnotations, boolean predictSecStr,
  50           boolean externalSecStr, String dataObject,
  51           DataSourceType sourceType) throws IOException
  52   {
  53     super(false, dataObject, sourceType);
  54     addSettings(addAlignmentAnnotations, predictSecStr, externalSecStr);
  55     doParse();
  56   }
  57
  58   public PDBfile(boolean addAlignmentAnnotations, boolean predictSecStr,
  59           boolean externalSecStr, FileParse source) throws IOException
  60   {
  61     super(false, source);
  62     addSettings(addAlignmentAnnotations, predictSecStr, externalSecStr);
  63     doParse();
  64   }
  65
  66   @Override
  67   public String print(SequenceI[] seqs, boolean jvSuffix)
  68   {
  69     return null;
  70   }
  71
  72   @Override
  73   public void parse() throws IOException
  74   {
  75     setDbRefType(DBRefSource.PDB);
  76     // TODO set the filename sensibly - try using data source name.
  77     setId(safeName(getDataName()));
  78
  79     setChains(new Vector<PDBChain>());
  80     List<SequenceI> rna = new ArrayList<SequenceI>();
  81     List<SequenceI> prot = new ArrayList<SequenceI>();
  82     PDBChain tmpchain;
  83     String line = null;
  84     boolean modelFlag = false;
  85     boolean terFlag = false;
  86     String lastID = "";
  87
  88     int indexx = 0;
  89     String atomnam = null;
  90     try
  91     {
  92       while ((line = nextLine()) != null)
  93       {
  94         if (line.indexOf("HEADER") == 0)
  95         {
  96           if (line.length() > 62)
  97           {
  98             String tid;
  99             if (line.length() > 67)
 100             {
 101               tid = line.substring(62, 67).trim();
 102             }
 103             else
 104             {
 105               tid = line.substring(62).trim();
 106             }
 107             if (tid.length() > 0)
 108             {
 109               setId(tid);
 110             }
 111             continue;
 112           }
 113         }
 114         // Were we to do anything with SEQRES - we start it here
 115         if (line.indexOf("SEQRES") == 0)
 116         {
 117         }
 118
 119         if (line.indexOf("MODEL") == 0)
 120         {
 121           modelFlag = true;
 122         }
 123
 124         if (line.indexOf("TER") == 0)
 125         {
 126           terFlag = true;
 127         }
 128
 129         if (modelFlag && line.indexOf("ENDMDL") == 0)
 130         {
 131           break;
 132         }
 133         if (line.indexOf("ATOM") == 0
 134                 || (line.indexOf("HETATM") == 0 && !terFlag))
 135         {
 136           terFlag = false;
 137
 138           // Jalview is only interested in CA bonds????
 139           atomnam = line.substring(12, 15).trim();
 140           if (!atomnam.equals("CA") && !atomnam.equals("P"))
 141           {
 142             continue;
 143           }
 144
 145           Atom tmpatom = new Atom(line);
 146           if (tmpatom.resNumIns.trim().equals(lastID))
 147           {
 148             // phosphorylated protein - seen both CA and P..
 149             continue;
 150           }
 151           tmpchain = findChain(tmpatom.chain);
 152           if (tmpchain != null)
 153           {
 154             tmpchain.atoms.addElement(tmpatom);
 155           }
 156           else
 157           {
 158             // PDBfile never handles alphafold models
 159             tmpchain = new PDBChain(getId(), tmpatom.chain);
 160             getChains().add(tmpchain);
 161             tmpchain.atoms.addElement(tmpatom);
 162           }
 163           lastID = tmpatom.resNumIns.trim();
 164         }
 165         index++;
 166       }
 167
 168       makeResidueList();
 169       makeCaBondList();
 170
 171       if (getId() == null)
 172       {
 173         setId(inFile.getName());
 174       }
 175       for (PDBChain chain : getChains())
 176       {
 177         SequenceI chainseq = postProcessChain(chain);
 178         if (isRNA(chainseq))
 179         {
 180           rna.add(chainseq);
 181         }
 182         else
 183         {
 184           prot.add(chainseq);
 185         }
 186       }
 187       if (predictSecondaryStructure)
 188       {
 189         addSecondaryStructure(rna, prot);
 190       }
 191     } catch (OutOfMemoryError er)
 192     {
 193       System.out.println("OUT OF MEMORY LOADING PDB FILE");
 194       throw new IOException(MessageManager
 195               .getString("exception.outofmemory_loading_pdb_file"));
 196     } catch (NumberFormatException ex)
 197     {
 198       if (line != null)
 199       {
 200         System.err.println("Couldn't read number from line:");
 201         System.err.println(line);
 202       }
 203     }
 204     markCalcIds();
 205   }
 206
 207   /**
 208    * Process a parsed chain to construct and return a Sequence, and add it to
 209    * the list of sequences parsed.
 210    *
 211    * @param chain
 212    * @return
 213    */
 214
 215   public static boolean isCalcIdHandled(String calcId)
 216   {
 217     return calcId != null && (CALC_ID_PREFIX.equals(calcId));
 218   }
 219
 220   public static boolean isCalcIdForFile(AlignmentAnnotation alan,
 221           String pdbFile)
 222   {
 223     return alan.getCalcId() != null
 224             && CALC_ID_PREFIX.equals(alan.getCalcId())
 225             && pdbFile.equals(alan.getProperty("PDBID"));
 226   }
 227
 228   public static String relocateCalcId(String calcId,
 229           Hashtable<String, String> alreadyLoadedPDB) throws Exception
 230   {
 231     int s = CALC_ID_PREFIX.length(),
 232             end = calcId.indexOf(CALC_ID_PREFIX, s);
 233     String between = calcId.substring(s, end - 1);
 234     return CALC_ID_PREFIX + alreadyLoadedPDB.get(between) + ":"
 235             + calcId.substring(end);
 236   }
 237
 238   private void markCalcIds()
 239   {
 240     for (SequenceI sq : seqs)
 241     {
 242       if (sq.getAnnotation() != null)
 243       {
 244         for (AlignmentAnnotation aa : sq.getAnnotation())
 245         {
 246           String oldId = aa.getCalcId();
 247           if (oldId == null)
 248           {
 249             oldId = "";
 250           }
 251           aa.setCalcId(CALC_ID_PREFIX);
 252           aa.setProperty("PDBID", getId());
 253           aa.setProperty("oldCalcId", oldId);
 254         }
 255       }
 256     }
 257   }
 258
 259 }