src/jalview/ws/dbsources/Uniprot.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.4)
   3  * Copyright (C) 2008 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
  18  */
  19 package jalview.ws.dbsources;
  20
  21 import java.io.File;
  22 import java.io.FileReader;
  23 import java.io.IOException;
  24 import java.util.Enumeration;
  25 import java.util.Hashtable;
  26 import java.util.Vector;
  27
  28 import org.exolab.castor.xml.Unmarshaller;
  29
  30 import com.stevesoft.pat.Regex;
  31
  32 import jalview.datamodel.Alignment;
  33 import jalview.datamodel.AlignmentI;
  34 import jalview.datamodel.DBRefEntry;
  35 import jalview.datamodel.DBRefSource;
  36 import jalview.datamodel.PDBEntry;
  37 import jalview.datamodel.SequenceFeature;
  38 import jalview.datamodel.SequenceI;
  39 import jalview.datamodel.UniprotEntry;
  40 import jalview.datamodel.UniprotFile;
  41 import jalview.io.FormatAdapter;
  42 import jalview.io.IdentifyFile;
  43 import jalview.ws.DBRefFetcher;
  44 import jalview.ws.ebi.EBIFetchClient;
  45 import jalview.ws.seqfetcher.DbSourceProxy;
  46 import jalview.ws.seqfetcher.DbSourceProxyImpl;
  47
  48 /**
  49  * @author JimP
  50  *
  51  */
  52 public class Uniprot extends DbSourceProxyImpl implements DbSourceProxy
  53 {
  54   public Uniprot()
  55   {
  56     super();
  57     addDbSourceProperty(DBRefSource.SEQDB, DBRefSource.SEQDB);
  58     addDbSourceProperty(DBRefSource.PROTSEQDB);
  59     // addDbSourceProperty(DBRefSource.MULTIACC, new Integer(50));
  60   }
  61
  62   /*
  63    * (non-Javadoc)
  64    *
  65    * @see jalview.ws.DbSourceProxy#getAccessionSeparator()
  66    */
  67   public String getAccessionSeparator()
  68   {
  69     return null; // ";";
  70   }
  71
  72   /*
  73    * (non-Javadoc)
  74    *
  75    * @see jalview.ws.DbSourceProxy#getAccessionValidator()
  76    */
  77   public Regex getAccessionValidator()
  78   {
  79     return null;
  80   }
  81
  82   /*
  83    * (non-Javadoc)
  84    *
  85    * @see jalview.ws.DbSourceProxy#getDbSource()
  86    */
  87   public String getDbSource()
  88   {
  89     return DBRefSource.UNIPROT;
  90   }
  91
  92   /*
  93    * (non-Javadoc)
  94    *
  95    * @see jalview.ws.DbSourceProxy#getDbVersion()
  96    */
  97   public String getDbVersion()
  98   {
  99     return "0"; // we really don't know what version we're on.
 100   }
 101
 102   private EBIFetchClient ebi = null;
 103
 104   public Vector getUniprotEntries(File file)
 105   {
 106     UniprotFile uni = new UniprotFile();
 107     try
 108     {
 109       // 1. Load the mapping information from the file
 110       org.exolab.castor.mapping.Mapping map = new org.exolab.castor.mapping.Mapping(
 111               uni.getClass().getClassLoader());
 112       java.net.URL url = getClass().getResource("/uniprot_mapping.xml");
 113       map.loadMapping(url);
 114
 115       // 2. Unmarshal the data
 116       Unmarshaller unmar = new Unmarshaller(uni);
 117       unmar.setIgnoreExtraElements(true);
 118       unmar.setMapping(map);
 119
 120       uni = (UniprotFile) unmar.unmarshal(new FileReader(file));
 121     } catch (Exception e)
 122     {
 123       System.out.println("Error getUniprotEntries() " + e);
 124     }
 125
 126     return uni.getUniprotEntries();
 127   }
 128
 129   /*
 130    * (non-Javadoc)
 131    *
 132    * @see jalview.ws.DbSourceProxy#getSequenceRecords(java.lang.String[])
 133    */
 134   public AlignmentI getSequenceRecords(String queries) throws Exception
 135   {
 136     startQuery();
 137     try
 138     {
 139       Alignment al = null;
 140       ebi = new EBIFetchClient();
 141       StringBuffer result = new StringBuffer();
 142       // uniprotxml parameter required since december 2007
 143       File file = ebi.fetchDataAsFile("uniprot:" + queries, "uniprotxml",
 144               null);
 145       Vector entries = getUniprotEntries(file);
 146
 147       if (entries != null)
 148       {
 149         // First, make the new sequences
 150         Enumeration en = entries.elements();
 151         while (en.hasMoreElements())
 152         {
 153           UniprotEntry entry = (UniprotEntry) en.nextElement();
 154
 155           StringBuffer name = new StringBuffer(">UniProt/Swiss-Prot");
 156           Enumeration en2 = entry.getAccession().elements();
 157           while (en2.hasMoreElements())
 158           {
 159             name.append("|");
 160             name.append(en2.nextElement());
 161           }
 162           en2 = entry.getName().elements();
 163           while (en2.hasMoreElements())
 164           {
 165             name.append("|");
 166             name.append(en2.nextElement());
 167           }
 168
 169           if (entry.getProtein() != null
 170                   && entry.getProtein().getName() != null)
 171           {
 172             for (int nm = 0, nmSize = entry.getProtein().getName().size(); nm < nmSize; nm++)
 173             {
 174               name.append(" " + entry.getProtein().getName().elementAt(nm));
 175             }
 176           }
 177
 178           result.append(name + "\n"
 179                   + entry.getUniprotSequence().getContent() + "\n");
 180
 181         }
 182
 183         // Then read in the features and apply them to the dataset
 184         al = parseResult(result.toString());
 185         if (al != null)
 186         {
 187           // Decorate the alignment with database entries.
 188           addUniprotXrefs(al, entries);
 189         }
 190         else
 191         {
 192           results = result;
 193         }
 194       }
 195       stopQuery();
 196       return al;
 197     } catch (Exception e)
 198     {
 199       stopQuery();
 200       throw (e);
 201     }
 202   }
 203
 204   /**
 205    * add an ordered set of UniprotEntry objects to an ordered set of seuqences.
 206    *
 207    * @param al -
 208    *                a sequence of n sequences
 209    * @param entries
 210    *                a seuqence of n uniprot entries to be analysed.
 211    */
 212   public void addUniprotXrefs(Alignment al, Vector entries)
 213   {
 214     for (int i = 0; i < entries.size(); i++)
 215     {
 216       UniprotEntry entry = (UniprotEntry) entries.elementAt(i);
 217       Enumeration e = entry.getDbReference().elements();
 218       Vector onlyPdbEntries = new Vector();
 219       Vector dbxrefs = new Vector();
 220       while (e.hasMoreElements())
 221       {
 222         PDBEntry pdb = (PDBEntry) e.nextElement();
 223         DBRefEntry dbr = new DBRefEntry();
 224         dbr.setSource(pdb.getType());
 225         dbr.setAccessionId(pdb.getId());
 226         dbr.setVersion(DBRefSource.UNIPROT + ":" + getDbVersion());
 227         dbxrefs.addElement(dbr);
 228         if (!pdb.getType().equals("PDB"))
 229         {
 230           continue;
 231         }
 232
 233         onlyPdbEntries.addElement(pdb);
 234       }
 235       SequenceI sq = al.getSequenceAt(i);
 236       while (sq.getDatasetSequence() != null)
 237       {
 238         sq = sq.getDatasetSequence();
 239       }
 240
 241       Enumeration en2 = entry.getAccession().elements();
 242       while (en2.hasMoreElements())
 243       {
 244         // we always add as uniprot if we retrieved from uniprot or uniprot name
 245         sq.addDBRef(new DBRefEntry(DBRefSource.UNIPROT, getDbVersion(), en2
 246                 .nextElement().toString()));
 247       }
 248       en2 = dbxrefs.elements();
 249       while (en2.hasMoreElements())
 250       {
 251         // we always add as uniprot if we retrieved from uniprot or uniprot name
 252         sq.addDBRef((DBRefEntry) en2.nextElement());
 253
 254       }
 255       sq.setPDBId(onlyPdbEntries);
 256       if (entry.getFeature() != null)
 257       {
 258         e = entry.getFeature().elements();
 259         while (e.hasMoreElements())
 260         {
 261           SequenceFeature sf = (SequenceFeature) e.nextElement();
 262           sf.setFeatureGroup("Uniprot");
 263           sq.addSequenceFeature(sf);
 264         }
 265       }
 266     }
 267   }
 268
 269   /*
 270    * (non-Javadoc)
 271    *
 272    * @see jalview.ws.DbSourceProxy#isValidReference(java.lang.String)
 273    */
 274   public boolean isValidReference(String accession)
 275   {
 276     return true;
 277   }
 278
 279   /**
 280    * return LDHA_CHICK uniprot entry
 281    */
 282   public String getTestQuery()
 283   {
 284     return "P00340";
 285   }
 286
 287   public String getDbName()
 288   {
 289     return "Uniprot"; // getDbSource();
 290   }
 291 }