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