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   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   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   boolean isShowInformationHistogram();
  91
  92   boolean isShowHMMSequenceLogo();
  93
  94   boolean isNormaliseHMMSequenceLogo();
  95
  96   ColourSchemeI getGlobalColourScheme();
  97
  98   /**
  99    * Returns an object that describes colouring (including any thresholding or
 100    * fading) of the alignment
 101    *
 102    * @return
 103    */
 104   ResidueShaderI getResidueShading();
 105
 106   AlignmentI getAlignment();
 107
 108   ColumnSelection getColumnSelection();
 109
 110   ProfilesI getSequenceConsensusHash();
 111
 112   /**
 113    * Get consensus data table for the cDNA complement of this alignment (if any)
 114    *
 115    * @return
 116    */
 117   Hashtable<String, Object>[] getComplementConsensusHash();
 118
 119   Hashtable<String, Object>[] getRnaStructureConsensusHash();
 120
 121   boolean isIgnoreGapsConsensus();
 122
 123   boolean isIgnoreBelowBackground();
 124
 125   boolean isCalculationInProgress(AlignmentAnnotation alignmentAnnotation);
 126
 127   AlignmentAnnotation getAlignmentQualityAnnot();
 128
 129   AlignmentAnnotation getAlignmentConservationAnnotation();
 130
 131   /**
 132    * get the container for alignment consensus annotation
 133    *
 134    * @return
 135    */
 136   AlignmentAnnotation getAlignmentConsensusAnnotation();
 137
 138   /**
 139    * get the container for alignment gap annotation
 140    *
 141    * @return
 142    */
 143   AlignmentAnnotation getAlignmentGapAnnotation();
 144
 145   /**
 146    * get the container for cDNA complement consensus annotation
 147    *
 148    * @return
 149    */
 150   AlignmentAnnotation getComplementConsensusAnnotation();
 151
 152   /**
 153    * Test to see if viewport is still open and active
 154    *
 155    * @return true indicates that all references to viewport should be dropped
 156    */
 157   boolean isClosed();
 158
 159   /**
 160    * Dispose of all references or resources held by the viewport
 161    */
 162   void dispose();
 163
 164   /**
 165    * get the associated calculation thread manager for the view
 166    *
 167    * @return
 168    */
 169   AlignCalcManagerI2 getCalcManager();
 170
 171   /**
 172    * get the percentage gaps allowed in a conservation calculation
 173    *
 174    */
 175   public int getConsPercGaps();
 176
 177   /**
 178    * set the consensus result object for the viewport
 179    *
 180    * @param hconsensus
 181    */
 182   void setSequenceConsensusHash(ProfilesI hconsensus);
 183
 184   /**
 185    * Set the cDNA complement consensus for the viewport
 186    *
 187    * @param hconsensus
 188    */
 189   void setComplementConsensusHash(Hashtable<String, Object>[] hconsensus);
 190
 191   /**
 192    *
 193    * @return the alignment annotation row for the structure consensus
 194    *         calculation
 195    */
 196   AlignmentAnnotation getAlignmentStrucConsensusAnnotation();
 197
 198   /**
 199    * set the Rna structure consensus result object for the viewport
 200    *
 201    * @param hStrucConsensus
 202    */
 203   void setRnaStructureConsensusHash(
 204           Hashtable<String, Object>[] hStrucConsensus);
 205
 206   /**
 207    * Sets the colour scheme for the background alignment (as distinct from
 208    * sub-groups, which may have their own colour schemes). A null value is used
 209    * for no residue colour (white).
 210    *
 211    * @param cs
 212    */
 213   void setGlobalColourScheme(ColourSchemeI cs);
 214
 215   Map<SequenceI, SequenceCollectionI> getHiddenRepSequences();
 216
 217   void setHiddenRepSequences(
 218           Map<SequenceI, SequenceCollectionI> hiddenRepSequences);
 219
 220   /**
 221    * hides or shows dynamic annotation rows based on groups and group and
 222    * alignment associated auto-annotation state flags apply the current
 223    * group/autoannotation settings to the alignment view. Usually you should
 224    * call the AlignmentViewPanel.adjustAnnotationHeight() method afterwards to
 225    * ensure the annotation panel bounds are set correctly.
 226    *
 227    * @param applyGlobalSettings
 228    *          - apply to all autoannotation rows or just the ones associated
 229    *          with the current visible region
 230    * @param preserveNewGroupSettings
 231    *          - don't apply global settings to groups which don't already have
 232    *          group associated annotation
 233    */
 234   void updateGroupAnnotationSettings(boolean applyGlobalSettings,
 235           boolean preserveNewGroupSettings);
 236
 237   void setSequenceColour(SequenceI seq, Color col);
 238
 239   Color getSequenceColour(SequenceI seq);
 240
 241   void updateSequenceIdColours();
 242
 243   SequenceGroup getSelectionGroup();
 244
 245   /**
 246    * get the currently selected sequence objects or all the sequences in the
 247    * alignment. TODO: change to List<>
 248    *
 249    * @return array of references to sequence objects
 250    */
 251   SequenceI[] getSequenceSelection();
 252
 253   void clearSequenceColours();
 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   /**
 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   void setHmmProfiles(ProfilesI info);
 511
 512   ProfilesI getHmmProfiles();
 513
 514   /**
 515    * Registers and starts a worker thread to calculate Information Content
 516    * annotation, if it is not already registered
 517    *
 518    * @param ap
 519    */
 520   void initInformationWorker(AlignmentViewPanel ap);
 521
 522   boolean isInfoLetterHeight();
 523
 524   public abstract TreeModel getCurrentTree();
 525
 526   /**
 527    * Answers a data bean containing data for export as configured by the
 528    * supplied options
 529    *
 530    * @param options
 531    * @return
 532    */
 533   AlignmentExportData getAlignExportData(AlignExportSettingsI options);
 534
 535   public abstract void setCurrentTree(TreeModel tree);
 536
 537   /**
 538    * @param update
 539    *          - set the flag for updating structures on next repaint
 540    */
 541   void setUpdateStructures(boolean update);
 542
 543   /**
 544    *
 545    * @return true if structure views will be updated on next refresh
 546    */
 547   boolean isUpdateStructures();
 548
 549   /**
 550    * check if structure views need to be updated, and clear the flag afterwards.
 551    *
 552    * @return if an update is needed
 553    */
 554   boolean needToUpdateStructureViews();
 555
 556   /**
 557    * Adds sequencegroup to the alignment in the view. Also adds a group to the
 558    * complement view if one is defined.
 559    *
 560    * @param sequenceGroup
 561    *          - a group defined on sequences in the alignment held by the view
 562    */
 563   void addSequenceGroup(SequenceGroup sequenceGroup);
 564 }