*/
package jalview.structure;
+import java.io.PrintStream;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.Enumeration;
+import java.util.HashMap;
+import java.util.IdentityHashMap;
+import java.util.List;
+import java.util.Locale;
+import java.util.Map;
+import java.util.Vector;
+
import jalview.analysis.AlignSeq;
import jalview.api.StructureSelectionManagerProvider;
+import jalview.bin.Console;
import jalview.commands.CommandI;
import jalview.commands.EditCommand;
import jalview.commands.OrderCommand;
import jalview.datamodel.AlignmentAnnotation;
import jalview.datamodel.AlignmentI;
import jalview.datamodel.Annotation;
+import jalview.datamodel.ContiguousI;
import jalview.datamodel.HiddenColumns;
import jalview.datamodel.PDBEntry;
import jalview.datamodel.SearchResults;
import jalview.io.AppletFormatAdapter;
import jalview.io.DataSourceType;
import jalview.io.StructureFile;
+import jalview.structure.StructureImportSettings.TFType;
import jalview.util.MappingUtils;
import jalview.util.MessageManager;
+import jalview.util.Platform;
import jalview.ws.sifts.SiftsClient;
import jalview.ws.sifts.SiftsException;
import jalview.ws.sifts.SiftsSettings;
-
-import java.io.PrintStream;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.Collections;
-import java.util.Enumeration;
-import java.util.HashMap;
-import java.util.IdentityHashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.Vector;
-
import mc_view.Atom;
import mc_view.PDBChain;
import mc_view.PDBfile;
{
if (mappings.isEmpty())
{
- System.err.println("reportMapping: No PDB/Sequence mappings.");
+ jalview.bin.Console.errPrintln("reportMapping: No PDB/Sequence mappings.");
}
else
{
- System.err.println(
+ jalview.bin.Console.errPrintln(
"reportMapping: There are " + mappings.size() + " mappings.");
int i = 0;
for (StructureMapping sm : mappings)
{
- System.err.println("mapping " + i++ + " : " + sm.pdbfile);
+ jalview.bin.Console.errPrintln("mapping " + i++ + " : " + sm.pdbfile);
}
}
}
* @return null or the structure data parsed as a pdb file
*/
synchronized public StructureFile setMapping(SequenceI[] sequence,
- String[] targetChains, String pdbFile, DataSourceType protocol,
+ String[] targetChains, String pdbFile, DataSourceType protocol,
IProgressIndicator progress)
{
return computeMapping(true, sequence, targetChains, pdbFile, protocol,
- progress);
+ progress, null, null, true);
}
/**
*/
synchronized public StructureFile setMapping(boolean forStructureView,
SequenceI[] sequenceArray, String[] targetChainIds,
- String pdbFile, DataSourceType sourceType)
+ String pdbFile, DataSourceType sourceType, TFType tft,
+ String paeFilename)
+ {
+ return setMapping(forStructureView, sequenceArray, targetChainIds,
+ pdbFile, sourceType, tft, paeFilename, true);
+ }
+
+
+ /**
+ * create sequence structure mappings between each sequence and the given
+ * pdbFile (retrieved via the given protocol). Either constructs a mapping
+ * using NW alignment or derives one from any available SIFTS mapping data.
+ *
+ * @param forStructureView
+ * when true, record the mapping for use in mouseOvers
+ *
+ * @param sequenceArray
+ * - one or more sequences to be mapped to pdbFile
+ * @param targetChainIds
+ * - optional chain specification for mapping each sequence to pdb
+ * (may be nill, individual elements may be nill) - JBPNote: JAL-2693
+ * - this should be List<List<String>>, empty lists indicate no
+ * predefined mappings
+ * @param pdbFile
+ * - structure data resource
+ * @param sourceType
+ * - how to resolve data from resource
+ * @param tft - specify how to interpret the temperature factor column in the atom data
+ * @param paeFilename - when not null, specifies a filename containing a matrix formatted in JSON using one of the known PAE formats
+ * @param doXferSettings - when true, transfer annotation to mapped sequences in sequenceArray
+ * @return null or the structure data parsed as a pdb file
+ */
+ synchronized public StructureFile setMapping(boolean forStructureView,
+ SequenceI[] sequenceArray, String[] targetChainIds,
+ String pdbFile, DataSourceType sourceType, TFType tft,
+ String paeFilename, boolean doXferSettings)
{
return computeMapping(forStructureView, sequenceArray, targetChainIds,
- pdbFile, sourceType, null);
+ pdbFile, sourceType, null, tft, paeFilename, doXferSettings);
}
/**
* @param IProgressIndicator
* reference to UI component that maintains a progress bar for the
* mapping operation
+ * @param tft - specify how to interpret the temperature factor column in the atom data
+ * @param paeFilename - when not null, specifies a filename containing a matrix formatted in JSON using one of the known PAE formats
+ * @param doXferSettings - when true, transfer annotation to mapped sequences in sequenceArray
* @return null or the structure data parsed as a pdb file
*/
- synchronized public StructureFile computeMapping(
- boolean forStructureView, SequenceI[] sequenceArray,
- String[] targetChainIds, String pdbFile, DataSourceType sourceType,
- IProgressIndicator progress)
+ synchronized public StructureFile computeMapping(boolean forStructureView,
+ SequenceI[] sequenceArray, String[] targetChainIds,
+ String pdbFile, DataSourceType sourceType,
+ IProgressIndicator progress, TFType tft, String paeFilename,
+ boolean doXferSettings)
{
long progressSessionId = System.currentTimeMillis() * 3;
// FIXME: possibly should just delete
boolean parseSecStr = processSecondaryStructure
- ? isStructureFileProcessed(pdbFile, sequenceArray)
- : false;
+ && !isStructureFileProcessed(pdbFile, sequenceArray);
StructureFile pdb = null;
boolean isMapUsingSIFTs = SiftsSettings.isMapWithSifts();
// FIXME if sourceType is not null, we've lost data here
sourceType = AppletFormatAdapter.checkProtocol(pdbFile);
pdb = new JmolParser(false, pdbFile, sourceType);
+ if (paeFilename != null)
+ {
+ pdb.setPAEMatrix(paeFilename);
+ }
+ pdb.setTemperatureFactorType(tft);
pdb.addSettings(parseSecStr && processSecondaryStructure,
parseSecStr && addTempFacAnnot,
parseSecStr && secStructServices);
+ // save doXferSettings and reset after doParse()
+ boolean temp = pdb.getDoXferSettings();
+ pdb.setDoXferSettings(doXferSettings);
pdb.doParse();
+ pdb.setDoXferSettings(temp);
if (pdb.getId() != null && pdb.getId().trim().length() > 0
&& DataSourceType.FILE == sourceType)
{
registerPDBFile(pdb.getId().trim(), pdbFile);
}
// if PDBId is unavailable then skip SIFTS mapping execution path
- isMapUsingSIFTs = isMapUsingSIFTs && pdb.isPPDBIdAvailable();
+ // TODO: JAL-3868 need to know if structure is actually from
+ // PDB (has valid PDB ID and has provenance suggesting it
+ // actually came from PDB)
+ boolean isProtein = false;
+ for (SequenceI s : sequenceArray)
+ {
+ if (s.isProtein())
+ {
+ isProtein = true;
+ break;
+ }
+ }
+ isMapUsingSIFTs = isMapUsingSIFTs && pdb.isPPDBIdAvailable()
+ && !pdb.getId().startsWith("AF-") && isProtein;
} catch (Exception ex)
{
} catch (SiftsException e)
{
isMapUsingSIFTs = false;
- e.printStackTrace();
+ Console.error("SIFTS mapping failed", e);
+ Console.error("Falling back on Needleman & Wunsch alignment");
siftsClient = null;
}
List<StructureMapping> seqToStrucMapping = new ArrayList<>();
if (isMapUsingSIFTs && seq.isProtein())
{
- if (progress!=null) {
- progress.setProgressBar(MessageManager
- .getString("status.obtaining_mapping_with_sifts"),
+ if (progress != null)
+ {
+ progress.setProgressBar(
+ MessageManager
+ .getString("status.obtaining_mapping_with_sifts"),
progressSessionId);
}
jalview.datamodel.Mapping sqmpping = maxAlignseq
pdb, maxChain, sqmpping, maxAlignseq, siftsClient);
seqToStrucMapping.add(siftsMapping);
maxChain.makeExactMapping(siftsMapping, seq);
- maxChain.transferRESNUMFeatures(seq, "IEA: SIFTS");// FIXME: is this
- // "IEA:SIFTS" ?
+ maxChain.transferRESNUMFeatures(seq, "IEA: SIFTS",
+ pdb.getId().toLowerCase(Locale.ROOT));
maxChain.transferResidueAnnotation(siftsMapping, null);
ds.addPDBId(maxChain.sequence.getAllPDBEntries().get(0));
} catch (SiftsException e)
{
// fall back to NW alignment
- System.err.println(e.getMessage());
+ Console.error(e.getMessage());
StructureMapping nwMapping = getNWMappings(seq, pdbFile,
targetChainId, maxChain, pdb, maxAlignseq);
seqToStrucMapping.add(nwMapping);
maxChain.makeExactMapping(maxAlignseq, seq);
- maxChain.transferRESNUMFeatures(seq, "IEA:Jalview"); // FIXME: is
- // this
- // "IEA:Jalview" ?
+ maxChain.transferRESNUMFeatures(seq, "IEA:Jalview",
+ pdb.getId().toLowerCase(Locale.ROOT)); // FIXME: is
+ // this
+ // "IEA:Jalview" ?
maxChain.transferResidueAnnotation(nwMapping, sqmpping);
ds.addPDBId(maxChain.sequence.getAllPDBEntries().get(0));
}
StructureMapping siftsMapping = null;
try
{
- siftsMapping = getStructureMapping(seq,
- pdbFile, chain.id, pdb, chain, sqmpping, maxAlignseq,
- siftsClient);
+ siftsMapping = getStructureMapping(seq, pdbFile, chain.id,
+ pdb, chain, sqmpping, maxAlignseq, siftsClient);
foundSiftsMappings.add(siftsMapping);
chain.makeExactMapping(siftsMapping, seq);
- chain.transferRESNUMFeatures(seq, "IEA: SIFTS");// FIXME: is this
+ chain.transferRESNUMFeatures(seq, "IEA: SIFTS",
+ pdb.getId().toLowerCase(Locale.ROOT));// FIXME: is this
// "IEA:SIFTS" ?
chain.transferResidueAnnotation(siftsMapping, null);
} catch (SiftsException e)
{
- System.err.println(e.getMessage());
- }
- catch (Exception e)
+ jalview.bin.Console.errPrintln(e.getMessage());
+ } catch (Exception e)
{
- System.err
- .println(
- "Unexpected exception during SIFTS mapping - falling back to NW for this sequence/structure pair");
- System.err.println(e.getMessage());
+ jalview.bin.Console.errPrintln(
+ "Unexpected exception during SIFTS mapping - falling back to NW for this sequence/structure pair");
+ jalview.bin.Console.errPrintln(e.getMessage());
}
}
if (!foundSiftsMappings.isEmpty())
StructureMapping nwMapping = getNWMappings(seq, pdbFile,
maxChainId, maxChain, pdb, maxAlignseq);
seqToStrucMapping.add(nwMapping);
- maxChain.transferRESNUMFeatures(seq, null); // FIXME: is this
- // "IEA:Jalview" ?
+ maxChain.transferRESNUMFeatures(seq, null,
+ pdb.getId().toLowerCase(Locale.ROOT)); // FIXME: is this
+ // "IEA:Jalview" ?
maxChain.transferResidueAnnotation(nwMapping, sqmpping);
ds.addPDBId(maxChain.sequence.getAllPDBEntries().get(0));
}
{
if (progress != null)
{
- progress.setProgressBar(MessageManager
- .getString("status.obtaining_mapping_with_nw_alignment"),
+ progress.setProgressBar(
+ MessageManager.getString(
+ "status.obtaining_mapping_with_nw_alignment"),
progressSessionId);
}
StructureMapping nwMapping = getNWMappings(seq, pdbFile, maxChainId,
private boolean isStructureFileProcessed(String pdbFile,
SequenceI[] sequenceArray)
{
- boolean parseSecStr = true;
+ boolean processed = false;
if (isPDBFileRegistered(pdbFile))
{
for (SequenceI sq : sequenceArray)
// passed, not the structure data ID -
if (PDBfile.isCalcIdForFile(ala, findIdForPDBFile(pdbFile)))
{
- parseSecStr = false;
+ processed = true;
}
}
}
}
}
- return parseSecStr;
+ return processed;
}
public void addStructureMapping(StructureMapping sm)
private StructureMapping getStructureMapping(SequenceI seq,
String pdbFile, String targetChainId, StructureFile pdb,
PDBChain maxChain, jalview.datamodel.Mapping sqmpping,
- AlignSeq maxAlignseq, SiftsClient siftsClient) throws SiftsException
+ AlignSeq maxAlignseq, SiftsClient siftsClient)
+ throws SiftsException
{
StructureMapping curChainMapping = siftsClient
.getSiftsStructureMapping(seq, pdbFile, targetChainId);
maxChain.makeExactMapping(maxAlignseq, seq);
jalview.datamodel.Mapping sqmpping = maxAlignseq
.getMappingFromS1(false);
- maxChain.transferRESNUMFeatures(seq, null);
+ maxChain.transferRESNUMFeatures(seq, null,
+ pdb.getId().toLowerCase(Locale.ROOT));
HashMap<Integer, int[]> mapping = new HashMap<>();
int resNum = -10000;
}
/**
+ * hack to highlight a range of positions at once on any structure views
+ *
+ * @param sequenceRef
+ * @param is
+ * - series of int start-end ranges as positions on sequenceRef
+ * @param i
+ * @param object
+ */
+ public void highlightPositionsOn(SequenceI sequenceRef, int[][] is,
+ Object source)
+ {
+ boolean hasSequenceListeners = handlingVamsasMo
+ || !seqmappings.isEmpty();
+ SearchResultsI results = null;
+ ArrayList<Integer> listOfPositions = new ArrayList<Integer>();
+ for (int[] s_e : is)
+ {
+ for (int p = s_e[0]; p <= s_e[1]; listOfPositions.add(p++))
+ ;
+ }
+ int seqpos[] = new int[listOfPositions.size()];
+ int i = 0;
+ for (Integer p : listOfPositions)
+ {
+ seqpos[i++] = p;
+ }
+
+ for (i = 0; i < listeners.size(); i++)
+ {
+ Object listener = listeners.elementAt(i);
+ if (listener == source)
+ {
+ // TODO listener (e.g. SeqPanel) is never == source (AlignViewport)
+ // Temporary fudge with SequenceListener.getVamsasSource()
+ continue;
+ }
+ if (listener instanceof StructureListener)
+ {
+ highlightStructure((StructureListener) listener, sequenceRef,
+ seqpos);
+ }
+
+ }
+ }
+
+ /**
* Propagate mouseover of a single position in a structure
*
* @param pdbResNum
* @param chain
* @param pdbfile
+ * @return
*/
- public void mouseOverStructure(int pdbResNum, String chain,
+ public String mouseOverStructure(int pdbResNum, String chain,
String pdbfile)
{
AtomSpec atomSpec = new AtomSpec(pdbfile, chain, pdbResNum, 0);
List<AtomSpec> atoms = Collections.singletonList(atomSpec);
- mouseOverStructure(atoms);
+ return mouseOverStructure(atoms);
}
/**
*
* @param atoms
*/
- public void mouseOverStructure(List<AtomSpec> atoms)
+ public String mouseOverStructure(List<AtomSpec> atoms)
{
if (listeners == null)
{
// old or prematurely sent event
- return;
+ return null;
}
boolean hasSequenceListener = false;
for (int i = 0; i < listeners.size(); i++)
}
if (!hasSequenceListener)
{
- return;
+ return null;
}
SearchResultsI results = findAlignmentPositionsForStructurePositions(
atoms);
+ String result = null;
for (Object li : listeners)
{
if (li instanceof SequenceListener)
{
- ((SequenceListener) li).highlightSequence(results);
+ String s = ((SequenceListener) li).highlightSequence(results);
+ if (s != null)
+ {
+ result = s;
+ }
}
}
+ return result;
}
/**
sl.highlightAtoms(atoms);
}
+ public void highlightStructureRegionsFor(StructureListener sl,
+ SequenceI[] seqs, int... columns)
+ {
+ List<SequenceI> to_highlight = new ArrayList<SequenceI>();
+ for (SequenceI seq : seqs)
+ {
+ if (sl.isListeningFor(seq))
+ {
+ to_highlight.add(seq);
+ }
+ }
+ if (to_highlight.size() == 0)
+ {
+ return;
+ }
+ List<AtomSpec> atoms = new ArrayList<>();
+ for (SequenceI seq : to_highlight)
+ {
+ int atomNo;
+ for (StructureMapping sm : mappings)
+ {
+ if (sm.sequence == seq || sm.sequence == seq.getDatasetSequence()
+ || (sm.sequence.getDatasetSequence() != null && sm.sequence
+ .getDatasetSequence() == seq.getDatasetSequence()))
+ {
+
+ for (int i = 0; i < columns.length; i += 2)
+ {
+ ContiguousI positions = seq.findPositions(columns[i] + 1,
+ columns[i + 1] + 1);
+ if (positions == null)
+ {
+ continue;
+ }
+ for (int index = positions.getBegin(); index <= positions
+ .getEnd(); index++)
+ {
+
+ atomNo = sm.getAtomNum(index);
+
+ if (atomNo > 0)
+ {
+ atoms.add(new AtomSpec(sm.pdbfile, sm.pdbchain,
+ sm.getPDBResNum(index), atomNo));
+ }
+ }
+ }
+ }
+ }
+ if (atoms.size() > 0)
+ {
+ sl.highlightAtoms(atoms);
+ }
+ }
+ }
+
/**
* true if a mouse over event from an external (ie Vamsas) source is being
* handled
*
* if (mappings[j].sequence == seq && mappings[j].getPdbId().equals(pdbid)
* && mappings[j].pdbfile.equals(sl.getPdbFile())) {
- * System.out.println(pdbid+" "+mappings[j].getPdbId() +"
+ * jalview.bin.Console.outPrintln(pdbid+" "+mappings[j].getPdbId() +"
* "+mappings[j].pdbfile);
*
* java.awt.Color col; for(int index=0; index<seq.getLength(); index++) {
StringBuilder sb = new StringBuilder(64);
for (StructureMapping sm : mappings)
{
- if (sm.pdbfile.equals(pdbfile) && seqs.contains(sm.sequence))
+ if (Platform.pathEquals(sm.pdbfile, pdbfile)
+ && seqs.contains(sm.sequence))
{
sb.append(sm.mappingDetails);
sb.append(NEWLINE);
boolean removed = seqmappings.remove(acf);
if (removed && seqmappings.isEmpty())
{ // debug
- System.out.println("All mappings removed");
+ jalview.bin.Console.outPrintln("All mappings removed");
}
}
}
instances.remove(jalviewLite);
try
{
- mnger.finalize();
+ /* bsoares 2019-03-20 finalize deprecated, no apparent external
+ * resources to close
+ */
+ // mnger.finalize();
} catch (Throwable x)
{
}
return seqmappings;
}
+ /**
+ * quick and dirty route to just highlight all structure positions for a range
+ * of columns
+ *
+ * @param sequencesArray
+ * @param is
+ * start-end columns on sequencesArray
+ * @param source
+ * origin parent AlignmentPanel
+ */
+ public void highlightPositionsOnMany(SequenceI[] sequencesArray, int[] is,
+ Object source)
+ {
+ for (int i = 0; i < listeners.size(); i++)
+ {
+ Object listener = listeners.elementAt(i);
+ if (listener == source)
+ {
+ // TODO listener (e.g. SeqPanel) is never == source (AlignViewport)
+ // Temporary fudge with SequenceListener.getVamsasSource()
+ continue;
+ }
+ if (listener instanceof StructureListener)
+ {
+ highlightStructureRegionsFor((StructureListener) listener,
+ sequencesArray, is);
+ }
+ }
+ }
+
+ public Map<String, String> getPdbFileNameIdMap()
+ {
+ return pdbFileNameId;
+ }
+
+ public Map<String, String> getPdbIdFileNameMap()
+ {
+ return pdbIdFileName;
+ }
+
}