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 cDNA complement consensus annotation
 130    *
 131    * @return
 132    */
 133   AlignmentAnnotation getComplementConsensusAnnotation();
 134
 135   /**
 136    * Test to see if viewport is still open and active
 137    *
 138    * @return true indicates that all references to viewport should be dropped
 139    */
 140   boolean isClosed();
 141
 142   /**
 143    * Dispose of all references or resources held by the viewport
 144    */
 145   void dispose();
 146
 147   /**
 148    * get the associated calculation thread manager for the view
 149    *
 150    * @return
 151    */
 152   AlignCalcManagerI getCalcManager();
 153
 154   /**
 155    * get the percentage gaps allowed in a conservation calculation
 156    *
 157    */
 158   public int getConsPercGaps();
 159
 160   /**
 161    * set the consensus result object for the viewport
 162    *
 163    * @param hconsensus
 164    */
 165   void setSequenceConsensusHash(ProfilesI hconsensus);
 166
 167   /**
 168    * Set the cDNA complement consensus for the viewport
 169    *
 170    * @param hconsensus
 171    */
 172   void setComplementConsensusHash(Hashtable[] hconsensus);
 173
 174   /**
 175    *
 176    * @return the alignment annotation row for the structure consensus
 177    *         calculation
 178    */
 179   AlignmentAnnotation getAlignmentStrucConsensusAnnotation();
 180
 181   /**
 182    * set the Rna structure consensus result object for the viewport
 183    *
 184    * @param hStrucConsensus
 185    */
 186   void setRnaStructureConsensusHash(Hashtable[] hStrucConsensus);
 187
 188   /**
 189    * Sets the colour scheme for the background alignment (as distinct from
 190    * sub-groups, which may have their own colour schemes). A null value is used
 191    * for no residue colour (white).
 192    *
 193    * @param cs
 194    */
 195   void setGlobalColourScheme(ColourSchemeI cs);
 196
 197   Map<SequenceI, SequenceCollectionI> getHiddenRepSequences();
 198
 199   void setHiddenRepSequences(
 200           Map<SequenceI, SequenceCollectionI> hiddenRepSequences);
 201
 202   /**
 203    * hides or shows dynamic annotation rows based on groups and group and
 204    * alignment associated auto-annotation state flags apply the current
 205    * group/autoannotation settings to the alignment view. Usually you should
 206    * call the AlignmentViewPanel.adjustAnnotationHeight() method afterwards to
 207    * ensure the annotation panel bounds are set correctly.
 208    *
 209    * @param applyGlobalSettings
 210    *          - apply to all autoannotation rows or just the ones associated
 211    *          with the current visible region
 212    * @param preserveNewGroupSettings
 213    *          - don't apply global settings to groups which don't already have
 214    *          group associated annotation
 215    */
 216   void updateGroupAnnotationSettings(boolean applyGlobalSettings,
 217           boolean preserveNewGroupSettings);
 218
 219   void setSequenceColour(SequenceI seq, Color col);
 220
 221   Color getSequenceColour(SequenceI seq);
 222
 223   void updateSequenceIdColours();
 224
 225   SequenceGroup getSelectionGroup();
 226
 227   /**
 228    * get the currently selected sequence objects or all the sequences in the
 229    * alignment. TODO: change to List<>
 230    *
 231    * @return array of references to sequence objects
 232    */
 233   SequenceI[] getSequenceSelection();
 234
 235   void clearSequenceColours();
 236
 237   /**
 238    * This method returns the visible alignment as text, as seen on the GUI, ie
 239    * if columns are hidden they will not be returned in the result. Use this for
 240    * calculating trees, PCA, redundancy etc on views which contain hidden
 241    * columns.
 242    *
 243    * @return String[]
 244    */
 245   CigarArray getViewAsCigars(boolean selectedRegionOnly);
 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   public void applyFeaturesStyle(FeatureSettingsModelI featureSettings);
 437
 438   /**
 439    * check if current selection group is defined on the view, or is simply a
 440    * temporary group.
 441    *
 442    * @return true if group is defined on the alignment
 443    */
 444   boolean isSelectionDefinedGroup();
 445
 446   /**
 447    *
 448    * @return true if there are search results on the view
 449    */
 450   boolean hasSearchResults();
 451
 452   /**
 453    * set the search results for the view
 454    *
 455    * @param results
 456    *          - or null to clear current results
 457    */
 458   void setSearchResults(SearchResultsI results);
 459
 460   /**
 461    * get search results for this view (if any)
 462    *
 463    * @return search results or null
 464    */
 465   SearchResultsI getSearchResults();
 466 }