JAL-2089 patch broken merge to master for Release 2.10.0b1
[jalview.git] / src / MCview / PDBfile.java
index 3153e3c..f5a0255 100755 (executable)
-/*\r
-* Jalview - A Sequence Alignment Editor and Viewer\r
-* Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
-*\r
-* This program is free software; you can redistribute it and/or\r
-* modify it under the terms of the GNU General Public License\r
-* as published by the Free Software Foundation; either version 2\r
-* of the License, or (at your option) any later version.\r
-*\r
-* This program is distributed in the hope that it will be useful,\r
-* but WITHOUT ANY WARRANTY; without even the implied warranty of\r
-* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
-* GNU General Public License for more details.\r
-*\r
-* You should have received a copy of the GNU General Public License\r
-* along with this program; if not, write to the Free Software\r
-* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
-*/\r
-package MCview;\r
-\r
-import jalview.datamodel.*;\r
-\r
-import java.io.*;\r
-\r
-import java.util.*;\r
-import java.awt.Color;\r
-\r
-\r
-public class PDBfile extends jalview.io.AlignFile {\r
-    public Vector chains;\r
-    public String id;\r
-\r
-    public PDBfile(String inFile, String inType) throws IOException\r
-    {\r
-        super(inFile, inType);\r
-    }\r
-\r
-    public String print()\r
-    {\r
-      return null;\r
-    }\r
-\r
-    public void parse() throws IOException\r
-    {\r
-        chains = new Vector();\r
-\r
-        PDBChain tmpchain;\r
-        String line;\r
-        boolean modelFlag = false;\r
-        boolean terFlag = false;\r
-\r
-\r
-        int index = 0;\r
-        while((line = nextLine())!=null)\r
-        {\r
-           if (line.indexOf("HEADER") == 0)\r
-           {\r
-             id = line.substring(62, 67).trim();\r
-             continue;\r
-           }\r
-\r
-           if(line.indexOf("MODEL")==0)\r
-             modelFlag = true;\r
-\r
-           if(line.indexOf("TER")==0)\r
-             terFlag = true;\r
-\r
-           if(modelFlag && line.indexOf("ENDMDL")==0)\r
-             break;\r
-\r
-           if (    line.indexOf("ATOM")==0\r
-               || (line.indexOf("HETATM")==0 && !terFlag)\r
-             )\r
-            {\r
-              terFlag = false;\r
-\r
-\r
-              //Jalview is only interested in CA bonds????\r
-              if (!line.substring(12, 15).trim().equals("CA"))\r
-              {\r
-                continue;\r
-              }\r
-\r
-              Atom tmpatom = new Atom(line);\r
-              tmpchain = findChain(tmpatom.chain);\r
-              if (tmpchain != null)\r
-              {\r
-                tmpchain.atoms.addElement(tmpatom);\r
-              }\r
-              else\r
-              {\r
-                tmpchain = new PDBChain(tmpatom.chain);\r
-                chains.addElement(tmpchain);\r
-                tmpchain.atoms.addElement(tmpatom);\r
-              }\r
-          }\r
-          index ++;\r
-        }\r
-\r
-       makeResidueList();\r
-       makeCaBondList();\r
-\r
-       if(id==null)\r
-       {\r
-         id = inFile.getName();\r
-       }\r
-       for (int i = 0; i < chains.size(); i++)\r
-       {\r
-         SequenceI seq = ( (PDBChain) chains.elementAt(i)).\r
-             sequence;\r
-         seq.setName(id + "|" + seq.getName());\r
-         Sequence dataset = new Sequence(seq.\r
-             getName(),\r
-             seq.getSequence().toString(), seq.getStart(), seq.getEnd());\r
-\r
-         PDBEntry entry = new PDBEntry();\r
-         entry.setId(id);\r
-         if(inFile!=null)\r
-           entry.setFile(inFile.getAbsolutePath());\r
-\r
-         seq.setDatasetSequence(dataset);\r
-         dataset.addPDBId(entry);\r
-\r
-         getSeqs().addElement(seq);\r
-       }\r
-    }\r
-\r
-    public void makeResidueList() {\r
-        for (int i = 0; i < chains.size(); i++) {\r
-            ((PDBChain) chains.elementAt(i)).makeResidueList();\r
-        }\r
-    }\r
-\r
-    public void makeCaBondList() {\r
-        for (int i = 0; i < chains.size(); i++) {\r
-            ((PDBChain) chains.elementAt(i)).makeCaBondList();\r
-        }\r
-    }\r
-\r
-    public PDBChain findChain(String id) {\r
-        for (int i = 0; i < chains.size(); i++) {\r
-            if (((PDBChain) chains.elementAt(i)).id.equals(id)) {\r
-                return (PDBChain) chains.elementAt(i);\r
-            }\r
-        }\r
-\r
-        return null;\r
-    }\r
-\r
-    public void setChargeColours() {\r
-        for (int i = 0; i < chains.size(); i++) {\r
-            ((PDBChain) chains.elementAt(i)).setChargeColours();\r
-        }\r
-    }\r
-\r
-    public void setColours(jalview.schemes.ColourSchemeI cs) {\r
-        for (int i = 0; i < chains.size(); i++) {\r
-            ((PDBChain) chains.elementAt(i)).setChainColours(cs);\r
-        }\r
-    }\r
-\r
-    public void setChainColours()\r
-    {\r
-       for (int i = 0; i < chains.size(); i++)\r
-       {\r
-            ((PDBChain) chains.elementAt(i)).setChainColours(\r
-                     Color.getHSBColor(1.0f / (float)i, .4f, 1.0f)\r
-                );\r
-        }\r
-    }\r
-}\r
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
+package MCview;
+
+import jalview.datamodel.AlignmentAnnotation;
+import jalview.datamodel.DBRefSource;
+import jalview.datamodel.SequenceI;
+import jalview.io.FileParse;
+import jalview.io.StructureFile;
+import jalview.util.MessageManager;
+
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Hashtable;
+import java.util.List;
+import java.util.Vector;
+
+public class PDBfile extends StructureFile
+{
+  private static String CALC_ID_PREFIX = "JalviewPDB";
+
+  public PDBfile(boolean addAlignmentAnnotations,
+          boolean predictSecondaryStructure, boolean externalSecStr)
+  {
+    super();
+    addSettings(addAlignmentAnnotations, predictSecondaryStructure,
+            externalSecStr);
+  }
+
+  public PDBfile(boolean addAlignmentAnnotations, boolean predictSecStr,
+          boolean externalSecStr, String dataObject, String protocol)
+          throws IOException
+  {
+    super(false, dataObject, protocol);
+    addSettings(addAlignmentAnnotations, predictSecStr, externalSecStr);
+    doParse();
+  }
+
+  public PDBfile(boolean addAlignmentAnnotations, boolean predictSecStr,
+          boolean externalSecStr, FileParse source) throws IOException
+  {
+    super(false, source);
+    addSettings(addAlignmentAnnotations, predictSecStr, externalSecStr);
+    doParse();
+  }
+
+  @Override
+  public String print()
+  {
+    return null;
+  }
+
+  @Override
+  public void parse() throws IOException
+  {
+    setDbRefType(DBRefSource.PDB);
+    // TODO set the filename sensibly - try using data source name.
+    setId(safeName(getDataName()));
+
+    setChains(new Vector<PDBChain>());
+    List<SequenceI> rna = new ArrayList<SequenceI>();
+    List<SequenceI> prot = new ArrayList<SequenceI>();
+    PDBChain tmpchain;
+    String line = null;
+    boolean modelFlag = false;
+    boolean terFlag = false;
+    String lastID = "";
+
+    int indexx = 0;
+    String atomnam = null;
+    try
+    {
+      while ((line = nextLine()) != null)
+      {
+        if (line.indexOf("HEADER") == 0)
+        {
+          if (line.length() > 62)
+          {
+            String tid;
+            if (line.length() > 67)
+            {
+              tid = line.substring(62, 67).trim();
+            }
+            else
+            {
+              tid = line.substring(62).trim();
+            }
+            if (tid.length() > 0)
+            {
+              setId(tid);
+            }
+            continue;
+          }
+        }
+        // Were we to do anything with SEQRES - we start it here
+        if (line.indexOf("SEQRES") == 0)
+        {
+        }
+
+        if (line.indexOf("MODEL") == 0)
+        {
+          modelFlag = true;
+        }
+
+        if (line.indexOf("TER") == 0)
+        {
+          terFlag = true;
+        }
+
+        if (modelFlag && line.indexOf("ENDMDL") == 0)
+        {
+          break;
+        }
+        if (line.indexOf("ATOM") == 0
+                || (line.indexOf("HETATM") == 0 && !terFlag))
+        {
+          terFlag = false;
+
+          // Jalview is only interested in CA bonds????
+          atomnam = line.substring(12, 15).trim();
+          if (!atomnam.equals("CA") && !atomnam.equals("P"))
+          {
+            continue;
+          }
+
+          Atom tmpatom = new Atom(line);
+          try
+          {
+            tmpchain = findChain(tmpatom.chain);
+            if (tmpatom.resNumIns.trim().equals(lastID))
+            {
+              // phosphorylated protein - seen both CA and P..
+              continue;
+            }
+            tmpchain.atoms.addElement(tmpatom);
+          } catch (Exception e)
+          {
+            tmpchain = new PDBChain(getId(), tmpatom.chain);
+            getChains().add(tmpchain);
+            tmpchain.atoms.addElement(tmpatom);
+          }
+          lastID = tmpatom.resNumIns.trim();
+        }
+        index++;
+      }
+
+      makeResidueList();
+      makeCaBondList();
+
+      if (getId() == null)
+      {
+        setId(inFile.getName());
+      }
+      for (PDBChain chain : getChains())
+      {
+        SequenceI chainseq = postProcessChain(chain);
+        if (isRNA(chainseq))
+        {
+          rna.add(chainseq);
+        }
+        else
+        {
+          prot.add(chainseq);
+        }
+      }
+      if (predictSecondaryStructure)
+      {
+        addSecondaryStructure(rna, prot);
+      }
+    } catch (OutOfMemoryError er)
+    {
+      System.out.println("OUT OF MEMORY LOADING PDB FILE");
+      throw new IOException(
+              MessageManager
+                      .getString("exception.outofmemory_loading_pdb_file"));
+    } catch (NumberFormatException ex)
+    {
+      if (line != null)
+      {
+        System.err.println("Couldn't read number from line:");
+        System.err.println(line);
+      }
+    }
+    markCalcIds();
+  }
+
+  /**
+   * Process a parsed chain to construct and return a Sequence, and add it to
+   * the list of sequences parsed.
+   * 
+   * @param chain
+   * @return
+   */
+
+  public static boolean isCalcIdHandled(String calcId)
+  {
+    return calcId != null && (CALC_ID_PREFIX.equals(calcId));
+  }
+
+  public static boolean isCalcIdForFile(AlignmentAnnotation alan,
+          String pdbFile)
+  {
+    return alan.getCalcId() != null
+            && CALC_ID_PREFIX.equals(alan.getCalcId())
+            && pdbFile.equals(alan.getProperty("PDBID"));
+  }
+
+  public static String relocateCalcId(String calcId,
+          Hashtable<String, String> alreadyLoadedPDB) throws Exception
+  {
+    int s = CALC_ID_PREFIX.length(), end = calcId
+            .indexOf(CALC_ID_PREFIX, s);
+    String between = calcId.substring(s, end - 1);
+    return CALC_ID_PREFIX + alreadyLoadedPDB.get(between) + ":"
+            + calcId.substring(end);
+  }
+
+  private void markCalcIds()
+  {
+    for (SequenceI sq : seqs)
+    {
+      if (sq.getAnnotation() != null)
+      {
+        for (AlignmentAnnotation aa : sq.getAnnotation())
+        {
+          String oldId = aa.getCalcId();
+          if (oldId == null)
+          {
+            oldId = "";
+          }
+          aa.setCalcId(CALC_ID_PREFIX);
+          aa.setProperty("PDBID", getId());
+          aa.setProperty("oldCalcId", oldId);
+        }
+      }
+    }
+  }
+
+}