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.AlignmentExportData;
  27 import jalview.datamodel.AlignmentI;
  28 import jalview.datamodel.AlignmentView;
  29 import jalview.datamodel.ColumnSelection;
  30 import jalview.datamodel.ProfilesI;
  31 import jalview.datamodel.SearchResultsI;
  32 import jalview.datamodel.SequenceCollectionI;
  33 import jalview.datamodel.SequenceGroup;
  34 import jalview.datamodel.SequenceI;
  35 import jalview.renderer.ResidueShaderI;
  36 import jalview.schemes.ColourSchemeI;
  37 import jalview.viewmodel.ViewportRanges;
  38
  39 import java.awt.Color;
  40 import java.awt.Font;
  41 import java.util.Hashtable;
  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<String, Object>[] getComplementConsensusHash();
 112
 113   Hashtable<String, Object>[] 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<String, Object>[] 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(
 196           Hashtable<String, Object>[] hStrucConsensus);
 197
 198   /**
 199    * Sets the colour scheme for the background alignment (as distinct from
 200    * sub-groups, which may have their own colour schemes). A null value is used
 201    * for no residue colour (white).
 202    *
 203    * @param cs
 204    */
 205   void setGlobalColourScheme(ColourSchemeI cs);
 206
 207   Map<SequenceI, SequenceCollectionI> getHiddenRepSequences();
 208
 209   void setHiddenRepSequences(
 210           Map<SequenceI, SequenceCollectionI> hiddenRepSequences);
 211
 212   /**
 213    * hides or shows dynamic annotation rows based on groups and group and
 214    * alignment associated auto-annotation state flags apply the current
 215    * group/autoannotation settings to the alignment view. Usually you should
 216    * call the AlignmentViewPanel.adjustAnnotationHeight() method afterwards to
 217    * ensure the annotation panel bounds are set correctly.
 218    *
 219    * @param applyGlobalSettings
 220    *          - apply to all autoannotation rows or just the ones associated
 221    *          with the current visible region
 222    * @param preserveNewGroupSettings
 223    *          - don't apply global settings to groups which don't already have
 224    *          group associated annotation
 225    */
 226   void updateGroupAnnotationSettings(boolean applyGlobalSettings,
 227           boolean preserveNewGroupSettings);
 228
 229   void setSequenceColour(SequenceI seq, Color col);
 230
 231   Color getSequenceColour(SequenceI seq);
 232
 233   void updateSequenceIdColours();
 234
 235   SequenceGroup getSelectionGroup();
 236
 237   /**
 238    * get the currently selected sequence objects or all the sequences in the
 239    * alignment. TODO: change to List<>
 240    *
 241    * @return array of references to sequence objects
 242    */
 243   SequenceI[] getSequenceSelection();
 244
 245   void clearSequenceColours();
 246
 247   /**
 248    * return a compact representation of the current alignment selection to pass
 249    * to an analysis function
 250    *
 251    * @param selectedOnly
 252    *          boolean true to just return the selected view
 253    * @return AlignmentView
 254    */
 255   AlignmentView getAlignmentView(boolean selectedOnly);
 256
 257   /**
 258    * return a compact representation of the current alignment selection to pass
 259    * to an analysis function
 260    *
 261    * @param selectedOnly
 262    *          boolean true to just return the selected view
 263    * @param markGroups
 264    *          boolean true to annotate the alignment view with groups on the
 265    *          alignment (and intersecting with selected region if selectedOnly
 266    *          is true)
 267    * @return AlignmentView
 268    */
 269   AlignmentView getAlignmentView(boolean selectedOnly, boolean markGroups);
 270
 271   /**
 272    * This method returns the visible alignment as text, as seen on the GUI, ie
 273    * if columns are hidden they will not be returned in the result. Use this for
 274    * calculating trees, PCA, redundancy etc on views which contain hidden
 275    * columns. This method doesn't exclude hidden sequences from the output.
 276    *
 277    * @param selectedRegionOnly
 278    *          - determines if only the selected region or entire alignment is
 279    *          exported
 280    * @return String[]
 281    */
 282   String[] getViewAsString(boolean selectedRegionOnly);
 283
 284   /**
 285    * This method returns the visible alignment as text, as seen on the GUI, ie
 286    * if columns are hidden they will not be returned in the result. Use this for
 287    * calculating trees, PCA, redundancy etc on views which contain hidden
 288    * columns.
 289    *
 290    * @param selectedRegionOnly
 291    *          - determines if only the selected region or entire alignment is
 292    *          exported
 293    * @param isExportHiddenSeqs
 294    *          - determines if hidden sequences would be exported or not.
 295    *
 296    * @return String[]
 297    */
 298   String[] getViewAsString(boolean selectedRegionOnly,
 299           boolean isExportHiddenSeqs);
 300
 301   void setSelectionGroup(SequenceGroup sg);
 302
 303   char getGapCharacter();
 304
 305   void setColumnSelection(ColumnSelection cs);
 306
 307   void setConservation(Conservation cons);
 308
 309   /**
 310    * get a copy of the currently visible alignment annotation
 311    *
 312    * @param selectedOnly
 313    *          if true - trim to selected regions on the alignment
 314    * @return an empty list or new alignment annotation objects shown only
 315    *         visible columns trimmed to selected region only
 316    */
 317   List<AlignmentAnnotation> getVisibleAlignmentAnnotation(
 318           boolean selectedOnly);
 319
 320   FeaturesDisplayedI getFeaturesDisplayed();
 321
 322   String getSequenceSetId();
 323
 324   boolean areFeaturesDisplayed();
 325
 326   void setFeaturesDisplayed(FeaturesDisplayedI featuresDisplayedI);
 327
 328   void alignmentChanged(AlignmentViewPanel ap);
 329
 330   /**
 331    * @return the padGaps
 332    */
 333   boolean isPadGaps();
 334
 335   /**
 336    * @param padGaps
 337    *          the padGaps to set
 338    */
 339   void setPadGaps(boolean padGaps);
 340
 341   /**
 342    * return visible region boundaries within given column range
 343    *
 344    * @param min
 345    *          first column (inclusive, from 0)
 346    * @param max
 347    *          last column (exclusive)
 348    * @return int[][] range of {start,end} visible positions
 349    */
 350   List<int[]> getVisibleRegionBoundaries(int min, int max);
 351
 352   /**
 353    * This method returns an array of new SequenceI objects derived from the
 354    * whole alignment or just the current selection with start and end points
 355    * adjusted
 356    *
 357    * @note if you need references to the actual SequenceI objects in the
 358    *       alignment or currently selected then use getSequenceSelection()
 359    * @return selection as new sequenceI objects
 360    */
 361   SequenceI[] getSelectionAsNewSequence();
 362
 363   void invertColumnSelection();
 364
 365   /**
 366    * broadcast selection to any interested parties
 367    */
 368   void sendSelection();
 369
 370   /**
 371    * calculate the row position for alignmentIndex if all hidden sequences were
 372    * shown
 373    *
 374    * @param alignmentIndex
 375    * @return adjusted row position
 376    */
 377   int adjustForHiddenSeqs(int alignmentIndex);
 378
 379   boolean hasHiddenRows();
 380
 381   /**
 382    *
 383    * @return a copy of this view's current display settings
 384    */
 385   public ViewStyleI getViewStyle();
 386
 387   /**
 388    * update the view's display settings with the given style set
 389    *
 390    * @param settingsForView
 391    */
 392   public void setViewStyle(ViewStyleI settingsForView);
 393
 394   /**
 395    * Returns a viewport which holds the cDna for this (protein), or vice versa,
 396    * or null if none is set.
 397    *
 398    * @return
 399    */
 400   AlignViewportI getCodingComplement();
 401
 402   /**
 403    * Sets the viewport which holds the cDna for this (protein), or vice versa.
 404    * Implementation should guarantee that the reciprocal relationship is always
 405    * set, i.e. each viewport is the complement of the other.
 406    */
 407   void setCodingComplement(AlignViewportI sl);
 408
 409   /**
 410    * Answers true if viewport hosts DNA/RNA, else false.
 411    *
 412    * @return
 413    */
 414   boolean isNucleotide();
 415
 416   /**
 417    * Returns an id guaranteed to be unique for this viewport.
 418    *
 419    * @return
 420    */
 421   String getViewId();
 422
 423   /**
 424    * Return true if view should scroll to show the highlighted region of a
 425    * sequence
 426    *
 427    * @return
 428    */
 429   boolean isFollowHighlight();
 430
 431   /**
 432    * Set whether view should scroll to show the highlighted region of a sequence
 433    */
 434   void setFollowHighlight(boolean b);
 435
 436   /**
 437    * configure the feature renderer with predefined feature settings
 438    *
 439    * @param featureSettings
 440    */
 441   public void applyFeaturesStyle(FeatureSettingsModelI featureSettings);
 442
 443   /**
 444    * Apply the given feature settings on top of existing feature settings.
 445    */
 446   public void mergeFeaturesStyle(FeatureSettingsModelI featureSettings);
 447
 448   /**
 449    * check if current selection group is defined on the view, or is simply a
 450    * temporary group.
 451    *
 452    * @return true if group is defined on the alignment
 453    */
 454   boolean isSelectionDefinedGroup();
 455
 456   /**
 457    *
 458    * @return true if there are search results on the view
 459    */
 460   boolean hasSearchResults();
 461
 462   /**
 463    * set the search results for the view
 464    *
 465    * @param results
 466    *          - or null to clear current results
 467    */
 468   void setSearchResults(SearchResultsI results);
 469
 470   /**
 471    * get search results for this view (if any)
 472    *
 473    * @return search results or null
 474    */
 475   SearchResultsI getSearchResults();
 476
 477   /**
 478    * Updates view settings with the given font. You may need to call
 479    * AlignmentPanel.fontChanged to update the layout geometry.
 480    *
 481    * @param setGrid
 482    *          when true, charWidth/height is set according to font metrics
 483    */
 484   void setFont(Font newFont, boolean b);
 485
 486   /**
 487    * Answers true if split screen protein and cDNA use the same font
 488    *
 489    * @return
 490    */
 491   @Override
 492   boolean isProteinFontAsCdna();
 493
 494   /**
 495    * Set the flag for whether split screen protein and cDNA use the same font
 496    *
 497    * @return
 498    */
 499   @Override
 500   void setProteinFontAsCdna(boolean b);
 501
 502   TreeModel getCurrentTree();
 503
 504   void setCurrentTree(TreeModel tree);
 505
 506   /**
 507    * Answers a data bean containing data for export as configured by the
 508    * supplied options
 509    *
 510    * @param options
 511    * @return
 512    */
 513   AlignmentExportData getAlignExportData(AlignExportSettingsI options);
 514
 515   /**
 516    * @param update
 517    *          - set the flag for updating structures on next repaint
 518    */
 519   void setUpdateStructures(boolean update);
 520
 521   /**
 522    *
 523    * @return true if structure views will be updated on next refresh
 524    */
 525   boolean isUpdateStructures();
 526
 527   /**
 528    * check if structure views need to be updated, and clear the flag afterwards.
 529    *
 530    * @return if an update is needed
 531    */
 532   boolean needToUpdateStructureViews();
 533
 534   /**
 535    * Adds sequencegroup to the alignment in the view. Also adds a group to the
 536    * complement view if one is defined.
 537    *
 538    * @param sequenceGroup
 539    *          - a group defined on sequences in the alignment held by the view
 540    */
 541   void addSequenceGroup(SequenceGroup sequenceGroup);
 542 }