X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fstructure%2FStructureSelectionManager.java;h=e2cf3c9940f1085e9f1dd0449ed74badfb7ae683;hb=153dd62dc91da13ae732600e6ea55ddbe15eab39;hp=48f46ed6d74f9168348d9f3638eedd8532c1842a;hpb=25c188b06c08f654687b66314aa0da00106488a0;p=jalview.git diff --git a/src/jalview/structure/StructureSelectionManager.java b/src/jalview/structure/StructureSelectionManager.java index 48f46ed..e2cf3c9 100644 --- a/src/jalview/structure/StructureSelectionManager.java +++ b/src/jalview/structure/StructureSelectionManager.java @@ -1,20 +1,19 @@ /* - * Jalview - A Sequence Alignment Editor and Viewer - * Copyright (C) 2007 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle - * - * This program 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 2 - * of the License, or (at your option) any later version. - * - * This program 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 this program; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA + * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6) + * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle + * + * 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 . */ package jalview.structure; @@ -28,7 +27,9 @@ import jalview.datamodel.*; public class StructureSelectionManager { static StructureSelectionManager instance; + StructureMapping[] mappings; + Hashtable mappingData = new Hashtable(); public static StructureSelectionManager getStructureSelectionManager() @@ -41,7 +42,37 @@ public class StructureSelectionManager return instance; } + /** + * flag controlling whether SeqMappings are relayed from received sequence + * mouse over events to other sequences + */ + boolean relaySeqMappings = true; + + /** + * Enable or disable relay of seqMapping events to other sequences. You might + * want to do this if there are many sequence mappings and the host computer + * is slow + * + * @param relay + */ + public void setRelaySeqMappings(boolean relay) + { + relaySeqMappings = relay; + } + + /** + * get the state of the relay seqMappings flag. + * + * @return true if sequence mouse overs are being relayed to other mapped + * sequences + */ + public boolean isRelaySeqMappingsEnabled() + { + return relaySeqMappings; + } + Vector listeners = new Vector(); + public void addStructureViewerListener(Object svl) { if (!listeners.contains(svl)) @@ -65,22 +96,33 @@ public class StructureSelectionManager return null; } - /* - There will be better ways of doing this in the future, for now we'll use - the tried and tested MCview pdb mapping + /** + * create sequence structure mappings between each sequence and the given + * pdbFile (retrieved via the given protocol). + * + * @param sequence + * - one or more sequences to be mapped to pdbFile + * @param targetChains + * - optional chain specification for mapping each sequence to pdb + * (may be nill, individual elements may be nill) + * @param pdbFile + * - structure data resource + * @param protocol + * - how to resolve data from resource + * @return null or the structure data parsed as a pdb file */ - synchronized public MCview.PDBfile setMapping( - SequenceI[] sequence, - String[] targetChains, - String pdbFile, - String protocol) + synchronized public MCview.PDBfile setMapping(SequenceI[] sequence, + String[] targetChains, String pdbFile, String protocol) { + /* + * There will be better ways of doing this in the future, for now we'll use + * the tried and tested MCview pdb mapping + */ MCview.PDBfile pdb = null; try { pdb = new MCview.PDBfile(pdbFile, protocol); - } - catch (Exception ex) + } catch (Exception ex) { ex.printStackTrace(); return null; @@ -89,49 +131,59 @@ public class StructureSelectionManager String targetChain; for (int s = 0; s < sequence.length; s++) { - if(targetChains!=null && targetChains[s]!=null) + if (targetChains != null && targetChains[s] != null) targetChain = targetChains[s]; else if (sequence[s].getName().indexOf("|") > -1) { targetChain = sequence[s].getName().substring( - sequence[s].getName().lastIndexOf("|") + 1); + sequence[s].getName().lastIndexOf("|") + 1); } else targetChain = ""; - int max = -10; AlignSeq maxAlignseq = null; String maxChainId = " "; PDBChain maxChain = null; - + boolean first = true; for (int i = 0; i < pdb.chains.size(); i++) { + // TODO: re http://issues.jalview.org/browse/JAL-583 : this patch may + // need to be revoked + PDBChain chain = ((PDBChain) pdb.chains.elementAt(i)); + if (targetChain.length() > 0 && !targetChain.equals(chain.id)) + { + continue; // don't try to map chains don't match. + } + // end of patch for limiting computed mappings + // TODO: correctly determine sequence type for mixed na/peptide + // structures AlignSeq as = new AlignSeq(sequence[s], - ( (PDBChain) pdb.chains.elementAt(i)). - sequence, - AlignSeq.PEP); + ((PDBChain) pdb.chains.elementAt(i)).sequence, + ((PDBChain) pdb.chains.elementAt(i)).isNa ? AlignSeq.DNA + : AlignSeq.PEP); as.calcScoreMatrix(); as.traceAlignment(); - PDBChain chain = ( (PDBChain) pdb.chains.elementAt(i)); - if (as.maxscore > max - || (as.maxscore == max && chain.id.equals(targetChain))) + if (first || as.maxscore > max + || (as.maxscore == max && chain.id.equals(targetChain))) { + first = false; maxChain = chain; max = as.maxscore; maxAlignseq = as; maxChainId = chain.id; } } - + if (maxChain == null) + { + continue; + } final StringBuffer mappingDetails = new StringBuffer(); - mappingDetails.append("\n\nPDB Sequence is :\nSequence = " + - maxChain.sequence.getSequenceAsString()); - mappingDetails.append("\nNo of residues = " + - maxChain.residues. - size() + - "\n\n"); + mappingDetails.append("\n\nPDB Sequence is :\nSequence = " + + maxChain.sequence.getSequenceAsString()); + mappingDetails.append("\nNo of residues = " + + maxChain.residues.size() + "\n\n"); PrintStream ps = new PrintStream(System.out) { public void print(String x) @@ -147,12 +199,11 @@ public class StructureSelectionManager maxAlignseq.printAlignment(ps); - mappingDetails.append("\nPDB start/end " + maxAlignseq.seq2start + " " + - maxAlignseq.seq2end); + mappingDetails.append("\nPDB start/end " + maxAlignseq.seq2start + + " " + maxAlignseq.seq2end); mappingDetails.append("\nSEQ start/end " - + (maxAlignseq.seq1start + sequence[s].getStart() - 1) + - " " - + (maxAlignseq.seq1end + sequence[s].getEnd() - 1)); + + (maxAlignseq.seq1start + sequence[s].getStart() - 1) + " " + + (maxAlignseq.seq1end + sequence[s].getEnd() - 1)); maxChain.makeExactMapping(maxAlignseq, sequence[s]); @@ -162,20 +213,18 @@ public class StructureSelectionManager int resNum = -10000; int index = 0; - do { Atom tmp = (Atom) maxChain.atoms.elementAt(index); if (resNum != tmp.resNumber && tmp.alignmentMapping != -1) { resNum = tmp.resNumber; - mapping[tmp.alignmentMapping+1][0] = tmp.resNumber; - mapping[tmp.alignmentMapping+1][1] = tmp.atomIndex; + mapping[tmp.alignmentMapping + 1][0] = tmp.resNumber; + mapping[tmp.alignmentMapping + 1][1] = tmp.atomIndex; } index++; - } - while(index < maxChain.atoms.size()); + } while (index < maxChain.atoms.size()); if (mappings == null) { @@ -188,45 +237,55 @@ public class StructureSelectionManager mappings = tmp; } - if(protocol.equals(jalview.io.AppletFormatAdapter.PASTE)) - pdbFile = "INLINE"+pdb.id; + if (protocol.equals(jalview.io.AppletFormatAdapter.PASTE)) + pdbFile = "INLINE" + pdb.id; - mappings[mappings.length - 1] - = new StructureMapping(sequence[s], pdbFile, pdb.id, maxChainId, - mapping, mappingDetails.toString()); - maxChain.transferResidueAnnotation(mappings[mappings.length-1]); + mappings[mappings.length - 1] = new StructureMapping(sequence[s], + pdbFile, pdb.id, maxChainId, mapping, + mappingDetails.toString()); + maxChain.transferResidueAnnotation(mappings[mappings.length - 1]); } - ///////// + // /////// return pdb; } - public void removeStructureViewerListener(Object svl, String pdbfile) + public void removeStructureViewerListener(Object svl, String[] pdbfiles) { listeners.removeElement(svl); - + if (pdbfiles == null) + { + return; + } boolean removeMapping = true; - + String[] handlepdbs; + Vector pdbs = new Vector(); + for (int i = 0; i < pdbfiles.length; pdbs.addElement(pdbfiles[i++])) + ; StructureListener sl; for (int i = 0; i < listeners.size(); i++) { if (listeners.elementAt(i) instanceof StructureListener) { sl = (StructureListener) listeners.elementAt(i); - if (sl.getPdbFile().equals(pdbfile)) + handlepdbs = sl.getPdbFile(); + for (int j = 0; j < handlepdbs.length; j++) { - removeMapping = false; - break; + if (pdbs.contains(handlepdbs[j])) + { + pdbs.removeElement(handlepdbs[j]); + } } + } } - if (removeMapping && mappings!=null) + if (pdbs.size() > 0 && mappings != null) { Vector tmp = new Vector(); for (int i = 0; i < mappings.length; i++) { - if (!mappings[i].pdbfile.equals(pdbfile)) + if (!pdbs.contains(mappings[i].pdbfile)) { tmp.addElement(mappings[i]); } @@ -239,28 +298,73 @@ public class StructureSelectionManager public void mouseOverStructure(int pdbResNum, String chain, String pdbfile) { - SequenceListener sl; + boolean hasSequenceListeners = handlingVamsasMo || seqmappings != null; + SearchResults results = null; for (int i = 0; i < listeners.size(); i++) { if (listeners.elementAt(i) instanceof SequenceListener) { - sl = (SequenceListener) listeners.elementAt(i); - - for (int j = 0; j < mappings.length; j++) + if (results == null) + { + results = new SearchResults(); + } + int indexpos; + if (mappings != null) { - if (mappings[j].pdbfile.equals(pdbfile) && - mappings[j].pdbchain.equals(chain)) + for (int j = 0; j < mappings.length; j++) { - sl.highlightSequence(mappings[j].sequence, - mappings[j].getSeqPos(pdbResNum)); + if (mappings[j].pdbfile.equals(pdbfile) + && mappings[j].pdbchain.equals(chain)) + { + indexpos = mappings[j].getSeqPos(pdbResNum); + results.addResult(mappings[j].sequence, indexpos, indexpos); + // construct highlighted sequence list + if (seqmappings != null) + { + + Enumeration e = seqmappings.elements(); + while (e.hasMoreElements()) + + { + ((AlignedCodonFrame) e.nextElement()).markMappedRegion( + mappings[j].sequence, indexpos, results); + } + } + } } } } } + if (results.getSize() > 0) + { + for (int i = 0; i < listeners.size(); i++) + { + Object li = listeners.elementAt(i); + if (li instanceof SequenceListener) + ((SequenceListener) li).highlightSequence(results); + } + } } - public void mouseOverSequence(SequenceI seq, int index) + Vector seqmappings = null; // should be a simpler list of mapped seuqence + + /** + * highlight regions associated with a position (indexpos) in seq + * + * @param seq + * the sequeence that the mouse over occured on + * @param indexpos + * the absolute position being mouseovered in seq (0 to seq.length()) + * @param index + * the sequence position (if -1, seq.findPosition is called to + * resolve the residue number) + */ + public void mouseOverSequence(SequenceI seq, int indexpos, int index) { + boolean hasSequenceListeners = handlingVamsasMo || seqmappings != null; + SearchResults results = null; + if (index == -1) + index = seq.findPosition(indexpos); StructureListener sl; int atomNo = 0; for (int i = 0; i < listeners.size(); i++) @@ -268,84 +372,152 @@ public class StructureSelectionManager if (listeners.elementAt(i) instanceof StructureListener) { sl = (StructureListener) listeners.elementAt(i); - + if (mappings == null) + { + continue; + } for (int j = 0; j < mappings.length; j++) { - if (mappings[j].sequence == seq) + if (mappings[j].sequence == seq + || mappings[j].sequence == seq.getDatasetSequence()) { atomNo = mappings[j].getAtomNum(index); if (atomNo > 0) { - sl.highlightAtom(atomNo, - mappings[j].getPDBResNum(index), - mappings[j].pdbchain, - mappings[j].pdbfile); + sl.highlightAtom(atomNo, mappings[j].getPDBResNum(index), + mappings[j].pdbchain, mappings[j].pdbfile); } } } } - } - } - - public Annotation[] colourSequenceFromStructure(SequenceI seq, String pdbid) - { - return null; - //THIS WILL NOT BE AVAILABLE IN JALVIEW 2.3, - //UNTIL THE COLOUR BY ANNOTATION IS REWORKED - /* Annotation [] annotations = new Annotation[seq.getLength()]; - - StructureListener sl; - int atomNo = 0; - for (int i = 0; i < listeners.size(); i++) - { - if (listeners.elementAt(i) instanceof StructureListener) + else { - sl = (StructureListener) listeners.elementAt(i); - - for (int j = 0; j < mappings.length; j++) + if (relaySeqMappings && hasSequenceListeners + && listeners.elementAt(i) instanceof SequenceListener) { + // DEBUG + // System.err.println("relay Seq " + seq.getDisplayId(false) + " " + + // index); - if (mappings[j].sequence == seq - && mappings[j].getPdbId().equals(pdbid) - && mappings[j].pdbfile.equals(sl.getPdbFile())) + if (results == null) { - System.out.println(pdbid+" "+mappings[j].getPdbId() - +" "+mappings[j].pdbfile); - - java.awt.Color col; - for(int index=0; index= seq.getStart() && index <= seq.getEnd()) { - if(jalview.util.Comparison.isGap(seq.getCharAt(index))) - continue; + // construct highlighted sequence list - atomNo = mappings[j].getAtomNum(seq.findPosition(index)); - col = java.awt.Color.white; - if (atomNo > 0) + if (seqmappings != null) { - col = sl.getColour(atomNo, - mappings[j].getPDBResNum(index), - mappings[j].pdbchain, - mappings[j].pdbfile); - } + Enumeration e = seqmappings.elements(); + while (e.hasMoreElements()) - annotations[index] = new Annotation("X",null,' ',0,col); + { + ((AlignedCodonFrame) e.nextElement()).markMappedRegion( + seq, index, results); + } + } + // hasSequenceListeners = results.getSize() > 0; + if (handlingVamsasMo) + { + // maybe have to resolve seq to a dataset seqeunce... + // add in additional direct sequence and/or dataset sequence + // highlighting + results.addResult(seq, index, index); + } } - return annotations; } + if (hasSequenceListeners) + { + ((SequenceListener) listeners.elementAt(i)) + .highlightSequence(results); + } + } + else if (listeners.elementAt(i) instanceof VamsasListener + && !handlingVamsasMo) + { + // DEBUG + // System.err.println("Vamsas from Seq " + seq.getDisplayId(false) + " + // " + + // index); + // pass the mouse over and absolute position onto the + // VamsasListener(s) + ((VamsasListener) listeners.elementAt(i)) + .mouseOver(seq, indexpos); } } } + } + + /** + * true if a mouse over event from an external (ie Vamsas) source is being + * handled + */ + boolean handlingVamsasMo = false; - return annotations;*/ + long lastmsg = 0; + + /** + * as mouseOverSequence but only route event to SequenceListeners + * + * @param sequenceI + * @param position + * in an alignment sequence + */ + public void mouseOverVamsasSequence(SequenceI sequenceI, int position) + { + handlingVamsasMo = true; + long msg = sequenceI.hashCode() * (1 + position); + if (lastmsg != msg) + { + lastmsg = msg; + mouseOverSequence(sequenceI, position, -1); + } + handlingVamsasMo = false; } + public Annotation[] colourSequenceFromStructure(SequenceI seq, + String pdbid) + { + return null; + // THIS WILL NOT BE AVAILABLE IN JALVIEW 2.3, + // UNTIL THE COLOUR BY ANNOTATION IS REWORKED + /* + * Annotation [] annotations = new Annotation[seq.getLength()]; + * + * StructureListener sl; int atomNo = 0; for (int i = 0; i < + * listeners.size(); i++) { if (listeners.elementAt(i) instanceof + * StructureListener) { sl = (StructureListener) listeners.elementAt(i); + * + * for (int j = 0; j < mappings.length; j++) { + * + * if (mappings[j].sequence == seq && mappings[j].getPdbId().equals(pdbid) + * && mappings[j].pdbfile.equals(sl.getPdbFile())) { + * System.out.println(pdbid+" "+mappings[j].getPdbId() +" + * "+mappings[j].pdbfile); + * + * java.awt.Color col; for(int index=0; index 0) { col = sl.getColour(atomNo, + * mappings[j].getPDBResNum(index), mappings[j].pdbchain, + * mappings[j].pdbfile); } + * + * annotations[index] = new Annotation("X",null,' ',0,col); } return + * annotations; } } } } + * + * return annotations; + */ + } public void structureSelectionChanged() - { } + { + } public void sequenceSelectionChanged() - { } + { + } public void sequenceColoursChanged(Object source) { @@ -363,14 +535,16 @@ public class StructureSelectionManager public StructureMapping[] getMapping(String pdbfile) { Vector tmp = new Vector(); - for (int i = 0; i < mappings.length; i++) + if (mappings != null) { - if (mappings[i].pdbfile.equals(pdbfile)) + for (int i = 0; i < mappings.length; i++) { - tmp.addElement(mappings[i]); + if (mappings[i].pdbfile.equals(pdbfile)) + { + tmp.addElement(mappings[i]); + } } } - StructureMapping[] ret = new StructureMapping[tmp.size()]; for (int i = 0; i < tmp.size(); i++) { @@ -393,4 +567,108 @@ public class StructureSelectionManager return sb.toString(); } + + private int[] seqmappingrefs = null; // refcount for seqmappings elements + + private synchronized void modifySeqMappingList(boolean add, + AlignedCodonFrame[] codonFrames) + { + if (!add && (seqmappings == null || seqmappings.size() == 0)) + return; + if (seqmappings == null) + seqmappings = new Vector(); + if (codonFrames != null && codonFrames.length > 0) + { + for (int cf = 0; cf < codonFrames.length; cf++) + { + if (seqmappings.contains(codonFrames[cf])) + { + if (add) + { + seqmappingrefs[seqmappings.indexOf(codonFrames[cf])]++; + } + else + { + if (--seqmappingrefs[seqmappings.indexOf(codonFrames[cf])] <= 0) + { + int pos = seqmappings.indexOf(codonFrames[cf]); + int[] nr = new int[seqmappingrefs.length - 1]; + if (pos > 0) + { + System.arraycopy(seqmappingrefs, 0, nr, 0, pos); + } + if (pos < seqmappingrefs.length - 1) + { + System.arraycopy(seqmappingrefs, pos + 1, nr, 0, + seqmappingrefs.length - pos - 2); + } + } + } + } + else + { + if (add) + { + seqmappings.addElement(codonFrames[cf]); + + int[] nsr = new int[(seqmappingrefs == null) ? 1 + : seqmappingrefs.length + 1]; + if (seqmappingrefs != null && seqmappingrefs.length > 0) + System.arraycopy(seqmappingrefs, 0, nsr, 0, + seqmappingrefs.length); + nsr[(seqmappingrefs == null) ? 0 : seqmappingrefs.length] = 1; + seqmappingrefs = nsr; + } + } + } + } + } + + public void removeMappings(AlignedCodonFrame[] codonFrames) + { + modifySeqMappingList(false, codonFrames); + } + + public void addMappings(AlignedCodonFrame[] codonFrames) + { + modifySeqMappingList(true, codonFrames); + } + + Vector sel_listeners = new Vector(); + + public void addSelectionListener(SelectionListener selecter) + { + if (!sel_listeners.contains(selecter)) + { + sel_listeners.addElement(selecter); + } + } + + public void removeSelectionListener(SelectionListener toremove) + { + if (sel_listeners.contains(toremove)) + { + sel_listeners.removeElement(toremove); + } + } + + public synchronized void sendSelection( + jalview.datamodel.SequenceGroup selection, + jalview.datamodel.ColumnSelection colsel, SelectionSource source) + { + if (sel_listeners != null && sel_listeners.size() > 0) + { + Enumeration listeners = sel_listeners.elements(); + while (listeners.hasMoreElements()) + { + SelectionListener slis = ((SelectionListener) listeners + .nextElement()); + if (slis != source) + { + slis.selection(selection, colsel, source); + } + ; + } + } + } }