X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FAlignViewport.java;h=f5bc6e4cf3014e61522070c5bffd4270d833be39;hb=797df64fa2a0a30773d0f48f5494d4155e5a8be3;hp=9f1d3c685195a5e871d20d1e46753db5fb1eaeab;hpb=1576c6118a09c59098483daa16a94e9cca8de260;p=jalview.git diff --git a/src/jalview/gui/AlignViewport.java b/src/jalview/gui/AlignViewport.java old mode 100755 new mode 100644 index 9f1d3c6..f5bc6e4 --- a/src/jalview/gui/AlignViewport.java +++ b/src/jalview/gui/AlignViewport.java @@ -1,20 +1,19 @@ /* - * Jalview - A Sequence Alignment Editor and Viewer (Version 2.4) - * Copyright (C) 2008 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle + * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7) + * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, 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 file is part of Jalview. * - * 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. + * 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. * - * 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 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 . */ /* * Jalview - A Sequence Alignment Editor and Viewer @@ -41,22 +40,27 @@ import java.util.*; import java.awt.*; import jalview.analysis.*; +import jalview.api.StructureSelectionManagerProvider; import jalview.bin.*; import jalview.datamodel.*; import jalview.schemes.*; +import jalview.structure.SelectionSource; import jalview.structure.StructureSelectionManager; +import jalview.structure.VamsasSource; /** * DOCUMENT ME! * * @author $author$ - * @version $Revision$ + * @version $Revision: 1.141 $ */ -public class AlignViewport +public class AlignViewport implements SelectionSource, VamsasSource { + private static final int RIGHT_JUSTIFY = 1; + int startRes; int endRes; @@ -127,21 +131,33 @@ public class AlignViewport boolean cursorMode = false; - // The following vector holds the features which are - // currently visible, in the correct order or rendering + /** + * Keys are the feature types which are currently visible. Note: Values are + * not used! + */ Hashtable featuresDisplayed = null; /** DOCUMENT ME!! */ public Hashtable[] hconsensus; + public Hashtable[] hStrucConsensus; + AlignmentAnnotation consensus; + AlignmentAnnotation strucConsensus; + AlignmentAnnotation conservation; AlignmentAnnotation quality; + AlignmentAnnotation[] groupConsensus; + + AlignmentAnnotation[] groupConservation; + boolean autoCalculateConsensus = true; + boolean autoCalculateStrucConsensus = true; + /** DOCUMENT ME!! */ public int ConsPercGaps = 25; // JBPNote : This should be a scalable property! @@ -181,11 +197,13 @@ public class AlignViewport Hashtable hiddenRepSequences; + boolean sortByTree; + /** * Creates a new AlignViewport object. * * @param al - * DOCUMENT ME! + * alignment to view */ public AlignViewport(AlignmentI al) { @@ -194,12 +212,42 @@ public class AlignViewport } /** + * Create a new AlignViewport object with a specific sequence set ID + * + * @param al + * @param seqsetid + * (may be null - but potential for ambiguous constructor exception) + */ + public AlignViewport(AlignmentI al, String seqsetid) + { + this(al, seqsetid, null); + } + + public AlignViewport(AlignmentI al, String seqsetid, String viewid) + { + sequenceSetID = seqsetid; + viewId = viewid; + // TODO remove these once 2.4.VAMSAS release finished + if (Cache.log != null && Cache.log.isDebugEnabled() && seqsetid != null) + { + Cache.log.debug("Setting viewport's sequence set id : " + + sequenceSetID); + } + if (Cache.log != null && Cache.log.isDebugEnabled() && viewId != null) + { + Cache.log.debug("Setting viewport's view id : " + viewId); + } + setAlignment(al); + init(); + } + + /** * Create a new AlignViewport with hidden regions * * @param al - * AlignmentI + * AlignmentI * @param hiddenColumns - * ColumnSelection + * ColumnSelection */ public AlignViewport(AlignmentI al, ColumnSelection hiddenColumns) { @@ -207,10 +255,71 @@ public class AlignViewport if (hiddenColumns != null) { this.colSel = hiddenColumns; - if (hiddenColumns.getHiddenColumns() != null) + if (hiddenColumns.getHiddenColumns() != null + && hiddenColumns.getHiddenColumns().size() > 0) + { + hasHiddenColumns = true; + } + else + { + hasHiddenColumns = false; + } + } + init(); + } + + /** + * New viewport with hidden columns and an existing sequence set id + * + * @param al + * @param hiddenColumns + * @param seqsetid + * (may be null) + */ + public AlignViewport(AlignmentI al, ColumnSelection hiddenColumns, + String seqsetid) + { + this(al, hiddenColumns, seqsetid, null); + } + + /** + * New viewport with hidden columns and an existing sequence set id and viewid + * + * @param al + * @param hiddenColumns + * @param seqsetid + * (may be null) + * @param viewid + * (may be null) + */ + public AlignViewport(AlignmentI al, ColumnSelection hiddenColumns, + String seqsetid, String viewid) + { + sequenceSetID = seqsetid; + viewId = viewid; + // TODO remove these once 2.4.VAMSAS release finished + if (Cache.log != null && Cache.log.isDebugEnabled() && seqsetid != null) + { + Cache.log.debug("Setting viewport's sequence set id : " + + sequenceSetID); + } + if (Cache.log != null && Cache.log.isDebugEnabled() && viewId != null) + { + Cache.log.debug("Setting viewport's view id : " + viewId); + } + setAlignment(al); + if (hiddenColumns != null) + { + this.colSel = hiddenColumns; + if (hiddenColumns.getHiddenColumns() != null + && hiddenColumns.getHiddenColumns().size() > 0) { hasHiddenColumns = true; } + else + { + hasHiddenColumns = false; + } } init(); } @@ -232,9 +341,9 @@ public class AlignViewport autoCalculateConsensus = Cache.getDefault("AUTO_CALC_CONSENSUS", true); padGaps = Cache.getDefault("PAD_GAPS", true); - shownpfeats = Cache.getDefault("SHOW_NPFEATS_TOOLTIP",true); - showdbrefs = Cache.getDefault("SHOW_DBREFS_TOOLTIP",true); - + shownpfeats = Cache.getDefault("SHOW_NPFEATS_TOOLTIP", true); + showdbrefs = Cache.getDefault("SHOW_DBREFS_TOOLTIP", true); + String fontName = Cache.getDefault("FONT_NAME", "SansSerif"); String fontStyle = Cache.getDefault("FONT_STYLE", Font.PLAIN + ""); String fontSize = Cache.getDefault("FONT_SIZE", "10"); @@ -285,17 +394,43 @@ public class AlignViewport alignment.addAnnotation(quality); } - } + showGroupConservation = Cache.getDefault("SHOW_GROUP_CONSERVATION", + false); + { + + } + } + showConsensusHistogram = Cache.getDefault("SHOW_CONSENSUS_HISTOGRAM", + true); + showSequenceLogo = Cache.getDefault("SHOW_CONSENSUS_LOGO", false); + showGroupConsensus = Cache.getDefault("SHOW_GROUP_CONSENSUS", false); + // TODO: add menu option action that nulls or creates consensus object + // depending on if the user wants to see the annotation or not in a + // specific alignment consensus = new AlignmentAnnotation("Consensus", "PID", new Annotation[1], 0f, 100f, AlignmentAnnotation.BAR_GRAPH); consensus.hasText = true; consensus.autoCalculated = true; + if (alignment.isNucleotide() && alignment.hasRNAStructure()) + { + strucConsensus = new AlignmentAnnotation("StrucConsensus", "PID", + new Annotation[1], 0f, 100f, AlignmentAnnotation.BAR_GRAPH); + strucConsensus.hasText = true; + strucConsensus.autoCalculated = true; + } + if (Cache.getDefault("SHOW_IDENTITY", true)) { alignment.addAnnotation(consensus); + // TODO: Make own if for structure + if (alignment.isNucleotide() && alignment.hasRNAStructure()) + { + alignment.addAnnotation(strucConsensus); + } } + } if (jalview.bin.Cache.getProperty("DEFAULT_COLOUR") != null) @@ -317,13 +452,18 @@ public class AlignViewport } wrapAlignment = jalview.bin.Cache.getDefault("WRAP_ALIGNMENT", false); + showUnconserved = jalview.bin.Cache.getDefault("SHOW_UNCONSERVED", + false); + sortByTree = jalview.bin.Cache.getDefault("SORT_BY_TREE", false); + followSelection = jalview.bin.Cache.getDefault("FOLLOW_SELECTIONS", + true); } /** - * DOCUMENT ME! + * set the flag * * @param b - * DOCUMENT ME! + * features are displayed if true */ public void setShowSequenceFeatures(boolean b) { @@ -335,158 +475,24 @@ public class AlignViewport return showSequenceFeatures; } - class ConservationThread extends Thread - { - AlignmentPanel ap; - - public ConservationThread(AlignmentPanel ap) - { - this.ap = ap; - } - - public void run() - { - try - { - updatingConservation = true; - - while (UPDATING_CONSERVATION) - { - try - { - if (ap != null) - { - ap.paintAlignment(false); - } - Thread.sleep(200); - } catch (Exception ex) - { - ex.printStackTrace(); - } - } - - UPDATING_CONSERVATION = true; - - int alWidth = alignment.getWidth(); - if (alWidth < 0) - { - return; - } - - Conservation cons = new jalview.analysis.Conservation("All", - jalview.schemes.ResidueProperties.propHash, 3, alignment - .getSequences(), 0, alWidth - 1); - - cons.calculate(); - cons.verdict(false, ConsPercGaps); - - if (quality != null) - { - cons.findQuality(); - } - - char[] sequence = cons.getConsSequence().getSequence(); - float minR; - float minG; - float minB; - float maxR; - float maxG; - float maxB; - minR = 0.3f; - minG = 0.0f; - minB = 0f; - maxR = 1.0f - minR; - maxG = 0.9f - minG; - maxB = 0f - minB; // scalable range for colouring both Conservation and - // Quality - - float min = 0f; - float max = 11f; - float qmin = 0f; - float qmax = 0f; - - char c; - - conservation.annotations = new Annotation[alWidth]; - - if (quality != null) - { - quality.graphMax = cons.qualityRange[1].floatValue(); - quality.annotations = new Annotation[alWidth]; - qmin = cons.qualityRange[0].floatValue(); - qmax = cons.qualityRange[1].floatValue(); - } - - for (int i = 0; i < alWidth; i++) - { - float value = 0; - - c = sequence[i]; - - if (Character.isDigit(c)) - { - value = (int) (c - '0'); - } - else if (c == '*') - { - value = 11; - } - else if (c == '+') - { - value = 10; - } - - float vprop = value - min; - vprop /= max; - conservation.annotations[i] = new Annotation(String.valueOf(c), - String.valueOf(value), ' ', value, new Color(minR - + (maxR * vprop), minG + (maxG * vprop), minB - + (maxB * vprop))); - - // Quality calc - if (quality != null) - { - value = ((Double) cons.quality.get(i)).floatValue(); - vprop = value - qmin; - vprop /= qmax; - quality.annotations[i] = new Annotation(" ", String - .valueOf(value), ' ', value, new Color(minR - + (maxR * vprop), minG + (maxG * vprop), minB - + (maxB * vprop))); - } - } - } catch (OutOfMemoryError error) - { - new OOMWarning("calculating conservation", error); - - conservation = null; - quality = null; - - } - - UPDATING_CONSERVATION = false; - updatingConservation = false; - - if (ap != null) - { - ap.paintAlignment(true); - } - - } - } - ConservationThread conservationThread; ConsensusThread consensusThread; + StrucConsensusThread strucConsensusThread; + boolean consUpdateNeeded = false; static boolean UPDATING_CONSENSUS = false; + static boolean UPDATING_STRUC_CONSENSUS = false; + static boolean UPDATING_CONSERVATION = false; boolean updatingConsensus = false; + boolean updatingStrucConsensus = false; + boolean updatingConservation = false; /** @@ -504,12 +510,14 @@ public class AlignViewport */ public void updateConservation(final AlignmentPanel ap) { - if (alignment.isNucleotide() || conservation == null) + // see note in mantis : issue number 8585 + if (alignment.isNucleotide() || conservation == null + || !autoCalculateConsensus) { return; } - conservationThread = new ConservationThread(ap); + conservationThread = new ConservationThread(this, ap); conservationThread.start(); } @@ -518,6 +526,11 @@ public class AlignViewport */ public void updateConsensus(final AlignmentPanel ap) { + // see note in mantis : issue number 8585 + if (consensus == null || !autoCalculateConsensus) + { + return; + } consensusThread = new ConsensusThread(ap); consensusThread.start(); } @@ -554,12 +567,14 @@ public class AlignViewport try { - int aWidth = (alignment != null) ? alignment.getWidth() : 0; // null - // pointer - // possibility - // here. - if (aWidth < 0) + int aWidth = (alignment != null) ? alignment.getWidth() : -1; // null + // pointer + // possibility + // here. + if (aWidth <= 0) { + updatingConsensus = false; + UPDATING_CONSENSUS = false; return; } @@ -568,61 +583,178 @@ public class AlignViewport hconsensus = new Hashtable[aWidth]; AAFrequency.calculate(alignment.getSequencesArray(), 0, alignment - .getWidth(), hconsensus); + .getWidth(), hconsensus, true); + updateAnnotation(true); + if (globalColourScheme != null) + { + globalColourScheme.setConsensus(hconsensus); + } + + } catch (OutOfMemoryError error) + { + alignment.deleteAnnotation(consensus); + + consensus = null; + hconsensus = null; + new OOMWarning("calculating consensus", error); + } + UPDATING_CONSENSUS = false; + updatingConsensus = false; + + if (ap != null) + { + ap.paintAlignment(true); + } + } + + /** + * update the consensus annotation from the sequence profile data using + * current visualization settings. + */ + public void updateAnnotation() + { + updateAnnotation(false); + } + + protected void updateAnnotation(boolean immediate) + { + // TODO: make calls thread-safe, so if another thread calls this method, + // it will either return or wait until one calculation is finished. + if (immediate + || (!updatingConsensus && consensus != null && hconsensus != null)) + { + AAFrequency.completeConsensus(consensus, hconsensus, 0, + hconsensus.length, ignoreGapsInConsensusCalculation, + showSequenceLogo); + } + } + } + + // --------START Structure Conservation + public void updateStrucConsensus(final AlignmentPanel ap) + { + // see note in mantis : issue number 8585 + if (strucConsensus == null || !autoCalculateStrucConsensus) + { + return; + } + strucConsensusThread = new StrucConsensusThread(ap); + strucConsensusThread.start(); + } - for (int i = 0; i < aWidth; i++) + class StrucConsensusThread extends Thread + { + AlignmentPanel ap; + + public StrucConsensusThread(AlignmentPanel ap) + { + this.ap = ap; + } + + public void run() + { + updatingStrucConsensus = true; + while (UPDATING_STRUC_CONSENSUS) + { + try { - float value = 0; - if (ignoreGapsInConsensusCalculation) - { - value = ((Float) hconsensus[i].get(AAFrequency.PID_NOGAPS)) - .floatValue(); - } - else + if (ap != null) { - value = ((Float) hconsensus[i].get(AAFrequency.PID_GAPS)) - .floatValue(); + ap.paintAlignment(false); } - String maxRes = hconsensus[i].get(AAFrequency.MAXRESIDUE) - .toString(); - String mouseOver = hconsensus[i].get(AAFrequency.MAXRESIDUE) - + " "; + Thread.sleep(200); + } catch (Exception ex) + { + ex.printStackTrace(); + } + } + + UPDATING_STRUC_CONSENSUS = true; + + try + { + int aWidth = (alignment != null) ? alignment.getWidth() : -1; // null + // pointer + // possibility + // here. + if (aWidth <= 0) + { + updatingStrucConsensus = false; + UPDATING_STRUC_CONSENSUS = false; + return; + } + + strucConsensus.annotations = null; + strucConsensus.annotations = new Annotation[aWidth]; + + hStrucConsensus = new Hashtable[aWidth]; - if (maxRes.length() > 1) + AlignmentAnnotation[] aa = ap.av.getAlignment() + .getAlignmentAnnotation(); + AlignmentAnnotation rnaStruc = null; + for (int i = 0; i < aa.length; i++) + { + if (aa[i].getRNAStruc() != null) { - mouseOver = "[" + maxRes + "] "; - maxRes = "+"; + rnaStruc = aa[i]; + break; } - - mouseOver += ((int) value + "%"); - consensus.annotations[i] = new Annotation(maxRes, mouseOver, ' ', - value); } + AlignmentAnnotation rna = ap.av.getAlignment() + .getAlignmentAnnotation()[0]; + StructureFrequency.calculate(alignment.getSequencesArray(), 0, + alignment.getWidth(), hStrucConsensus, true, rnaStruc); + // TODO AlignmentAnnotation rnaStruc!!! + updateAnnotation(true); if (globalColourScheme != null) { - globalColourScheme.setConsensus(hconsensus); + globalColourScheme.setConsensus(hStrucConsensus); } } catch (OutOfMemoryError error) { - alignment.deleteAnnotation(consensus); + alignment.deleteAnnotation(strucConsensus); - consensus = null; - hconsensus = null; - new OOMWarning("calculating consensus", error); + strucConsensus = null; + hStrucConsensus = null; + new OOMWarning("calculating structure consensus", error); } - UPDATING_CONSENSUS = false; - updatingConsensus = false; + UPDATING_STRUC_CONSENSUS = false; + updatingStrucConsensus = false; if (ap != null) { ap.paintAlignment(true); } } + + /** + * update the consensus annotation from the sequence profile data using + * current visualization settings. + */ + public void updateAnnotation() + { + updateAnnotation(false); + } + + protected void updateAnnotation(boolean immediate) + { + // TODO: make calls thread-safe, so if another thread calls this method, + // it will either return or wait until one calculation is finished. + if (immediate + || (!updatingStrucConsensus && strucConsensus != null && hStrucConsensus != null)) + { + StructureFrequency.completeConsensus(strucConsensus, + hStrucConsensus, 0, hStrucConsensus.length, false, + showSequenceLogo); + } + } } + // --------END Structure Conservation + /** * get the consensus sequence as displayed under the PID consensus annotation * row. @@ -662,9 +794,9 @@ public class AlignViewport } /** - * DOCUMENT ME! * - * @return DOCUMENT ME! + * + * @return null or the currently selected sequence region */ public SequenceGroup getSelectionGroup() { @@ -672,10 +804,11 @@ public class AlignViewport } /** - * DOCUMENT ME! + * Set the selection group for this window. * * @param sg - * DOCUMENT ME! + * - group holding references to sequences in this alignment view + * */ public void setSelectionGroup(SequenceGroup sg) { @@ -683,9 +816,9 @@ public class AlignViewport } /** - * DOCUMENT ME! + * GUI state * - * @return DOCUMENT ME! + * @return true if conservation based shading is enabled */ public boolean getConservationSelected() { @@ -693,10 +826,10 @@ public class AlignViewport } /** - * DOCUMENT ME! + * GUI state * * @param b - * DOCUMENT ME! + * enable conservation based shading */ public void setConservationSelected(boolean b) { @@ -704,9 +837,9 @@ public class AlignViewport } /** - * DOCUMENT ME! + * GUI state * - * @return DOCUMENT ME! + * @return true if percent identity threshold is applied to shading */ public boolean getAbovePIDThreshold() { @@ -714,10 +847,11 @@ public class AlignViewport } /** - * DOCUMENT ME! + * GUI state + * * * @param b - * DOCUMENT ME! + * indicate if percent identity threshold is applied to shading */ public void setAbovePIDThreshold(boolean b) { @@ -758,7 +892,7 @@ public class AlignViewport * DOCUMENT ME! * * @param cs - * DOCUMENT ME! + * DOCUMENT ME! */ public void setGlobalColourScheme(ColourSchemeI cs) { @@ -779,7 +913,7 @@ public class AlignViewport * DOCUMENT ME! * * @param res - * DOCUMENT ME! + * DOCUMENT ME! */ public void setStartRes(int res) { @@ -790,7 +924,7 @@ public class AlignViewport * DOCUMENT ME! * * @param seq - * DOCUMENT ME! + * DOCUMENT ME! */ public void setStartSeq(int seq) { @@ -801,7 +935,7 @@ public class AlignViewport * DOCUMENT ME! * * @param res - * DOCUMENT ME! + * DOCUMENT ME! */ public void setEndRes(int res) { @@ -824,7 +958,7 @@ public class AlignViewport * DOCUMENT ME! * * @param seq - * DOCUMENT ME! + * DOCUMENT ME! */ public void setEndSeq(int seq) { @@ -855,7 +989,7 @@ public class AlignViewport * DOCUMENT ME! * * @param f - * DOCUMENT ME! + * DOCUMENT ME! */ public void setFont(Font f) { @@ -883,7 +1017,7 @@ public class AlignViewport * DOCUMENT ME! * * @param w - * DOCUMENT ME! + * DOCUMENT ME! */ public void setCharWidth(int w) { @@ -904,7 +1038,7 @@ public class AlignViewport * DOCUMENT ME! * * @param h - * DOCUMENT ME! + * DOCUMENT ME! */ public void setCharHeight(int h) { @@ -925,7 +1059,7 @@ public class AlignViewport * DOCUMENT ME! * * @param w - * DOCUMENT ME! + * DOCUMENT ME! */ public void setWrappedWidth(int w) { @@ -956,20 +1090,20 @@ public class AlignViewport * DOCUMENT ME! * * @param align - * DOCUMENT ME! + * DOCUMENT ME! */ public void setAlignment(AlignmentI align) { if (alignment != null && alignment.getCodonFrames() != null) { - StructureSelectionManager.getStructureSelectionManager() - .removeMappings(alignment.getCodonFrames()); + StructureSelectionManager.getStructureSelectionManager( + Desktop.instance).removeMappings(alignment.getCodonFrames()); } this.alignment = align; if (alignment.getCodonFrames() != null) { - StructureSelectionManager.getStructureSelectionManager().addMappings( - alignment.getCodonFrames()); + StructureSelectionManager.getStructureSelectionManager( + Desktop.instance).addMappings(alignment.getCodonFrames()); } } @@ -977,7 +1111,7 @@ public class AlignViewport * DOCUMENT ME! * * @param state - * DOCUMENT ME! + * DOCUMENT ME! */ public void setWrapAlignment(boolean state) { @@ -988,7 +1122,7 @@ public class AlignViewport * DOCUMENT ME! * * @param state - * DOCUMENT ME! + * DOCUMENT ME! */ public void setShowText(boolean state) { @@ -999,7 +1133,7 @@ public class AlignViewport * DOCUMENT ME! * * @param state - * DOCUMENT ME! + * DOCUMENT ME! */ public void setRenderGaps(boolean state) { @@ -1020,7 +1154,7 @@ public class AlignViewport * DOCUMENT ME! * * @param state - * DOCUMENT ME! + * DOCUMENT ME! */ public void setColourText(boolean state) { @@ -1031,7 +1165,7 @@ public class AlignViewport * DOCUMENT ME! * * @param state - * DOCUMENT ME! + * DOCUMENT ME! */ public void setShowBoxes(boolean state) { @@ -1082,7 +1216,7 @@ public class AlignViewport * DOCUMENT ME! * * @param gap - * DOCUMENT ME! + * DOCUMENT ME! */ public void setGapCharacter(char gap) { @@ -1096,7 +1230,7 @@ public class AlignViewport * DOCUMENT ME! * * @param thresh - * DOCUMENT ME! + * DOCUMENT ME! */ public void setThreshold(int thresh) { @@ -1117,7 +1251,7 @@ public class AlignViewport * DOCUMENT ME! * * @param inc - * DOCUMENT ME! + * DOCUMENT ME! */ public void setIncrement(int inc) { @@ -1148,7 +1282,7 @@ public class AlignViewport * DOCUMENT ME! * * @param tree - * DOCUMENT ME! + * DOCUMENT ME! */ public void setCurrentTree(NJTree tree) { @@ -1169,7 +1303,7 @@ public class AlignViewport * DOCUMENT ME! * * @param b - * DOCUMENT ME! + * DOCUMENT ME! */ public void setColourAppliesToAllGroups(boolean b) { @@ -1200,7 +1334,7 @@ public class AlignViewport * DOCUMENT ME! * * @param b - * DOCUMENT ME! + * DOCUMENT ME! */ public void setShowJVSuffix(boolean b) { @@ -1221,7 +1355,7 @@ public class AlignViewport * DOCUMENT ME! * * @param b - * DOCUMENT ME! + * DOCUMENT ME! */ public void setShowAnnotation(boolean b) { @@ -1262,7 +1396,7 @@ public class AlignViewport * DOCUMENT ME! * * @param b - * DOCUMENT ME! + * DOCUMENT ME! */ public void setScaleAboveWrapped(boolean b) { @@ -1273,7 +1407,7 @@ public class AlignViewport * DOCUMENT ME! * * @param b - * DOCUMENT ME! + * DOCUMENT ME! */ public void setScaleLeftWrapped(boolean b) { @@ -1284,7 +1418,7 @@ public class AlignViewport * DOCUMENT ME! * * @param b - * DOCUMENT ME! + * DOCUMENT ME! */ public void setScaleRightWrapped(boolean b) { @@ -1295,7 +1429,7 @@ public class AlignViewport * Property change listener for changes in alignment * * @param listener - * DOCUMENT ME! + * DOCUMENT ME! */ public void addPropertyChangeListener( java.beans.PropertyChangeListener listener) @@ -1307,7 +1441,7 @@ public class AlignViewport * DOCUMENT ME! * * @param listener - * DOCUMENT ME! + * DOCUMENT ME! */ public void removePropertyChangeListener( java.beans.PropertyChangeListener listener) @@ -1319,11 +1453,11 @@ public class AlignViewport * Property change listener for changes in alignment * * @param prop - * DOCUMENT ME! + * DOCUMENT ME! * @param oldvalue - * DOCUMENT ME! + * DOCUMENT ME! * @param newvalue - * DOCUMENT ME! + * DOCUMENT ME! */ public void firePropertyChange(String prop, Object oldvalue, Object newvalue) @@ -1414,7 +1548,8 @@ public class AlignViewport seqs[index++] = sg.getSequenceAt(i); } } - + sg.setSeqrep(repSequence); + sg.setHidereps(true); hideSequence(seqs); } @@ -1463,6 +1598,7 @@ public class AlignViewport selectionGroup.addSequence((SequenceI) tmp.elementAt(t), false); } firePropertyChange("alignment", null, alignment.getSequences()); + sendSelection(); } if (alignment.getHiddenSequences().getSize() < 1) @@ -1502,6 +1638,7 @@ public class AlignViewport selectionGroup.addSequence((SequenceI) tmp.elementAt(t), false); } firePropertyChange("alignment", null, alignment.getSequences()); + sendSelection(); hasHiddenRows = false; hiddenRepSequences = null; } @@ -1538,9 +1675,9 @@ public class AlignViewport for (int i = 0; i < sequences.length; i++) { sequences[i] = new Sequence(sequences[i], annots); // construct new - // sequence with - // subset of visible - // annotation + // sequence with + // subset of visible + // annotation } } else @@ -1559,14 +1696,14 @@ public class AlignViewport */ public SequenceI[] getSequenceSelection() { - SequenceI[] sequences; - if (selectionGroup == null) + SequenceI[] sequences = null; + if (selectionGroup != null) { - sequences = alignment.getSequencesArray(); + sequences = selectionGroup.getSequencesInOrder(alignment); } - else + if (sequences == null) { - sequences = selectionGroup.getSequencesInOrder(alignment); + sequences = alignment.getSequencesArray(); } return sequences; } @@ -1582,90 +1719,23 @@ public class AlignViewport public jalview.datamodel.CigarArray getViewAsCigars( boolean selectedRegionOnly) { - CigarArray selection = null; - SequenceI[] seqs = null; - int i, iSize; - int start = 0, end = 0; - if (selectedRegionOnly && selectionGroup != null) - { - iSize = selectionGroup.getSize(); - seqs = selectionGroup.getSequencesInOrder(alignment); - start = selectionGroup.getStartRes(); - end = selectionGroup.getEndRes(); // inclusive for start and end in - // SeqCigar constructor - } - else - { - iSize = alignment.getHeight(); - seqs = alignment.getSequencesArray(); - end = alignment.getWidth() - 1; - } - SeqCigar[] selseqs = new SeqCigar[iSize]; - for (i = 0; i < iSize; i++) - { - selseqs[i] = new SeqCigar(seqs[i], start, end); - } - selection = new CigarArray(selseqs); - // now construct the CigarArray operations - if (hasHiddenColumns) - { - Vector regions = colSel.getHiddenColumns(); - int[] region; - int hideStart, hideEnd; - int last = start; - for (int j = 0; last < end & j < regions.size(); j++) - { - region = (int[]) regions.elementAt(j); - hideStart = region[0]; - hideEnd = region[1]; - // edit hidden regions to selection range - if (hideStart < last) - { - if (hideEnd > last) - { - hideStart = last; - } - else - { - continue; - } - } - - if (hideStart > end) - { - break; - } - - if (hideEnd > end) - { - hideEnd = end; - } + return new jalview.datamodel.CigarArray(alignment, + (hasHiddenColumns ? colSel : null), + (selectedRegionOnly ? selectionGroup : null)); + } - if (hideStart > hideEnd) - { - break; - } - /** - * form operations... - */ - if (last < hideStart) - { - selection.addOperation(CigarArray.M, hideStart - last); - } - selection.addOperation(CigarArray.D, 1 + hideEnd - hideStart); - last = hideEnd + 1; - } - // Final match if necessary. - if (last < end) - { - selection.addOperation(CigarArray.M, end - last + 1); - } - } - else - { - selection.addOperation(CigarArray.M, end - start + 1); - } - return selection; + /** + * return a compact representation of the current alignment selection to pass + * to an analysis function + * + * @param selectedOnly + * boolean true to just return the selected view + * @return AlignmentView + */ + public jalview.datamodel.AlignmentView getAlignmentView( + boolean selectedOnly) + { + return getAlignmentView(selectedOnly, false); } /** @@ -1673,24 +1743,18 @@ public class AlignViewport * to an analysis function * * @param selectedOnly - * boolean true to just return the selected view + * boolean true to just return the selected view + * @param markGroups + * boolean true to annotate the alignment view with groups on the + * alignment (and intersecting with selected region if selectedOnly + * is true) * @return AlignmentView */ - jalview.datamodel.AlignmentView getAlignmentView(boolean selectedOnly) + public jalview.datamodel.AlignmentView getAlignmentView( + boolean selectedOnly, boolean markGroups) { - // JBPNote: - // this is here because the AlignmentView constructor modifies the - // CigarArray - // object. Refactoring of Cigar and alignment view representation should - // be done to remove redundancy. - CigarArray aligview = getViewAsCigars(selectedOnly); - if (aligview != null) - { - return new AlignmentView(aligview, - (selectedOnly && selectionGroup != null) ? selectionGroup - .getStartRes() : 0); - } - return null; + return new AlignmentView(alignment, colSel, selectionGroup, + hasHiddenColumns, selectedOnly, markGroups); } /** @@ -1801,18 +1865,39 @@ public class AlignViewport return sequenceSetID; } + /** + * unique viewId for synchronizing state with stored Jalview Project + * + */ + private String viewId = null; + + public String getViewId() + { + if (viewId == null) + { + viewId = this.getSequenceSetId() + "." + this.hashCode() + ""; + } + return viewId; + } + public void alignmentChanged(AlignmentPanel ap) { if (padGaps) { alignment.padGaps(); } - if (hconsensus != null && autoCalculateConsensus) { - updateConsensus(ap); updateConservation(ap); } + if (autoCalculateConsensus) + { + updateConsensus(ap); + } + if (autoCalculateStrucConsensus) + { + updateStrucConsensus(ap); + } // Reset endRes of groups if beyond alignment width int alWidth = alignment.getWidth(); @@ -1910,8 +1995,8 @@ public class AlignViewport * returns the visible column regions of the alignment * * @param selectedRegionOnly - * true to just return the contigs intersecting with the - * selected area + * true to just return the contigs intersecting with the selected + * area * @return */ public int[] getViewAsVisibleContigs(boolean selectedRegionOnly) @@ -1950,7 +2035,7 @@ public class AlignViewport * the undo and redo list. * * @param undoredo - * the stored set of hashcodes as returned by getUndoRedoHash + * the stored set of hashcodes as returned by getUndoRedoHash * @return true if the hashcodes differ (ie the alignment has been edited) or * the stored hashcode array differs in size */ @@ -2008,11 +2093,12 @@ public class AlignViewport } /** - * enable or disable the display of Database Cross References in the sequence ID tooltip - */ + * enable or disable the display of Database Cross References in the sequence + * ID tooltip + */ public void setShowDbRefs(boolean show) { - showdbrefs=show; + showdbrefs = show; } /** @@ -2032,12 +2118,352 @@ public class AlignViewport { return shownpfeats; } + /** - * enable or disable the display of Non-Positional sequence features in the sequence ID tooltip - * @param show + * enable or disable the display of Non-Positional sequence features in the + * sequence ID tooltip + * + * @param show */ public void setShowNpFeats(boolean show) { - shownpfeats=show; + shownpfeats = show; + } + + /** + * + * @return true if view has hidden rows + */ + public boolean hasHiddenRows() + { + return hasHiddenRows; + } + + /** + * + * @return true if view has hidden columns + */ + public boolean hasHiddenColumns() + { + return hasHiddenColumns; + } + + /** + * when set, view will scroll to show the highlighted position + */ + public boolean followHighlight = true; + + /** + * @return true if view should scroll to show the highlighted region of a + * sequence + * @return + */ + public boolean getFollowHighlight() + { + return followHighlight; + } + + public boolean followSelection = true; + + /** + * @return true if view selection should always follow the selections + * broadcast by other selection sources + */ + public boolean getFollowSelection() + { + return followSelection; + } + + private long sgrouphash = -1, colselhash = -1; + + boolean showSeqFeaturesHeight; + + /** + * checks current SelectionGroup against record of last hash value, and + * updates record. + * + * @param b + * update the record of last hash value + * + * @return true if SelectionGroup changed since last call (when b is true) + */ + boolean isSelectionGroupChanged(boolean b) + { + int hc = (selectionGroup == null || selectionGroup.getSize() == 0) ? -1 + : selectionGroup.hashCode(); + if (hc != -1 && hc != sgrouphash) + { + if (b) + { + sgrouphash = hc; + } + return true; + } + return false; + } + + /** + * checks current colsel against record of last hash value, and optionally + * updates record. + * + * @param b + * update the record of last hash value + * @return true if colsel changed since last call (when b is true) + */ + boolean isColSelChanged(boolean b) + { + int hc = (colSel == null || colSel.size() == 0) ? -1 : colSel + .hashCode(); + if (hc != -1 && hc != colselhash) + { + if (b) + { + colselhash = hc; + } + return true; + } + return false; + } + + public void sendSelection() + { + jalview.structure.StructureSelectionManager + .getStructureSelectionManager(Desktop.instance).sendSelection( + new SequenceGroup(getSelectionGroup()), + new ColumnSelection(getColumnSelection()), this); + } + + public void setShowSequenceFeaturesHeight(boolean selected) + { + showSeqFeaturesHeight = selected; + } + + public boolean getShowSequenceFeaturesHeight() + { + return showSeqFeaturesHeight; + } + + boolean showUnconserved = false; + + public boolean getShowUnconserved() + { + return showUnconserved; + } + + public void setShowUnconserved(boolean showunconserved) + { + showUnconserved = showunconserved; + } + + /** + * return the alignPanel containing the given viewport. Use this to get the + * components currently handling the given viewport. + * + * @param av + * @return null or an alignPanel guaranteed to have non-null alignFrame + * reference + */ + public AlignmentPanel getAlignPanel() + { + AlignmentPanel[] aps = PaintRefresher.getAssociatedPanels(this + .getSequenceSetId()); + AlignmentPanel ap = null; + for (int p = 0; aps != null && p < aps.length; p++) + { + if (aps[p].av == this) + { + return aps[p]; + } + } + return null; + } + + public boolean getSortByTree() + { + return sortByTree; + } + + public void setSortByTree(boolean sort) + { + sortByTree = sort; + } + + /** + * should conservation rows be shown for groups + */ + boolean showGroupConservation = false; + + /** + * should consensus rows be shown for groups + */ + boolean showGroupConsensus = false; + + /** + * should consensus profile be rendered by default + */ + public boolean showSequenceLogo = false; + + /** + * should consensus histograms be rendered by default + */ + public boolean showConsensusHistogram = true; + + /** + * @return the showConsensusProfile + */ + public boolean isShowSequenceLogo() + { + return showSequenceLogo; + } + + /** + * @param showSequenceLogo + * the new value + */ + public void setShowSequenceLogo(boolean showSequenceLogo) + { + if (showSequenceLogo != this.showSequenceLogo) + { + // TODO: decouple settings setting from calculation when refactoring + // annotation update method from alignframe to viewport + this.showSequenceLogo = showSequenceLogo; + if (consensusThread != null) + { + consensusThread.updateAnnotation(); + } + if (strucConsensusThread != null) + { + strucConsensusThread.updateAnnotation(); + } + } + this.showSequenceLogo = showSequenceLogo; + } + + /** + * @param showConsensusHistogram + * the showConsensusHistogram to set + */ + public void setShowConsensusHistogram(boolean showConsensusHistogram) + { + this.showConsensusHistogram = showConsensusHistogram; + } + + /** + * @return the showGroupConservation + */ + public boolean isShowGroupConservation() + { + return showGroupConservation; + } + + /** + * @param showGroupConservation + * the showGroupConservation to set + */ + public void setShowGroupConservation(boolean showGroupConservation) + { + this.showGroupConservation = showGroupConservation; + } + + /** + * @return the showGroupConsensus + */ + public boolean isShowGroupConsensus() + { + return showGroupConsensus; + } + + /** + * @param showGroupConsensus + * the showGroupConsensus to set + */ + public void setShowGroupConsensus(boolean showGroupConsensus) + { + this.showGroupConsensus = showGroupConsensus; + } + + /** + * + * @return flag to indicate if the consensus histogram should be rendered by + * default + */ + public boolean isShowConsensusHistogram() + { + return this.showConsensusHistogram; + } + + /** + * synthesize a column selection if none exists so it covers the given + * selection group. if wholewidth is false, no column selection is made if the + * selection group covers the whole alignment width. + * + * @param sg + * @param wholewidth + */ + public void expandColSelection(SequenceGroup sg, boolean wholewidth) + { + int sgs, sge; + if (sg != null + && (sgs = sg.getStartRes()) >= 0 + && sg.getStartRes() <= (sge = sg.getEndRes()) + && (colSel == null || colSel.getSelected() == null || colSel + .getSelected().size() == 0)) + { + if (!wholewidth && alignment.getWidth() == (1 + sge - sgs)) + { + // do nothing + return; + } + if (colSel == null) + { + colSel = new ColumnSelection(); + } + for (int cspos = sg.getStartRes(); cspos <= sg.getEndRes(); cspos++) + { + colSel.addElement(cspos); + } + } + } + + public StructureSelectionManager getStructureSelectionManager() + { + return StructureSelectionManager + .getStructureSelectionManager(Desktop.instance); + } + + /** + * + * @param pdbEntries + * @return a series of SequenceI arrays, one for each PDBEntry, listing which + * sequence in the alignment holds a reference to it + */ + public SequenceI[][] collateForPDB(PDBEntry[] pdbEntries) + { + ArrayList seqvectors = new ArrayList(); + for (PDBEntry pdb : pdbEntries) + { + ArrayList seqs = new ArrayList(); + for (int i = 0; i < alignment.getHeight(); i++) + { + Vector pdbs = alignment.getSequenceAt(i).getDatasetSequence() + .getPDBId(); + if (pdbs == null) + continue; + SequenceI sq; + for (int p = 0; p < pdbs.size(); p++) + { + PDBEntry p1 = (PDBEntry) pdbs.elementAt(p); + if (p1.getId().equals(pdb.getId())) + { + if (!seqs.contains(sq = alignment.getSequenceAt(i))) + seqs.add(sq); + + continue; + } + } + } + seqvectors.add(seqs.toArray(new SequenceI[seqs.size()])); + } + return seqvectors.toArray(new SequenceI[seqvectors.size()][]); } }