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