src/jalview/ws/dbsources/Uniprot.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 jalview.ws.dbsources;
  22
  23 import jalview.datamodel.Alignment;
  24 import jalview.datamodel.AlignmentI;
  25 import jalview.datamodel.DBRefEntry;
  26 import jalview.datamodel.DBRefSource;
  27 import jalview.datamodel.PDBEntry;
  28 import jalview.datamodel.Sequence;
  29 import jalview.datamodel.SequenceFeature;
  30 import jalview.datamodel.SequenceI;
  31 import jalview.datamodel.UniprotEntry;
  32 import jalview.datamodel.UniprotFile;
  33 import jalview.ws.ebi.EBIFetchClient;
  34 import jalview.ws.seqfetcher.DbSourceProxyImpl;
  35
  36 import java.io.File;
  37 import java.io.FileReader;
  38 import java.io.Reader;
  39 import java.net.URL;
  40 import java.util.ArrayList;
  41 import java.util.Vector;
  42
  43 import org.exolab.castor.mapping.Mapping;
  44 import org.exolab.castor.xml.Unmarshaller;
  45
  46 import com.stevesoft.pat.Regex;
  47
  48 /**
  49  * @author JimP
  50  *
  51  */
  52 public class Uniprot extends DbSourceProxyImpl
  53 {
  54   private static final String BAR_DELIMITER = "|";
  55
  56   /*
  57    * Castor mapping loaded from uniprot_mapping.xml
  58    */
  59   private static Mapping map;
  60
  61   /**
  62    * Constructor
  63    */
  64   public Uniprot()
  65   {
  66     super();
  67   }
  68
  69   /*
  70    * (non-Javadoc)
  71    *
  72    * @see jalview.ws.DbSourceProxy#getAccessionSeparator()
  73    */
  74   @Override
  75   public String getAccessionSeparator()
  76   {
  77     return null;
  78   }
  79
  80   /*
  81    * (non-Javadoc)
  82    *
  83    * @see jalview.ws.DbSourceProxy#getAccessionValidator()
  84    */
  85   @Override
  86   public Regex getAccessionValidator()
  87   {
  88     return new Regex("([A-Z]+[0-9]+[A-Z0-9]+|[A-Z0-9]+_[A-Z0-9]+)");
  89   }
  90
  91   /*
  92    * (non-Javadoc)
  93    *
  94    * @see jalview.ws.DbSourceProxy#getDbSource()
  95    */
  96   @Override
  97   public String getDbSource()
  98   {
  99     return DBRefSource.UNIPROT;
 100   }
 101
 102   /*
 103    * (non-Javadoc)
 104    *
 105    * @see jalview.ws.DbSourceProxy#getDbVersion()
 106    */
 107   @Override
 108   public String getDbVersion()
 109   {
 110     return "0"; // we really don't know what version we're on.
 111   }
 112
 113   /**
 114    * Reads a file containing the reply to the EBI Fetch Uniprot data query,
 115    * unmarshals it to a UniprotFile object, and returns the list of UniprotEntry
 116    * data models (mapped from &lt;entry&gt; elements)
 117    *
 118    * @param fileReader
 119    * @return
 120    */
 121   public Vector<UniprotEntry> getUniprotEntries(Reader fileReader)
 122   {
 123     UniprotFile uni = new UniprotFile();
 124     try
 125     {
 126       if (map == null)
 127       {
 128         // 1. Load the mapping information from the file
 129         map = new Mapping(uni.getClass().getClassLoader());
 130         URL url = getClass().getResource("/uniprot_mapping.xml");
 131         map.loadMapping(url);
 132       }
 133
 134       // 2. Unmarshal the data
 135       Unmarshaller unmar = new Unmarshaller(uni);
 136       unmar.setIgnoreExtraElements(true);
 137       unmar.setMapping(map);
 138       if (fileReader != null)
 139       {
 140         uni = (UniprotFile) unmar.unmarshal(fileReader);
 141       }
 142     } catch (Exception e)
 143     {
 144       System.out.println("Error getUniprotEntries() " + e);
 145     }
 146
 147     return uni.getUniprotEntries();
 148   }
 149
 150   /*
 151    * (non-Javadoc)
 152    *
 153    * @see jalview.ws.DbSourceProxy#getSequenceRecords(java.lang.String[])
 154    */
 155   @Override
 156   public AlignmentI getSequenceRecords(String queries) throws Exception
 157   {
 158     startQuery();
 159     try
 160     {
 161       queries = queries.toUpperCase().replaceAll(
 162               "(UNIPROT\\|?|UNIPROT_|UNIREF\\d+_|UNIREF\\d+\\|?)", "");
 163       AlignmentI al = null;
 164       EBIFetchClient ebi = new EBIFetchClient();
 165       // uniprotxml parameter required since december 2007
 166       // uniprotkb dbname changed introduced december 2008
 167       File file = ebi.fetchDataAsFile("uniprotkb:" + queries, "uniprotxml",
 168               ".xml");
 169       Vector<UniprotEntry> entries = getUniprotEntries(new FileReader(file));
 170
 171       if (entries != null)
 172       {
 173         ArrayList<SequenceI> seqs = new ArrayList<SequenceI>();
 174         for (UniprotEntry entry : entries)
 175         {
 176           seqs.add(uniprotEntryToSequenceI(entry));
 177         }
 178         al = new Alignment(seqs.toArray(new SequenceI[0]));
 179
 180       }
 181       stopQuery();
 182       return al;
 183     } catch (Exception e)
 184     {
 185       stopQuery();
 186       throw (e);
 187     }
 188   }
 189
 190   /**
 191    *
 192    * @param entry
 193    *          UniprotEntry
 194    * @return SequenceI instance created from the UniprotEntry instance
 195    */
 196   public SequenceI uniprotEntryToSequenceI(UniprotEntry entry)
 197   {
 198     String id = getUniprotEntryId(entry);
 199     SequenceI sequence = new Sequence(id, entry.getUniprotSequence()
 200             .getContent());
 201     sequence.setDescription(getUniprotEntryDescription(entry));
 202
 203     final String dbVersion = getDbVersion();
 204     ArrayList<DBRefEntry> dbRefs = new ArrayList<DBRefEntry>();
 205     for (String accessionId : entry.getAccession())
 206     {
 207       DBRefEntry dbRef = new DBRefEntry(DBRefSource.UNIPROT, dbVersion,
 208               accessionId);
 209
 210       // mark dbRef as a primary reference for this sequence
 211       dbRefs.add(dbRef);
 212     }
 213
 214     Vector<PDBEntry> onlyPdbEntries = new Vector<PDBEntry>();
 215     for (PDBEntry pdb : entry.getDbReference())
 216     {
 217       DBRefEntry dbr = new DBRefEntry();
 218       dbr.setSource(pdb.getType());
 219       dbr.setAccessionId(pdb.getId());
 220       dbr.setVersion(DBRefSource.UNIPROT + ":" + dbVersion);
 221       dbRefs.add(dbr);
 222       if ("PDB".equals(pdb.getType()))
 223       {
 224         onlyPdbEntries.addElement(pdb);
 225       }
 226       if ("EMBL".equals(pdb.getType()))
 227       {
 228         // look for a CDS reference and add it, too.
 229         String cdsId = (String) pdb.getProperty()
 230                 .get("protein sequence ID");
 231         if (cdsId != null && cdsId.trim().length() > 0)
 232         {
 233           // remove version
 234           String[] vrs = cdsId.split("\\.");
 235           dbr = new DBRefEntry(DBRefSource.EMBLCDS, vrs.length > 1 ? vrs[1]
 236                   : DBRefSource.UNIPROT + ":" + dbVersion, vrs[0]);
 237           dbRefs.add(dbr);
 238         }
 239       }
 240       if ("Ensembl".equals(pdb.getType()))
 241       {
 242         /*UniprotXML
 243          * <dbReference type="Ensembl" id="ENST00000321556">
 244         * <molecule id="Q9BXM7-1"/>
 245         * <property type="protein sequence ID" value="ENSP00000364204"/>
 246         * <property type="gene ID" value="ENSG00000158828"/>
 247         * </dbReference>
 248          */
 249         String cdsId = (String) pdb.getProperty()
 250                 .get("protein sequence ID");
 251         if (cdsId != null && cdsId.trim().length() > 0)
 252         {
 253           dbr = new DBRefEntry(DBRefSource.ENSEMBL, DBRefSource.UNIPROT
 254                   + ":" + dbVersion, cdsId.trim());
 255           dbRefs.add(dbr);
 256
 257         }
 258       }
 259
 260     }
 261
 262     sequence.setPDBId(onlyPdbEntries);
 263     if (entry.getFeature() != null)
 264     {
 265       for (SequenceFeature sf : entry.getFeature())
 266       {
 267         sf.setFeatureGroup("Uniprot");
 268         sequence.addSequenceFeature(sf);
 269       }
 270     }
 271     for (DBRefEntry dbr : dbRefs)
 272     {
 273       sequence.addDBRef(dbr);
 274     }
 275     return sequence;
 276   }
 277
 278   /**
 279    *
 280    * @param entry
 281    *          UniportEntry
 282    * @return protein name(s) delimited by a white space character
 283    */
 284   public static String getUniprotEntryDescription(UniprotEntry entry)
 285   {
 286     StringBuilder desc = new StringBuilder(32);
 287     if (entry.getProtein() != null && entry.getProtein().getName() != null)
 288     {
 289       boolean first = true;
 290       for (String nm : entry.getProtein().getName())
 291       {
 292         if (!first)
 293         {
 294           desc.append(" ");
 295         }
 296         first = false;
 297         desc.append(nm);
 298       }
 299     }
 300     return desc.toString();
 301   }
 302
 303   /**
 304    *
 305    * @param entry
 306    *          UniportEntry
 307    * @return The accession id(s) and name(s) delimited by '|'.
 308    */
 309   public static String getUniprotEntryId(UniprotEntry entry)
 310   {
 311     StringBuilder name = new StringBuilder(32);
 312     // name.append("UniProt/Swiss-Prot");
 313     // use 'canonicalised' name for optimal id matching
 314     name.append(DBRefSource.UNIPROT);
 315     for (String accessionId : entry.getAccession())
 316     {
 317       name.append(BAR_DELIMITER);
 318       name.append(accessionId);
 319     }
 320     for (String n : entry.getName())
 321     {
 322       name.append(BAR_DELIMITER);
 323       name.append(n);
 324     }
 325     return name.toString();
 326   }
 327
 328   /*
 329    * (non-Javadoc)
 330    *
 331    * @see jalview.ws.DbSourceProxy#isValidReference(java.lang.String)
 332    */
 333   @Override
 334   public boolean isValidReference(String accession)
 335   {
 336     // TODO: make the following a standard validator
 337     return (accession == null || accession.length() < 2) ? false
 338             : getAccessionValidator().search(accession);
 339   }
 340
 341   /**
 342    * return LDHA_CHICK uniprot entry
 343    */
 344   @Override
 345   public String getTestQuery()
 346   {
 347     return "P00340";
 348   }
 349
 350   @Override
 351   public String getDbName()
 352   {
 353     return "Uniprot"; // getDbSource();
 354   }
 355
 356   @Override
 357   public int getTier()
 358   {
 359     return 0;
 360   }
 361 }