src/jalview/ws/dbsources/Pdb.java

   1 /**\r
   2  * \r
   3  */\r
   4 package jalview.ws.dbsources;\r
   5 \r
   6 import jalview.datamodel.Alignment;\r
   7 import jalview.datamodel.DBRefEntry;\r
   8 import jalview.datamodel.DBRefSource;\r
   9 import jalview.datamodel.SequenceI;\r
  10 \r
  11 import java.io.BufferedInputStream;\r
  12 import java.io.InputStream;\r
  13 import java.io.InputStreamReader;\r
  14 import java.util.Hashtable;\r
  15 import java.util.Vector;\r
  16 \r
  17 import MCview.PDBChain;\r
  18 import MCview.PDBfile;\r
  19 \r
  20 import com.stevesoft.pat.Regex;\r
  21 \r
  22 import jalview.datamodel.AlignmentI;\r
  23 import jalview.io.FileParse;\r
  24 import jalview.ws.ebi.EBIFetchClient;\r
  25 import jalview.ws.seqfetcher.DbSourceProxy;\r
  26 import jalview.ws.seqfetcher.DbSourceProxyImpl;\r
  27 \r
  28 /**\r
  29  * @author JimP\r
  30  *\r
  31  */\r
  32 public class Pdb extends EbiFileRetrievedProxy implements DbSourceProxy\r
  33 {\r
  34   public Pdb() {\r
  35     super();\r
  36     addDbSourceProperty(DBRefSource.PROTSEQDB);\r
  37   }\r
  38 \r
  39   /* (non-Javadoc)\r
  40    * @see jalview.ws.DbSourceProxy#getAccessionSeparator()\r
  41    */\r
  42   public String getAccessionSeparator()\r
  43   {\r
  44     // TODO Auto-generated method stub\r
  45     return null;\r
  46   }\r
  47 \r
  48   /* (non-Javadoc)\r
  49    * @see jalview.ws.DbSourceProxy#getAccessionValidator()\r
  50    */\r
  51   public Regex getAccessionValidator()\r
  52   {\r
  53     return new Regex("([1-9][0-9A-Za-z]{3}):?([ _A-Za-z0-9]?)");\r
  54   }\r
  55 \r
  56   /* (non-Javadoc)\r
  57    * @see jalview.ws.DbSourceProxy#getDbSource()\r
  58    */\r
  59   public String getDbSource()\r
  60   {\r
  61     return DBRefSource.PDB;\r
  62   }\r
  63 \r
  64   /* (non-Javadoc)\r
  65    * @see jalview.ws.DbSourceProxy#getDbVersion()\r
  66    */\r
  67   public String getDbVersion()\r
  68   {\r
  69     return "0";\r
  70   }\r
  71   /* (non-Javadoc)\r
  72    * @see jalview.ws.DbSourceProxy#getSequenceRecords(java.lang.String[])\r
  73    */\r
  74   public AlignmentI getSequenceRecords(String queries) throws Exception\r
  75   {\r
  76 \r
  77     Vector result = new Vector();\r
  78     String chain = null;\r
  79     String id = null;\r
  80     if (queries.indexOf(":") > -1)\r
  81     {\r
  82       chain = queries.substring(queries.indexOf(":") + 1);\r
  83       id = queries.substring(0, queries.indexOf(":"));\r
  84     }\r
  85     else\r
  86     {\r
  87       id = queries;\r
  88     }\r
  89     if (queries.length() > 4 && chain == null)\r
  90     {\r
  91       chain = queries.substring(4,5);\r
  92       id = queries.substring(0, 4);\r
  93     }\r
  94     if (!isValidReference(id))\r
  95     {\r
  96       System.err.println("Ignoring invalid pdb query: '"+id+"'");\r
  97       stopQuery();\r
  98       return null;\r
  99     }\r
 100     EBIFetchClient ebi = new EBIFetchClient();\r
 101     file = ebi.fetchDataAsFile("pdb:" + id, "pdb", "raw")\r
 102             .getAbsolutePath();\r
 103     stopQuery();\r
 104     if (file == null)\r
 105     {\r
 106       return null;\r
 107     }\r
 108     try\r
 109     {\r
 110       \r
 111       PDBfile pdbfile = new PDBfile(file,\r
 112               jalview.io.AppletFormatAdapter.FILE);\r
 113       for (int i = 0; i < pdbfile.chains.size(); i++)\r
 114       {\r
 115         if (chain == null\r
 116                 || ((PDBChain) pdbfile.chains.elementAt(i)).id\r
 117                         .toUpperCase().equals(chain))\r
 118         {\r
 119           PDBChain pdbchain = (PDBChain) pdbfile.chains.elementAt(i);\r
 120           // Get the Chain's Sequence - who's dataset includes any special features added from the PDB file\r
 121           SequenceI sq = pdbchain.sequence;\r
 122           // Specially formatted name for the PDB chain sequences retrieved from the PDB\r
 123           sq.setName(jalview.datamodel.DBRefSource.PDB+"|" + id + "|" + sq.getName());\r
 124           // Might need to add more metadata to the PDBEntry object\r
 125           // like below\r
 126           /*\r
 127            * PDBEntry entry = new PDBEntry();\r
 128            // Construct the PDBEntry\r
 129            entry.setId(id);\r
 130            if (entry.getProperty() == null)\r
 131            entry.setProperty(new Hashtable());\r
 132            entry.getProperty().put("chains",\r
 133            pdbchain.id\r
 134            + "=" + sq.getStart()\r
 135            + "-" + sq.getEnd());\r
 136            sq.getDatasetSequence().addPDBId(entry);\r
 137            */\r
 138           // Add PDB DB Refs\r
 139           // We make a DBRefEtntry because we have obtained the PDB file from a verifiable source\r
 140           // JBPNote - PDB DBRefEntry should also carry the chain and mapping information\r
 141           DBRefEntry dbentry = new DBRefEntry(getDbSource(),\r
 142                   getDbVersion(), id + pdbchain.id);\r
 143           sq.addDBRef(dbentry);\r
 144           // and add seuqence to the retrieved set\r
 145           result.addElement(sq.deriveSequence());\r
 146         }\r
 147       }\r
 148 \r
 149       if (result.size() < 1)\r
 150       {\r
 151         throw new Exception("No PDB Records for " + id + " chain "\r
 152                 + ((chain == null) ? "' '" : chain));\r
 153       }\r
 154     } catch (Exception ex) // Problem parsing PDB file\r
 155     {\r
 156       stopQuery();\r
 157       throw (ex);\r
 158     }\r
 159 \r
 160     SequenceI[] results = new SequenceI[result.size()];\r
 161     for (int i = 0, j = result.size(); i < j; i++)\r
 162     {\r
 163       results[i] = (SequenceI) result.elementAt(i);\r
 164       result.setElementAt(null, i);\r
 165     }\r
 166     return new Alignment(results);\r
 167   }\r
 168 \r
 169   /* (non-Javadoc)\r
 170    * @see jalview.ws.DbSourceProxy#isValidReference(java.lang.String)\r
 171    */\r
 172   public boolean isValidReference(String accession)\r
 173   {\r
 174     Regex r = getAccessionValidator();\r
 175     return r.search(accession.trim());\r
 176   }\r
 177 \r
 178   /**\r
 179    * obtain human glyoxalase chain A sequence\r
 180    */\r
 181   public String getTestQuery()\r
 182   {\r
 183     return "1QIPA";\r
 184   }\r
 185 \r
 186   public String getDbName()\r
 187   {\r
 188     return "PDB"; // getDbSource();\r
 189   }\r
 190 \r
 191 }\r