src/jalview/util/DBRefUtils.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.util;
  22
  23 import jalview.datamodel.DBRefEntry;
  24 import jalview.datamodel.DBRefSource;
  25 import jalview.datamodel.PDBEntry;
  26 import jalview.datamodel.SequenceI;
  27
  28 import java.util.ArrayList;
  29 import java.util.HashMap;
  30 import java.util.HashSet;
  31 import java.util.Hashtable;
  32 import java.util.List;
  33 import java.util.Map;
  34 import java.util.Set;
  35
  36 import com.stevesoft.pat.Regex;
  37
  38 /**
  39  * Utilities for handling DBRef objects and their collections.
  40  */
  41 public class DBRefUtils
  42 {
  43   /*
  44    * lookup from lower-case form of a name to its canonical (standardised) form
  45    */
  46   private static Map<String, String> canonicalSourceNameLookup = new HashMap<String, String>();
  47
  48   private static Map<String, String> dasCoordinateSystemsLookup = new HashMap<String, String>();
  49
  50   static
  51   {
  52     // TODO load these from a resource file?
  53     canonicalSourceNameLookup.put("uniprotkb/swiss-prot",
  54             DBRefSource.UNIPROT);
  55     canonicalSourceNameLookup.put("uniprotkb/trembl", DBRefSource.UNIPROT);
  56
  57     // Ensembl values for dbname in xref REST service:
  58     canonicalSourceNameLookup.put("uniprot/sptrembl", DBRefSource.UNIPROT);
  59     canonicalSourceNameLookup.put("uniprot/swissprot", DBRefSource.UNIPROT);
  60
  61     canonicalSourceNameLookup.put("pdb", DBRefSource.PDB);
  62     canonicalSourceNameLookup.put("ensembl", DBRefSource.ENSEMBL);
  63     // Ensembl Gn and Tr are for Ensembl genomic and transcript IDs as served
  64     // from ENA.
  65     canonicalSourceNameLookup.put("ensembl-tr", DBRefSource.ENSEMBL);
  66     canonicalSourceNameLookup.put("ensembl-gn", DBRefSource.ENSEMBL);
  67
  68     // Make sure we have lowercase entries for all canonical string lookups
  69     Set<String> keys = canonicalSourceNameLookup.keySet();
  70     for (String k : keys)
  71     {
  72       canonicalSourceNameLookup.put(k.toLowerCase(),
  73               canonicalSourceNameLookup.get(k));
  74     }
  75
  76     dasCoordinateSystemsLookup.put("pdbresnum", DBRefSource.PDB);
  77     dasCoordinateSystemsLookup.put("uniprot", DBRefSource.UNIPROT);
  78     dasCoordinateSystemsLookup.put("embl", DBRefSource.EMBL);
  79     // dasCoordinateSystemsLookup.put("embl", DBRefSource.EMBLCDS);
  80   }
  81
  82   /**
  83    * Returns those DBRefEntry objects whose source identifier (once converted to
  84    * Jalview's canonical form) is in the list of sources to search for. Returns
  85    * null if no matches found.
  86    *
  87    * @param dbrefs
  88    *          DBRefEntry objects to search
  89    * @param sources
  90    *          array of sources to select
  91    * @return
  92    */
  93   public static DBRefEntry[] selectRefs(DBRefEntry[] dbrefs,
  94           String[] sources)
  95   {
  96     if (dbrefs == null || sources == null)
  97     {
  98       return dbrefs;
  99     }
 100     HashSet<String> srcs = new HashSet<String>();
 101     for (String src : sources)
 102     {
 103       srcs.add(src);
 104     }
 105
 106     List<DBRefEntry> res = new ArrayList<DBRefEntry>();
 107     for (DBRefEntry dbr : dbrefs)
 108     {
 109       String source = getCanonicalName(dbr.getSource());
 110       if (srcs.contains(source))
 111       {
 112         res.add(dbr);
 113       }
 114     }
 115
 116     if (res.size() > 0)
 117     {
 118       DBRefEntry[] reply = new DBRefEntry[res.size()];
 119       return res.toArray(reply);
 120     }
 121     return null;
 122   }
 123
 124   /**
 125    * isDasCoordinateSystem
 126    *
 127    * @param string
 128    *          String
 129    * @param dBRefEntry
 130    *          DBRefEntry
 131    * @return boolean true if Source DBRefEntry is compatible with DAS
 132    *         CoordinateSystem name
 133    */
 134
 135   public static boolean isDasCoordinateSystem(String string,
 136           DBRefEntry dBRefEntry)
 137   {
 138     if (string == null || dBRefEntry == null)
 139     {
 140       return false;
 141     }
 142     String coordsys = dasCoordinateSystemsLookup.get(string.toLowerCase());
 143     return coordsys == null ? false : coordsys.equals(dBRefEntry
 144             .getSource());
 145   }
 146
 147   /**
 148    * look up source in an internal list of database reference sources and return
 149    * the canonical jalview name for the source, or the original string if it has
 150    * no canonical form.
 151    *
 152    * @param source
 153    * @return canonical jalview source (one of jalview.datamodel.DBRefSource.*)
 154    *         or original source
 155    */
 156   public static String getCanonicalName(String source)
 157   {
 158     if (source == null)
 159     {
 160       return null;
 161     }
 162     String canonical = canonicalSourceNameLookup.get(source.toLowerCase());
 163     return canonical == null ? source : canonical;
 164   }
 165
 166   /**
 167    * Returns a (possibly empty) list of those references that match the given
 168    * entry. Currently uses a comparator which matches if
 169    * <ul>
 170    * <li>database sources are the same</li>
 171    * <li>accession ids are the same</li>
 172    * <li>both have no mapping, or the mappings are the same</li>
 173    * </ul>
 174    *
 175    * @param ref
 176    *          Set of references to search
 177    * @param entry
 178    *          pattern to match
 179    * @return
 180    */
 181   public static List<DBRefEntry> searchRefs(DBRefEntry[] ref,
 182           DBRefEntry entry)
 183   {
 184     return searchRefs(ref, entry,
 185             matchDbAndIdAndEitherMapOrEquivalentMapList);
 186   }
 187
 188   /**
 189    * Returns a list of those references that match the given accession id
 190    * <ul>
 191    * <li>database sources are the same</li>
 192    * <li>accession ids are the same</li>
 193    * <li>both have no mapping, or the mappings are the same</li>
 194    * </ul>
 195    *
 196    * @param refs
 197    *          Set of references to search
 198    * @param accId
 199    *          accession id to match
 200    * @return
 201    */
 202   public static List<DBRefEntry> searchRefs(DBRefEntry[] refs, String accId)
 203   {
 204     return searchRefs(refs, new DBRefEntry("", "", accId), matchId);
 205   }
 206
 207   /**
 208    * Returns a (possibly empty) list of those references that match the given
 209    * entry, according to the given comparator.
 210    *
 211    * @param refs
 212    *          an array of database references to search
 213    * @param entry
 214    *          an entry to compare against
 215    * @param comparator
 216    * @return
 217    */
 218   static List<DBRefEntry> searchRefs(DBRefEntry[] refs, DBRefEntry entry,
 219           DbRefComp comparator)
 220   {
 221     List<DBRefEntry> rfs = new ArrayList<DBRefEntry>();
 222     if (refs == null || entry == null)
 223     {
 224       return rfs;
 225     }
 226     for (int i = 0; i < refs.length; i++)
 227     {
 228       if (comparator.matches(entry, refs[i]))
 229       {
 230         rfs.add(refs[i]);
 231       }
 232     }
 233     return rfs;
 234   }
 235
 236   interface DbRefComp
 237   {
 238     public boolean matches(DBRefEntry refa, DBRefEntry refb);
 239   }
 240
 241   /**
 242    * match on all non-null fields in refa
 243    */
 244   // TODO unused - remove?
 245   public static DbRefComp matchNonNullonA = new DbRefComp()
 246   {
 247     @Override
 248     public boolean matches(DBRefEntry refa, DBRefEntry refb)
 249     {
 250       if (refa.getSource() == null
 251               || DBRefUtils.getCanonicalName(refb.getSource()).equals(
 252                       DBRefUtils.getCanonicalName(refa.getSource())))
 253       {
 254         if (refa.getVersion() == null
 255                 || refb.getVersion().equals(refa.getVersion()))
 256         {
 257           if (refa.getAccessionId() == null
 258                   || refb.getAccessionId().equals(refa.getAccessionId()))
 259           {
 260             if (refa.getMap() == null
 261                     || (refb.getMap() != null && refb.getMap().equals(
 262                             refa.getMap())))
 263             {
 264               return true;
 265             }
 266           }
 267         }
 268       }
 269       return false;
 270     }
 271   };
 272
 273   /**
 274    * either field is null or field matches for all of source, version, accession
 275    * id and map.
 276    */
 277   // TODO unused - remove?
 278   public static DbRefComp matchEitherNonNull = new DbRefComp()
 279   {
 280     @Override
 281     public boolean matches(DBRefEntry refa, DBRefEntry refb)
 282     {
 283       if (nullOrEqualSource(refa.getSource(), refb.getSource())
 284               && nullOrEqual(refa.getVersion(), refb.getVersion())
 285               && nullOrEqual(refa.getAccessionId(), refb.getAccessionId())
 286               && nullOrEqual(refa.getMap(), refb.getMap()))
 287       {
 288         return true;
 289       }
 290       return false;
 291     }
 292   };
 293
 294   /**
 295    * accession ID and DB must be identical. Version is ignored. Map is either
 296    * not defined or is a match (or is compatible?)
 297    */
 298   // TODO unused - remove?
 299   public static DbRefComp matchDbAndIdAndEitherMap = new DbRefComp()
 300   {
 301     @Override
 302     public boolean matches(DBRefEntry refa, DBRefEntry refb)
 303     {
 304       if (refa.getSource() != null && refb.getSource() != null
 305               && DBRefUtils.getCanonicalName(refb.getSource()).equals(
 306                       DBRefUtils.getCanonicalName(refa.getSource())))
 307       {
 308         // We dont care about version
 309         if (refa.getAccessionId() != null && refb.getAccessionId() != null
 310         // FIXME should be && not || here?
 311                 || refb.getAccessionId().equals(refa.getAccessionId()))
 312         {
 313           if ((refa.getMap() == null || refb.getMap() == null)
 314                   || (refa.getMap() != null && refb.getMap() != null && refb
 315                           .getMap().equals(refa.getMap())))
 316           {
 317             return true;
 318           }
 319         }
 320       }
 321       return false;
 322     }
 323   };
 324
 325   /**
 326    * accession ID and DB must be identical. Version is ignored. No map on either
 327    * or map but no maplist on either or maplist of map on a is the complement of
 328    * maplist of map on b.
 329    */
 330   // TODO unused - remove?
 331   public static DbRefComp matchDbAndIdAndComplementaryMapList = new DbRefComp()
 332   {
 333     @Override
 334     public boolean matches(DBRefEntry refa, DBRefEntry refb)
 335     {
 336       if (refa.getSource() != null && refb.getSource() != null
 337               && DBRefUtils.getCanonicalName(refb.getSource()).equals(
 338                       DBRefUtils.getCanonicalName(refa.getSource())))
 339       {
 340         // We dont care about version
 341         if (refa.getAccessionId() != null && refb.getAccessionId() != null
 342                 || refb.getAccessionId().equals(refa.getAccessionId()))
 343         {
 344           if ((refa.getMap() == null && refb.getMap() == null)
 345                   || (refa.getMap() != null && refb.getMap() != null))
 346           {
 347             if ((refb.getMap().getMap() == null && refa.getMap().getMap() == null)
 348                     || (refb.getMap().getMap() != null
 349                             && refa.getMap().getMap() != null && refb
 350                             .getMap().getMap().getInverse()
 351                             .equals(refa.getMap().getMap())))
 352             {
 353               return true;
 354             }
 355           }
 356         }
 357       }
 358       return false;
 359     }
 360   };
 361
 362   /**
 363    * accession ID and DB must be identical. Version is ignored. No map on both
 364    * or or map but no maplist on either or maplist of map on a is equivalent to
 365    * the maplist of map on b.
 366    */
 367   // TODO unused - remove?
 368   public static DbRefComp matchDbAndIdAndEquivalentMapList = new DbRefComp()
 369   {
 370     @Override
 371     public boolean matches(DBRefEntry refa, DBRefEntry refb)
 372     {
 373       if (refa.getSource() != null && refb.getSource() != null
 374               && DBRefUtils.getCanonicalName(refb.getSource()).equals(
 375                       DBRefUtils.getCanonicalName(refa.getSource())))
 376       {
 377         // We dont care about version
 378         // if ((refa.getVersion()==null || refb.getVersion()==null)
 379         // || refb.getVersion().equals(refa.getVersion()))
 380         // {
 381         if (refa.getAccessionId() != null && refb.getAccessionId() != null
 382                 || refb.getAccessionId().equals(refa.getAccessionId()))
 383         {
 384           if (refa.getMap() == null && refb.getMap() == null)
 385           {
 386             return true;
 387           }
 388           if (refa.getMap() != null
 389                   && refb.getMap() != null
 390                   && ((refb.getMap().getMap() == null && refa.getMap()
 391                           .getMap() == null) || (refb.getMap().getMap() != null
 392                           && refa.getMap().getMap() != null && refb
 393                           .getMap().getMap().equals(refa.getMap().getMap()))))
 394           {
 395             return true;
 396           }
 397         }
 398       }
 399       return false;
 400     }
 401   };
 402
 403   /**
 404    * accession ID and DB must be identical, or null on a. Version is ignored. No
 405    * map on either or map but no maplist on either or maplist of map on a is
 406    * equivalent to the maplist of map on b.
 407    */
 408   public static DbRefComp matchDbAndIdAndEitherMapOrEquivalentMapList = new DbRefComp()
 409   {
 410     @Override
 411     public boolean matches(DBRefEntry refa, DBRefEntry refb)
 412     {
 413       if (refa.getSource() != null && refb.getSource() != null
 414               && DBRefUtils.getCanonicalName(refb.getSource()).equals(
 415                       DBRefUtils.getCanonicalName(refa.getSource())))
 416       {
 417         // We dont care about version
 418
 419         if (refa.getAccessionId() == null
 420                 || refa.getAccessionId().equals(refb.getAccessionId()))
 421         {
 422           if (refa.getMap() == null || refb.getMap() == null)
 423           {
 424             return true;
 425           }
 426           if ((refa.getMap() != null && refb.getMap() != null)
 427                   && (refb.getMap().getMap() == null && refa.getMap()
 428                           .getMap() == null)
 429                   || (refb.getMap().getMap() != null
 430                           && refa.getMap().getMap() != null && (refb
 431                           .getMap().getMap().equals(refa.getMap().getMap()))))
 432           {
 433             return true;
 434           }
 435         }
 436       }
 437       return false;
 438     }
 439   };
 440
 441   /**
 442    * accession ID only must be identical.
 443    */
 444   public static DbRefComp matchId = new DbRefComp()
 445   {
 446     @Override
 447     public boolean matches(DBRefEntry refa, DBRefEntry refb)
 448     {
 449       if (refa.getAccessionId() != null && refb.getAccessionId() != null
 450               && refb.getAccessionId().equals(refa.getAccessionId()))
 451       {
 452         return true;
 453       }
 454       return false;
 455     }
 456   };
 457
 458   /**
 459    * Parses a DBRefEntry and adds it to the sequence, also a PDBEntry if the
 460    * database is PDB.
 461    * <p>
 462    * Used by file parsers to generate DBRefs from annotation within file (eg
 463    * Stockholm)
 464    *
 465    * @param dbname
 466    * @param version
 467    * @param acn
 468    * @param seq
 469    *          where to annotate with reference
 470    * @return parsed version of entry that was added to seq (if any)
 471    */
 472   public static DBRefEntry parseToDbRef(SequenceI seq, String dbname,
 473           String version, String acn)
 474   {
 475     DBRefEntry ref = null;
 476     if (dbname != null)
 477     {
 478       String locsrc = DBRefUtils.getCanonicalName(dbname);
 479       if (locsrc.equals(DBRefSource.PDB))
 480       {
 481         /*
 482          * Check for PFAM style stockhom PDB accession id citation e.g.
 483          * "1WRI A; 7-80;"
 484          */
 485         Regex r = new com.stevesoft.pat.Regex(
 486                 "([0-9][0-9A-Za-z]{3})\\s*(.?)\\s*;\\s*([0-9]+)-([0-9]+)");
 487         if (r.search(acn.trim()))
 488         {
 489           String pdbid = r.stringMatched(1);
 490           String chaincode = r.stringMatched(2);
 491           if (chaincode == null)
 492           {
 493             chaincode = " ";
 494           }
 495           // String mapstart = r.stringMatched(3);
 496           // String mapend = r.stringMatched(4);
 497           if (chaincode.equals(" "))
 498           {
 499             chaincode = "_";
 500           }
 501           // construct pdb ref.
 502           ref = new DBRefEntry(locsrc, version, pdbid + chaincode);
 503           PDBEntry pdbr = new PDBEntry();
 504           pdbr.setId(pdbid);
 505           pdbr.setType(PDBEntry.Type.PDB);
 506           pdbr.setProperty(new Hashtable());
 507           pdbr.setChainCode(chaincode);
 508           // pdbr.getProperty().put("CHAIN", chaincode);
 509           seq.addPDBId(pdbr);
 510         }
 511         else
 512         {
 513           System.err.println("Malformed PDB DR line:" + acn);
 514         }
 515       }
 516       else
 517       {
 518         // default:
 519         ref = new DBRefEntry(locsrc, version, acn);
 520       }
 521     }
 522     if (ref != null)
 523     {
 524       seq.addDBRef(ref);
 525     }
 526     return ref;
 527   }
 528
 529   /**
 530    * Returns true if either object is null, or they are equal
 531    *
 532    * @param o1
 533    * @param o2
 534    * @return
 535    */
 536   public static boolean nullOrEqual(Object o1, Object o2)
 537   {
 538     if (o1 == null || o2 == null)
 539     {
 540       return true;
 541     }
 542     return o1.equals(o2);
 543   }
 544
 545   /**
 546    * canonicalise source string before comparing. null is always wildcard
 547    *
 548    * @param o1
 549    *          - null or source string to compare
 550    * @param o2
 551    *          - null or source string to compare
 552    * @return true if either o1 or o2 are null, or o1 equals o2 under
 553    *         DBRefUtils.getCanonicalName
 554    *         (o1).equals(DBRefUtils.getCanonicalName(o2))
 555    */
 556   public static boolean nullOrEqualSource(String o1, String o2)
 557   {
 558     if (o1 == null || o2 == null)
 559     {
 560       return true;
 561     }
 562     return DBRefUtils.getCanonicalName(o1).equals(
 563             DBRefUtils.getCanonicalName(o2));
 564   }
 565
 566   /**
 567    * Selects just the DNA or protein references from a set of references
 568    *
 569    * @param selectDna
 570    *          if true, select references to 'standard' DNA databases, else to
 571    *          'standard' peptide databases
 572    * @param refs
 573    *          a set of references to select from
 574    * @return
 575    */
 576   public static DBRefEntry[] selectDbRefs(boolean selectDna,
 577           DBRefEntry[] refs)
 578   {
 579     return selectRefs(refs, selectDna ? DBRefSource.DNACODINGDBS
 580             : DBRefSource.PROTEINDBS);
 581     // could attempt to find other cross
 582     // refs here - ie PDB xrefs
 583     // (not dna, not protein seq)
 584   }
 585
 586   /**
 587    * Returns the (possibly empty) list of those supplied dbrefs which have the
 588    * specified source database, with a case-insensitive match of source name
 589    *
 590    * @param dbRefs
 591    * @param source
 592    * @return
 593    */
 594   public static List<DBRefEntry> searchRefsForSource(DBRefEntry[] dbRefs,
 595           String source)
 596   {
 597     List<DBRefEntry> matches = new ArrayList<DBRefEntry>();
 598     if (dbRefs != null && source != null)
 599     {
 600       for (DBRefEntry dbref : dbRefs)
 601       {
 602         if (source.equalsIgnoreCase(dbref.getSource()))
 603         {
 604           matches.add(dbref);
 605         }
 606       }
 607     }
 608     return matches;
 609   }
 610
 611 }