X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fstructures%2Fmodels%2FAAStructureBindingModel.java;h=9c8afdf83283b6cabd93298add6540b1d03fe6b7;hb=1140532d01b32b648e7e5b17ea717ae790625f8f;hp=e77a23c55b0a47e61219bd2db8c58735bd2860fb;hpb=43b415c68805f3dec44a6ddc666d52220483c120;p=jalview.git
diff --git a/src/jalview/structures/models/AAStructureBindingModel.java b/src/jalview/structures/models/AAStructureBindingModel.java
index e77a23c..9c8afdf 100644
--- a/src/jalview/structures/models/AAStructureBindingModel.java
+++ b/src/jalview/structures/models/AAStructureBindingModel.java
@@ -1,14 +1,68 @@
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ *
+ * This file is part of Jalview.
+ *
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *
+ * Jalview is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ * PURPOSE. See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview. If not, see .
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
package jalview.structures.models;
+import java.awt.Color;
+import java.io.File;
+import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
+import java.util.BitSet;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.LinkedHashMap;
import java.util.List;
+import java.util.Locale;
+import java.util.Map;
+import javax.swing.SwingUtilities;
+
+import jalview.api.AlignViewportI;
+import jalview.api.AlignmentViewPanel;
+import jalview.api.FeatureRenderer;
+import jalview.api.SequenceRenderer;
import jalview.api.StructureSelectionManagerProvider;
+import jalview.api.structures.JalviewStructureDisplayI;
+import jalview.bin.Console;
import jalview.datamodel.AlignmentI;
+import jalview.datamodel.ColumnSelection;
+import jalview.datamodel.HiddenColumns;
+import jalview.datamodel.MappedFeatures;
import jalview.datamodel.PDBEntry;
+import jalview.datamodel.SequenceFeature;
import jalview.datamodel.SequenceI;
+import jalview.ext.rbvi.chimera.JalviewChimeraBinding;
+import jalview.gui.AlignmentPanel;
+import jalview.gui.Desktop;
+import jalview.gui.StructureViewer.ViewerType;
+import jalview.io.DataSourceType;
+import jalview.io.StructureFile;
+import jalview.renderer.seqfeatures.FeatureColourFinder;
+import jalview.schemes.ColourSchemeI;
+import jalview.schemes.ResidueProperties;
import jalview.structure.AtomSpec;
+import jalview.structure.AtomSpecModel;
+import jalview.structure.StructureCommandI;
+import jalview.structure.StructureCommandsI;
+import jalview.structure.StructureCommandsI.AtomSpecType;
import jalview.structure.StructureListener;
import jalview.structure.StructureMapping;
import jalview.structure.StructureSelectionManager;
@@ -17,20 +71,88 @@ import jalview.util.MessageManager;
/**
*
- * A base class to hold common function for protein structure model binding.
- * Initial version created by refactoring JMol and Chimera binding models, but
- * other structure viewers could in principle be accommodated in future.
+ * A base class to hold common function for 3D structure model binding. Initial
+ * version created by refactoring JMol and Chimera binding models, but other
+ * structure viewers could in principle be accommodated in future.
*
* @author gmcarstairs
*
*/
-public abstract class AAStructureBindingModel extends
- SequenceStructureBindingModel implements StructureListener,
- StructureSelectionManagerProvider
+public abstract class AAStructureBindingModel
+ extends SequenceStructureBindingModel
+ implements StructureListener, StructureSelectionManagerProvider
{
+ /**
+ * Data bean class to simplify parameterisation in superposeStructures
+ */
+ public static class SuperposeData
+ {
+ public String filename;
+
+ public String pdbId;
+
+ public String chain = "";
+
+ /**
+ * is the mapped sequence not protein ?
+ */
+ public boolean isRna;
+
+ /*
+ * The pdb residue number (if any) mapped to columns of the alignment
+ */
+ public int[] pdbResNo; // or use SparseIntArray?
+
+ public String modelId;
+
+ /**
+ * Constructor
+ *
+ * @param width
+ * width of alignment (number of columns that may potentially
+ * participate in superposition)
+ * @param model
+ * structure viewer model number
+ */
+ public SuperposeData(int width, String model)
+ {
+ pdbResNo = new int[width];
+ modelId = model;
+ }
+ }
+
+ private static final int MIN_POS_TO_SUPERPOSE = 4;
+
+ private static final String COLOURING_STRUCTURES = MessageManager
+ .getString("status.colouring_structures");
+
+ /*
+ * the Jalview panel through which the user interacts
+ * with the structure viewer
+ */
+ private JalviewStructureDisplayI viewer;
+
+ /*
+ * helper that generates command syntax
+ */
+ private StructureCommandsI commandGenerator;
private StructureSelectionManager ssm;
+ /*
+ * modelled chains, formatted as "pdbid:chainCode"
+ */
+ private List chainNames;
+
+ /*
+ * lookup of pdb file name by key "pdbid:chainCode"
+ */
+ private Map chainFile;
+
+ /*
+ * distinct PDB entries (pdb files) associated
+ * with sequences
+ */
private PDBEntry[] pdbEntry;
/*
@@ -46,40 +168,25 @@ public abstract class AAStructureBindingModel extends
/*
* datasource protocol for access to PDBEntrylatest
*/
- String protocol = null;
+ DataSourceType protocol = null;
protected boolean colourBySequence = true;
- private boolean nucleotide;
-
/**
- * Data bean class to simplify parameterisation in superposeStructures
+ * true if all sequences appear to be nucleotide
*/
- protected class SuperposeData
- {
- /**
- * Constructor with alignment width argument
- *
- * @param width
- */
- public SuperposeData(int width)
- {
- pdbResNo = new int[width];
- }
-
- public String filename;
+ private boolean nucleotide;
- public String pdbId;
+ private boolean finishedInit = false;
- public String chain = "";
+ /**
+ * current set of model filenames loaded in the viewer
+ */
+ protected String[] modelFileNames = null;
- public boolean isRna;
+ public String fileLoadingError;
- /*
- * The pdb residue number (if any) mapped to each column of the alignment
- */
- public int[] pdbResNo;
- }
+ protected Thread externalViewerMonitor;
/**
* Constructor
@@ -92,6 +199,8 @@ public abstract class AAStructureBindingModel extends
{
this.ssm = ssm;
this.sequence = seqs;
+ chainNames = new ArrayList<>();
+ chainFile = new HashMap<>();
}
/**
@@ -100,23 +209,69 @@ public abstract class AAStructureBindingModel extends
* @param ssm
* @param pdbentry
* @param sequenceIs
- * @param chains
* @param protocol
*/
public AAStructureBindingModel(StructureSelectionManager ssm,
- PDBEntry[] pdbentry, SequenceI[][] sequenceIs, String[][] chains,
- String protocol)
+ PDBEntry[] pdbentry, SequenceI[][] sequenceIs,
+ DataSourceType protocol)
{
- this.ssm = ssm;
- this.sequence = sequenceIs;
+ this(ssm, sequenceIs);
this.nucleotide = Comparison.isNucleotide(sequenceIs);
- this.chains = chains;
this.pdbEntry = pdbentry;
this.protocol = protocol;
- if (chains == null)
+ resolveChains();
+ }
+
+ private boolean resolveChains()
+ {
+ /**
+ * final count of chain mappings discovered
+ */
+ int chainmaps = 0;
+ // JBPNote: JAL-2693 - this should be a list of chain mappings per
+ // [pdbentry][sequence]
+ String[][] newchains = new String[pdbEntry.length][];
+ int pe = 0;
+ for (PDBEntry pdb : pdbEntry)
{
- this.chains = new String[pdbentry.length][];
+ SequenceI[] seqsForPdb = sequence[pe];
+ if (seqsForPdb != null)
+ {
+ newchains[pe] = new String[seqsForPdb.length];
+ int se = 0;
+ for (SequenceI asq : seqsForPdb)
+ {
+ String chain = (chains != null && chains[pe] != null)
+ ? chains[pe][se]
+ : null;
+ SequenceI sq = (asq.getDatasetSequence() == null) ? asq
+ : asq.getDatasetSequence();
+ if (sq.getAllPDBEntries() != null)
+ {
+ for (PDBEntry pdbentry : sq.getAllPDBEntries())
+ {
+ if (pdb.getFile() != null && pdbentry.getFile() != null
+ && pdb.getFile().equals(pdbentry.getFile()))
+ {
+ String chaincode = pdbentry.getChainCode();
+ if (chaincode != null && chaincode.length() > 0)
+ {
+ chain = chaincode;
+ chainmaps++;
+ break;
+ }
+ }
+ }
+ }
+ newchains[pe][se] = chain;
+ se++;
+ }
+ pe++;
+ }
}
+
+ chains = newchains;
+ return chainmaps > 0;
}
public StructureSelectionManager getSsm()
@@ -176,7 +331,7 @@ public abstract class AAStructureBindingModel extends
return chains;
}
- public String getProtocol()
+ public DataSourceType getProtocol()
{
return protocol;
}
@@ -200,7 +355,9 @@ public abstract class AAStructureBindingModel extends
/**
* Construct a title string for the viewer window based on the data Jalview
* knows about
- * @param viewerName TODO
+ *
+ * @param viewerName
+ * TODO
* @param verbose
*
* @return
@@ -208,33 +365,28 @@ public abstract class AAStructureBindingModel extends
public String getViewerTitle(String viewerName, boolean verbose)
{
if (getSequence() == null || getSequence().length < 1
- || getPdbCount() < 1
- || getSequence()[0].length < 1)
+ || getPdbCount() < 1 || getSequence()[0].length < 1)
{
return ("Jalview " + viewerName + " Window");
}
// TODO: give a more informative title when multiple structures are
// displayed.
StringBuilder title = new StringBuilder(64);
- final PDBEntry pdbEntry = getPdbEntry(0);
+ final PDBEntry pdbe = getPdbEntry(0);
title.append(viewerName + " view for " + getSequence()[0][0].getName()
- + ":"
- + pdbEntry.getId());
-
+ + ":" + pdbe.getId());
+
if (verbose)
{
- if (pdbEntry.getProperty() != null)
+ String method = (String) pdbe.getProperty("method");
+ if (method != null)
{
- if (pdbEntry.getProperty().get("method") != null)
- {
- title.append(" Method: ");
- title.append(pdbEntry.getProperty().get("method"));
- }
- if (pdbEntry.getProperty().get("chains") != null)
- {
- title.append(" Chain:");
- title.append(pdbEntry.getProperty().get("chains"));
- }
+ title.append(" Method: ").append(method);
+ }
+ String chain = (String) pdbe.getProperty("chains");
+ if (chain != null)
+ {
+ title.append(" Chain:").append(chain);
}
}
return title.toString();
@@ -246,7 +398,11 @@ public abstract class AAStructureBindingModel extends
*/
protected void releaseUIResources()
{
+ }
+ @Override
+ public void releaseReferences(Object svl)
+ {
}
public boolean isColourBySequence()
@@ -254,6 +410,25 @@ public abstract class AAStructureBindingModel extends
return colourBySequence;
}
+ /**
+ * Called when the binding thinks the UI needs to be refreshed after a
+ * structure viewer state change. This could be because structures were
+ * loaded, or because an error has occurred. Default does nothing, override as
+ * required.
+ */
+ public void refreshGUI()
+ {
+ }
+
+ /**
+ * Instruct the Jalview binding to update the pdbentries vector if necessary
+ * prior to matching the jmol view's contents to the list of structure files
+ * Jalview knows about. By default does nothing, override as required.
+ */
+ public void refreshPdbEntries()
+ {
+ }
+
public void setColourBySequence(boolean colourBySequence)
{
this.colourBySequence = colourBySequence;
@@ -270,8 +445,8 @@ public abstract class AAStructureBindingModel extends
{ Integer.valueOf(pe).toString() }));
}
final String nullChain = "TheNullChain";
- List s = new ArrayList();
- List c = new ArrayList();
+ List s = new ArrayList<>();
+ List c = new ArrayList<>();
if (getChains() == null)
{
setChains(new String[getPdbCount()][]);
@@ -337,11 +512,11 @@ public abstract class AAStructureBindingModel extends
*
* @returns the pdb entries added to the current set.
*/
- public synchronized PDBEntry[] addSequenceAndChain(PDBEntry[] pdbe, SequenceI[][] seq,
- String[][] chns)
+ public synchronized PDBEntry[] addSequenceAndChain(PDBEntry[] pdbe,
+ SequenceI[][] seq, String[][] chns)
{
- List v = new ArrayList();
- List rtn = new ArrayList();
+ List v = new ArrayList<>();
+ List rtn = new ArrayList<>();
for (int i = 0; i < getPdbCount(); i++)
{
v.add(getPdbEntry(i));
@@ -351,8 +526,7 @@ public abstract class AAStructureBindingModel extends
int r = v.indexOf(pdbe[i]);
if (r == -1 || r >= getPdbCount())
{
- rtn.add(new int[]
- { v.size(), i });
+ rtn.add(new int[] { v.size(), i });
v.add(pdbe[i]);
}
else
@@ -489,18 +663,23 @@ public abstract class AAStructureBindingModel extends
* the sequence alignment which is the basis of structure
* superposition
* @param matched
- * an array of booleans, indexed by alignment column, where true
- * indicates that every structure has a mapped residue present in the
- * column (so the column can participate in structure alignment)
+ * a BitSet, where bit j is set to indicate that every structure has
+ * a mapped residue present in column j (so the column can
+ * participate in structure alignment)
* @param structures
* an array of data beans corresponding to pdb file index
* @return
*/
protected int findSuperposableResidues(AlignmentI alignment,
- boolean[] matched, SuperposeData[] structures)
+ BitSet matched,
+ AAStructureBindingModel.SuperposeData[] structures)
{
int refStructure = -1;
- String[] files = getPdbFile();
+ String[] files = getStructureFiles();
+ if (files == null)
+ {
+ return -1;
+ }
for (int pdbfnum = 0; pdbfnum < files.length; pdbfnum++)
{
StructureMapping[] mappings = getSsm().getMapping(files[pdbfnum]);
@@ -523,16 +702,16 @@ public abstract class AAStructureBindingModel extends
{
refStructure = pdbfnum;
}
- for (int r = 0; r < matched.length; r++)
+ for (int r = 0; r < alignment.getWidth(); r++)
{
- if (!matched[r])
+ if (!matched.get(r))
{
continue;
}
int pos = getMappedPosition(theSequence, r, mapping);
if (pos < 1 || pos == lastPos)
{
- matched[r] = false;
+ matched.clear(r);
continue;
}
lastPos = pos;
@@ -544,10 +723,14 @@ public abstract class AAStructureBindingModel extends
structures[pdbfnum].chain = chain;
}
structures[pdbfnum].pdbId = mapping.getPdbId();
- structures[pdbfnum].isRna = theSequence.getRNA() != null;
- // move on to next pdb file
+ structures[pdbfnum].isRna = !theSequence.isProtein();
+
+ /*
+ * move on to next pdb file (ignore sequences for other chains
+ * for the same structure)
+ */
s = seqCountForPdbFile;
- break;
+ break; // fixme break out of two loops here!
}
}
}
@@ -578,6 +761,10 @@ public abstract class AAStructureBindingModel extends
for (String file : files)
{
notLoaded = file;
+ if (file == null)
+ {
+ continue;
+ }
try
{
StructureMapping[] sm = getSsm().getMapping(file);
@@ -594,8 +781,8 @@ public abstract class AAStructureBindingModel extends
if (waiting)
{
- System.err
- .println("Timed out waiting for structure viewer to load file "
+ jalview.bin.Console.errPrintln(
+ "Timed out waiting for structure viewer to load file "
+ notLoaded);
return false;
}
@@ -613,7 +800,8 @@ public abstract class AAStructureBindingModel extends
{
for (SequenceI s : seqs)
{
- if (s == seq)
+ if (s == seq || (s.getDatasetSequence() != null
+ && s.getDatasetSequence() == seq.getDatasetSequence()))
{
return true;
}
@@ -623,4 +811,1218 @@ public abstract class AAStructureBindingModel extends
}
return false;
}
-}
\ No newline at end of file
+
+ public boolean isFinishedInit()
+ {
+ return finishedInit;
+ }
+
+ public void setFinishedInit(boolean fi)
+ {
+ this.finishedInit = fi;
+ }
+
+ /**
+ * Returns a list of chains mapped in this viewer, formatted as
+ * "pdbid:chainCode"
+ *
+ * @return
+ */
+ public List getChainNames()
+ {
+ return chainNames;
+ }
+
+ /**
+ * Returns the Jalview panel hosting the structure viewer (if any)
+ *
+ * @return
+ */
+ public JalviewStructureDisplayI getViewer()
+ {
+ return viewer;
+ }
+
+ public void setViewer(JalviewStructureDisplayI v)
+ {
+ viewer = v;
+ }
+
+ /**
+ * Constructs and sends a command to align structures against a reference
+ * structure, based on one or more sequence alignments. May optionally return
+ * an error or warning message for the alignment command(s).
+ *
+ * @param alignWith
+ * an array of one or more alignment views to process
+ * @return
+ */
+ public String superposeStructures(List alignWith)
+ {
+ String error = "";
+ String[] files = getStructureFiles();
+
+ if (!waitForFileLoad(files))
+ {
+ return null;
+ }
+ refreshPdbEntries();
+
+ for (AlignmentViewPanel view : alignWith)
+ {
+ AlignmentI alignment = view.getAlignment();
+ HiddenColumns hiddenCols = alignment.getHiddenColumns();
+ /*
+ * 'matched' bit i will be set for visible alignment columns i where
+ * all sequences have a residue with a mapping to their PDB structure
+ */
+ final int width = alignment.getWidth();
+ BitSet matched = new BitSet();
+ ColumnSelection cs = view.getAlignViewport().getColumnSelection();
+ // restrict to active column selection, if there is one
+ if (cs != null && cs.hasSelectedColumns()
+ && cs.getSelected().size() >= 4)
+ {
+ for (int s : cs.getSelected())
+ {
+ matched.set(s);
+ }
+ }
+ else
+ {
+ for (int m = 0; m < width; m++)
+ {
+ if (hiddenCols == null || hiddenCols.isVisible(m))
+ {
+ matched.set(m);
+ }
+ }
+ }
+ AAStructureBindingModel.SuperposeData[] structures = new AAStructureBindingModel.SuperposeData[files.length];
+ for (int f = 0; f < files.length; f++)
+ {
+ structures[f] = new AAStructureBindingModel.SuperposeData(width,
+ getModelIdForFile(files[f]));
+ }
+
+ /*
+ * Calculate the superposable alignment columns ('matched'), and the
+ * corresponding structure residue positions (structures.pdbResNo)
+ */
+ int refStructure = findSuperposableResidues(alignment, matched,
+ structures);
+
+ /*
+ * require at least 4 positions to be able to execute superposition
+ */
+ int nmatched = matched.cardinality();
+ if (nmatched < MIN_POS_TO_SUPERPOSE)
+ {
+ String msg = MessageManager
+ .formatMessage("label.insufficient_residues", nmatched);
+ error += view.getViewName() + ": " + msg + "; ";
+ continue;
+ }
+
+ /*
+ * get a model of the superposable residues in the reference structure
+ */
+ AtomSpecModel refAtoms = getAtomSpec(structures[refStructure],
+ matched);
+
+ /*
+ * Show all as backbone before doing superposition(s)
+ * (residues used for matching will be shown as ribbon)
+ */
+ // todo better way to ensure synchronous than setting getReply true!!
+ executeCommands(commandGenerator.showBackbone(), true, null);
+
+ AtomSpecType backbone = structures[refStructure].isRna
+ ? AtomSpecType.PHOSPHATE
+ : AtomSpecType.ALPHA;
+ List models = new ArrayList();
+ models.add(refAtoms);
+ /*
+ * superpose each (other) structure to the reference in turn
+ */
+ for (int i = 0; i < structures.length; i++)
+ {
+ if (i != refStructure)
+ {
+ AtomSpecModel atomSpec = getAtomSpec(structures[i], matched);
+ List commands = commandGenerator
+ .superposeStructures(refAtoms, atomSpec, backbone);
+ List replies = executeCommands(commands, true, null);
+ for (String reply : replies)
+ {
+ // return this error (Chimera only) to the user
+ if (reply.toLowerCase(Locale.ROOT)
+ .contains("unequal numbers of atoms"))
+ {
+ error += "; " + reply;
+ }
+ }
+ models.add(atomSpec);
+ }
+ }
+ List finalView = commandGenerator
+ .centerViewOn(models);
+ if (finalView != null && finalView.size() > 0)
+ {
+ executeCommands(finalView, false, "Centered on Superposition");
+ }
+ }
+ return error;
+ }
+
+ private AtomSpecModel getAtomSpec(
+ AAStructureBindingModel.SuperposeData superposeData,
+ BitSet matched)
+ {
+ AtomSpecModel model = new AtomSpecModel();
+ int nextColumnMatch = matched.nextSetBit(0);
+ while (nextColumnMatch != -1)
+ {
+ int pdbResNum = superposeData.pdbResNo[nextColumnMatch];
+ model.addRange(superposeData.modelId, pdbResNum, pdbResNum,
+ superposeData.chain);
+ nextColumnMatch = matched.nextSetBit(nextColumnMatch + 1);
+ }
+
+ return model;
+ }
+
+ /**
+ * returns the current sequenceRenderer that should be used to colour the
+ * structures
+ *
+ * @param alignment
+ *
+ * @return
+ */
+ public abstract SequenceRenderer getSequenceRenderer(
+ AlignmentViewPanel alignment);
+
+ /**
+ * Sends a command to the structure viewer to colour each chain with a
+ * distinct colour (to the extent supported by the viewer)
+ */
+ public void colourByChain()
+ {
+ colourBySequence = false;
+
+ // TODO: JAL-628 colour chains distinctly across all visible models
+
+ executeCommand(false, COLOURING_STRUCTURES,
+ commandGenerator.colourByChain());
+ }
+
+ /**
+ * Sends a command to the structure viewer to colour each chain with a
+ * distinct colour (to the extent supported by the viewer)
+ */
+ public void colourByCharge()
+ {
+ colourBySequence = false;
+
+ executeCommands(commandGenerator.colourByCharge(), false,
+ COLOURING_STRUCTURES);
+ }
+
+ /**
+ * Sends a command to the structure to apply a colour scheme (defined in
+ * Jalview but not necessarily applied to the alignment), which defines a
+ * colour per residue letter. More complex schemes (e.g. that depend on
+ * consensus) cannot be used here and are ignored.
+ *
+ * @param cs
+ */
+ public void colourByJalviewColourScheme(ColourSchemeI cs)
+ {
+ colourBySequence = false;
+
+ if (cs == null || !cs.isSimple())
+ {
+ return;
+ }
+
+ /*
+ * build a map of {Residue3LetterCode, Color}
+ */
+ Map colours = new HashMap<>();
+ List residues = ResidueProperties.getResidues(isNucleotide(),
+ false);
+ for (String resName : residues)
+ {
+ char res = resName.length() == 3
+ ? ResidueProperties.getSingleCharacterCode(resName)
+ : resName.charAt(0);
+ Color colour = cs.findColour(res, 0, null, null, 0f);
+ colours.put(resName, colour);
+ }
+
+ /*
+ * pass to the command constructor, and send the command
+ */
+ List cmd = commandGenerator
+ .colourByResidues(colours);
+ executeCommands(cmd, false, COLOURING_STRUCTURES);
+ }
+
+ public void setBackgroundColour(Color col)
+ {
+ StructureCommandI cmd = commandGenerator.setBackgroundColour(col);
+ executeCommand(false, null, cmd);
+ }
+
+ /**
+ * Execute one structure viewer command. If {@code getReply} is true, may
+ * optionally return one or more reply messages, else returns null.
+ *
+ * @param cmd
+ * @param getReply
+ */
+ protected abstract List executeCommand(StructureCommandI cmd,
+ boolean getReply);
+
+ /**
+ * Executes one or more structure viewer commands
+ *
+ * @param commands
+ * @param getReply
+ * @param msg
+ */
+ public List executeCommands(List commands,
+ boolean getReply, String msg)
+ {
+ return executeCommand(getReply, msg,
+ commands.toArray(new StructureCommandI[commands.size()]));
+ }
+
+ /**
+ * Executes one or more structure viewer commands, optionally returning the
+ * reply, and optionally showing a status message while the command is being
+ * executed.
+ *
+ * If a reply is wanted, the execution is done synchronously (waits),
+ * otherwise it is done in a separate thread (doesn't wait). WARNING: if you
+ * are sending commands that need to execute before later calls to
+ * executeCommand (e.g. mouseovers, which clean up after previous ones) then
+ * set getReply true to ensure that commands are not executed out of order.
+ *
+ * @param getReply
+ * @param msg
+ * @param cmds
+ * @return
+ */
+ protected List executeCommand(boolean getReply, String msg,
+ StructureCommandI... cmds)
+ {
+ JalviewStructureDisplayI theViewer = getViewer();
+ final long handle = msg == null ? 0 : theViewer.startProgressBar(msg);
+
+ if (getReply)
+ {
+ /*
+ * execute and wait for reply
+ */
+ List response = new ArrayList<>();
+ try
+ {
+ for (StructureCommandI cmd : cmds)
+ {
+ List replies = executeCommand(cmd, true);
+ if (replies != null)
+ {
+ response.addAll(replies);
+ }
+ }
+ return response;
+ } finally
+ {
+ if (msg != null)
+ {
+ theViewer.stopProgressBar(null, handle);
+ }
+ }
+ }
+
+ /*
+ * fire and forget
+ */
+ String threadName = msg == null ? "StructureCommand" : msg;
+ new Thread(new Runnable()
+ {
+ @Override
+ public void run()
+ {
+ try
+ {
+ for (StructureCommandI cmd : cmds)
+ {
+ executeCommand(cmd, false);
+ }
+ } finally
+ {
+ if (msg != null)
+ {
+ SwingUtilities.invokeLater(new Runnable()
+ {
+ @Override
+ public void run()
+ {
+ theViewer.stopProgressBar(null, handle);
+ }
+ });
+ }
+ }
+ }
+ }, threadName).start();
+ return null;
+ }
+
+ /**
+ * Colours any structures associated with sequences in the given alignment as
+ * coloured in the alignment view, provided colourBySequence is enabled
+ */
+ public void colourBySequence(AlignmentViewPanel alignmentv)
+ {
+ if (!colourBySequence || !isLoadingFinished() || getSsm() == null)
+ {
+ return;
+ }
+ Map