src/jalview/ws/sifts/SiftsClient.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.sifts;
  22
  23 import jalview.analysis.AlignSeq;
  24 import jalview.api.DBRefEntryI;
  25 import jalview.api.SiftsClientI;
  26 import jalview.datamodel.DBRefEntry;
  27 import jalview.datamodel.DBRefSource;
  28 import jalview.datamodel.SequenceI;
  29 import jalview.io.StructureFile;
  30 import jalview.schemes.ResidueProperties;
  31 import jalview.structure.StructureMapping;
  32 import jalview.util.Comparison;
  33 import jalview.util.DBRefUtils;
  34 import jalview.util.Format;
  35 import jalview.xml.binding.sifts.Entry;
  36 import jalview.xml.binding.sifts.Entry.Entity;
  37 import jalview.xml.binding.sifts.Entry.Entity.Segment;
  38 import jalview.xml.binding.sifts.Entry.Entity.Segment.ListMapRegion.MapRegion;
  39 import jalview.xml.binding.sifts.Entry.Entity.Segment.ListResidue.Residue;
  40 import jalview.xml.binding.sifts.Entry.Entity.Segment.ListResidue.Residue.CrossRefDb;
  41 import jalview.xml.binding.sifts.Entry.Entity.Segment.ListResidue.Residue.ResidueDetail;
  42
  43 import java.io.File;
  44 import java.io.FileInputStream;
  45 import java.io.FileOutputStream;
  46 import java.io.IOException;
  47 import java.io.InputStream;
  48 import java.io.PrintStream;
  49 import java.net.URL;
  50 import java.net.URLConnection;
  51 import java.nio.file.Files;
  52 import java.nio.file.Path;
  53 import java.nio.file.attribute.BasicFileAttributes;
  54 import java.util.ArrayList;
  55 import java.util.Arrays;
  56 import java.util.Collection;
  57 import java.util.Collections;
  58 import java.util.Date;
  59 import java.util.HashMap;
  60 import java.util.HashSet;
  61 import java.util.List;
  62 import java.util.Map;
  63 import java.util.Set;
  64 import java.util.TreeMap;
  65 import java.util.zip.GZIPInputStream;
  66
  67 import javax.xml.bind.JAXBContext;
  68 import javax.xml.bind.Unmarshaller;
  69 import javax.xml.stream.XMLInputFactory;
  70 import javax.xml.stream.XMLStreamReader;
  71
  72 import MCview.Atom;
  73 import MCview.PDBChain;
  74
  75 public class SiftsClient implements SiftsClientI
  76 {
  77   /*
  78    * for use in mocking out file fetch for tests only
  79    * - reset to null after testing!
  80    */
  81   private static File mockSiftsFile;
  82
  83   private Entry siftsEntry;
  84
  85   private StructureFile pdb;
  86
  87   private String pdbId;
  88
  89   private String structId;
  90
  91   private CoordinateSys seqCoordSys = CoordinateSys.UNIPROT;
  92
  93   private static final int BUFFER_SIZE = 4096;
  94
  95   public static final int UNASSIGNED = -1;
  96
  97   private static final int PDB_RES_POS = 0;
  98
  99   private static final int PDB_ATOM_POS = 1;
 100
 101   private static final String NOT_OBSERVED = "Not_Observed";
 102
 103   private static final String SIFTS_FTP_BASE_URL = "http://ftp.ebi.ac.uk/pub/databases/msd/sifts/xml/";
 104
 105   private final static String NEWLINE = System.lineSeparator();
 106
 107   private String curSourceDBRef;
 108
 109   private HashSet<String> curDBRefAccessionIdsString;
 110
 111   private enum CoordinateSys
 112   {
 113     UNIPROT("UniProt"), PDB("PDBresnum"), PDBe("PDBe");
 114     private String name;
 115
 116     private CoordinateSys(String name)
 117     {
 118       this.name = name;
 119     }
 120
 121     public String getName()
 122     {
 123       return name;
 124     }
 125   };
 126
 127   private enum ResidueDetailType
 128   {
 129     NAME_SEC_STRUCTURE("nameSecondaryStructure"), CODE_SEC_STRUCTURE(
 130             "codeSecondaryStructure"), ANNOTATION("Annotation");
 131     private String code;
 132
 133     private ResidueDetailType(String code)
 134     {
 135       this.code = code;
 136     }
 137
 138     public String getCode()
 139     {
 140       return code;
 141     }
 142   };
 143
 144   /**
 145    * Fetch SIFTs file for the given PDBfile and construct an instance of
 146    * SiftsClient
 147    *
 148    * @param pdbId
 149    * @throws SiftsException
 150    */
 151   public SiftsClient(StructureFile pdb) throws SiftsException
 152   {
 153     this.pdb = pdb;
 154     this.pdbId = pdb.getId();
 155     File siftsFile = getSiftsFile(pdbId);
 156     siftsEntry = parseSIFTs(siftsFile);
 157   }
 158
 159   /**
 160    * Parse the given SIFTs File and return a JAXB POJO of parsed data
 161    *
 162    * @param siftFile
 163    *          - the GZipped SIFTs XML file to parse
 164    * @return
 165    * @throws Exception
 166    *           if a problem occurs while parsing the SIFTs XML
 167    */
 168   private Entry parseSIFTs(File siftFile) throws SiftsException
 169   {
 170     try (InputStream in = new FileInputStream(siftFile);
 171             GZIPInputStream gzis = new GZIPInputStream(in);)
 172     {
 173       // System.out.println("File : " + siftFile.getAbsolutePath());
 174       JAXBContext jc = JAXBContext.newInstance("jalview.xml.binding.sifts");
 175       XMLStreamReader streamReader = XMLInputFactory.newInstance()
 176               .createXMLStreamReader(gzis);
 177       Unmarshaller um = jc.createUnmarshaller();
 178       return (Entry) um.unmarshal(streamReader);
 179     } catch (Exception e)
 180     {
 181       e.printStackTrace();
 182       throw new SiftsException(e.getMessage());
 183     }
 184   }
 185
 186   /**
 187    * Get a SIFTs XML file for a given PDB Id from Cache or download from FTP
 188    * repository if not found in cache
 189    *
 190    * @param pdbId
 191    * @return SIFTs XML file
 192    * @throws SiftsException
 193    */
 194   public static File getSiftsFile(String pdbId) throws SiftsException
 195   {
 196     /*
 197      * return mocked file if it has been set
 198      */
 199     if (mockSiftsFile != null)
 200     {
 201       return mockSiftsFile;
 202     }
 203
 204     String siftsFileName = SiftsSettings.getSiftDownloadDirectory()
 205             + pdbId.toLowerCase() + ".xml.gz";
 206     File siftsFile = new File(siftsFileName);
 207     if (siftsFile.exists())
 208     {
 209       // The line below is required for unit testing... don't comment it out!!!
 210       System.out.println(">>> SIFTS File already downloaded for " + pdbId);
 211
 212       if (isFileOlderThanThreshold(siftsFile,
 213               SiftsSettings.getCacheThresholdInDays()))
 214       {
 215         File oldSiftsFile = new File(siftsFileName + "_old");
 216         siftsFile.renameTo(oldSiftsFile);
 217         try
 218         {
 219           siftsFile = downloadSiftsFile(pdbId.toLowerCase());
 220           oldSiftsFile.delete();
 221           return siftsFile;
 222         } catch (IOException e)
 223         {
 224           e.printStackTrace();
 225           oldSiftsFile.renameTo(siftsFile);
 226           return new File(siftsFileName);
 227         }
 228       }
 229       else
 230       {
 231         return siftsFile;
 232       }
 233     }
 234     try
 235     {
 236       siftsFile = downloadSiftsFile(pdbId.toLowerCase());
 237     } catch (IOException e)
 238     {
 239       throw new SiftsException(e.getMessage());
 240     }
 241     return siftsFile;
 242   }
 243
 244   /**
 245    * This method enables checking if a cached file has exceeded a certain
 246    * threshold(in days)
 247    *
 248    * @param file
 249    *          the cached file
 250    * @param noOfDays
 251    *          the threshold in days
 252    * @return
 253    */
 254   public static boolean isFileOlderThanThreshold(File file, int noOfDays)
 255   {
 256     Path filePath = file.toPath();
 257     BasicFileAttributes attr;
 258     int diffInDays = 0;
 259     try
 260     {
 261       attr = Files.readAttributes(filePath, BasicFileAttributes.class);
 262       diffInDays = (int) ((new Date().getTime() - attr.lastModifiedTime()
 263               .toMillis()) / (1000 * 60 * 60 * 24));
 264       // System.out.println("Diff in days : " + diffInDays);
 265     } catch (IOException e)
 266     {
 267       e.printStackTrace();
 268     }
 269     return noOfDays <= diffInDays;
 270   }
 271
 272   /**
 273    * Download a SIFTs XML file for a given PDB Id from an FTP repository
 274    *
 275    * @param pdbId
 276    * @return downloaded SIFTs XML file
 277    * @throws SiftsException
 278    * @throws IOException
 279    */
 280   public static File downloadSiftsFile(String pdbId) throws SiftsException,
 281           IOException
 282   {
 283     if (pdbId.contains(".cif"))
 284     {
 285       pdbId = pdbId.replace(".cif", "");
 286     }
 287     String siftFile = pdbId + ".xml.gz";
 288     String siftsFileFTPURL = SIFTS_FTP_BASE_URL + siftFile;
 289     String downloadedSiftsFile = SiftsSettings.getSiftDownloadDirectory()
 290             + siftFile;
 291     File siftsDownloadDir = new File(
 292             SiftsSettings.getSiftDownloadDirectory());
 293     if (!siftsDownloadDir.exists())
 294     {
 295       siftsDownloadDir.mkdirs();
 296     }
 297     // System.out.println(">> Download ftp url : " + siftsFileFTPURL);
 298     // long now = System.currentTimeMillis();
 299     URL url = new URL(siftsFileFTPURL);
 300     URLConnection conn = url.openConnection();
 301     InputStream inputStream = conn.getInputStream();
 302     FileOutputStream outputStream = new FileOutputStream(
 303             downloadedSiftsFile);
 304     byte[] buffer = new byte[BUFFER_SIZE];
 305     int bytesRead = -1;
 306     while ((bytesRead = inputStream.read(buffer)) != -1)
 307     {
 308       outputStream.write(buffer, 0, bytesRead);
 309     }
 310     outputStream.close();
 311     inputStream.close();
 312 //    System.out.println(">>> File downloaded : " + downloadedSiftsFile
 313 //            + " took " + (System.currentTimeMillis() - now) + "ms");
 314     return new File(downloadedSiftsFile);
 315   }
 316
 317   /**
 318    * Delete the SIFTs file for the given PDB Id in the local SIFTs download
 319    * directory
 320    *
 321    * @param pdbId
 322    * @return true if the file was deleted or doesn't exist
 323    */
 324   public static boolean deleteSiftsFileByPDBId(String pdbId)
 325   {
 326     File siftsFile = new File(SiftsSettings.getSiftDownloadDirectory()
 327             + pdbId.toLowerCase() + ".xml.gz");
 328     if (siftsFile.exists())
 329     {
 330       return siftsFile.delete();
 331     }
 332     return true;
 333   }
 334
 335   /**
 336    * Get a valid SIFTs DBRef for the given sequence current SIFTs entry
 337    *
 338    * @param seq
 339    *          - the target sequence for the operation
 340    * @return a valid DBRefEntry that is SIFTs compatible
 341    * @throws Exception
 342    *           if no valid source DBRefEntry was found for the given sequences
 343    */
 344   public DBRefEntryI getValidSourceDBRef(SequenceI seq)
 345           throws SiftsException
 346   {
 347     List<DBRefEntry> dbRefs = seq.getPrimaryDBRefs();
 348     if (dbRefs == null || dbRefs.size() < 1)
 349     {
 350       throw new SiftsException(
 351               "Source DBRef could not be determined. DBRefs might not have been retrieved.");
 352     }
 353
 354     for (DBRefEntry dbRef : dbRefs)
 355     {
 356       if (dbRef == null || dbRef.getAccessionId() == null
 357               || dbRef.getSource() == null)
 358       {
 359         continue;
 360       }
 361       String canonicalSource = DBRefUtils.getCanonicalName(dbRef
 362               .getSource());
 363       if (isValidDBRefEntry(dbRef)
 364               && (canonicalSource.equalsIgnoreCase(DBRefSource.UNIPROT) || canonicalSource
 365                       .equalsIgnoreCase(DBRefSource.PDB)))
 366       {
 367         return dbRef;
 368       }
 369     }
 370     throw new SiftsException("Could not get source DB Ref");
 371   }
 372
 373   /**
 374    * Check that the DBRef Entry is properly populated and is available in this
 375    * SiftClient instance
 376    *
 377    * @param entry
 378    *          - DBRefEntry to validate
 379    * @return true validation is successful otherwise false is returned.
 380    */
 381   boolean isValidDBRefEntry(DBRefEntryI entry)
 382   {
 383     return entry != null && entry.getAccessionId() != null
 384             && isFoundInSiftsEntry(entry.getAccessionId());
 385   }
 386
 387   @Override
 388   public HashSet<String> getAllMappingAccession()
 389   {
 390     HashSet<String> accessions = new HashSet<String>();
 391     List<Entity> entities = siftsEntry.getEntity();
 392     for (Entity entity : entities)
 393     {
 394       List<Segment> segments = entity.getSegment();
 395       for (Segment segment : segments)
 396       {
 397         List<MapRegion> mapRegions = segment.getListMapRegion()
 398                 .getMapRegion();
 399         for (MapRegion mapRegion : mapRegions)
 400         {
 401           accessions
 402                   .add(mapRegion.getDb().getDbAccessionId().toLowerCase());
 403         }
 404       }
 405     }
 406     return accessions;
 407   }
 408
 409   @Override
 410   public StructureMapping getSiftsStructureMapping(SequenceI seq,
 411           String pdbFile, String chain) throws SiftsException
 412   {
 413     structId = (chain == null) ? pdbId : pdbId + "|" + chain;
 414     System.out.println("Getting SIFTS mapping for " + structId + ": seq "
 415             + seq.getName());
 416
 417     final StringBuilder mappingDetails = new StringBuilder(128);
 418     PrintStream ps = new PrintStream(System.out)
 419     {
 420       @Override
 421       public void print(String x)
 422       {
 423         mappingDetails.append(x);
 424       }
 425
 426       @Override
 427       public void println()
 428       {
 429         mappingDetails.append(NEWLINE);
 430       }
 431     };
 432     HashMap<Integer, int[]> mapping = getGreedyMapping(chain, seq, ps);
 433
 434     String mappingOutput = mappingDetails.toString();
 435     StructureMapping siftsMapping = new StructureMapping(seq, pdbFile,
 436             pdbId, chain, mapping, mappingOutput);
 437     return siftsMapping;
 438   }
 439
 440   @Override
 441   public HashMap<Integer, int[]> getGreedyMapping(String entityId,
 442           SequenceI seq, java.io.PrintStream os) throws SiftsException
 443   {
 444     List<Integer> omitNonObserved = new ArrayList<Integer>();
 445     int nonObservedShiftIndex = 0;
 446     // System.out.println("Generating mappings for : " + entityId);
 447     Entity entity = null;
 448     entity = getEntityById(entityId);
 449     String originalSeq = AlignSeq.extractGaps(
 450             jalview.util.Comparison.GapChars, seq.getSequenceAsString());
 451     HashMap<Integer, int[]> mapping = new HashMap<Integer, int[]>();
 452     DBRefEntryI sourceDBRef;
 453     sourceDBRef = getValidSourceDBRef(seq);
 454     // TODO ensure sequence start/end is in the same coordinate system and
 455     // consistent with the choosen sourceDBRef
 456
 457     // set sequence coordinate system - default value is UniProt
 458     if (sourceDBRef.getSource().equalsIgnoreCase(DBRefSource.PDB))
 459     {
 460       seqCoordSys = CoordinateSys.PDB;
 461     }
 462
 463     HashSet<String> dbRefAccessionIdsString = new HashSet<String>();
 464     for (DBRefEntry dbref : seq.getDBRefs())
 465     {
 466       dbRefAccessionIdsString.add(dbref.getAccessionId().toLowerCase());
 467     }
 468     dbRefAccessionIdsString.add(sourceDBRef.getAccessionId().toLowerCase());
 469
 470     curDBRefAccessionIdsString = dbRefAccessionIdsString;
 471     curSourceDBRef = sourceDBRef.getAccessionId();
 472
 473     TreeMap<Integer, String> resNumMap = new TreeMap<Integer, String>();
 474     List<Segment> segments = entity.getSegment();
 475     SegmentHelperPojo shp = new SegmentHelperPojo(seq, mapping, resNumMap,
 476             omitNonObserved, nonObservedShiftIndex);
 477     processSegments(segments, shp);
 478     try
 479     {
 480       populateAtomPositions(entityId, mapping);
 481     } catch (Exception e)
 482     {
 483       e.printStackTrace();
 484     }
 485     if (seqCoordSys == CoordinateSys.UNIPROT)
 486     {
 487       padWithGaps(resNumMap, omitNonObserved);
 488     }
 489     int seqStart = UNASSIGNED;
 490     int seqEnd = UNASSIGNED;
 491     int pdbStart = UNASSIGNED;
 492     int pdbEnd = UNASSIGNED;
 493
 494     if (mapping.isEmpty())
 495     {
 496       throw new SiftsException("SIFTS mapping failed");
 497     }
 498
 499     Integer[] keys = mapping.keySet().toArray(new Integer[0]);
 500     Arrays.sort(keys);
 501     seqStart = keys[0];
 502     seqEnd = keys[keys.length - 1];
 503
 504     String matchedSeq = originalSeq;
 505     if (seqStart != UNASSIGNED)
 506     {
 507       pdbStart = mapping.get(seqStart)[PDB_RES_POS];
 508       pdbEnd = mapping.get(seqEnd)[PDB_RES_POS];
 509       int orignalSeqStart = seq.getStart();
 510       if (orignalSeqStart >= 1)
 511       {
 512         int subSeqStart = (seqStart >= orignalSeqStart) ? seqStart
 513                 - orignalSeqStart : 0;
 514         int subSeqEnd = seqEnd - (orignalSeqStart - 1);
 515         subSeqEnd = originalSeq.length() < subSeqEnd ? originalSeq.length()
 516                 : subSeqEnd;
 517         matchedSeq = originalSeq.substring(subSeqStart, subSeqEnd);
 518       }
 519       else
 520       {
 521         matchedSeq = originalSeq.substring(1, originalSeq.length());
 522       }
 523     }
 524
 525     StringBuilder targetStrucSeqs = new StringBuilder();
 526     for (String res : resNumMap.values())
 527     {
 528       targetStrucSeqs.append(res);
 529     }
 530
 531     if (os != null)
 532     {
 533       MappingOutputPojo mop = new MappingOutputPojo();
 534       mop.setSeqStart(seqStart);
 535       mop.setSeqEnd(seqEnd);
 536       mop.setSeqName(seq.getName());
 537       mop.setSeqResidue(matchedSeq);
 538
 539       mop.setStrStart(pdbStart);
 540       mop.setStrEnd(pdbEnd);
 541       mop.setStrName(structId);
 542       mop.setStrResidue(targetStrucSeqs.toString());
 543
 544       mop.setType("pep");
 545       os.print(getMappingOutput(mop).toString());
 546       os.println();
 547     }
 548     return mapping;
 549   }
 550
 551   void processSegments(List<Segment> segments, SegmentHelperPojo shp)
 552   {
 553     SequenceI seq = shp.getSeq();
 554     HashMap<Integer, int[]> mapping = shp.getMapping();
 555     TreeMap<Integer, String> resNumMap = shp.getResNumMap();
 556     List<Integer> omitNonObserved = shp.getOmitNonObserved();
 557     int nonObservedShiftIndex = shp.getNonObservedShiftIndex();
 558     for (Segment segment : segments)
 559     {
 560       // System.out.println("Mapping segments : " + segment.getSegId() + "\\"s
 561       // + segStartEnd);
 562       List<Residue> residues = segment.getListResidue().getResidue();
 563       for (Residue residue : residues)
 564       {
 565         int currSeqIndex = UNASSIGNED;
 566         List<CrossRefDb> cRefDbs = residue.getCrossRefDb();
 567         CrossRefDb pdbRefDb = null;
 568         for (CrossRefDb cRefDb : cRefDbs)
 569         {
 570           if (cRefDb.getDbSource().equalsIgnoreCase(DBRefSource.PDB))
 571           {
 572             pdbRefDb = cRefDb;
 573           }
 574           if (cRefDb.getDbCoordSys()
 575                   .equalsIgnoreCase(seqCoordSys.getName())
 576                   && isAccessionMatched(cRefDb.getDbAccessionId()))
 577           {
 578             String resNumIndexString = cRefDb.getDbResNum()
 579                     .equalsIgnoreCase("None") ? String.valueOf(UNASSIGNED)
 580                     : cRefDb.getDbResNum();
 581             try
 582             {
 583               currSeqIndex = Integer.valueOf(resNumIndexString);
 584             } catch (NumberFormatException nfe)
 585             {
 586               currSeqIndex = Integer.valueOf(resNumIndexString
 587                       .split("[a-zA-Z]")[0]);
 588               continue;
 589             }
 590             if (pdbRefDb != null)
 591             {
 592               break;// exit loop if pdb and uniprot are already found
 593             }
 594           }
 595         }
 596         if (currSeqIndex == UNASSIGNED)
 597         {
 598           continue;
 599         }
 600         if (currSeqIndex >= seq.getStart() && currSeqIndex <= seq.getEnd())
 601         {
 602           int resNum;
 603           try
 604           {
 605             resNum = (pdbRefDb == null) ? Integer.valueOf(residue
 606                     .getDbResNum()) : Integer.valueOf(pdbRefDb
 607                     .getDbResNum());
 608           } catch (NumberFormatException nfe)
 609           {
 610             resNum = (pdbRefDb == null) ? Integer.valueOf(residue
 611                     .getDbResNum()) : Integer.valueOf(pdbRefDb
 612                     .getDbResNum().split("[a-zA-Z]")[0]);
 613             continue;
 614           }
 615
 616           if (isResidueObserved(residue)
 617                   || seqCoordSys == CoordinateSys.UNIPROT)
 618           {
 619             char resCharCode = ResidueProperties
 620                     .getSingleCharacterCode(ResidueProperties
 621                             .getCanonicalAminoAcid(residue.getDbResName()));
 622             resNumMap.put(currSeqIndex, String.valueOf(resCharCode));
 623           }
 624           else
 625           {
 626             omitNonObserved.add(currSeqIndex);
 627             ++nonObservedShiftIndex;
 628           }
 629           mapping.put(currSeqIndex - nonObservedShiftIndex, new int[] {
 630               Integer.valueOf(resNum), UNASSIGNED });
 631         }
 632       }
 633     }
 634   }
 635
 636   /**
 637    *
 638    * @param chainId
 639    *          Target chain to populate mapping of its atom positions.
 640    * @param mapping
 641    *          Two dimension array of residue index versus atom position
 642    * @throws IllegalArgumentException
 643    *           Thrown if chainId or mapping is null
 644    * @throws SiftsException
 645    */
 646   void populateAtomPositions(String chainId, Map<Integer, int[]> mapping)
 647           throws IllegalArgumentException, SiftsException
 648   {
 649     try
 650     {
 651       PDBChain chain = pdb.findChain(chainId);
 652
 653       if (chain == null || mapping == null)
 654       {
 655         throw new IllegalArgumentException(
 656                 "Chain id or mapping must not be null.");
 657       }
 658       for (int[] map : mapping.values())
 659       {
 660         if (map[PDB_RES_POS] != UNASSIGNED)
 661         {
 662           map[PDB_ATOM_POS] = getAtomIndex(map[PDB_RES_POS], chain.atoms);
 663         }
 664       }
 665     } catch (NullPointerException e)
 666     {
 667       throw new SiftsException(e.getMessage());
 668     } catch (Exception e)
 669     {
 670       throw new SiftsException(e.getMessage());
 671     }
 672   }
 673
 674   /**
 675    *
 676    * @param residueIndex
 677    *          The residue index used for the search
 678    * @param atoms
 679    *          A collection of Atom to search
 680    * @return atom position for the given residue index
 681    */
 682   int getAtomIndex(int residueIndex, Collection<Atom> atoms)
 683   {
 684     if (atoms == null)
 685     {
 686       throw new IllegalArgumentException(
 687               "atoms collection must not be null!");
 688     }
 689     for (Atom atom : atoms)
 690     {
 691       if (atom.resNumber == residueIndex)
 692       {
 693         return atom.atomIndex;
 694       }
 695     }
 696     return UNASSIGNED;
 697   }
 698
 699   /**
 700    * Checks if the residue instance is marked 'Not_observed' or not
 701    *
 702    * @param residue
 703    * @return
 704    */
 705   private boolean isResidueObserved(Residue residue)
 706   {
 707     Set<String> annotations = getResidueAnnotaitons(residue,
 708             ResidueDetailType.ANNOTATION);
 709     if (annotations == null || annotations.isEmpty())
 710     {
 711       return true;
 712     }
 713     for (String annotation : annotations)
 714     {
 715       if (annotation.equalsIgnoreCase(NOT_OBSERVED))
 716       {
 717         return false;
 718       }
 719     }
 720     return true;
 721   }
 722
 723   /**
 724    * Get annotation String for a given residue and annotation type
 725    *
 726    * @param residue
 727    * @param type
 728    * @return
 729    */
 730   private Set<String> getResidueAnnotaitons(Residue residue,
 731           ResidueDetailType type)
 732   {
 733     HashSet<String> foundAnnotations = new HashSet<String>();
 734     List<ResidueDetail> resDetails = residue.getResidueDetail();
 735     for (ResidueDetail resDetail : resDetails)
 736     {
 737       if (resDetail.getProperty().equalsIgnoreCase(type.getCode()))
 738       {
 739         foundAnnotations.add(resDetail.getContent());
 740       }
 741     }
 742     return foundAnnotations;
 743   }
 744
 745   @Override
 746   public boolean isAccessionMatched(String accession)
 747   {
 748     boolean isStrictMatch = true;
 749     return isStrictMatch ? curSourceDBRef.equalsIgnoreCase(accession)
 750             : curDBRefAccessionIdsString.contains(accession.toLowerCase());
 751   }
 752
 753   private boolean isFoundInSiftsEntry(String accessionId)
 754   {
 755     Set<String> siftsDBRefs = getAllMappingAccession();
 756     return accessionId != null
 757             && siftsDBRefs.contains(accessionId.toLowerCase());
 758   }
 759
 760   /**
 761    * Pad omitted residue positions in PDB sequence with gaps
 762    *
 763    * @param resNumMap
 764    */
 765   void padWithGaps(Map<Integer, String> resNumMap,
 766           List<Integer> omitNonObserved)
 767   {
 768     if (resNumMap == null || resNumMap.isEmpty())
 769     {
 770       return;
 771     }
 772     Integer[] keys = resNumMap.keySet().toArray(new Integer[0]);
 773     // Arrays.sort(keys);
 774     int firstIndex = keys[0];
 775     int lastIndex = keys[keys.length - 1];
 776     // System.out.println("Min value " + firstIndex);
 777     // System.out.println("Max value " + lastIndex);
 778     for (int x = firstIndex; x <= lastIndex; x++)
 779     {
 780       if (!resNumMap.containsKey(x) && !omitNonObserved.contains(x))
 781       {
 782         resNumMap.put(x, "-");
 783       }
 784     }
 785   }
 786
 787   @Override
 788   public Entity getEntityById(String id) throws SiftsException
 789   {
 790     // Determines an entity to process by performing a heuristic matching of all
 791     // Entities with the given chainId and choosing the best matching Entity
 792     Entity entity = getEntityByMostOptimalMatchedId(id);
 793     if (entity != null)
 794     {
 795       return entity;
 796     }
 797     throw new SiftsException("Entity " + id + " not found");
 798   }
 799
 800   /**
 801    * This method was added because EntityId is NOT always equal to ChainId.
 802    * Hence, it provides the logic to greedily detect the "true" Entity for a
 803    * given chainId where discrepancies exist.
 804    *
 805    * @param chainId
 806    * @return
 807    */
 808   public Entity getEntityByMostOptimalMatchedId(String chainId)
 809   {
 810     // System.out.println("---> advanced greedy entityId matching block entered..");
 811     List<Entity> entities = siftsEntry.getEntity();
 812     SiftsEntitySortPojo[] sPojo = new SiftsEntitySortPojo[entities.size()];
 813     int count = 0;
 814     for (Entity entity : entities)
 815     {
 816       sPojo[count] = new SiftsEntitySortPojo();
 817       sPojo[count].entityId = entity.getEntityId();
 818
 819       List<Segment> segments = entity.getSegment();
 820       for (Segment segment : segments)
 821       {
 822         List<Residue> residues = segment.getListResidue().getResidue();
 823         for (Residue residue : residues)
 824         {
 825           List<CrossRefDb> cRefDbs = residue.getCrossRefDb();
 826           for (CrossRefDb cRefDb : cRefDbs)
 827           {
 828             if (!cRefDb.getDbSource().equalsIgnoreCase("PDB"))
 829             {
 830               continue;
 831             }
 832             ++sPojo[count].resCount;
 833             if (cRefDb.getDbChainId().equalsIgnoreCase(chainId))
 834             {
 835               ++sPojo[count].chainIdFreq;
 836             }
 837           }
 838         }
 839       }
 840       sPojo[count].pid = (100 * sPojo[count].chainIdFreq)
 841               / sPojo[count].resCount;
 842       ++count;
 843     }
 844     Arrays.sort(sPojo, Collections.reverseOrder());
 845     // System.out.println("highest matched entity : " + sPojo[0].entityId);
 846     // System.out.println("highest matched pid : " + sPojo[0].pid);
 847
 848     if (sPojo[0].entityId != null)
 849     {
 850       if (sPojo[0].pid < 1)
 851       {
 852         return null;
 853       }
 854       for (Entity entity : entities)
 855       {
 856         if (!entity.getEntityId().equalsIgnoreCase(sPojo[0].entityId))
 857         {
 858           continue;
 859         }
 860         return entity;
 861       }
 862     }
 863     return null;
 864   }
 865
 866   private class SiftsEntitySortPojo implements
 867           Comparable<SiftsEntitySortPojo>
 868   {
 869     public String entityId;
 870
 871     public int chainIdFreq;
 872
 873     public int pid;
 874
 875     public int resCount;
 876
 877     @Override
 878     public int compareTo(SiftsEntitySortPojo o)
 879     {
 880       return this.pid - o.pid;
 881     }
 882   }
 883
 884   private class SegmentHelperPojo
 885   {
 886     private SequenceI seq;
 887
 888     private HashMap<Integer, int[]> mapping;
 889
 890     private TreeMap<Integer, String> resNumMap;
 891
 892     private List<Integer> omitNonObserved;
 893
 894     private int nonObservedShiftIndex;
 895
 896     public SegmentHelperPojo(SequenceI seq,
 897             HashMap<Integer, int[]> mapping,
 898             TreeMap<Integer, String> resNumMap,
 899             List<Integer> omitNonObserved, int nonObservedShiftIndex)
 900     {
 901       setSeq(seq);
 902       setMapping(mapping);
 903       setResNumMap(resNumMap);
 904       setOmitNonObserved(omitNonObserved);
 905       setNonObservedShiftIndex(nonObservedShiftIndex);
 906     }
 907
 908     public SequenceI getSeq()
 909     {
 910       return seq;
 911     }
 912
 913     public void setSeq(SequenceI seq)
 914     {
 915       this.seq = seq;
 916     }
 917
 918     public HashMap<Integer, int[]> getMapping()
 919     {
 920       return mapping;
 921     }
 922
 923     public void setMapping(HashMap<Integer, int[]> mapping)
 924     {
 925       this.mapping = mapping;
 926     }
 927
 928     public TreeMap<Integer, String> getResNumMap()
 929     {
 930       return resNumMap;
 931     }
 932
 933     public void setResNumMap(TreeMap<Integer, String> resNumMap)
 934     {
 935       this.resNumMap = resNumMap;
 936     }
 937
 938     public List<Integer> getOmitNonObserved()
 939     {
 940       return omitNonObserved;
 941     }
 942
 943     public void setOmitNonObserved(List<Integer> omitNonObserved)
 944     {
 945       this.omitNonObserved = omitNonObserved;
 946     }
 947
 948     public int getNonObservedShiftIndex()
 949     {
 950       return nonObservedShiftIndex;
 951     }
 952
 953     public void setNonObservedShiftIndex(int nonObservedShiftIndex)
 954     {
 955       this.nonObservedShiftIndex = nonObservedShiftIndex;
 956     }
 957   }
 958
 959   @Override
 960   public StringBuffer getMappingOutput(MappingOutputPojo mp)
 961           throws SiftsException
 962   {
 963     String seqRes = mp.getSeqResidue();
 964     String seqName = mp.getSeqName();
 965     int sStart = mp.getSeqStart();
 966     int sEnd = mp.getSeqEnd();
 967
 968     String strRes = mp.getStrResidue();
 969     String strName = mp.getStrName();
 970     int pdbStart = mp.getStrStart();
 971     int pdbEnd = mp.getStrEnd();
 972
 973     String type = mp.getType();
 974
 975     int maxid = (seqName.length() >= strName.length()) ? seqName.length()
 976             : strName.length();
 977     int len = 72 - maxid - 1;
 978
 979     int nochunks = ((seqRes.length()) / len)
 980             + ((seqRes.length()) % len > 0 ? 1 : 0);
 981     // output mappings
 982     StringBuffer output = new StringBuffer();
 983     output.append(NEWLINE);
 984     output.append("Sequence \u27f7 Structure mapping details").append(
 985             NEWLINE);
 986     output.append("Method: SIFTS");
 987     output.append(NEWLINE).append(NEWLINE);
 988
 989     output.append(new Format("%" + maxid + "s").form(seqName));
 990     output.append(" :  ");
 991     output.append(String.valueOf(sStart));
 992     output.append(" - ");
 993     output.append(String.valueOf(sEnd));
 994     output.append(" Maps to ");
 995     output.append(NEWLINE);
 996     output.append(new Format("%" + maxid + "s").form(structId));
 997     output.append(" :  ");
 998     output.append(String.valueOf(pdbStart));
 999     output.append(" - ");
1000     output.append(String.valueOf(pdbEnd));
1001     output.append(NEWLINE).append(NEWLINE);
1002
1003     int matchedSeqCount = 0;
1004     for (int j = 0; j < nochunks; j++)
1005     {
1006       // Print the first aligned sequence
1007       output.append(new Format("%" + (maxid) + "s").form(seqName)).append(
1008               " ");
1009
1010       for (int i = 0; i < len; i++)
1011       {
1012         if ((i + (j * len)) < seqRes.length())
1013         {
1014           output.append(seqRes.charAt(i + (j * len)));
1015         }
1016       }
1017
1018       output.append(NEWLINE);
1019       output.append(new Format("%" + (maxid) + "s").form(" ")).append(" ");
1020
1021       // Print out the matching chars
1022       for (int i = 0; i < len; i++)
1023       {
1024         try
1025         {
1026           if ((i + (j * len)) < seqRes.length())
1027           {
1028             boolean sameChar = Comparison.isSameResidue(
1029                     seqRes.charAt(i + (j * len)),
1030                     strRes.charAt(i + (j * len)), false);
1031             if (sameChar
1032                     && !jalview.util.Comparison.isGap(seqRes.charAt(i
1033                             + (j * len))))
1034             {
1035               matchedSeqCount++;
1036               output.append("|");
1037             }
1038             else if (type.equals("pep"))
1039             {
1040               if (ResidueProperties.getPAM250(seqRes.charAt(i + (j * len)),
1041                       strRes.charAt(i + (j * len))) > 0)
1042               {
1043                 output.append(".");
1044               }
1045               else
1046               {
1047                 output.append(" ");
1048               }
1049             }
1050             else
1051             {
1052               output.append(" ");
1053             }
1054           }
1055         } catch (IndexOutOfBoundsException e)
1056         {
1057           continue;
1058         }
1059       }
1060       // Now print the second aligned sequence
1061       output = output.append(NEWLINE);
1062       output = output.append(new Format("%" + (maxid) + "s").form(strName))
1063               .append(" ");
1064       for (int i = 0; i < len; i++)
1065       {
1066         if ((i + (j * len)) < strRes.length())
1067         {
1068           output.append(strRes.charAt(i + (j * len)));
1069         }
1070       }
1071       output.append(NEWLINE).append(NEWLINE);
1072     }
1073     float pid = (float) matchedSeqCount / seqRes.length() * 100;
1074     if (pid < SiftsSettings.getFailSafePIDThreshold())
1075     {
1076       throw new SiftsException(">>> Low PID detected for SIFTs mapping...");
1077     }
1078     output.append("Length of alignment = " + seqRes.length()).append(
1079             NEWLINE);
1080     output.append(new Format("Percentage ID = %2.2f").form(pid));
1081     return output;
1082   }
1083
1084   @Override
1085   public int getEntityCount()
1086   {
1087     return siftsEntry.getEntity().size();
1088   }
1089
1090   @Override
1091   public String getDbAccessionId()
1092   {
1093     return siftsEntry.getDbAccessionId();
1094   }
1095
1096   @Override
1097   public String getDbCoordSys()
1098   {
1099     return siftsEntry.getDbCoordSys();
1100   }
1101
1102   @Override
1103   public String getDbSource()
1104   {
1105     return siftsEntry.getDbSource();
1106   }
1107
1108   @Override
1109   public String getDbVersion()
1110   {
1111     return siftsEntry.getDbVersion();
1112   }
1113
1114   public static void setMockSiftsFile(File file)
1115   {
1116     mockSiftsFile = file;
1117   }
1118
1119 }