src/jalview/ws/dbsources/Pdb.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
   3  * Copyright (C) 2014 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 jalview.ws.dbsources;
  22
  23 import jalview.datamodel.Alignment;
  24 import jalview.datamodel.DBRefEntry;
  25 import jalview.datamodel.DBRefSource;
  26 import jalview.datamodel.PDBEntry;
  27 import jalview.datamodel.SequenceI;
  28
  29 import java.util.ArrayList;
  30 import java.util.List;
  31 import java.util.Vector;
  32
  33 import MCview.PDBChain;
  34 import MCview.PDBfile;
  35
  36 import com.stevesoft.pat.Regex;
  37
  38 import jalview.datamodel.AlignmentI;
  39 import jalview.io.FormatAdapter;
  40 import jalview.ws.ebi.EBIFetchClient;
  41 import jalview.ws.seqfetcher.DbSourceProxy;
  42
  43 /**
  44  * @author JimP
  45  *
  46  */
  47 public class Pdb extends EbiFileRetrievedProxy implements DbSourceProxy
  48 {
  49   public Pdb()
  50   {
  51     super();
  52     addDbSourceProperty(DBRefSource.PROTSEQDB);
  53   }
  54
  55   /*
  56    * (non-Javadoc)
  57    *
  58    * @see jalview.ws.DbSourceProxy#getAccessionSeparator()
  59    */
  60   public String getAccessionSeparator()
  61   {
  62     // TODO Auto-generated method stub
  63     return null;
  64   }
  65
  66   /*
  67    * (non-Javadoc)
  68    *
  69    * @see jalview.ws.DbSourceProxy#getAccessionValidator()
  70    */
  71   public Regex getAccessionValidator()
  72   {
  73     return new Regex("([1-9][0-9A-Za-z]{3}):?([ _A-Za-z0-9]?)");
  74   }
  75
  76   /*
  77    * (non-Javadoc)
  78    *
  79    * @see jalview.ws.DbSourceProxy#getDbSource()
  80    */
  81   public String getDbSource()
  82   {
  83     return DBRefSource.PDB;
  84   }
  85
  86   /*
  87    * (non-Javadoc)
  88    *
  89    * @see jalview.ws.DbSourceProxy#getDbVersion()
  90    */
  91   public String getDbVersion()
  92   {
  93     return "0";
  94   }
  95
  96   /*
  97    * (non-Javadoc)
  98    *
  99    * @see jalview.ws.DbSourceProxy#getSequenceRecords(java.lang.String[])
 100    */
 101   public AlignmentI getSequenceRecords(String queries) throws Exception
 102   {
 103     AlignmentI pdbfile = null;
 104     Vector result = new Vector();
 105     String chain = null;
 106     String id = null;
 107     if (queries.indexOf(":") > -1)
 108     {
 109       chain = queries.substring(queries.indexOf(":") + 1);
 110       id = queries.substring(0, queries.indexOf(":"));
 111     }
 112     else
 113     {
 114       id = queries;
 115     }
 116     if (queries.length() > 4 && chain == null)
 117     {
 118       chain = queries.substring(4, 5);
 119       id = queries.substring(0, 4);
 120     }
 121     if (!isValidReference(id))
 122     {
 123       System.err.println("Ignoring invalid pdb query: '" + id + "'");
 124       stopQuery();
 125       return null;
 126     }
 127     EBIFetchClient ebi = new EBIFetchClient();
 128     file = ebi.fetchDataAsFile("pdb:" + id, "pdb", "raw").getAbsolutePath();
 129     stopQuery();
 130     if (file == null)
 131     {
 132       return null;
 133     }
 134     try
 135     {
 136
 137       pdbfile = new FormatAdapter().readFile(file,
 138               jalview.io.AppletFormatAdapter.FILE, "PDB");
 139       if (pdbfile != null)
 140       {
 141         List<SequenceI> toremove=new ArrayList<SequenceI>();
 142         for (SequenceI pdbcs : pdbfile.getSequences())
 143         {
 144           String chid = null;
 145           // Mapping map=null;
 146           for (PDBEntry pid : (Vector<PDBEntry>) pdbcs.getPDBId())
 147           {
 148             if (pid.getFile() == file)
 149             {
 150               chid = (String) pid.getProperty().get("CHAIN");
 151
 152             }
 153             ;
 154
 155           }
 156           if (chain == null
 157                   || (chid != null && (chid.equals(chain)
 158                           || chid.trim().equals(chain.trim()) || (chain
 159                           .trim().length() == 0 && chid.equals("_")))))
 160           {
 161             pdbcs.setName(jalview.datamodel.DBRefSource.PDB + "|" + id
 162                     + "|" + pdbcs.getName());
 163             // Might need to add more metadata to the PDBEntry object
 164             // like below
 165             /*
 166              * PDBEntry entry = new PDBEntry(); // Construct the PDBEntry
 167              * entry.setId(id); if (entry.getProperty() == null)
 168              * entry.setProperty(new Hashtable());
 169              * entry.getProperty().put("chains", pdbchain.id + "=" +
 170              * sq.getStart() + "-" + sq.getEnd());
 171              * sq.getDatasetSequence().addPDBId(entry);
 172              */
 173             // Add PDB DB Refs
 174             // We make a DBRefEtntry because we have obtained the PDB file from
 175             // a
 176             // verifiable source
 177             // JBPNote - PDB DBRefEntry should also carry the chain and mapping
 178             // information
 179             DBRefEntry dbentry = new DBRefEntry(getDbSource(),
 180                     getDbVersion(), (chid == null ? id : id + chid));
 181             // dbentry.setMap()
 182             pdbcs.addDBRef(dbentry);
 183           }
 184           else
 185           {
 186             // mark this sequence to be removed from the alignment
 187             // - since it's not from the right chain
 188             toremove.add(pdbcs);
 189           }
 190         }
 191         // now remove marked sequences
 192         for (SequenceI pdbcs:toremove) {
 193           pdbfile.deleteSequence(pdbcs);
 194         }
 195       }
 196
 197       if (pdbfile == null || pdbfile.getHeight() < 1)
 198       {
 199         throw new Exception("No PDB Records for " + id + " chain "
 200                 + ((chain == null) ? "' '" : chain));
 201       }
 202
 203     } catch (Exception ex) // Problem parsing PDB file
 204     {
 205       stopQuery();
 206       throw (ex);
 207     }
 208     return pdbfile;
 209   }
 210
 211   /*
 212    * (non-Javadoc)
 213    *
 214    * @see jalview.ws.DbSourceProxy#isValidReference(java.lang.String)
 215    */
 216   public boolean isValidReference(String accession)
 217   {
 218     Regex r = getAccessionValidator();
 219     return r.search(accession.trim());
 220   }
 221
 222   /**
 223    * obtain human glyoxalase chain A sequence
 224    */
 225   public String getTestQuery()
 226   {
 227     return "1QIPA";
 228   }
 229
 230   public String getDbName()
 231   {
 232     return "PDB"; // getDbSource();
 233   }
 234
 235   @Override
 236   public int getTier()
 237   {
 238     return 0;
 239   }
 240 }