src/jalview/api/AlignViewportI.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.api;
  22
  23 import jalview.analysis.Conservation;
  24 import jalview.datamodel.AlignmentAnnotation;
  25 import jalview.datamodel.AlignmentI;
  26 import jalview.datamodel.AlignmentView;
  27 import jalview.datamodel.CigarArray;
  28 import jalview.datamodel.ColumnSelection;
  29 import jalview.datamodel.ProfilesI;
  30 import jalview.datamodel.SearchResultsI;
  31 import jalview.datamodel.SequenceCollectionI;
  32 import jalview.datamodel.SequenceGroup;
  33 import jalview.datamodel.SequenceI;
  34 import jalview.renderer.ResidueShaderI;
  35 import jalview.schemes.ColourSchemeI;
  36 import jalview.viewmodel.ViewportRanges;
  37
  38 import java.awt.Color;
  39 import java.awt.Font;
  40 import java.util.Hashtable;
  41 import java.util.List;
  42 import java.util.Map;
  43
  44 /**
  45  * @author jimp
  46  *
  47  */
  48 public interface AlignViewportI extends ViewStyleI
  49 {
  50
  51   /**
  52    * Get the ranges object containing details of the start and end sequences and
  53    * residues
  54    *
  55    * @return
  56    */
  57   public ViewportRanges getRanges();
  58
  59   /**
  60    * calculate the height for visible annotation, revalidating bounds where
  61    * necessary ABSTRACT GUI METHOD
  62    *
  63    * @return total height of annotation
  64    */
  65   public int calcPanelHeight();
  66
  67   /**
  68    * Answers true if the viewport has at least one column selected
  69    *
  70    * @return
  71    */
  72   boolean hasSelectedColumns();
  73
  74   /**
  75    * Answers true if the viewport has at least one hidden column
  76    *
  77    * @return
  78    */
  79   boolean hasHiddenColumns();
  80
  81   boolean isValidCharWidth();
  82
  83   boolean isShowConsensusHistogram();
  84
  85   boolean isShowSequenceLogo();
  86
  87   boolean isNormaliseSequenceLogo();
  88
  89   ColourSchemeI getGlobalColourScheme();
  90
  91   /**
  92    * Returns an object that describes colouring (including any thresholding or
  93    * fading) of the alignment
  94    *
  95    * @return
  96    */
  97   ResidueShaderI getResidueShading();
  98
  99   AlignmentI getAlignment();
 100
 101   ColumnSelection getColumnSelection();
 102
 103   ProfilesI getSequenceConsensusHash();
 104
 105   /**
 106    * Get consensus data table for the cDNA complement of this alignment (if any)
 107    *
 108    * @return
 109    */
 110   Hashtable[] getComplementConsensusHash();
 111
 112   Hashtable[] getRnaStructureConsensusHash();
 113
 114   boolean isIgnoreGapsConsensus();
 115
 116   boolean isCalculationInProgress(AlignmentAnnotation alignmentAnnotation);
 117
 118   AlignmentAnnotation getAlignmentQualityAnnot();
 119
 120   AlignmentAnnotation getAlignmentConservationAnnotation();
 121
 122   /**
 123    * get the container for alignment consensus annotation
 124    *
 125    * @return
 126    */
 127   AlignmentAnnotation getAlignmentConsensusAnnotation();
 128
 129   /**
 130    * get the container for alignment gap annotation
 131    *
 132    * @return
 133    */
 134   AlignmentAnnotation getAlignmentGapAnnotation();
 135
 136   /**
 137    * get the container for cDNA complement consensus annotation
 138    *
 139    * @return
 140    */
 141   AlignmentAnnotation getComplementConsensusAnnotation();
 142
 143   /**
 144    * Test to see if viewport is still open and active
 145    *
 146    * @return true indicates that all references to viewport should be dropped
 147    */
 148   boolean isClosed();
 149
 150   /**
 151    * Dispose of all references or resources held by the viewport
 152    */
 153   void dispose();
 154
 155   /**
 156    * get the associated calculation thread manager for the view
 157    *
 158    * @return
 159    */
 160   AlignCalcManagerI getCalcManager();
 161
 162   /**
 163    * get the percentage gaps allowed in a conservation calculation
 164    *
 165    */
 166   public int getConsPercGaps();
 167
 168   /**
 169    * set the consensus result object for the viewport
 170    *
 171    * @param hconsensus
 172    */
 173   void setSequenceConsensusHash(ProfilesI hconsensus);
 174
 175   /**
 176    * Set the cDNA complement consensus for the viewport
 177    *
 178    * @param hconsensus
 179    */
 180   void setComplementConsensusHash(Hashtable[] hconsensus);
 181
 182   /**
 183    *
 184    * @return the alignment annotation row for the structure consensus
 185    *         calculation
 186    */
 187   AlignmentAnnotation getAlignmentStrucConsensusAnnotation();
 188
 189   /**
 190    * set the Rna structure consensus result object for the viewport
 191    *
 192    * @param hStrucConsensus
 193    */
 194   void setRnaStructureConsensusHash(Hashtable[] hStrucConsensus);
 195
 196   /**
 197    * Sets the colour scheme for the background alignment (as distinct from
 198    * sub-groups, which may have their own colour schemes). A null value is used
 199    * for no residue colour (white).
 200    *
 201    * @param cs
 202    */
 203   void setGlobalColourScheme(ColourSchemeI cs);
 204
 205   Map<SequenceI, SequenceCollectionI> getHiddenRepSequences();
 206
 207   void setHiddenRepSequences(
 208           Map<SequenceI, SequenceCollectionI> hiddenRepSequences);
 209
 210   /**
 211    * hides or shows dynamic annotation rows based on groups and group and
 212    * alignment associated auto-annotation state flags apply the current
 213    * group/autoannotation settings to the alignment view. Usually you should
 214    * call the AlignmentViewPanel.adjustAnnotationHeight() method afterwards to
 215    * ensure the annotation panel bounds are set correctly.
 216    *
 217    * @param applyGlobalSettings
 218    *          - apply to all autoannotation rows or just the ones associated
 219    *          with the current visible region
 220    * @param preserveNewGroupSettings
 221    *          - don't apply global settings to groups which don't already have
 222    *          group associated annotation
 223    */
 224   void updateGroupAnnotationSettings(boolean applyGlobalSettings,
 225           boolean preserveNewGroupSettings);
 226
 227   void setSequenceColour(SequenceI seq, Color col);
 228
 229   Color getSequenceColour(SequenceI seq);
 230
 231   void updateSequenceIdColours();
 232
 233   SequenceGroup getSelectionGroup();
 234
 235   /**
 236    * get the currently selected sequence objects or all the sequences in the
 237    * alignment. TODO: change to List<>
 238    *
 239    * @return array of references to sequence objects
 240    */
 241   SequenceI[] getSequenceSelection();
 242
 243   void clearSequenceColours();
 244
 245   /**
 246    * This method returns the visible alignment as text, as seen on the GUI, ie
 247    * if columns are hidden they will not be returned in the result. Use this for
 248    * calculating trees, PCA, redundancy etc on views which contain hidden
 249    * columns.
 250    *
 251    * @return String[]
 252    */
 253   CigarArray getViewAsCigars(boolean selectedRegionOnly);
 254
 255   /**
 256    * return a compact representation of the current alignment selection to pass
 257    * to an analysis function
 258    *
 259    * @param selectedOnly
 260    *          boolean true to just return the selected view
 261    * @return AlignmentView
 262    */
 263   AlignmentView getAlignmentView(boolean selectedOnly);
 264
 265   /**
 266    * return a compact representation of the current alignment selection to pass
 267    * to an analysis function
 268    *
 269    * @param selectedOnly
 270    *          boolean true to just return the selected view
 271    * @param markGroups
 272    *          boolean true to annotate the alignment view with groups on the
 273    *          alignment (and intersecting with selected region if selectedOnly
 274    *          is true)
 275    * @return AlignmentView
 276    */
 277   AlignmentView getAlignmentView(boolean selectedOnly, boolean markGroups);
 278
 279   /**
 280    * This method returns the visible alignment as text, as seen on the GUI, ie
 281    * if columns are hidden they will not be returned in the result. Use this for
 282    * calculating trees, PCA, redundancy etc on views which contain hidden
 283    * columns. This method doesn't exclude hidden sequences from the output.
 284    *
 285    * @param selectedRegionOnly
 286    *          - determines if only the selected region or entire alignment is
 287    *          exported
 288    * @return String[]
 289    */
 290   String[] getViewAsString(boolean selectedRegionOnly);
 291
 292   /**
 293    * This method returns the visible alignment as text, as seen on the GUI, ie
 294    * if columns are hidden they will not be returned in the result. Use this for
 295    * calculating trees, PCA, redundancy etc on views which contain hidden
 296    * columns.
 297    *
 298    * @param selectedRegionOnly
 299    *          - determines if only the selected region or entire alignment is
 300    *          exported
 301    * @param isExportHiddenSeqs
 302    *          - determines if hidden sequences would be exported or not.
 303    *
 304    * @return String[]
 305    */
 306   String[] getViewAsString(boolean selectedRegionOnly,
 307           boolean isExportHiddenSeqs);
 308
 309   void setSelectionGroup(SequenceGroup sg);
 310
 311   char getGapCharacter();
 312
 313   void setColumnSelection(ColumnSelection cs);
 314
 315   void setConservation(Conservation cons);
 316
 317   /**
 318    * get a copy of the currently visible alignment annotation
 319    *
 320    * @param selectedOnly
 321    *          if true - trim to selected regions on the alignment
 322    * @return an empty list or new alignment annotation objects shown only
 323    *         visible columns trimmed to selected region only
 324    */
 325   List<AlignmentAnnotation> getVisibleAlignmentAnnotation(
 326           boolean selectedOnly);
 327
 328   FeaturesDisplayedI getFeaturesDisplayed();
 329
 330   String getSequenceSetId();
 331
 332   boolean areFeaturesDisplayed();
 333
 334   void setFeaturesDisplayed(FeaturesDisplayedI featuresDisplayedI);
 335
 336   void alignmentChanged(AlignmentViewPanel ap);
 337
 338   /**
 339    * @return the padGaps
 340    */
 341   boolean isPadGaps();
 342
 343   /**
 344    * @param padGaps
 345    *          the padGaps to set
 346    */
 347   void setPadGaps(boolean padGaps);
 348
 349   /**
 350    * return visible region boundaries within given column range
 351    *
 352    * @param min
 353    *          first column (inclusive, from 0)
 354    * @param max
 355    *          last column (exclusive)
 356    * @return int[][] range of {start,end} visible positions
 357    */
 358   List<int[]> getVisibleRegionBoundaries(int min, int max);
 359
 360   /**
 361    * This method returns an array of new SequenceI objects derived from the
 362    * whole alignment or just the current selection with start and end points
 363    * adjusted
 364    *
 365    * @note if you need references to the actual SequenceI objects in the
 366    *       alignment or currently selected then use getSequenceSelection()
 367    * @return selection as new sequenceI objects
 368    */
 369   SequenceI[] getSelectionAsNewSequence();
 370
 371   void invertColumnSelection();
 372
 373   /**
 374    * broadcast selection to any interested parties
 375    */
 376   void sendSelection();
 377
 378   /**
 379    * calculate the row position for alignmentIndex if all hidden sequences were
 380    * shown
 381    *
 382    * @param alignmentIndex
 383    * @return adjusted row position
 384    */
 385   int adjustForHiddenSeqs(int alignmentIndex);
 386
 387   boolean hasHiddenRows();
 388
 389   /**
 390    *
 391    * @return a copy of this view's current display settings
 392    */
 393   public ViewStyleI getViewStyle();
 394
 395   /**
 396    * update the view's display settings with the given style set
 397    *
 398    * @param settingsForView
 399    */
 400   public void setViewStyle(ViewStyleI settingsForView);
 401
 402   /**
 403    * Returns a viewport which holds the cDna for this (protein), or vice versa,
 404    * or null if none is set.
 405    *
 406    * @return
 407    */
 408   AlignViewportI getCodingComplement();
 409
 410   /**
 411    * Sets the viewport which holds the cDna for this (protein), or vice versa.
 412    * Implementation should guarantee that the reciprocal relationship is always
 413    * set, i.e. each viewport is the complement of the other.
 414    */
 415   void setCodingComplement(AlignViewportI sl);
 416
 417   /**
 418    * Answers true if viewport hosts DNA/RNA, else false.
 419    *
 420    * @return
 421    */
 422   boolean isNucleotide();
 423
 424   /**
 425    * Returns an id guaranteed to be unique for this viewport.
 426    *
 427    * @return
 428    */
 429   String getViewId();
 430
 431   /**
 432    * Return true if view should scroll to show the highlighted region of a
 433    * sequence
 434    *
 435    * @return
 436    */
 437   boolean isFollowHighlight();
 438
 439   /**
 440    * Set whether view should scroll to show the highlighted region of a sequence
 441    */
 442   void setFollowHighlight(boolean b);
 443
 444   public void applyFeaturesStyle(FeatureSettingsModelI featureSettings);
 445
 446   /**
 447    * check if current selection group is defined on the view, or is simply a
 448    * temporary group.
 449    *
 450    * @return true if group is defined on the alignment
 451    */
 452   boolean isSelectionDefinedGroup();
 453
 454   /**
 455    *
 456    * @return true if there are search results on the view
 457    */
 458   boolean hasSearchResults();
 459
 460   /**
 461    * set the search results for the view
 462    *
 463    * @param results
 464    *          - or null to clear current results
 465    */
 466   void setSearchResults(SearchResultsI results);
 467
 468   /**
 469    * get search results for this view (if any)
 470    *
 471    * @return search results or null
 472    */
 473   SearchResultsI getSearchResults();
 474
 475   /**
 476    * Updates view settings with the given font. You may need to call
 477    * AlignmentPanel.fontChanged to update the layout geometry.
 478    *
 479    * @param setGrid
 480    *          when true, charWidth/height is set according to font metrics
 481    */
 482   void setFont(Font newFont, boolean b);
 483
 484   /**
 485    * Answers true if split screen protein and cDNA use the same font
 486    *
 487    * @return
 488    */
 489   boolean isProteinFontAsCdna();
 490
 491   /**
 492    * Set the flag for whether split screen protein and cDNA use the same font
 493    *
 494    * @return
 495    */
 496   void setProteinFontAsCdna(boolean b);
 497 }