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             if (pdbRefDb == null || pdbRefDb.getDbResNum().equals("null"))
 611             {
 612               resNum = UNASSIGNED;
 613               continue;
 614             }
 615             resNum = Integer.valueOf(pdbRefDb
 616                     .getDbResNum().split("[a-zA-Z]")[0]);
 617             continue;
 618           }
 619
 620           if (isResidueObserved(residue)
 621                   || seqCoordSys == CoordinateSys.UNIPROT)
 622           {
 623             char resCharCode = ResidueProperties
 624                     .getSingleCharacterCode(ResidueProperties
 625                             .getCanonicalAminoAcid(residue.getDbResName()));
 626             resNumMap.put(currSeqIndex, String.valueOf(resCharCode));
 627           }
 628           else
 629           {
 630             omitNonObserved.add(currSeqIndex);
 631             ++nonObservedShiftIndex;
 632           }
 633           mapping.put(currSeqIndex - nonObservedShiftIndex, new int[] {
 634               Integer.valueOf(resNum), UNASSIGNED });
 635         }
 636       }
 637     }
 638   }
 639
 640   /**
 641    *
 642    * @param chainId
 643    *          Target chain to populate mapping of its atom positions.
 644    * @param mapping
 645    *          Two dimension array of residue index versus atom position
 646    * @throws IllegalArgumentException
 647    *           Thrown if chainId or mapping is null
 648    * @throws SiftsException
 649    */
 650   void populateAtomPositions(String chainId, Map<Integer, int[]> mapping)
 651           throws IllegalArgumentException, SiftsException
 652   {
 653     try
 654     {
 655       PDBChain chain = pdb.findChain(chainId);
 656
 657       if (chain == null || mapping == null)
 658       {
 659         throw new IllegalArgumentException(
 660                 "Chain id or mapping must not be null.");
 661       }
 662       for (int[] map : mapping.values())
 663       {
 664         if (map[PDB_RES_POS] != UNASSIGNED)
 665         {
 666           map[PDB_ATOM_POS] = getAtomIndex(map[PDB_RES_POS], chain.atoms);
 667         }
 668       }
 669     } catch (NullPointerException e)
 670     {
 671       throw new SiftsException(e.getMessage());
 672     } catch (Exception e)
 673     {
 674       throw new SiftsException(e.getMessage());
 675     }
 676   }
 677
 678   /**
 679    *
 680    * @param residueIndex
 681    *          The residue index used for the search
 682    * @param atoms
 683    *          A collection of Atom to search
 684    * @return atom position for the given residue index
 685    */
 686   int getAtomIndex(int residueIndex, Collection<Atom> atoms)
 687   {
 688     if (atoms == null)
 689     {
 690       throw new IllegalArgumentException(
 691               "atoms collection must not be null!");
 692     }
 693     for (Atom atom : atoms)
 694     {
 695       if (atom.resNumber == residueIndex)
 696       {
 697         return atom.atomIndex;
 698       }
 699     }
 700     return UNASSIGNED;
 701   }
 702
 703   /**
 704    * Checks if the residue instance is marked 'Not_observed' or not
 705    *
 706    * @param residue
 707    * @return
 708    */
 709   private boolean isResidueObserved(Residue residue)
 710   {
 711     Set<String> annotations = getResidueAnnotaitons(residue,
 712             ResidueDetailType.ANNOTATION);
 713     if (annotations == null || annotations.isEmpty())
 714     {
 715       return true;
 716     }
 717     for (String annotation : annotations)
 718     {
 719       if (annotation.equalsIgnoreCase(NOT_OBSERVED))
 720       {
 721         return false;
 722       }
 723     }
 724     return true;
 725   }
 726
 727   /**
 728    * Get annotation String for a given residue and annotation type
 729    *
 730    * @param residue
 731    * @param type
 732    * @return
 733    */
 734   private Set<String> getResidueAnnotaitons(Residue residue,
 735           ResidueDetailType type)
 736   {
 737     HashSet<String> foundAnnotations = new HashSet<String>();
 738     List<ResidueDetail> resDetails = residue.getResidueDetail();
 739     for (ResidueDetail resDetail : resDetails)
 740     {
 741       if (resDetail.getProperty().equalsIgnoreCase(type.getCode()))
 742       {
 743         foundAnnotations.add(resDetail.getContent());
 744       }
 745     }
 746     return foundAnnotations;
 747   }
 748
 749   @Override
 750   public boolean isAccessionMatched(String accession)
 751   {
 752     boolean isStrictMatch = true;
 753     return isStrictMatch ? curSourceDBRef.equalsIgnoreCase(accession)
 754             : curDBRefAccessionIdsString.contains(accession.toLowerCase());
 755   }
 756
 757   private boolean isFoundInSiftsEntry(String accessionId)
 758   {
 759     Set<String> siftsDBRefs = getAllMappingAccession();
 760     return accessionId != null
 761             && siftsDBRefs.contains(accessionId.toLowerCase());
 762   }
 763
 764   /**
 765    * Pad omitted residue positions in PDB sequence with gaps
 766    *
 767    * @param resNumMap
 768    */
 769   void padWithGaps(Map<Integer, String> resNumMap,
 770           List<Integer> omitNonObserved)
 771   {
 772     if (resNumMap == null || resNumMap.isEmpty())
 773     {
 774       return;
 775     }
 776     Integer[] keys = resNumMap.keySet().toArray(new Integer[0]);
 777     // Arrays.sort(keys);
 778     int firstIndex = keys[0];
 779     int lastIndex = keys[keys.length - 1];
 780     // System.out.println("Min value " + firstIndex);
 781     // System.out.println("Max value " + lastIndex);
 782     for (int x = firstIndex; x <= lastIndex; x++)
 783     {
 784       if (!resNumMap.containsKey(x) && !omitNonObserved.contains(x))
 785       {
 786         resNumMap.put(x, "-");
 787       }
 788     }
 789   }
 790
 791   @Override
 792   public Entity getEntityById(String id) throws SiftsException
 793   {
 794     // Determines an entity to process by performing a heuristic matching of all
 795     // Entities with the given chainId and choosing the best matching Entity
 796     Entity entity = getEntityByMostOptimalMatchedId(id);
 797     if (entity != null)
 798     {
 799       return entity;
 800     }
 801     throw new SiftsException("Entity " + id + " not found");
 802   }
 803
 804   /**
 805    * This method was added because EntityId is NOT always equal to ChainId.
 806    * Hence, it provides the logic to greedily detect the "true" Entity for a
 807    * given chainId where discrepancies exist.
 808    *
 809    * @param chainId
 810    * @return
 811    */
 812   public Entity getEntityByMostOptimalMatchedId(String chainId)
 813   {
 814     // System.out.println("---> advanced greedy entityId matching block entered..");
 815     List<Entity> entities = siftsEntry.getEntity();
 816     SiftsEntitySortPojo[] sPojo = new SiftsEntitySortPojo[entities.size()];
 817     int count = 0;
 818     for (Entity entity : entities)
 819     {
 820       sPojo[count] = new SiftsEntitySortPojo();
 821       sPojo[count].entityId = entity.getEntityId();
 822
 823       List<Segment> segments = entity.getSegment();
 824       for (Segment segment : segments)
 825       {
 826         List<Residue> residues = segment.getListResidue().getResidue();
 827         for (Residue residue : residues)
 828         {
 829           List<CrossRefDb> cRefDbs = residue.getCrossRefDb();
 830           for (CrossRefDb cRefDb : cRefDbs)
 831           {
 832             if (!cRefDb.getDbSource().equalsIgnoreCase("PDB"))
 833             {
 834               continue;
 835             }
 836             ++sPojo[count].resCount;
 837             if (cRefDb.getDbChainId().equalsIgnoreCase(chainId))
 838             {
 839               ++sPojo[count].chainIdFreq;
 840             }
 841           }
 842         }
 843       }
 844       sPojo[count].pid = (100 * sPojo[count].chainIdFreq)
 845               / sPojo[count].resCount;
 846       ++count;
 847     }
 848     Arrays.sort(sPojo, Collections.reverseOrder());
 849     // System.out.println("highest matched entity : " + sPojo[0].entityId);
 850     // System.out.println("highest matched pid : " + sPojo[0].pid);
 851
 852     if (sPojo[0].entityId != null)
 853     {
 854       if (sPojo[0].pid < 1)
 855       {
 856         return null;
 857       }
 858       for (Entity entity : entities)
 859       {
 860         if (!entity.getEntityId().equalsIgnoreCase(sPojo[0].entityId))
 861         {
 862           continue;
 863         }
 864         return entity;
 865       }
 866     }
 867     return null;
 868   }
 869
 870   private class SiftsEntitySortPojo implements
 871           Comparable<SiftsEntitySortPojo>
 872   {
 873     public String entityId;
 874
 875     public int chainIdFreq;
 876
 877     public int pid;
 878
 879     public int resCount;
 880
 881     @Override
 882     public int compareTo(SiftsEntitySortPojo o)
 883     {
 884       return this.pid - o.pid;
 885     }
 886   }
 887
 888   private class SegmentHelperPojo
 889   {
 890     private SequenceI seq;
 891
 892     private HashMap<Integer, int[]> mapping;
 893
 894     private TreeMap<Integer, String> resNumMap;
 895
 896     private List<Integer> omitNonObserved;
 897
 898     private int nonObservedShiftIndex;
 899
 900     public SegmentHelperPojo(SequenceI seq,
 901             HashMap<Integer, int[]> mapping,
 902             TreeMap<Integer, String> resNumMap,
 903             List<Integer> omitNonObserved, int nonObservedShiftIndex)
 904     {
 905       setSeq(seq);
 906       setMapping(mapping);
 907       setResNumMap(resNumMap);
 908       setOmitNonObserved(omitNonObserved);
 909       setNonObservedShiftIndex(nonObservedShiftIndex);
 910     }
 911
 912     public SequenceI getSeq()
 913     {
 914       return seq;
 915     }
 916
 917     public void setSeq(SequenceI seq)
 918     {
 919       this.seq = seq;
 920     }
 921
 922     public HashMap<Integer, int[]> getMapping()
 923     {
 924       return mapping;
 925     }
 926
 927     public void setMapping(HashMap<Integer, int[]> mapping)
 928     {
 929       this.mapping = mapping;
 930     }
 931
 932     public TreeMap<Integer, String> getResNumMap()
 933     {
 934       return resNumMap;
 935     }
 936
 937     public void setResNumMap(TreeMap<Integer, String> resNumMap)
 938     {
 939       this.resNumMap = resNumMap;
 940     }
 941
 942     public List<Integer> getOmitNonObserved()
 943     {
 944       return omitNonObserved;
 945     }
 946
 947     public void setOmitNonObserved(List<Integer> omitNonObserved)
 948     {
 949       this.omitNonObserved = omitNonObserved;
 950     }
 951
 952     public int getNonObservedShiftIndex()
 953     {
 954       return nonObservedShiftIndex;
 955     }
 956
 957     public void setNonObservedShiftIndex(int nonObservedShiftIndex)
 958     {
 959       this.nonObservedShiftIndex = nonObservedShiftIndex;
 960     }
 961   }
 962
 963   @Override
 964   public StringBuffer getMappingOutput(MappingOutputPojo mp)
 965           throws SiftsException
 966   {
 967     String seqRes = mp.getSeqResidue();
 968     String seqName = mp.getSeqName();
 969     int sStart = mp.getSeqStart();
 970     int sEnd = mp.getSeqEnd();
 971
 972     String strRes = mp.getStrResidue();
 973     String strName = mp.getStrName();
 974     int pdbStart = mp.getStrStart();
 975     int pdbEnd = mp.getStrEnd();
 976
 977     String type = mp.getType();
 978
 979     int maxid = (seqName.length() >= strName.length()) ? seqName.length()
 980             : strName.length();
 981     int len = 72 - maxid - 1;
 982
 983     int nochunks = ((seqRes.length()) / len)
 984             + ((seqRes.length()) % len > 0 ? 1 : 0);
 985     // output mappings
 986     StringBuffer output = new StringBuffer();
 987     output.append(NEWLINE);
 988     output.append("Sequence \u27f7 Structure mapping details").append(
 989             NEWLINE);
 990     output.append("Method: SIFTS");
 991     output.append(NEWLINE).append(NEWLINE);
 992
 993     output.append(new Format("%" + maxid + "s").form(seqName));
 994     output.append(" :  ");
 995     output.append(String.valueOf(sStart));
 996     output.append(" - ");
 997     output.append(String.valueOf(sEnd));
 998     output.append(" Maps to ");
 999     output.append(NEWLINE);
1000     output.append(new Format("%" + maxid + "s").form(structId));
1001     output.append(" :  ");
1002     output.append(String.valueOf(pdbStart));
1003     output.append(" - ");
1004     output.append(String.valueOf(pdbEnd));
1005     output.append(NEWLINE).append(NEWLINE);
1006
1007     int matchedSeqCount = 0;
1008     for (int j = 0; j < nochunks; j++)
1009     {
1010       // Print the first aligned sequence
1011       output.append(new Format("%" + (maxid) + "s").form(seqName)).append(
1012               " ");
1013
1014       for (int i = 0; i < len; i++)
1015       {
1016         if ((i + (j * len)) < seqRes.length())
1017         {
1018           output.append(seqRes.charAt(i + (j * len)));
1019         }
1020       }
1021
1022       output.append(NEWLINE);
1023       output.append(new Format("%" + (maxid) + "s").form(" ")).append(" ");
1024
1025       // Print out the matching chars
1026       for (int i = 0; i < len; i++)
1027       {
1028         try
1029         {
1030           if ((i + (j * len)) < seqRes.length())
1031           {
1032             boolean sameChar = Comparison.isSameResidue(
1033                     seqRes.charAt(i + (j * len)),
1034                     strRes.charAt(i + (j * len)), false);
1035             if (sameChar
1036                     && !jalview.util.Comparison.isGap(seqRes.charAt(i
1037                             + (j * len))))
1038             {
1039               matchedSeqCount++;
1040               output.append("|");
1041             }
1042             else if (type.equals("pep"))
1043             {
1044               if (ResidueProperties.getPAM250(seqRes.charAt(i + (j * len)),
1045                       strRes.charAt(i + (j * len))) > 0)
1046               {
1047                 output.append(".");
1048               }
1049               else
1050               {
1051                 output.append(" ");
1052               }
1053             }
1054             else
1055             {
1056               output.append(" ");
1057             }
1058           }
1059         } catch (IndexOutOfBoundsException e)
1060         {
1061           continue;
1062         }
1063       }
1064       // Now print the second aligned sequence
1065       output = output.append(NEWLINE);
1066       output = output.append(new Format("%" + (maxid) + "s").form(strName))
1067               .append(" ");
1068       for (int i = 0; i < len; i++)
1069       {
1070         if ((i + (j * len)) < strRes.length())
1071         {
1072           output.append(strRes.charAt(i + (j * len)));
1073         }
1074       }
1075       output.append(NEWLINE).append(NEWLINE);
1076     }
1077     float pid = (float) matchedSeqCount / seqRes.length() * 100;
1078     if (pid < SiftsSettings.getFailSafePIDThreshold())
1079     {
1080       throw new SiftsException(">>> Low PID detected for SIFTs mapping...");
1081     }
1082     output.append("Length of alignment = " + seqRes.length()).append(
1083             NEWLINE);
1084     output.append(new Format("Percentage ID = %2.2f").form(pid));
1085     return output;
1086   }
1087
1088   @Override
1089   public int getEntityCount()
1090   {
1091     return siftsEntry.getEntity().size();
1092   }
1093
1094   @Override
1095   public String getDbAccessionId()
1096   {
1097     return siftsEntry.getDbAccessionId();
1098   }
1099
1100   @Override
1101   public String getDbCoordSys()
1102   {
1103     return siftsEntry.getDbCoordSys();
1104   }
1105
1106   @Override
1107   public String getDbSource()
1108   {
1109     return siftsEntry.getDbSource();
1110   }
1111
1112   @Override
1113   public String getDbVersion()
1114   {
1115     return siftsEntry.getDbVersion();
1116   }
1117
1118   public static void setMockSiftsFile(File file)
1119   {
1120     mockSiftsFile = file;
1121   }
1122
1123 }