JAL-1479 refactored DBRef fetching code to StructureChooser to enable applet build
[jalview.git] / src / jalview / ws / sifts / SiftsClient.java
index b9d023b..00da2fc 100644 (file)
@@ -24,6 +24,7 @@ import jalview.analysis.AlignSeq;
 import jalview.api.DBRefEntryI;
 import jalview.api.SiftsClientI;
 import jalview.datamodel.DBRefEntry;
+import jalview.datamodel.DBRefSource;
 import jalview.datamodel.SequenceI;
 import jalview.schemes.ResidueProperties;
 import jalview.structure.StructureMapping;
@@ -34,6 +35,7 @@ import jalview.xml.binding.sifts.Entry.Entity.Segment;
 import jalview.xml.binding.sifts.Entry.Entity.Segment.ListMapRegion.MapRegion;
 import jalview.xml.binding.sifts.Entry.Entity.Segment.ListResidue.Residue;
 import jalview.xml.binding.sifts.Entry.Entity.Segment.ListResidue.Residue.CrossRefDb;
+import jalview.xml.binding.sifts.Entry.Entity.Segment.ListResidue.Residue.ResidueDetail;
 import jalview.xml.binding.sifts.Entry.ListDB.Db;
 
 import java.io.File;
@@ -46,9 +48,12 @@ import java.io.PrintStream;
 import java.net.URL;
 import java.net.URLConnection;
 import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.HashMap;
 import java.util.HashSet;
-import java.util.LinkedHashMap;
 import java.util.List;
+import java.util.TreeMap;
 import java.util.zip.GZIPInputStream;
 
 import javax.xml.bind.JAXBContext;
@@ -59,67 +64,106 @@ import javax.xml.stream.XMLInputFactory;
 import javax.xml.stream.XMLStreamException;
 import javax.xml.stream.XMLStreamReader;
 
+import MCview.Atom;
+import MCview.PDBChain;
+import MCview.PDBfile;
+
 public class SiftsClient implements SiftsClientI
 {
   private Entry siftsEntry;
 
+  private PDBfile pdb;
+
   private String pdbId;
 
   private String structId;
 
   private String segStartEnd;
 
+  private CoordinateSys seqCoordSys = CoordinateSys.UNIPROT;
+
   private static final int BUFFER_SIZE = 4096;
 
-  private static final String SIFTS_FTP_BASE_URL = "ftp://ftp.ebi.ac.uk/pub/databases/msd/sifts/xml/";
+  public static final int UNASSIGNED = -1;
+
+  private static final int PDB_RES_POS = 0;
 
-  public static final String DEFAULT_SIFTS_DOWNLOAD_DIR = System
-          .getProperty("user.home")
-          + File.separatorChar
-          + ".sifts_downloads" + File.separatorChar;
+  private static final int PDB_ATOM_POS = 1;
 
-  public static final String SIFTS_DOWNLOAD_DIR = jalview.bin.Cache
-          .getDefault("sifts_download_dir", DEFAULT_SIFTS_DOWNLOAD_DIR);
+  private static final String NOT_FOUND = "Not_Found";
+
+  private static final String NOT_OBSERVED = "Not_Observed";
+
+  private static final String SIFTS_FTP_BASE_URL = "ftp://ftp.ebi.ac.uk/pub/databases/msd/sifts/xml/";
 
   private final static String NEWLINE = System.lineSeparator();
 
+  private String curSourceDBRef;
+
+  private HashSet<String> curDBRefAccessionIdsString;
+
+  public enum CoordinateSys
+  {
+    UNIPROT("UniProt"), PDB("PDBresnum"), PDBe("PDBe");
+    private String name;
+
+    private CoordinateSys(String name)
+    {
+      this.name = name;
+    }
+
+    public String getName()
+    {
+      return name;
+    }
+  };
+
+  public enum ResidueDetailType
+  {
+    NAME_SEC_STRUCTURE("nameSecondaryStructure"), CODE_SEC_STRUCTURE(
+            "codeSecondaryStructure"), ANNOTATION("Annotation");
+    private String code;
+
+    private ResidueDetailType(String code)
+    {
+      this.code = code;
+    }
+
+    public String getCode()
+    {
+      return code;
+    }
+  };
+
   /**
-   * Fetch SIFTs file for the given PDB Id and construct an instance of
+   * Fetch SIFTs file for the given PDBfile and construct an instance of
    * SiftsClient
    * 
    * @param pdbId
+   * @throws SiftsException
    */
-  public SiftsClient(String pdbId)
+  public SiftsClient(PDBfile pdb) throws SiftsException
   {
-    this.pdbId = pdbId;
-    try
-    {
-      File siftsFile = getSiftsFile(pdbId);
-      siftsEntry = parseSIFTs(siftsFile);
-    } catch (Exception e)
-    {
-      e.printStackTrace();
-    }
+    this.pdb = pdb;
+    this.pdbId = pdb.id;
+    File siftsFile = getSiftsFile(pdbId);
+    siftsEntry = parseSIFTs(siftsFile);
   }
 
   /**
-   * Construct an instance of SiftsClient using the supplied SIFTs file - 
-   * the SIFTs file should correspond to the given PDB Id
+   * Construct an instance of SiftsClient using the supplied SIFTs file. Note:
+   * The SIFTs file should correspond to the PDB Id in PDBfile instance
    * 
    * @param pdbId
    * @param siftsFile
+   * @throws SiftsException
+   * @throws Exception
    */
-  public SiftsClient(String pdbId, File siftsFile)
+  public SiftsClient(PDBfile pdb, File siftsFile) throws SiftsException
   {
-    this.pdbId = pdbId;
-    try
-    {
-      siftsEntry = parseSIFTs(siftsFile);
-    } catch (Exception e)
-    {
-      e.printStackTrace();
-    }
-
+    this.pdb = pdb;
+    this.pdbId = pdb.id;
+    siftsEntry = parseSIFTs(siftsFile);
   }
 
   /**
@@ -131,14 +175,13 @@ public class SiftsClient implements SiftsClientI
    * @throws Exception
    *           if a problem occurs while parsing the SIFTs XML
    */
-  private Entry parseSIFTs(File siftFile) throws Exception
+  private Entry parseSIFTs(File siftFile) throws SiftsException
   {
-    try
+    try (InputStream in = new FileInputStream(siftFile);
+            GZIPInputStream gzis = new GZIPInputStream(in);)
     {
       System.out.println("File : " + siftFile.getAbsolutePath());
       JAXBContext jc = JAXBContext.newInstance("jalview.xml.binding.sifts");
-      InputStream in = new FileInputStream(siftFile);
-      GZIPInputStream gzis = new GZIPInputStream(in);
       XMLStreamReader streamReader = XMLInputFactory.newInstance()
               .createXMLStreamReader(gzis);
       Unmarshaller um = jc.createUnmarshaller();
@@ -146,35 +189,42 @@ public class SiftsClient implements SiftsClientI
     } catch (JAXBException e)
     {
       e.printStackTrace();
+      throw new SiftsException(e.getMessage());
     } catch (FileNotFoundException e)
     {
       e.printStackTrace();
+      throw new SiftsException(e.getMessage());
     } catch (XMLStreamException e)
     {
       e.printStackTrace();
+      throw new SiftsException(e.getMessage());
     } catch (FactoryConfigurationError e)
     {
       e.printStackTrace();
+      throw new SiftsException(e.getMessage());
     } catch (IOException e)
     {
       e.printStackTrace();
+      throw new SiftsException(e.getMessage());
     }
-    throw new Exception("Error parsing siftFile");
   }
 
   /**
-   * Get a SIFTs XML file for a given PDB Id
+   * Get a SIFTs XML file for a given PDB Id from Cache or download from FTP
+   * repository if not found in cache
    * 
    * @param pdbId
    * @return SIFTs XML file
+   * @throws SiftsException
    */
-  public static File getSiftsFile(String pdbId)
+  public static File getSiftsFile(String pdbId) throws SiftsException
   {
-    File siftsFile = new File(SIFTS_DOWNLOAD_DIR + pdbId.toLowerCase()
+    File siftsFile = new File(SiftsSettings.getSiftDownloadDirectory()
+            + pdbId.toLowerCase()
             + ".xml.gz");
     if (siftsFile.exists())
     {
-      // TODO it may be worth performing a timestamp age check to determine if a
+      // TODO it may be worth performing an age check to determine if a
       // new SIFTs file should be re-downloaded as SIFTs entries are usually
       // updated weekly
       System.out.println(">>> SIFTS File already downloaded for " + pdbId);
@@ -185,17 +235,20 @@ public class SiftsClient implements SiftsClientI
   }
 
   /**
-   * Download a SIFTs XML file for a given PDB Id
+   * Download a SIFTs XML file for a given PDB Id from an FTP repository
    * 
    * @param pdbId
    * @return downloaded SIFTs XML file
+   * @throws SiftsException
    */
-  public static File downloadSiftsFile(String pdbId)
+  public static File downloadSiftsFile(String pdbId) throws SiftsException
   {
     String siftFile = pdbId + ".xml.gz";
     String siftsFileFTPURL = SIFTS_FTP_BASE_URL + siftFile;
-    String downloadedSiftsFile = SIFTS_DOWNLOAD_DIR + siftFile;
-    File siftsDownloadDir = new File(SIFTS_DOWNLOAD_DIR);
+    String downloadedSiftsFile = SiftsSettings.getSiftDownloadDirectory()
+            + siftFile;
+    File siftsDownloadDir = new File(
+            SiftsSettings.getSiftDownloadDirectory());
     if (!siftsDownloadDir.exists())
     {
       siftsDownloadDir.mkdirs();
@@ -219,7 +272,7 @@ public class SiftsClient implements SiftsClientI
       System.out.println(">>> File downloaded : " + downloadedSiftsFile);
     } catch (IOException ex)
     {
-      ex.printStackTrace();
+      throw new SiftsException(ex.getMessage());
     }
     return new File(downloadedSiftsFile);
   }
@@ -233,7 +286,8 @@ public class SiftsClient implements SiftsClientI
    */
   public static boolean deleteSiftsFileByPDBId(String pdbId)
   {
-    File siftsFile = new File(SIFTS_DOWNLOAD_DIR + pdbId.toLowerCase()
+    File siftsFile = new File(SiftsSettings.getSiftDownloadDirectory()
+            + pdbId.toLowerCase()
             + ".xml.gz");
     if (siftsFile.exists())
     {
@@ -266,14 +320,6 @@ public class SiftsClient implements SiftsClientI
       DBRefEntry[] dbRefs = seq.getDBRefs();
       if (dbRefs == null || dbRefs.length < 1)
       {
-        final SequenceI[] seqs = new SequenceI[] { seq };
-        new jalview.ws.DBRefFetcher(seqs, null, null, null, false)
-                .fetchDBRefs(true);
-        dbRefs = seq.getDBRefs();
-      }
-
-      if (dbRefs == null || dbRefs.length < 1)
-      {
         throw new SiftsException("Could not get source DB Ref");
       }
 
@@ -285,8 +331,8 @@ public class SiftsClient implements SiftsClientI
           continue;
         }
         if (isFoundInSiftsEntry(dbRef.getAccessionId())
-                && (dbRef.getSource().equalsIgnoreCase("uniprot") || dbRef
-                        .getSource().equalsIgnoreCase("pdb")))
+                && (dbRef.getSource().equalsIgnoreCase(DBRefSource.UNIPROT) || dbRef
+                        .getSource().equalsIgnoreCase(DBRefSource.PDB)))
         {
           return dbRef;
         }
@@ -301,8 +347,8 @@ public class SiftsClient implements SiftsClientI
 
 
   /**
-   * Check that the DBRef Entry is properly populated and is available in the
-   * instantiated SIFTs Entry
+   * Check that the DBRef Entry is properly populated and is available in this
+   * SiftClient instance
    * 
    * @param entry
    *          - DBRefEntry to validate
@@ -312,7 +358,6 @@ public class SiftsClient implements SiftsClientI
   {
     return entry != null && entry.getAccessionId() != null
             && isFoundInSiftsEntry(entry.getAccessionId());
-    // & entry.getStartRes() > 0;
   }
 
   @Override
@@ -359,51 +404,54 @@ public class SiftsClient implements SiftsClientI
         mappingDetails.append(NEWLINE);
       }
     };
-    int[][] mapping = getGreedyMapping(chain, seq, ps);
+    HashMap<Integer, int[]> mapping = getGreedyMapping(chain, seq, ps);
 
     String mappingOutput = mappingDetails.toString();
-    return new StructureMapping(seq, pdbFile, pdbId, chain, mapping,
+    StructureMapping siftsMapping = new StructureMapping(seq, pdbFile,
+            pdbId, chain, mapping,
             mappingOutput);
+    return siftsMapping;
   }
 
   @Override
-  public int[][] getGreedyMapping(String entityId, SequenceI seq,
+  public HashMap<Integer, int[]> getGreedyMapping(String entityId, SequenceI seq,
           java.io.PrintStream os)
  throws SiftsException
   {
-    int matchedResStart = -1;
-    int matchedResEnd = -1;
-    int counter = 0;
-    int pdbStart = -1;
-    int pdbEnd = -1;
-    int sStart = -1;
-    int sEnd = -1;
-    boolean startDetected = false;
-
+    ArrayList<Integer> omitNonObserved = new ArrayList<Integer>();
+    int nonObservedShiftIndex = 0;
     System.out.println("Generating mappings for : " + entityId);
     Entity entity = null;
     entity = getEntityById(entityId);
-    String seqStr = AlignSeq.extractGaps(jalview.util.Comparison.GapChars,
+    String originalSeq = AlignSeq.extractGaps(
+            jalview.util.Comparison.GapChars,
             seq.getSequenceAsString());
-    int mapping[][] = new int[seqStr.length() + seq.getStart()][2];
+    HashMap<Integer, int[]> mapping = new HashMap<Integer, int[]>();
     DBRefEntryI sourceDBRef = seq.getSourceDBRef();
     if (sourceDBRef == null)
     {
       sourceDBRef = getValidSourceDBRef(seq);
-      // TODO update sequence start/end with sourceDBRef start/end
-      // seq.setStart(sourceDBRef.getStartRes());
-      // seq.setEnd(sourceDBRef.getEndRes());
+      // TODO ensure sequence start/end is in the same coordinate system and
+      // consistent with the choosen sourceDBRef
     }
 
-    String crossRefAccessionId = sourceDBRef.getAccessionId();
-    int count = 0;
-    for (int residue[] : mapping)
+    // set sequence coordinate system - default value is UniProt
+    if (sourceDBRef.getSource().equalsIgnoreCase(DBRefSource.PDB))
     {
-      residue[1] = count++;
-      residue[0] = -1;
+      seqCoordSys = CoordinateSys.PDB;
     }
-    
-    LinkedHashMap<Integer, String> resNumMap = new LinkedHashMap<Integer, String>();
+
+    HashSet<String> dbRefAccessionIdsString = new HashSet<String>();
+    for (DBRefEntry dbref : seq.getDBRefs())
+    {
+      dbRefAccessionIdsString.add(dbref.getAccessionId().toLowerCase());
+    }
+    dbRefAccessionIdsString.add(sourceDBRef.getAccessionId().toLowerCase());
+
+    curDBRefAccessionIdsString = dbRefAccessionIdsString;
+    curSourceDBRef = sourceDBRef.getAccessionId();
+
+    TreeMap<Integer, String> resNumMap = new TreeMap<Integer, String>();
     List<Segment> segments = entity.getSegment();
     for (Segment segment : segments)
     {
@@ -413,72 +461,96 @@ public class SiftsClient implements SiftsClientI
       List<Residue> residues = segment.getListResidue().getResidue();
       for (Residue residue : residues)
       {
-        int refDbResNum = -1;
+        int currSeqIndex = UNASSIGNED;
         List<CrossRefDb> cRefDbs = residue.getCrossRefDb();
+        CrossRefDb pdbRefDb = null;
         for (CrossRefDb cRefDb : cRefDbs)
         {
-          if (cRefDb.getDbAccessionId().equalsIgnoreCase(
-                  crossRefAccessionId))
+          if (cRefDb.getDbSource().equalsIgnoreCase(DBRefSource.PDB))
           {
-            refDbResNum = Integer.valueOf(cRefDb.getDbResNum());
+            pdbRefDb = cRefDb;
+          }
+          if (cRefDb.getDbCoordSys()
+                  .equalsIgnoreCase(seqCoordSys.getName())
+                  && isAccessionMatched(cRefDb.getDbAccessionId()))
+          {
+            String resNumIndexString = cRefDb.getDbResNum()
+                    .equalsIgnoreCase("None") ? String.valueOf(UNASSIGNED)
+                    : cRefDb.getDbResNum();
+            currSeqIndex = Integer.valueOf(resNumIndexString);
+            if (pdbRefDb != null)
+            {
+              break;// exit loop if pdb and uniprot are already found
+            }
           }
         }
-        if (refDbResNum == -1)
+        if (currSeqIndex == UNASSIGNED)
         {
           continue;
         }
-        int loopCount = 0;
-        for (int[] x : mapping)
+        if (currSeqIndex > seq.getStart() && currSeqIndex <= seq.getEnd())
         {
-          if (loopCount > seq.getStart() && x[1] == refDbResNum)
+          int resNum;
+          try
+          {
+            resNum = (pdbRefDb == null) ? Integer.valueOf(residue
+                  .getDbResNum()) : Integer.valueOf(pdbRefDb.getDbResNum());
+          } catch (NumberFormatException nfe)
+          {
+            resNum = (pdbRefDb == null) ? Integer.valueOf(residue
+                    .getDbResNum()) : Integer.valueOf(pdbRefDb
+                    .getDbResNum().split("[a-zA-Z]")[0]);
+          }
+
+          if (isResidueObserved(residue)
+                  || seqCoordSys == CoordinateSys.UNIPROT)
           {
-            int resNum = Integer.valueOf(residue.getDbResNum());
-            x[0] = resNum;
             char resCharCode = ResidueProperties
                     .getSingleCharacterCode(residue.getDbResName());
-            resNumMap.put(resNum, String.valueOf(resCharCode));
+            resNumMap.put(currSeqIndex, String.valueOf(resCharCode));
           }
-          ++loopCount;
+          else
+          {
+            omitNonObserved.add(currSeqIndex);
+            ++nonObservedShiftIndex;
+          }
+          mapping.put(currSeqIndex - nonObservedShiftIndex, new int[] {
+              Integer.valueOf(resNum), UNASSIGNED });
         }
       }
     }
-
-    for (int[] x : mapping)
+    try
     {
-      if (!startDetected && x[0] > -1)
-      {
-        matchedResStart = counter;
-        // System.out.println(matchedResStart);
-        startDetected = true;
-      }
-
-      if (startDetected && x[0] == -1)
-      {
-        matchedResEnd = counter;
-      }
-      ++counter;
+      populateAtomPositions(entityId, mapping);
+    } catch (Exception e)
+    {
+      e.printStackTrace();
     }
-
-    String matchedSeqStr = seqStr;
-    if (matchedResStart != -1)
+    padWithGaps(resNumMap, omitNonObserved);
+    int seqStart = UNASSIGNED;
+    int seqEnd = UNASSIGNED;
+    int pdbStart = UNASSIGNED;
+    int pdbEnd = UNASSIGNED;
+
+    Integer[] keys = mapping.keySet().toArray(new Integer[0]);
+    Arrays.sort(keys);
+    seqStart = keys[0];
+    seqEnd = keys[keys.length - 1];
+
+    String matchedSeq = originalSeq;
+    if (seqStart != UNASSIGNED)
     {
-      matchedResEnd = (matchedResEnd == -1) ? counter : matchedResEnd;
-      pdbStart = mapping[matchedResStart][0];
-      pdbEnd = mapping[matchedResEnd - 1][0];
-      sStart = mapping[matchedResStart][1];
-      sEnd = mapping[matchedResEnd - 1][1];
-      int seqStart = seq.getStart();
-      if (seqStart > 1)
+      pdbStart = mapping.get(seqStart)[PDB_RES_POS];
+      pdbEnd = mapping.get(seqEnd)[PDB_RES_POS];
+      int orignalSeqStart = seq.getStart();
+      if (orignalSeqStart >= 1)
       {
-        matchedResStart = matchedResStart - seqStart;
-        matchedResEnd = matchedResEnd - seqStart;
+        int subSeqStart = seqStart - orignalSeqStart;
+        int subSeqEnd = seqEnd - (orignalSeqStart - 1);
+        subSeqEnd = originalSeq.length() < subSeqEnd ? originalSeq.length()
+                : subSeqEnd;
+        matchedSeq = originalSeq.substring(subSeqStart, subSeqEnd);
       }
-      else
-      {
-        --matchedResStart;
-        --matchedResEnd;
-      }
-      matchedSeqStr = seqStr.substring(matchedResStart, matchedResEnd);
     }
 
     StringBuilder targetStrucSeqs = new StringBuilder();
@@ -487,38 +559,162 @@ public class SiftsClient implements SiftsClientI
       targetStrucSeqs.append(res);
     }
 
-    try
+    if (os != null)
     {
-      if (os != null)
+      MappingOutputPojo mop = new MappingOutputPojo();
+      mop.setSeqStart(seqStart);
+      mop.setSeqEnd(seqEnd);
+      mop.setSeqName(seq.getName());
+      mop.setSeqResidue(matchedSeq);
+
+      mop.setStrStart(pdbStart);
+      mop.setStrEnd(pdbEnd);
+      mop.setStrName(structId);
+      mop.setStrResidue(targetStrucSeqs.toString());
+
+      mop.setType("pep");
+      os.print(getMappingOutput(mop).toString());
+    }
+    return mapping;
+  }
+
+  /**
+   * Checks if the residue instance is marked 'Not_observed' or not
+   * 
+   * @param residue
+   * @return
+   */
+  private boolean isResidueObserved(Residue residue)
+  {
+    String annotation = getResidueAnnotaiton(residue,
+            ResidueDetailType.ANNOTATION);
+    if (annotation == null)
+    {
+      return true;
+    }
+    if (!annotation.equalsIgnoreCase(NOT_FOUND)
+            && annotation.equalsIgnoreCase(NOT_OBSERVED))
+    {
+      return false;
+    }
+    return true;
+  }
+
+  /**
+   * Get annotation String for a given residue and annotation type
+   * 
+   * @param residue
+   * @param type
+   * @return
+   */
+  private String getResidueAnnotaiton(Residue residue,
+          ResidueDetailType type)
+  {
+    List<ResidueDetail> resDetails = residue.getResidueDetail();
+    for (ResidueDetail resDetail : resDetails)
+    {
+      if (resDetail.getProperty().equalsIgnoreCase(type.getCode()))
       {
-        MappingOutputPojo mop = new MappingOutputPojo();
-        mop.setSeqStart(sStart);
-        mop.setSeqEnd(sEnd);
-        mop.setSeqName(seq.getName());
-        mop.setSeqResidue(matchedSeqStr);
-
-        mop.setStrStart(pdbStart);
-        mop.setStrEnd(pdbEnd);
-        mop.setStrName(structId);
-        mop.setStrResidue(targetStrucSeqs.toString());
-
-        mop.setType("pep");
-        os.print(getMappingOutput(mop).toString());
+        return resDetail.getContent();
       }
-    } catch (Exception ex)
-    {
-      ex.printStackTrace();
     }
-    return mapping;
+    return NOT_FOUND;
   }
 
   @Override
-  public boolean isFoundInSiftsEntry(String accessionId)
+  public boolean isAccessionMatched(String accession)
+  {
+    boolean isStrictMatch = true;
+    return isStrictMatch ? curSourceDBRef.equalsIgnoreCase(accession)
+            : curDBRefAccessionIdsString.contains(accession.toLowerCase());
+  }
+
+  private boolean isFoundInSiftsEntry(String accessionId)
   {
     return accessionId != null
             && getAllMappingAccession().contains(accessionId);
   }
 
+  /**
+   * Pad omitted residue positions in PDB sequence with gaps
+   * 
+   * @param resNumMap
+   */
+  void padWithGaps(TreeMap<Integer, String> resNumMap,
+          ArrayList<Integer> omitNonObserved)
+  {
+    if (resNumMap == null || resNumMap.isEmpty())
+    {
+      return;
+    }
+    Integer[] keys = resNumMap.keySet().toArray(new Integer[0]);
+    Arrays.sort(keys);
+    int firstIndex = keys[0];
+    int lastIndex = keys[keys.length - 1];
+    System.out.println("Min value " + firstIndex);
+    System.out.println("Max value " + lastIndex);
+    for (int x = firstIndex; x <= lastIndex; x++)
+    {
+      if (!resNumMap.containsKey(x) && !omitNonObserved.contains(x))
+      {
+        resNumMap.put(x, "-");
+      }
+    }
+  }
+
+
+  /**
+   * 
+   * @param chainId
+   *          Target chain to populate mapping of its atom positions.
+   * @param mapping
+   *          Two dimension array of residue index versus atom position
+   * @throws IllegalArgumentException
+   *           Thrown if chainId or mapping is null
+   */
+  void populateAtomPositions(String chainId, HashMap<Integer, int[]> mapping)
+          throws IllegalArgumentException
+  {
+    PDBChain chain = pdb.findChain(chainId);
+    if (chain == null || mapping == null)
+    {
+      throw new IllegalArgumentException(
+              "Chain id or mapping must not be null.");
+    }
+    for (int[] map : mapping.values())
+    {
+      if (map[PDB_RES_POS] != UNASSIGNED)
+      {
+        map[PDB_ATOM_POS] = getAtomIndex(map[PDB_RES_POS], chain.atoms);
+      }
+    }
+  }
+
+  /**
+   * 
+   * @param residueIndex
+   *          The residue index used for the search
+   * @param atoms
+   *          A collection of Atom to search
+   * @return atom position for the given residue index
+   */
+  int getAtomIndex(int residueIndex, Collection<Atom> atoms)
+  {
+    if (atoms == null)
+    {
+      throw new IllegalArgumentException(
+              "atoms collection must not be null!");
+    }
+    for (Atom atom : atoms)
+    {
+      if (atom.resNumber == residueIndex)
+      {
+        return atom.atomIndex;
+      }
+    }
+    return UNASSIGNED;
+  }
+
   @Override
   public Entity getEntityById(String id) throws SiftsException
   {
@@ -550,6 +746,7 @@ public class SiftsClient implements SiftsClientI
 
   @Override
   public StringBuffer getMappingOutput(MappingOutputPojo mp)
+          throws SiftsException
   {
     String seqRes = mp.getSeqResidue();
     String seqName = mp.getSeqName();
@@ -572,7 +769,8 @@ public class SiftsClient implements SiftsClientI
     // output mappings
     StringBuffer output = new StringBuffer();
     output.append(NEWLINE);
-    output.append("Sequence ⟷ Structure mapping details:");
+    output.append("Sequence ⟷ Structure mapping details").append(NEWLINE);
+    output.append("Method: SIFTS");
     output.append(NEWLINE).append(NEWLINE);
 
     output.append(new Format("%" + maxid + "s").form(seqName));
@@ -589,7 +787,7 @@ public class SiftsClient implements SiftsClientI
     output.append(String.valueOf(pdbEnd));
     output.append(NEWLINE).append(NEWLINE);
     
-    float pid = 0;
+    int matchedSeqCount = 0;
     for (int j = 0; j < nochunks; j++)
     {
       // Print the first aligned sequence
@@ -610,13 +808,15 @@ public class SiftsClient implements SiftsClientI
       // Print out the matching chars
       for (int i = 0; i < len; i++)
       {
+        try
+        {
         if ((i + (j * len)) < seqRes.length())
         {
           if (seqRes.charAt(i + (j * len)) == strRes.charAt(i + (j * len))
                   && !jalview.util.Comparison.isGap(seqRes.charAt(i
                           + (j * len))))
           {
-            pid++;
+              matchedSeqCount++;
             output.append("|");
           }
           else if (type.equals("pep"))
@@ -636,6 +836,10 @@ public class SiftsClient implements SiftsClientI
             output.append(" ");
           }
         }
+        } catch (IndexOutOfBoundsException e)
+        {
+          continue;
+        }
       }
       // Now print the second aligned sequence
       output = output.append(NEWLINE);
@@ -650,12 +854,15 @@ public class SiftsClient implements SiftsClientI
       }
       output.append(NEWLINE).append(NEWLINE);
     }
-    pid = pid / (seqRes.length()) * 100;
+    float pid = (float) matchedSeqCount / seqRes.length() * 100;
+    if (pid < 2)
+    {
+      throw new SiftsException("Low PID detected for SIFTs mapping...");
+    }
     output.append("Length of alignment = " + seqRes.length())
             .append(NEWLINE);
     output.append(new Format("Percentage ID = %2.2f").form(pid));
     output.append(NEWLINE);
-    output.append("Mapping method: SIFTS").append(NEWLINE);
     return output;
   }