import jalview.io.StructureFile;
import jalview.schemes.ResidueProperties;
import jalview.structure.StructureMapping;
+import jalview.util.DBRefUtils;
import jalview.util.Format;
import jalview.xml.binding.sifts.Entry;
import jalview.xml.binding.sifts.Entry.Entity;
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;
import java.io.FileInputStream;
-import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
+import java.util.Map;
+import java.util.Set;
import java.util.TreeMap;
import java.util.zip.GZIPInputStream;
import javax.xml.bind.JAXBContext;
-import javax.xml.bind.JAXBException;
import javax.xml.bind.Unmarshaller;
-import javax.xml.stream.FactoryConfigurationError;
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 String structId;
- private String segStartEnd;
-
private CoordinateSys seqCoordSys = CoordinateSys.UNIPROT;
private static final int BUFFER_SIZE = 4096;
private static final int PDB_ATOM_POS = 1;
- 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 static final String SIFTS_FTP_BASE_URL = "http://ftp.ebi.ac.uk/pub/databases/msd/sifts/xml/";
private final static String NEWLINE = System.lineSeparator();
private HashSet<String> curDBRefAccessionIdsString;
- public enum CoordinateSys
+ private enum CoordinateSys
{
UNIPROT("UniProt"), PDB("PDBresnum"), PDBe("PDBe");
private String name;
}
};
- public enum ResidueDetailType
+ private enum ResidueDetailType
{
NAME_SEC_STRUCTURE("nameSecondaryStructure"), CODE_SEC_STRUCTURE(
"codeSecondaryStructure"), ANNOTATION("Annotation");
siftsEntry = parseSIFTs(siftsFile);
}
- /**
- * 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(PDBfile pdb, File siftsFile) throws SiftsException
- {
- this.pdb = pdb;
- this.pdbId = pdb.getId();
- siftsEntry = parseSIFTs(siftsFile);
- }
/**
* Parse the given SIFTs File and return a JAXB POJO of parsed data
.createXMLStreamReader(gzis);
Unmarshaller um = jc.createUnmarshaller();
return (Entry) um.unmarshal(streamReader);
- } 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)
+ } catch (Exception e)
{
e.printStackTrace();
throw new SiftsException(e.getMessage());
*/
public static File getSiftsFile(String pdbId) throws SiftsException
{
- File siftsFile = new File(SiftsSettings.getSiftDownloadDirectory()
- + pdbId.toLowerCase() + ".xml.gz");
+ String siftsFileName = SiftsSettings.getSiftDownloadDirectory()
+ + pdbId.toLowerCase() + ".xml.gz";
+ File siftsFile = new File(siftsFileName);
if (siftsFile.exists())
{
// The line below is required for unit testing... don't comment it out!!!
if (isFileOlderThanThreshold(siftsFile,
SiftsSettings.getCacheThresholdInDays()))
{
- // System.out.println("Downloaded file is out of date, hence re-downloading...");
- siftsFile = downloadSiftsFile(pdbId.toLowerCase());
+ File oldSiftsFile = new File(siftsFileName + "_old");
+ siftsFile.renameTo(oldSiftsFile);
+ try
+ {
+ siftsFile = downloadSiftsFile(pdbId.toLowerCase());
+ oldSiftsFile.delete();
+ return siftsFile;
+ } catch (IOException e)
+ {
+ e.printStackTrace();
+ oldSiftsFile.renameTo(siftsFile);
+ return new File(siftsFileName);
+ }
}
- return siftsFile;
}
- siftsFile = downloadSiftsFile(pdbId.toLowerCase());
+ try
+ {
+ siftsFile = downloadSiftsFile(pdbId.toLowerCase());
+ } catch (IOException e)
+ {
+ throw new SiftsException(e.getMessage());
+ }
return siftsFile;
}
* @param pdbId
* @return downloaded SIFTs XML file
* @throws SiftsException
+ * @throws IOException
*/
- public static File downloadSiftsFile(String pdbId) throws SiftsException
+ public static File downloadSiftsFile(String pdbId) throws SiftsException,
+ IOException
{
if (pdbId.contains(".cif"))
{
{
siftsDownloadDir.mkdirs();
}
- try
- {
// System.out.println(">> Download ftp url : " + siftsFileFTPURL);
URL url = new URL(siftsFileFTPURL);
URLConnection conn = url.openConnection();
outputStream.close();
inputStream.close();
// System.out.println(">>> File downloaded : " + downloadedSiftsFile);
- } catch (IOException ex)
- {
- throw new SiftsException(ex.getMessage());
- }
return new File(downloadedSiftsFile);
}
public DBRefEntryI getValidSourceDBRef(SequenceI seq)
throws SiftsException
{
- DBRefEntryI sourceDBRef = null;
- sourceDBRef = seq.getSourceDBRef();
- if (sourceDBRef != null && isValidDBRefEntry(sourceDBRef))
+ List<DBRefEntry> dbRefs = seq.getPrimaryDBRefs();
+ if (dbRefs == null || dbRefs.size() < 1)
{
- return sourceDBRef;
+ throw new SiftsException(
+ "Source DBRef could not be determined. DBRefs might not have been retrieved.");
}
- else
+
+ for (DBRefEntry dbRef : dbRefs)
{
- DBRefEntry[] dbRefs = seq.getDBRefs();
- if (dbRefs == null || dbRefs.length < 1)
+ if (dbRef == null || dbRef.getAccessionId() == null
+ || dbRef.getSource() == null)
{
- throw new SiftsException("Could not get source DB Ref");
+ continue;
}
-
- for (DBRefEntryI dbRef : dbRefs)
+ if (isValidDBRefEntry(dbRef)
+ && dbRef.isPrimary()
+ && (DBRefUtils.getCanonicalName(dbRef.getSource())
+ .equalsIgnoreCase(DBRefSource.UNIPROT) || DBRefUtils
+ .getCanonicalName(dbRef.getSource())
+ .equalsIgnoreCase(DBRefSource.PDB)))
{
- if (dbRef == null || dbRef.getAccessionId() == null
- || dbRef.getSource() == null)
- {
- continue;
- }
- if (isFoundInSiftsEntry(dbRef.getAccessionId())
- && (dbRef.getSource().equalsIgnoreCase(DBRefSource.UNIPROT) || dbRef
- .getSource().equalsIgnoreCase(DBRefSource.PDB)))
- {
- return dbRef;
- }
+ return dbRef;
}
}
- if (sourceDBRef != null && isValidDBRefEntry(sourceDBRef))
- {
- return sourceDBRef;
- }
throw new SiftsException("Could not get source DB Ref");
}
* - DBRefEntry to validate
* @return true validation is successful otherwise false is returned.
*/
- private boolean isValidDBRefEntry(DBRefEntryI entry)
+ boolean isValidDBRefEntry(DBRefEntryI entry)
{
return entry != null && entry.getAccessionId() != null
&& isFoundInSiftsEntry(entry.getAccessionId());
.getMapRegion();
for (MapRegion mapRegion : mapRegions)
{
- accessions.add(mapRegion.getDb().getDbAccessionId());
+ accessions
+ .add(mapRegion.getDb().getDbAccessionId().toLowerCase());
}
}
}
public HashMap<Integer, int[]> getGreedyMapping(String entityId,
SequenceI seq, java.io.PrintStream os) throws SiftsException
{
- ArrayList<Integer> omitNonObserved = new ArrayList<Integer>();
+ List<Integer> omitNonObserved = new ArrayList<Integer>();
int nonObservedShiftIndex = 0;
// System.out.println("Generating mappings for : " + entityId);
Entity entity = null;
String originalSeq = AlignSeq.extractGaps(
jalview.util.Comparison.GapChars, seq.getSequenceAsString());
HashMap<Integer, int[]> mapping = new HashMap<Integer, int[]>();
- DBRefEntryI sourceDBRef = seq.getSourceDBRef();
- if (sourceDBRef == null)
- {
- sourceDBRef = getValidSourceDBRef(seq);
- // TODO ensure sequence start/end is in the same coordinate system and
- // consistent with the choosen sourceDBRef
- }
+ DBRefEntryI sourceDBRef;
+ sourceDBRef = getValidSourceDBRef(seq);
+ // TODO ensure sequence start/end is in the same coordinate system and
+ // consistent with the choosen sourceDBRef
// set sequence coordinate system - default value is UniProt
if (sourceDBRef.getSource().equalsIgnoreCase(DBRefSource.PDB))
TreeMap<Integer, String> resNumMap = new TreeMap<Integer, String>();
List<Segment> segments = entity.getSegment();
+ SegmentHelperPojo shp = new SegmentHelperPojo(seq, mapping, resNumMap,
+ omitNonObserved, nonObservedShiftIndex);
+ processSegments(segments, shp);
+ try
+ {
+ populateAtomPositions(entityId, mapping);
+ } catch (Exception e)
+ {
+ e.printStackTrace();
+ }
+ if (seqCoordSys == CoordinateSys.UNIPROT)
+ {
+ 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);
+ if (keys.length < 1)
+ {
+ throw new SiftsException(">>> Empty SIFTS mapping generated!!");
+ }
+ seqStart = keys[0];
+ seqEnd = keys[keys.length - 1];
+
+ String matchedSeq = originalSeq;
+ if (seqStart != UNASSIGNED)
+ {
+ pdbStart = mapping.get(seqStart)[PDB_RES_POS];
+ pdbEnd = mapping.get(seqEnd)[PDB_RES_POS];
+ int orignalSeqStart = seq.getStart();
+ if (orignalSeqStart >= 1)
+ {
+ int subSeqStart = (seqStart >= orignalSeqStart) ? seqStart
+ - orignalSeqStart : 0;
+ int subSeqEnd = seqEnd - (orignalSeqStart - 1);
+ subSeqEnd = originalSeq.length() < subSeqEnd ? originalSeq.length()
+ : subSeqEnd;
+ matchedSeq = originalSeq.substring(subSeqStart, subSeqEnd);
+ }
+ else
+ {
+ matchedSeq = originalSeq.substring(1, originalSeq.length());
+ }
+ }
+
+ StringBuilder targetStrucSeqs = new StringBuilder();
+ for (String res : resNumMap.values())
+ {
+ targetStrucSeqs.append(res);
+ }
+
+ if (os != null)
+ {
+ MappingOutputPojo mop = new MappingOutputPojo();
+ mop.setSeqStart(pdbStart);
+ mop.setSeqEnd(pdbEnd);
+ mop.setSeqName(seq.getName());
+ mop.setSeqResidue(matchedSeq);
+
+ mop.setStrStart(seqStart);
+ mop.setStrEnd(seqEnd);
+ mop.setStrName(structId);
+ mop.setStrResidue(targetStrucSeqs.toString());
+
+ mop.setType("pep");
+ os.print(getMappingOutput(mop).toString());
+ os.println();
+ }
+ return mapping;
+ }
+
+ void processSegments(List<Segment> segments, SegmentHelperPojo shp)
+ {
+ SequenceI seq = shp.getSeq();
+ HashMap<Integer, int[]> mapping = shp.getMapping();
+ TreeMap<Integer, String> resNumMap = shp.getResNumMap();
+ List<Integer> omitNonObserved = shp.getOmitNonObserved();
+ int nonObservedShiftIndex = shp.getNonObservedShiftIndex();
for (Segment segment : segments)
{
- segStartEnd = segment.getStart() + " - " + segment.getEnd();
- // System.out.println("Mapping segments : " + segment.getSegId() + "\\"
+ // System.out.println("Mapping segments : " + segment.getSegId() + "\\"s
// + segStartEnd);
List<Residue> residues = segment.getListResidue().getResidue();
for (Residue residue : residues)
}
}
}
- try
- {
- populateAtomPositions(entityId, mapping);
- } catch (Exception e)
- {
- e.printStackTrace();
- }
- if (seqCoordSys == CoordinateSys.UNIPROT)
- {
- 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);
- if (keys.length < 1)
- {
- throw new SiftsException(">>> Empty SIFTS mapping generated!!");
- }
- seqStart = keys[0];
- seqEnd = keys[keys.length - 1];
-
- String matchedSeq = originalSeq;
- if (seqStart != UNASSIGNED)
- {
- pdbStart = mapping.get(seqStart)[PDB_RES_POS];
- pdbEnd = mapping.get(seqEnd)[PDB_RES_POS];
- int orignalSeqStart = seq.getStart();
- if (orignalSeqStart >= 1)
- {
- int subSeqStart = (seqStart >= orignalSeqStart) ? seqStart
- - orignalSeqStart : 0;
- int subSeqEnd = seqEnd - (orignalSeqStart - 1);
- subSeqEnd = originalSeq.length() < subSeqEnd ? originalSeq.length()
- : subSeqEnd;
- matchedSeq = originalSeq.substring(subSeqStart, subSeqEnd);
- }
- else
- {
- matchedSeq = originalSeq.substring(1, originalSeq.length());
- }
- }
-
- StringBuilder targetStrucSeqs = new StringBuilder();
- for (String res : resNumMap.values())
- {
- targetStrucSeqs.append(res);
- }
-
- if (os != null)
- {
- MappingOutputPojo mop = new MappingOutputPojo();
- mop.setSeqStart(pdbStart);
- mop.setSeqEnd(pdbEnd);
- mop.setSeqName(seq.getName());
- mop.setSeqResidue(matchedSeq);
-
- mop.setStrStart(seqStart);
- mop.setStrEnd(seqEnd);
- mop.setStrName(structId);
- mop.setStrResidue(targetStrucSeqs.toString());
-
- mop.setType("pep");
- os.print(getMappingOutput(mop).toString());
- }
- return mapping;
}
-
/**
*
* @param chainId
* Two dimension array of residue index versus atom position
* @throws IllegalArgumentException
* Thrown if chainId or mapping is null
+ * @throws SiftsException
*/
- void populateAtomPositions(String chainId,
- HashMap<Integer, int[]> mapping) throws IllegalArgumentException
+ void populateAtomPositions(String chainId, Map<Integer, int[]> mapping)
+ throws IllegalArgumentException, SiftsException
{
try
{
map[PDB_ATOM_POS] = getAtomIndex(map[PDB_RES_POS], chain.atoms);
}
}
+ } catch (NullPointerException e)
+ {
+ throw new SiftsException(e.getMessage());
} catch (Exception e)
{
- e.printStackTrace();
+ throw new SiftsException(e.getMessage());
}
}
*/
private boolean isResidueObserved(Residue residue)
{
- HashSet<String> annotations = getResidueAnnotaitons(residue,
+ Set<String> annotations = getResidueAnnotaitons(residue,
ResidueDetailType.ANNOTATION);
if (annotations == null || annotations.isEmpty())
{
* @param type
* @return
*/
- private HashSet<String> getResidueAnnotaitons(Residue residue,
+ private Set<String> getResidueAnnotaitons(Residue residue,
ResidueDetailType type)
{
HashSet<String> foundAnnotations = new HashSet<String>();
private boolean isFoundInSiftsEntry(String accessionId)
{
+ Set<String> siftsDBRefs = getAllMappingAccession();
return accessionId != null
- && getAllMappingAccession().contains(accessionId);
+ && siftsDBRefs.contains(accessionId.toLowerCase());
}
/**
*
* @param resNumMap
*/
- void padWithGaps(TreeMap<Integer, String> resNumMap,
- ArrayList<Integer> omitNonObserved)
+ void padWithGaps(Map<Integer, String> resNumMap,
+ List<Integer> omitNonObserved)
{
if (resNumMap == null || resNumMap.isEmpty())
{
return;
}
Integer[] keys = resNumMap.keySet().toArray(new Integer[0]);
- Arrays.sort(keys);
+ // Arrays.sort(keys);
int firstIndex = keys[0];
int lastIndex = keys[keys.length - 1];
// System.out.println("Min value " + firstIndex);
@Override
public Entity getEntityById(String id) throws SiftsException
{
- // Sometimes SIFTS mappings are wrongly swapped between different chains of
- // a PDB entry. This results to wrong mappings being generated. The boolean
- // flag 'isGetEntityIdDirectly, determines whether an entity to process is
- // determined by a greedy heuristic search or by just matching the Chain Id
- // directly against the entity Id tag. Setting the default value to 'false'
- // utilise the heuristic search which always produces correct mappings but
- // less optimised processing, where as changing the value to 'true'
- // optimises performance but might result to incorrect mapping in some cases
- // where SIFTS mappings are wrongly swapped between different chains.
- boolean isGetEntityIdDirectly = false;
- if (isGetEntityIdDirectly)
- {
- List<Entity> entities = siftsEntry.getEntity();
- for (Entity entity : entities)
- {
- if (!entity.getEntityId().equalsIgnoreCase(id))
- {
- continue;
- }
- return entity;
- }
- }
+ // Determines an entity to process by performing a heuristic matching of all
+ // Entities with the given chainId and choosing the best matching Entity
Entity entity = getEntityByMostOptimalMatchedId(id);
if (entity != null)
{
}
}
}
- sPojo[count].pid = 100 * (sPojo[count].chainIdFreq / sPojo[count].resCount);
+ sPojo[count].pid = (100 * sPojo[count].chainIdFreq)
+ / sPojo[count].resCount;
++count;
}
Arrays.sort(sPojo, Collections.reverseOrder());
return null;
}
- public class SiftsEntitySortPojo implements
+ private class SiftsEntitySortPojo implements
Comparable<SiftsEntitySortPojo>
{
public String entityId;
}
}
- @Override
- public String[] getEntryDBs()
+ private class SegmentHelperPojo
{
- System.out.println("\nListing DB entries...");
- List<String> availDbs = new ArrayList<String>();
- List<Db> dbs = siftsEntry.getListDB().getDb();
- for (Db db : dbs)
+ private SequenceI seq;
+
+ private HashMap<Integer, int[]> mapping;
+
+ private TreeMap<Integer, String> resNumMap;
+
+ private List<Integer> omitNonObserved;
+
+ private int nonObservedShiftIndex;
+
+ public SegmentHelperPojo(SequenceI seq,
+ HashMap<Integer, int[]> mapping,
+ TreeMap<Integer, String> resNumMap,
+ List<Integer> omitNonObserved, int nonObservedShiftIndex)
{
- availDbs.add(db.getDbSource());
- System.out.println(db.getDbSource() + " | " + db.getDbCoordSys());
+ setSeq(seq);
+ setMapping(mapping);
+ setResNumMap(resNumMap);
+ setOmitNonObserved(omitNonObserved);
+ setNonObservedShiftIndex(nonObservedShiftIndex);
+ }
+
+ public SequenceI getSeq()
+ {
+ return seq;
+ }
+
+ public void setSeq(SequenceI seq)
+ {
+ this.seq = seq;
+ }
+
+ public HashMap<Integer, int[]> getMapping()
+ {
+ return mapping;
+ }
+
+ public void setMapping(HashMap<Integer, int[]> mapping)
+ {
+ this.mapping = mapping;
+ }
+
+ public TreeMap<Integer, String> getResNumMap()
+ {
+ return resNumMap;
+ }
+
+ public void setResNumMap(TreeMap<Integer, String> resNumMap)
+ {
+ this.resNumMap = resNumMap;
+ }
+
+ public List<Integer> getOmitNonObserved()
+ {
+ return omitNonObserved;
+ }
+
+ public void setOmitNonObserved(List<Integer> omitNonObserved)
+ {
+ this.omitNonObserved = omitNonObserved;
+ }
+
+ public int getNonObservedShiftIndex()
+ {
+ return nonObservedShiftIndex;
+ }
+
+ public void setNonObservedShiftIndex(int nonObservedShiftIndex)
+ {
+ this.nonObservedShiftIndex = nonObservedShiftIndex;
}
- return availDbs.toArray(new String[0]);
}
@Override
output.append("Length of alignment = " + seqRes.length()).append(
NEWLINE);
output.append(new Format("Percentage ID = %2.2f").form(pid));
- output.append(NEWLINE);
return output;
}
}
@Override
- public String getDbEvidence()
- {
- return siftsEntry.getDbEvidence();
- }
-
- @Override
public String getDbSource()
{
return siftsEntry.getDbSource();
git://source.jalview.org / jalview.git / blobdiff