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.analysis.TreeModel;
  25 import jalview.datamodel.AlignmentAnnotation;
  26 import jalview.datamodel.AlignmentI;
  27 import jalview.datamodel.AlignmentView;
  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.Iterator;
  42 import java.util.List;
  43 import java.util.Map;
  44
  45 /**
  46  * @author jimp
  47  *
  48  */
  49 public interface AlignViewportI extends ViewStyleI
  50 {
  51
  52   /**
  53    * Get the ranges object containing details of the start and end sequences and
  54    * residues
  55    *
  56    * @return
  57    */
  58   public ViewportRanges getRanges();
  59
  60   /**
  61    * calculate the height for visible annotation, revalidating bounds where
  62    * necessary ABSTRACT GUI METHOD
  63    *
  64    * @return total height of annotation
  65    */
  66   public int calcPanelHeight();
  67
  68   /**
  69    * Answers true if the viewport has at least one column selected
  70    *
  71    * @return
  72    */
  73   boolean hasSelectedColumns();
  74
  75   /**
  76    * Answers true if the viewport has at least one hidden column
  77    *
  78    * @return
  79    */
  80   boolean hasHiddenColumns();
  81
  82   boolean isValidCharWidth();
  83
  84   boolean isShowConsensusHistogram();
  85
  86   boolean isShowSequenceLogo();
  87
  88   boolean isNormaliseSequenceLogo();
  89
  90   ColourSchemeI getGlobalColourScheme();
  91
  92   /**
  93    * Returns an object that describes colouring (including any thresholding or
  94    * fading) of the alignment
  95    *
  96    * @return
  97    */
  98   ResidueShaderI getResidueShading();
  99
 100   AlignmentI getAlignment();
 101
 102   ColumnSelection getColumnSelection();
 103
 104   ProfilesI getSequenceConsensusHash();
 105
 106   /**
 107    * Get consensus data table for the cDNA complement of this alignment (if any)
 108    *
 109    * @return
 110    */
 111   Hashtable[] getComplementConsensusHash();
 112
 113   Hashtable[] getRnaStructureConsensusHash();
 114
 115   boolean isIgnoreGapsConsensus();
 116
 117   boolean isCalculationInProgress(AlignmentAnnotation alignmentAnnotation);
 118
 119   AlignmentAnnotation getAlignmentQualityAnnot();
 120
 121   AlignmentAnnotation getAlignmentConservationAnnotation();
 122
 123   /**
 124    * get the container for alignment consensus annotation
 125    *
 126    * @return
 127    */
 128   AlignmentAnnotation getAlignmentConsensusAnnotation();
 129
 130   /**
 131    * get the container for alignment gap annotation
 132    *
 133    * @return
 134    */
 135   AlignmentAnnotation getAlignmentGapAnnotation();
 136
 137   /**
 138    * get the container for cDNA complement consensus annotation
 139    *
 140    * @return
 141    */
 142   AlignmentAnnotation getComplementConsensusAnnotation();
 143
 144   /**
 145    * Test to see if viewport is still open and active
 146    *
 147    * @return true indicates that all references to viewport should be dropped
 148    */
 149   boolean isClosed();
 150
 151   /**
 152    * Dispose of all references or resources held by the viewport
 153    */
 154   void dispose();
 155
 156   /**
 157    * get the associated calculation thread manager for the view
 158    *
 159    * @return
 160    */
 161   AlignCalcManagerI getCalcManager();
 162
 163   /**
 164    * get the percentage gaps allowed in a conservation calculation
 165    *
 166    */
 167   public int getConsPercGaps();
 168
 169   /**
 170    * set the consensus result object for the viewport
 171    *
 172    * @param hconsensus
 173    */
 174   void setSequenceConsensusHash(ProfilesI hconsensus);
 175
 176   /**
 177    * Set the cDNA complement consensus for the viewport
 178    *
 179    * @param hconsensus
 180    */
 181   void setComplementConsensusHash(Hashtable[] hconsensus);
 182
 183   /**
 184    *
 185    * @return the alignment annotation row for the structure consensus
 186    *         calculation
 187    */
 188   AlignmentAnnotation getAlignmentStrucConsensusAnnotation();
 189
 190   /**
 191    * set the Rna structure consensus result object for the viewport
 192    *
 193    * @param hStrucConsensus
 194    */
 195   void setRnaStructureConsensusHash(Hashtable[] hStrucConsensus);
 196
 197   /**
 198    * Sets the colour scheme for the background alignment (as distinct from
 199    * sub-groups, which may have their own colour schemes). A null value is used
 200    * for no residue colour (white).
 201    *
 202    * @param cs
 203    */
 204   void setGlobalColourScheme(ColourSchemeI cs);
 205
 206   Map<SequenceI, SequenceCollectionI> getHiddenRepSequences();
 207
 208   void setHiddenRepSequences(
 209           Map<SequenceI, SequenceCollectionI> hiddenRepSequences);
 210
 211   /**
 212    * hides or shows dynamic annotation rows based on groups and group and
 213    * alignment associated auto-annotation state flags apply the current
 214    * group/autoannotation settings to the alignment view. Usually you should
 215    * call the AlignmentViewPanel.adjustAnnotationHeight() method afterwards to
 216    * ensure the annotation panel bounds are set correctly.
 217    *
 218    * @param applyGlobalSettings
 219    *          - apply to all autoannotation rows or just the ones associated
 220    *          with the current visible region
 221    * @param preserveNewGroupSettings
 222    *          - don't apply global settings to groups which don't already have
 223    *          group associated annotation
 224    */
 225   void updateGroupAnnotationSettings(boolean applyGlobalSettings,
 226           boolean preserveNewGroupSettings);
 227
 228   void setSequenceColour(SequenceI seq, Color col);
 229
 230   Color getSequenceColour(SequenceI seq);
 231
 232   void updateSequenceIdColours();
 233
 234   SequenceGroup getSelectionGroup();
 235
 236   /**
 237    * get the currently selected sequence objects or all the sequences in the
 238    * alignment. TODO: change to List<>
 239    *
 240    * @return array of references to sequence objects
 241    */
 242   SequenceI[] getSequenceSelection();
 243
 244   void clearSequenceColours();
 245
 246   /**
 247    * return a compact representation of the current alignment selection to pass
 248    * to an analysis function
 249    *
 250    * @param selectedOnly
 251    *          boolean true to just return the selected view
 252    * @return AlignmentView
 253    */
 254   AlignmentView getAlignmentView(boolean selectedOnly);
 255
 256   /**
 257    * return a compact representation of the current alignment selection to pass
 258    * to an analysis function
 259    *
 260    * @param selectedOnly
 261    *          boolean true to just return the selected view
 262    * @param markGroups
 263    *          boolean true to annotate the alignment view with groups on the
 264    *          alignment (and intersecting with selected region if selectedOnly
 265    *          is true)
 266    * @return AlignmentView
 267    */
 268   AlignmentView getAlignmentView(boolean selectedOnly, boolean markGroups);
 269
 270   /**
 271    * @return an alignment view, optionally without a complement view
 272    * @param selectedOnly
 273    * @param markGroups
 274    * @param withComplement - false if no complement view required
 275    */
 276   AlignmentView getAlignmentViewWithComplement(boolean selectedOnly,
 277           boolean markGroups, boolean withComplement);
 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   /**
 445    * configure the feature renderer with predefined feature settings
 446    *
 447    * @param featureSettings
 448    */
 449   public void applyFeaturesStyle(FeatureSettingsModelI featureSettings);
 450
 451   /**
 452    * Apply the given feature settings on top of existing feature settings.
 453    */
 454   public void mergeFeaturesStyle(FeatureSettingsModelI featureSettings);
 455
 456   /**
 457    * check if current selection group is defined on the view, or is simply a
 458    * temporary group.
 459    *
 460    * @return true if group is defined on the alignment
 461    */
 462   boolean isSelectionDefinedGroup();
 463
 464   /**
 465    *
 466    * @return true if there are search results on the view
 467    */
 468   boolean hasSearchResults();
 469
 470   /**
 471    * set the search results for the view
 472    *
 473    * @param results
 474    *          - or null to clear current results
 475    */
 476   void setSearchResults(SearchResultsI results);
 477
 478   /**
 479    * get search results for this view (if any)
 480    *
 481    * @return search results or null
 482    */
 483   SearchResultsI getSearchResults();
 484
 485   /**
 486    * Updates view settings with the given font. You may need to call
 487    * AlignmentPanel.fontChanged to update the layout geometry.
 488    *
 489    * @param setGrid
 490    *          when true, charWidth/height is set according to font metrics
 491    */
 492   void setFont(Font newFont, boolean b);
 493
 494   /**
 495    * Answers true if split screen protein and cDNA use the same font
 496    *
 497    * @return
 498    */
 499   @Override
 500   boolean isProteinFontAsCdna();
 501
 502   /**
 503    * Set the flag for whether split screen protein and cDNA use the same font
 504    *
 505    * @return
 506    */
 507   @Override
 508   void setProteinFontAsCdna(boolean b);
 509
 510   public abstract TreeModel getCurrentTree();
 511
 512   public abstract void setCurrentTree(TreeModel tree);
 513
 514   /**
 515    * @param update
 516    *          - set the flag for updating structures on next repaint
 517    */
 518   void setUpdateStructures(boolean update);
 519
 520   /**
 521    *
 522    * @return true if structure views will be updated on next refresh
 523    */
 524   boolean isUpdateStructures();
 525
 526   /**
 527    * check if structure views need to be updated, and clear the flag afterwards.
 528    *
 529    * @return if an update is needed
 530    */
 531   boolean needToUpdateStructureViews();
 532
 533   /**
 534    * Adds sequencegroup to the alignment in the view. Also adds a group to the
 535    * complement view if one is defined.
 536    *
 537    * @param sequenceGroup
 538    *          - a group defined on sequences in the alignment held by the view
 539    */
 540   void addSequenceGroup(SequenceGroup sequenceGroup);
 541
 542   /**
 543    * Returns an interator over the [start, end] column positions of the visible
 544    * regions of the alignment
 545    *
 546    * @param selectedRegionOnly
 547    *                             if true, and the view has a selection region,
 548    *                             then only the intersection of visible columns
 549    *                             with the selection region is returned
 550    * @return
 551    */
 552   Iterator<int[]> getViewAsVisibleContigs(boolean selectedRegionOnly);
 553 }